blob: 0886987a6003a09bfa58f05a1935a6f399d47ca8 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00002# (C) Copyright 2000 - 2011
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /nios2 Files generic to Altera NIOS2 architecture
186 /cpu CPU specific files
187 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200188 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /cpu CPU specific files
190 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
191 /mpc5xx Files specific to Freescale MPC5xx CPUs
192 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
193 /mpc8xx Files specific to Freescale MPC8xx CPUs
194 /mpc8220 Files specific to Freescale MPC8220 CPUs
195 /mpc824x Files specific to Freescale MPC824x CPUs
196 /mpc8260 Files specific to Freescale MPC8260 CPUs
197 /mpc85xx Files specific to Freescale MPC85xx CPUs
198 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
199 /lib Architecture specific library files
200 /sh Files generic to SH architecture
201 /cpu CPU specific files
202 /sh2 Files specific to sh2 CPUs
203 /sh3 Files specific to sh3 CPUs
204 /sh4 Files specific to sh4 CPUs
205 /lib Architecture specific library files
206 /sparc Files generic to SPARC architecture
207 /cpu CPU specific files
208 /leon2 Files specific to Gaisler LEON2 SPARC CPU
209 /leon3 Files specific to Gaisler LEON3 SPARC CPU
210 /lib Architecture specific library files
211/api Machine/arch independent API for external apps
212/board Board dependent files
213/common Misc architecture independent functions
214/disk Code for disk drive partition handling
215/doc Documentation (don't expect too much)
216/drivers Commonly used device drivers
217/examples Example code for standalone applications, etc.
218/fs Filesystem code (cramfs, ext2, jffs2, etc.)
219/include Header Files
220/lib Files generic to all architectures
221 /libfdt Library files to support flattened device trees
222 /lzma Library files to support LZMA decompression
223 /lzo Library files to support LZO decompression
224/net Networking code
225/post Power On Self Test
226/rtc Real Time Clock drivers
227/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000228
wdenkc6097192002-11-03 00:24:07 +0000229Software Configuration:
230=======================
231
232Configuration is usually done using C preprocessor defines; the
233rationale behind that is to avoid dead code whenever possible.
234
235There are two classes of configuration variables:
236
237* Configuration _OPTIONS_:
238 These are selectable by the user and have names beginning with
239 "CONFIG_".
240
241* Configuration _SETTINGS_:
242 These depend on the hardware etc. and should not be meddled with if
243 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200244 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000245
246Later we will add a configuration tool - probably similar to or even
247identical to what's used for the Linux kernel. Right now, we have to
248do the configuration by hand, which means creating some symbolic
249links and editing some configuration files. We use the TQM8xxL boards
250as an example here.
251
252
253Selection of Processor Architecture and Board Type:
254---------------------------------------------------
255
256For all supported boards there are ready-to-use default
257configurations available; just type "make <board_name>_config".
258
259Example: For a TQM823L module type:
260
261 cd u-boot
262 make TQM823L_config
263
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200264For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000265e.g. "make cogent_mpc8xx_config". And also configure the cogent
266directory according to the instructions in cogent/README.
267
268
269Configuration Options:
270----------------------
271
272Configuration depends on the combination of board and CPU type; all
273such information is kept in a configuration file
274"include/configs/<board_name>.h".
275
276Example: For a TQM823L module, all configuration settings are in
277"include/configs/TQM823L.h".
278
279
wdenk7f6c2cb2002-11-10 22:06:23 +0000280Many of the options are named exactly as the corresponding Linux
281kernel configuration options. The intention is to make it easier to
282build a config tool - later.
283
284
wdenkc6097192002-11-03 00:24:07 +0000285The following options need to be configured:
286
Kim Phillips26281142007-08-10 13:28:25 -0500287- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000288
Kim Phillips26281142007-08-10 13:28:25 -0500289- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200290
291- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100292 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000293
294- CPU Module Type: (if CONFIG_COGENT is defined)
295 Define exactly one of
296 CONFIG_CMA286_60_OLD
297--- FIXME --- not tested yet:
298 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
299 CONFIG_CMA287_23, CONFIG_CMA287_50
300
301- Motherboard Type: (if CONFIG_COGENT is defined)
302 Define exactly one of
303 CONFIG_CMA101, CONFIG_CMA102
304
305- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
306 Define one or more of
307 CONFIG_CMA302
308
309- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
310 Define one or more of
311 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200312 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000313 a "rotator" |\-/|\-/
314
wdenk2535d602003-07-17 23:16:40 +0000315- Board flavour: (if CONFIG_MPC8260ADS is defined)
316 CONFIG_ADSTYPE
317 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200318 CONFIG_SYS_8260ADS - original MPC8260ADS
319 CONFIG_SYS_8266ADS - MPC8266ADS
320 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
321 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000322
Lei Wencf946c62011-02-09 18:06:58 +0530323- Marvell Family Member
324 CONFIG_SYS_MVFS - define it if you want to enable
325 multiple fs option at one time
326 for marvell soc family
327
wdenkc6097192002-11-03 00:24:07 +0000328- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000329 Define exactly one of
330 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000331
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200332- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000333 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
334 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000335 e.g. if there is no 32KHz
336 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
338 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000339
wdenk66ca92a2004-09-28 17:59:53 +0000340- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_8xx_CPUCLK_MIN
342 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000343 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000344 See doc/README.MPC866
345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000347
wdenkba56f622004-02-06 23:19:44 +0000348 Define this to measure the actual CPU clock instead
349 of relying on the correctness of the configured
350 values. Mostly useful for board bringup to make sure
351 the PLL is locked at the intended frequency. Note
352 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200353 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000354
Heiko Schocher506f3912009-03-12 07:37:15 +0100355 CONFIG_SYS_DELAYED_ICACHE
356
357 Define this option if you want to enable the
358 ICache only when Code runs from RAM.
359
Kumar Gala66412c62011-02-18 05:40:54 -0600360- 85xx CPU Options:
361 CONFIG_SYS_FSL_TBCLK_DIV
362
363 Defines the core time base clock divider ratio compared to the
364 system clock. On most PQ3 devices this is 8, on newer QorIQ
365 devices it can be 16 or 32. The ratio varies from SoC to Soc.
366
Kumar Gala8f290842011-05-20 00:39:21 -0500367 CONFIG_SYS_FSL_PCIE_COMPAT
368
369 Defines the string to utilize when trying to match PCIe device
370 tree nodes for the given platform.
371
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100372- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200373 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100374
375 Defines the Monahans run mode to oscillator
376 ratio. Valid values are 8, 16, 24, 31. The core
377 frequency is this value multiplied by 13 MHz.
378
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200379 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200380
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100381 Defines the Monahans turbo mode to oscillator
382 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200383 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100384 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200385
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200386- MIPS CPU options:
387 CONFIG_SYS_INIT_SP_OFFSET
388
389 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
390 pointer. This is needed for the temporary stack before
391 relocation.
392
393 CONFIG_SYS_MIPS_CACHE_MODE
394
395 Cache operation mode for the MIPS CPU.
396 See also arch/mips/include/asm/mipsregs.h.
397 Possible values are:
398 CONF_CM_CACHABLE_NO_WA
399 CONF_CM_CACHABLE_WA
400 CONF_CM_UNCACHED
401 CONF_CM_CACHABLE_NONCOHERENT
402 CONF_CM_CACHABLE_CE
403 CONF_CM_CACHABLE_COW
404 CONF_CM_CACHABLE_CUW
405 CONF_CM_CACHABLE_ACCELERATED
406
407 CONFIG_SYS_XWAY_EBU_BOOTCFG
408
409 Special option for Lantiq XWAY SoCs for booting from NOR flash.
410 See also arch/mips/cpu/mips32/start.S.
411
412 CONFIG_XWAY_SWAP_BYTES
413
414 Enable compilation of tools/xway-swap-bytes needed for Lantiq
415 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
416 be swapped if a flash programmer is used.
417
wdenk5da627a2003-10-09 20:09:04 +0000418- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000419 CONFIG_CLOCKS_IN_MHZ
420
421 U-Boot stores all clock information in Hz
422 internally. For binary compatibility with older Linux
423 kernels (which expect the clocks passed in the
424 bd_info data to be in MHz) the environment variable
425 "clocks_in_mhz" can be defined so that U-Boot
426 converts clock data to MHZ before passing it to the
427 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000428 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100429 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000430 default environment.
431
wdenk5da627a2003-10-09 20:09:04 +0000432 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
433
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200434 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000435 expect it to be in bytes, others in MB.
436 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
437
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400438 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200439
440 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400441 passed using flattened device trees (based on open firmware
442 concepts).
443
444 CONFIG_OF_LIBFDT
445 * New libfdt-based support
446 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500447 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400448
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200449 OF_CPU - The proper name of the cpus node (only required for
450 MPC512X and MPC5xxx based boards).
451 OF_SOC - The proper name of the soc node (only required for
452 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200453 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600454 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200455
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200456 boards with QUICC Engines require OF_QE to set UCC MAC
457 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500458
Kumar Gala4e253132006-01-11 13:54:17 -0600459 CONFIG_OF_BOARD_SETUP
460
461 Board code has addition modification that it wants to make
462 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000463
Matthew McClintock02677682006-06-28 10:41:37 -0500464 CONFIG_OF_BOOT_CPU
465
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200466 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500467 param header, the default value is zero if undefined.
468
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200469 CONFIG_OF_IDE_FIXUP
470
471 U-Boot can detect if an IDE device is present or not.
472 If not, and this new config option is activated, U-Boot
473 removes the ATA node from the DTS before booting Linux,
474 so the Linux IDE driver does not probe the device and
475 crash. This is needed for buggy hardware (uc101) where
476 no pull down resistor is connected to the signal IDE5V_DD7.
477
Igor Grinberg7eb29392011-07-14 05:45:07 +0000478 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
479
480 This setting is mandatory for all boards that have only one
481 machine type and must be used to specify the machine type
482 number as it appears in the ARM machine registry
483 (see http://www.arm.linux.org.uk/developer/machines/).
484 Only boards that have multiple machine types supported
485 in a single configuration file and the machine type is
486 runtime discoverable, do not have to use this setting.
487
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100488- vxWorks boot parameters:
489
490 bootvx constructs a valid bootline using the following
491 environments variables: bootfile, ipaddr, serverip, hostname.
492 It loads the vxWorks image pointed bootfile.
493
494 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
495 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
496 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
497 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
498
499 CONFIG_SYS_VXWORKS_ADD_PARAMS
500
501 Add it at the end of the bootline. E.g "u=username pw=secret"
502
503 Note: If a "bootargs" environment is defined, it will overwride
504 the defaults discussed just above.
505
Aneesh V2c451f72011-06-16 23:30:47 +0000506- Cache Configuration:
507 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
508 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
509 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
510
Aneesh V93bc2192011-06-16 23:30:51 +0000511- Cache Configuration for ARM:
512 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
513 controller
514 CONFIG_SYS_PL310_BASE - Physical base address of PL310
515 controller register space
516
wdenk6705d812004-08-02 23:22:59 +0000517- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200518 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000519
520 Define this if you want support for Amba PrimeCell PL010 UARTs.
521
Andreas Engel48d01922008-09-08 14:30:53 +0200522 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000523
524 Define this if you want support for Amba PrimeCell PL011 UARTs.
525
526 CONFIG_PL011_CLOCK
527
528 If you have Amba PrimeCell PL011 UARTs, set this variable to
529 the clock speed of the UARTs.
530
531 CONFIG_PL01x_PORTS
532
533 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
534 define this to a list of base addresses for each (supported)
535 port. See e.g. include/configs/versatile.h
536
John Rigby910f1ae2011-04-19 10:42:39 +0000537 CONFIG_PL011_SERIAL_RLCR
538
539 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
540 have separate receive and transmit line control registers. Set
541 this variable to initialize the extra register.
542
543 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
544
545 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
546 boot loader that has already initialized the UART. Define this
547 variable to flush the UART at init time.
548
wdenk6705d812004-08-02 23:22:59 +0000549
wdenkc6097192002-11-03 00:24:07 +0000550- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000551 Depending on board, define exactly one serial port
552 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
553 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
554 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000555
556 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
557 port routines must be defined elsewhere
558 (i.e. serial_init(), serial_getc(), ...)
559
560 CONFIG_CFB_CONSOLE
561 Enables console device for a color framebuffer. Needs following
562 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
563 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
564 (default big endian)
565 VIDEO_HW_RECTFILL graphic chip supports
566 rectangle fill
567 (cf. smiLynxEM)
568 VIDEO_HW_BITBLT graphic chip supports
569 bit-blit (cf. smiLynxEM)
570 VIDEO_VISIBLE_COLS visible pixel columns
571 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000572 VIDEO_VISIBLE_ROWS visible pixel rows
573 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000574 VIDEO_DATA_FORMAT graphic data format
575 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000576 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000577 VIDEO_KBD_INIT_FCT keyboard int fct
578 (i.e. i8042_kbd_init())
579 VIDEO_TSTC_FCT test char fct
580 (i.e. i8042_tstc)
581 VIDEO_GETC_FCT get char fct
582 (i.e. i8042_getc)
583 CONFIG_CONSOLE_CURSOR cursor drawing on/off
584 (requires blink timer
585 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200586 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000587 CONFIG_CONSOLE_TIME display time/date info in
588 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500589 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000590 CONFIG_VIDEO_LOGO display Linux logo in
591 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000592 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
593 linux_logo.h for logo.
594 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200596 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000597 the logo
598
wdenk43d96162003-03-06 00:02:04 +0000599 When CONFIG_CFB_CONSOLE is defined, video console is
600 default i/o. Serial console can be forced with
601 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000602
wdenkd4ca31c2004-01-02 14:00:00 +0000603 When CONFIG_SILENT_CONSOLE is defined, all console
604 messages (by U-Boot and Linux!) can be silenced with
605 the "silent" environment variable. See
606 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000607
wdenkc6097192002-11-03 00:24:07 +0000608- Console Baudrate:
609 CONFIG_BAUDRATE - in bps
610 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200611 CONFIG_SYS_BAUDRATE_TABLE, see below.
612 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000613
Heiko Schocherc92fac92009-01-30 12:55:38 +0100614- Console Rx buffer length
615 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
616 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100617 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100618 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
619 must be defined, to setup the maximum idle timeout for
620 the SMC.
621
wdenkc6097192002-11-03 00:24:07 +0000622- Boot Delay: CONFIG_BOOTDELAY - in seconds
623 Delay before automatically booting the default image;
624 set to -1 to disable autoboot.
625
626 See doc/README.autoboot for these options that
627 work with CONFIG_BOOTDELAY. None are required.
628 CONFIG_BOOT_RETRY_TIME
629 CONFIG_BOOT_RETRY_MIN
630 CONFIG_AUTOBOOT_KEYED
631 CONFIG_AUTOBOOT_PROMPT
632 CONFIG_AUTOBOOT_DELAY_STR
633 CONFIG_AUTOBOOT_STOP_STR
634 CONFIG_AUTOBOOT_DELAY_STR2
635 CONFIG_AUTOBOOT_STOP_STR2
636 CONFIG_ZERO_BOOTDELAY_CHECK
637 CONFIG_RESET_TO_RETRY
638
639- Autoboot Command:
640 CONFIG_BOOTCOMMAND
641 Only needed when CONFIG_BOOTDELAY is enabled;
642 define a command string that is automatically executed
643 when no character is read on the console interface
644 within "Boot Delay" after reset.
645
646 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000647 This can be used to pass arguments to the bootm
648 command. The value of CONFIG_BOOTARGS goes into the
649 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000650
651 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000652 The value of these goes into the environment as
653 "ramboot" and "nfsboot" respectively, and can be used
654 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200655 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000656
657- Pre-Boot Commands:
658 CONFIG_PREBOOT
659
660 When this option is #defined, the existence of the
661 environment variable "preboot" will be checked
662 immediately before starting the CONFIG_BOOTDELAY
663 countdown and/or running the auto-boot command resp.
664 entering interactive mode.
665
666 This feature is especially useful when "preboot" is
667 automatically generated or modified. For an example
668 see the LWMON board specific code: here "preboot" is
669 modified when the user holds down a certain
670 combination of keys on the (special) keyboard when
671 booting the systems
672
673- Serial Download Echo Mode:
674 CONFIG_LOADS_ECHO
675 If defined to 1, all characters received during a
676 serial download (using the "loads" command) are
677 echoed back. This might be needed by some terminal
678 emulations (like "cu"), but may as well just take
679 time on others. This setting #define's the initial
680 value of the "loads_echo" environment variable.
681
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500682- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000683 CONFIG_KGDB_BAUDRATE
684 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200685 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000686
687- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500688 Monitor commands can be included or excluded
689 from the build by using the #include files
690 "config_cmd_all.h" and #undef'ing unwanted
691 commands, or using "config_cmd_default.h"
692 and augmenting with additional #define's
693 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000694
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500695 The default command configuration includes all commands
696 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000697
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500698 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500699 CONFIG_CMD_BDI bdinfo
700 CONFIG_CMD_BEDBUG * Include BedBug Debugger
701 CONFIG_CMD_BMP * BMP support
702 CONFIG_CMD_BSP * Board specific commands
703 CONFIG_CMD_BOOTD bootd
704 CONFIG_CMD_CACHE * icache, dcache
705 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500706 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 CONFIG_CMD_DATE * support for RTC, date/time...
708 CONFIG_CMD_DHCP * DHCP support
709 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600710 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
711 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
712 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
713 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500714 CONFIG_CMD_DTT * Digital Therm and Thermostat
715 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500716 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 CONFIG_CMD_EEPROM * EEPROM read/write support
718 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500719 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500720 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500721 CONFIG_CMD_FDC * Floppy Disk Support
722 CONFIG_CMD_FAT * FAT partition support
723 CONFIG_CMD_FDOS * Dos diskette Support
724 CONFIG_CMD_FLASH flinfo, erase, protect
725 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500726 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000727 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500728 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
729 CONFIG_CMD_I2C * I2C serial bus support
730 CONFIG_CMD_IDE * IDE harddisk support
731 CONFIG_CMD_IMI iminfo
732 CONFIG_CMD_IMLS List all found images
733 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500734 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500735 CONFIG_CMD_IRQ * irqinfo
736 CONFIG_CMD_ITEST Integer/string test of 2 values
737 CONFIG_CMD_JFFS2 * JFFS2 Support
738 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500739 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500740 CONFIG_CMD_LOADB loadb
741 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400742 CONFIG_CMD_MD5SUM print md5 message digest
743 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500744 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
745 loop, loopw, mtest
746 CONFIG_CMD_MISC Misc functions like sleep etc
747 CONFIG_CMD_MMC * MMC memory mapped support
748 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100749 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500750 CONFIG_CMD_NAND * NAND support
751 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600752 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
753 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 CONFIG_CMD_PCI * pciinfo
755 CONFIG_CMD_PCMCIA * PCMCIA support
756 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
757 host
758 CONFIG_CMD_PORTIO * Port I/O
759 CONFIG_CMD_REGINFO * Register dump
760 CONFIG_CMD_RUN run command in env variable
761 CONFIG_CMD_SAVES * save S record dump
762 CONFIG_CMD_SCSI * SCSI Support
763 CONFIG_CMD_SDRAM * print SDRAM configuration information
764 (requires CONFIG_CMD_I2C)
765 CONFIG_CMD_SETGETDCR Support for DCR Register access
766 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100767 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400768 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200769 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500770 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000771 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500772 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 CONFIG_CMD_CDP * Cisco Discover Protocol support
774 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000775
wdenkc6097192002-11-03 00:24:07 +0000776
777 EXAMPLE: If you want all functions except of network
778 support you can write:
779
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500780 #include "config_cmd_all.h"
781 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000782
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400783 Other Commands:
784 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000785
786 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500787 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000788 what you (and your U-Boot users) are doing. Data
789 cache cannot be enabled on systems like the 8xx or
790 8260 (where accesses to the IMMR region must be
791 uncached), and it cannot be disabled on all other
792 systems where we (mis-) use the data cache to hold an
793 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000794
795
796 XXX - this list needs to get updated!
797
798- Watchdog:
799 CONFIG_WATCHDOG
800 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000801 support for the SoC. There must be support in the SoC
802 specific code for a watchdog. For the 8xx and 8260
803 CPUs, the SIU Watchdog feature is enabled in the SYPCR
804 register. When supported for a specific SoC is
805 available, then no further board specific code should
806 be needed to use it.
807
808 CONFIG_HW_WATCHDOG
809 When using a watchdog circuitry external to the used
810 SoC, then define this variable and provide board
811 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000812
stroesec1551ea2003-04-04 15:53:41 +0000813- U-Boot Version:
814 CONFIG_VERSION_VARIABLE
815 If this variable is defined, an environment variable
816 named "ver" is created by U-Boot showing the U-Boot
817 version as printed by the "version" command.
818 This variable is readonly.
819
wdenkc6097192002-11-03 00:24:07 +0000820- Real-Time Clock:
821
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500822 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000823 has to be selected, too. Define exactly one of the
824 following options:
825
826 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
827 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200828 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000829 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000830 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000831 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000832 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000833 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100834 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000835 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200836 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200837 CONFIG_SYS_RV3029_TCR - enable trickle charger on
838 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000839
wdenkb37c7e52003-06-30 16:24:52 +0000840 Note that if the RTC uses I2C, then the I2C interface
841 must also be configured. See I2C Support, below.
842
Peter Tysere92739d2008-12-17 16:36:21 -0600843- GPIO Support:
844 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
845 CONFIG_PCA953X_INFO - enable pca953x info command
846
Chris Packham5dec49c2010-12-19 10:12:13 +0000847 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
848 chip-ngpio pairs that tell the PCA953X driver the number of
849 pins supported by a particular chip.
850
Peter Tysere92739d2008-12-17 16:36:21 -0600851 Note that if the GPIO device uses I2C, then the I2C interface
852 must also be configured. See I2C Support, below.
853
wdenkc6097192002-11-03 00:24:07 +0000854- Timestamp Support:
855
wdenk43d96162003-03-06 00:02:04 +0000856 When CONFIG_TIMESTAMP is selected, the timestamp
857 (date and time) of an image is printed by image
858 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500859 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000860
861- Partition Support:
862 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400863 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000864
Wolfgang Denk218ca722008-03-26 10:40:12 +0100865 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
866 CONFIG_CMD_SCSI) you must configure support for at
867 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000868
869- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000870 CONFIG_IDE_RESET_ROUTINE - this is defined in several
871 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000872
wdenk4d13cba2004-03-14 14:09:05 +0000873 CONFIG_IDE_RESET - is this is defined, IDE Reset will
874 be performed by calling the function
875 ide_set_reset(int reset)
876 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000877
878- ATAPI Support:
879 CONFIG_ATAPI
880
881 Set this to enable ATAPI support.
882
wdenkc40b2952004-03-13 23:29:43 +0000883- LBA48 Support
884 CONFIG_LBA48
885
886 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100887 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000888 Whithout these , LBA48 support uses 32bit variables and will 'only'
889 support disks up to 2.1TB.
890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200891 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000892 When enabled, makes the IDE subsystem use 64bit sector addresses.
893 Default is 32bit.
894
wdenkc6097192002-11-03 00:24:07 +0000895- SCSI Support:
896 At the moment only there is only support for the
897 SYM53C8XX SCSI controller; define
898 CONFIG_SCSI_SYM53C8XX to enable it.
899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200900 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
901 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
902 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000903 maximum numbers of LUNs, SCSI ID's and target
904 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200905 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000906
907- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000908 CONFIG_E1000
909 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000910
Andre Schwarzac3315c2008-03-06 16:45:44 +0100911 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200912 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100913
wdenkc6097192002-11-03 00:24:07 +0000914 CONFIG_EEPRO100
915 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200916 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000917 write routine for first time initialisation.
918
919 CONFIG_TULIP
920 Support for Digital 2114x chips.
921 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
922 modem chip initialisation (KS8761/QS6611).
923
924 CONFIG_NATSEMI
925 Support for National dp83815 chips.
926
927 CONFIG_NS8382X
928 Support for National dp8382[01] gigabit chips.
929
wdenk45219c42003-05-12 21:50:16 +0000930- NETWORK Support (other):
931
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100932 CONFIG_DRIVER_AT91EMAC
933 Support for AT91RM9200 EMAC.
934
935 CONFIG_RMII
936 Define this to use reduced MII inteface
937
938 CONFIG_DRIVER_AT91EMAC_QUIET
939 If this defined, the driver is quiet.
940 The driver doen't show link status messages.
941
wdenk45219c42003-05-12 21:50:16 +0000942 CONFIG_DRIVER_LAN91C96
943 Support for SMSC's LAN91C96 chips.
944
945 CONFIG_LAN91C96_BASE
946 Define this to hold the physical address
947 of the LAN91C96's I/O space
948
949 CONFIG_LAN91C96_USE_32_BIT
950 Define this to enable 32 bit addressing
951
wdenkf39748a2004-06-09 13:37:52 +0000952 CONFIG_DRIVER_SMC91111
953 Support for SMSC's LAN91C111 chip
954
955 CONFIG_SMC91111_BASE
956 Define this to hold the physical address
957 of the device (I/O space)
958
959 CONFIG_SMC_USE_32_BIT
960 Define this if data bus is 32 bits
961
962 CONFIG_SMC_USE_IOFUNCS
963 Define this to use i/o functions instead of macros
964 (some hardware wont work with macros)
965
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800966 CONFIG_FTGMAC100
967 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
968
969 CONFIG_FTGMAC100_EGIGA
970 Define this to use GE link update with gigabit PHY.
971 Define this if FTGMAC100 is connected to gigabit PHY.
972 If your system has 10/100 PHY only, it might not occur
973 wrong behavior. Because PHY usually return timeout or
974 useless data when polling gigabit status and gigabit
975 control registers. This behavior won't affect the
976 correctnessof 10/100 link speed update.
977
Mike Rapoportc2fff332009-11-11 10:03:03 +0200978 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200979 Support for SMSC's LAN911x and LAN921x chips
980
Mike Rapoportc2fff332009-11-11 10:03:03 +0200981 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200982 Define this to hold the physical address
983 of the device (I/O space)
984
Mike Rapoportc2fff332009-11-11 10:03:03 +0200985 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200986 Define this if data bus is 32 bits
987
Mike Rapoportc2fff332009-11-11 10:03:03 +0200988 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200989 Define this if data bus is 16 bits. If your processor
990 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200991 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200992
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900993 CONFIG_SH_ETHER
994 Support for Renesas on-chip Ethernet controller
995
996 CONFIG_SH_ETHER_USE_PORT
997 Define the number of ports to be used
998
999 CONFIG_SH_ETHER_PHY_ADDR
1000 Define the ETH PHY's address
1001
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001002 CONFIG_SH_ETHER_CACHE_WRITEBACK
1003 If this option is set, the driver enables cache flush.
1004
wdenkc6097192002-11-03 00:24:07 +00001005- USB Support:
1006 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001007 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001008 CONFIG_USB_UHCI to enable it.
1009 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001010 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001011 storage devices.
1012 Note:
1013 Supported are USB Keyboards and USB Floppy drives
1014 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001015 MPC5200 USB requires additional defines:
1016 CONFIG_USB_CLOCK
1017 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001018 CONFIG_PSC3_USB
1019 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001020 CONFIG_USB_CONFIG
1021 for differential drivers: 0x00001000
1022 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001023 for differential drivers on PSC3: 0x00000100
1024 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001025 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001026 May be defined to allow interrupt polling
1027 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001028
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001029- USB Device:
1030 Define the below if you wish to use the USB console.
1031 Once firmware is rebuilt from a serial console issue the
1032 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001033 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001034 it has found a new device. The environment variable usbtty
1035 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001036 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001037 Common Device Class Abstract Control Model serial device.
1038 If you select usbtty = gserial you should be able to enumerate
1039 a Linux host by
1040 # modprobe usbserial vendor=0xVendorID product=0xProductID
1041 else if using cdc_acm, simply setting the environment
1042 variable usbtty to be cdc_acm should suffice. The following
1043 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001044
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001045 CONFIG_USB_DEVICE
1046 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001047
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001048 CONFIG_USB_TTY
1049 Define this to have a tty type of device available to
1050 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001051
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001052 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001053 Define this if you want stdin, stdout &/or stderr to
1054 be set to usbtty.
1055
1056 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001057 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001058 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001059 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001061 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001062 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001063 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001064
Wolfgang Denk386eda02006-06-14 18:14:56 +02001065 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001066 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001067 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001068 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1069 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1070 should pretend to be a Linux device to it's target host.
1071
1072 CONFIG_USBD_MANUFACTURER
1073 Define this string as the name of your company for
1074 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001075
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001076 CONFIG_USBD_PRODUCT_NAME
1077 Define this string as the name of your product
1078 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1079
1080 CONFIG_USBD_VENDORID
1081 Define this as your assigned Vendor ID from the USB
1082 Implementors Forum. This *must* be a genuine Vendor ID
1083 to avoid polluting the USB namespace.
1084 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001085
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001086 CONFIG_USBD_PRODUCTID
1087 Define this as the unique Product ID
1088 for your device
1089 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001090
1091
1092- MMC Support:
1093 The MMC controller on the Intel PXA is supported. To
1094 enable this define CONFIG_MMC. The MMC can be
1095 accessed from the boot prompt by mapping the device
1096 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001097 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1098 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001099
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001100 CONFIG_SH_MMCIF
1101 Support for Renesas on-chip MMCIF controller
1102
1103 CONFIG_SH_MMCIF_ADDR
1104 Define the base address of MMCIF registers
1105
1106 CONFIG_SH_MMCIF_CLK
1107 Define the clock frequency for MMCIF
1108
wdenk6705d812004-08-02 23:22:59 +00001109- Journaling Flash filesystem support:
1110 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1111 CONFIG_JFFS2_NAND_DEV
1112 Define these for a default partition on a NAND device
1113
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001114 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1115 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001116 Define these for a default partition on a NOR device
1117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001118 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001119 Define this to create an own partition. You have to provide a
1120 function struct part_info* jffs2_part_info(int part_num)
1121
1122 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001123 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001124 to disable the command chpart. This is the default when you
1125 have not defined a custom partition
1126
wdenkc6097192002-11-03 00:24:07 +00001127- Keyboard Support:
1128 CONFIG_ISA_KEYBOARD
1129
1130 Define this to enable standard (PC-Style) keyboard
1131 support
1132
1133 CONFIG_I8042_KBD
1134 Standard PC keyboard driver with US (is default) and
1135 GERMAN key layout (switch via environment 'keymap=de') support.
1136 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1137 for cfb_console. Supports cursor blinking.
1138
1139- Video support:
1140 CONFIG_VIDEO
1141
1142 Define this to enable video support (for output to
1143 video).
1144
1145 CONFIG_VIDEO_CT69000
1146
1147 Enable Chips & Technologies 69000 Video chip
1148
1149 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001150 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001151 video output is selected via environment 'videoout'
1152 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1153 assumed.
wdenkc6097192002-11-03 00:24:07 +00001154
wdenkb79a11c2004-03-25 15:14:43 +00001155 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001156 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001157 are possible:
1158 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001159 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001160
1161 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1162 -------------+---------------------------------------------
1163 8 bits | 0x301* 0x303 0x305 0x161 0x307
1164 15 bits | 0x310 0x313 0x316 0x162 0x319
1165 16 bits | 0x311 0x314 0x317 0x163 0x31A
1166 24 bits | 0x312 0x315 0x318 ? 0x31B
1167 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001168 (i.e. setenv videomode 317; saveenv; reset;)
1169
wdenkb79a11c2004-03-25 15:14:43 +00001170 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001171 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001172
1173
stroesec1551ea2003-04-04 15:53:41 +00001174 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001175 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001176 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1177 or CONFIG_VIDEO_SED13806_16BPP
1178
Timur Tabi7d3053f2011-02-15 17:09:19 -06001179 CONFIG_FSL_DIU_FB
1180 Enable the Freescale DIU video driver. Reference boards for
1181 SOCs that have a DIU should define this macro to enable DIU
1182 support, and should also define these other macros:
1183
1184 CONFIG_SYS_DIU_ADDR
1185 CONFIG_VIDEO
1186 CONFIG_CMD_BMP
1187 CONFIG_CFB_CONSOLE
1188 CONFIG_VIDEO_SW_CURSOR
1189 CONFIG_VGA_AS_SINGLE_DEVICE
1190 CONFIG_VIDEO_LOGO
1191 CONFIG_VIDEO_BMP_LOGO
1192
Timur Tabiba8e76b2011-04-11 14:18:22 -05001193 The DIU driver will look for the 'video-mode' environment
1194 variable, and if defined, enable the DIU as a console during
1195 boot. See the documentation file README.video for a
1196 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001197
wdenk682011f2003-06-03 23:54:09 +00001198- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001199 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001200
wdenk8bde7f72003-06-27 21:31:46 +00001201 Define this to enable a custom keyboard support.
1202 This simply calls drv_keyboard_init() which must be
1203 defined in your board-specific files.
1204 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001205
wdenkc6097192002-11-03 00:24:07 +00001206- LCD Support: CONFIG_LCD
1207
1208 Define this to enable LCD support (for output to LCD
1209 display); also select one of the supported displays
1210 by defining one of these:
1211
Stelian Pop39cf4802008-05-09 21:57:18 +02001212 CONFIG_ATMEL_LCD:
1213
1214 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1215
wdenkfd3103b2003-11-25 16:55:19 +00001216 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001217
wdenkfd3103b2003-11-25 16:55:19 +00001218 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001219
wdenkfd3103b2003-11-25 16:55:19 +00001220 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001221
wdenkfd3103b2003-11-25 16:55:19 +00001222 NEC NL6448BC20-08. 6.5", 640x480.
1223 Active, color, single scan.
1224
1225 CONFIG_NEC_NL6448BC33_54
1226
1227 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001228 Active, color, single scan.
1229
1230 CONFIG_SHARP_16x9
1231
1232 Sharp 320x240. Active, color, single scan.
1233 It isn't 16x9, and I am not sure what it is.
1234
1235 CONFIG_SHARP_LQ64D341
1236
1237 Sharp LQ64D341 display, 640x480.
1238 Active, color, single scan.
1239
1240 CONFIG_HLD1045
1241
1242 HLD1045 display, 640x480.
1243 Active, color, single scan.
1244
1245 CONFIG_OPTREX_BW
1246
1247 Optrex CBL50840-2 NF-FW 99 22 M5
1248 or
1249 Hitachi LMG6912RPFC-00T
1250 or
1251 Hitachi SP14Q002
1252
1253 320x240. Black & white.
1254
1255 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001256 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001257
wdenk7152b1d2003-09-05 23:19:14 +00001258- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001259
wdenk8bde7f72003-06-27 21:31:46 +00001260 If this option is set, the environment is checked for
1261 a variable "splashimage". If found, the usual display
1262 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001263 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001264 specified in "splashimage" is loaded instead. The
1265 console is redirected to the "nulldev", too. This
1266 allows for a "silent" boot where a splash screen is
1267 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001268
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001269 CONFIG_SPLASH_SCREEN_ALIGN
1270
1271 If this option is set the splash image can be freely positioned
1272 on the screen. Environment variable "splashpos" specifies the
1273 position as "x,y". If a positive number is given it is used as
1274 number of pixel from left/top. If a negative number is given it
1275 is used as number of pixel from right/bottom. You can also
1276 specify 'm' for centering the image.
1277
1278 Example:
1279 setenv splashpos m,m
1280 => image at center of screen
1281
1282 setenv splashpos 30,20
1283 => image at x = 30 and y = 20
1284
1285 setenv splashpos -10,m
1286 => vertically centered image
1287 at x = dspWidth - bmpWidth - 9
1288
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001289- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1290
1291 If this option is set, additionally to standard BMP
1292 images, gzipped BMP images can be displayed via the
1293 splashscreen support or the bmp command.
1294
Anatolij Gustschind5011762010-03-15 14:50:25 +01001295- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1296
1297 If this option is set, 8-bit RLE compressed BMP images
1298 can be displayed via the splashscreen support or the
1299 bmp command.
1300
wdenkc29fdfc2003-08-29 20:57:53 +00001301- Compression support:
1302 CONFIG_BZIP2
1303
1304 If this option is set, support for bzip2 compressed
1305 images is included. If not, only uncompressed and gzip
1306 compressed images are supported.
1307
wdenk42d1f032003-10-15 23:53:47 +00001308 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001309 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001310 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001311
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001312 CONFIG_LZMA
1313
1314 If this option is set, support for lzma compressed
1315 images is included.
1316
1317 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1318 requires an amount of dynamic memory that is given by the
1319 formula:
1320
1321 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1322
1323 Where lc and lp stand for, respectively, Literal context bits
1324 and Literal pos bits.
1325
1326 This value is upper-bounded by 14MB in the worst case. Anyway,
1327 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1328 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1329 a very small buffer.
1330
1331 Use the lzmainfo tool to determinate the lc and lp values and
1332 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001333 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001334
wdenk17ea1172004-06-06 21:51:03 +00001335- MII/PHY support:
1336 CONFIG_PHY_ADDR
1337
1338 The address of PHY on MII bus.
1339
1340 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1341
1342 The clock frequency of the MII bus
1343
1344 CONFIG_PHY_GIGE
1345
1346 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001347 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001348
1349 CONFIG_PHY_RESET_DELAY
1350
1351 Some PHY like Intel LXT971A need extra delay after
1352 reset before any MII register access is possible.
1353 For such PHY, set this option to the usec delay
1354 required. (minimum 300usec for LXT971A)
1355
1356 CONFIG_PHY_CMD_DELAY (ppc4xx)
1357
1358 Some PHY like Intel LXT971A need extra delay after
1359 command issued before MII status register can be read
1360
wdenkc6097192002-11-03 00:24:07 +00001361- Ethernet address:
1362 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001363 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001364 CONFIG_ETH2ADDR
1365 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001366 CONFIG_ETH4ADDR
1367 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001368
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001369 Define a default value for Ethernet address to use
1370 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001371 is not determined automatically.
1372
1373- IP address:
1374 CONFIG_IPADDR
1375
1376 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001377 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001378 determined through e.g. bootp.
1379
1380- Server IP address:
1381 CONFIG_SERVERIP
1382
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001383 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001384 server to contact when using the "tftboot" command.
1385
Robin Getz97cfe862009-07-21 12:15:28 -04001386 CONFIG_KEEP_SERVERADDR
1387
1388 Keeps the server's MAC address, in the env 'serveraddr'
1389 for passing to bootargs (like Linux's netconsole option)
1390
David Updegraff53a5c422007-06-11 10:41:07 -05001391- Multicast TFTP Mode:
1392 CONFIG_MCAST_TFTP
1393
1394 Defines whether you want to support multicast TFTP as per
1395 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001396 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001397 driver in use must provide a function: mcast() to join/leave a
1398 multicast group.
1399
wdenkc6097192002-11-03 00:24:07 +00001400- BOOTP Recovery Mode:
1401 CONFIG_BOOTP_RANDOM_DELAY
1402
1403 If you have many targets in a network that try to
1404 boot using BOOTP, you may want to avoid that all
1405 systems send out BOOTP requests at precisely the same
1406 moment (which would happen for instance at recovery
1407 from a power failure, when all systems will try to
1408 boot, thus flooding the BOOTP server. Defining
1409 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1410 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001411 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001412
1413 1st BOOTP request: delay 0 ... 1 sec
1414 2nd BOOTP request: delay 0 ... 2 sec
1415 3rd BOOTP request: delay 0 ... 4 sec
1416 4th and following
1417 BOOTP requests: delay 0 ... 8 sec
1418
stroesefe389a82003-08-28 14:17:32 +00001419- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001420 You can fine tune the DHCP functionality by defining
1421 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001422
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001423 CONFIG_BOOTP_SUBNETMASK
1424 CONFIG_BOOTP_GATEWAY
1425 CONFIG_BOOTP_HOSTNAME
1426 CONFIG_BOOTP_NISDOMAIN
1427 CONFIG_BOOTP_BOOTPATH
1428 CONFIG_BOOTP_BOOTFILESIZE
1429 CONFIG_BOOTP_DNS
1430 CONFIG_BOOTP_DNS2
1431 CONFIG_BOOTP_SEND_HOSTNAME
1432 CONFIG_BOOTP_NTPSERVER
1433 CONFIG_BOOTP_TIMEOFFSET
1434 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001435
Wilson Callan5d110f02007-07-28 10:56:13 -04001436 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1437 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001438
1439 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1440 serverip from a DHCP server, it is possible that more
1441 than one DNS serverip is offered to the client.
1442 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1443 serverip will be stored in the additional environment
1444 variable "dnsip2". The first DNS serverip is always
1445 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001446 is defined.
stroesefe389a82003-08-28 14:17:32 +00001447
1448 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1449 to do a dynamic update of a DNS server. To do this, they
1450 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001451 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001452 of the "hostname" environment variable is passed as
1453 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001454
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001455 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1456
1457 A 32bit value in microseconds for a delay between
1458 receiving a "DHCP Offer" and sending the "DHCP Request".
1459 This fixes a problem with certain DHCP servers that don't
1460 respond 100% of the time to a "DHCP request". E.g. On an
1461 AT91RM9200 processor running at 180MHz, this delay needed
1462 to be *at least* 15,000 usec before a Windows Server 2003
1463 DHCP server would reply 100% of the time. I recommend at
1464 least 50,000 usec to be safe. The alternative is to hope
1465 that one of the retries will be successful but note that
1466 the DHCP timeout and retry process takes a longer than
1467 this delay.
1468
wdenka3d991b2004-04-15 21:48:45 +00001469 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001470 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001471
1472 The device id used in CDP trigger frames.
1473
1474 CONFIG_CDP_DEVICE_ID_PREFIX
1475
1476 A two character string which is prefixed to the MAC address
1477 of the device.
1478
1479 CONFIG_CDP_PORT_ID
1480
1481 A printf format string which contains the ascii name of
1482 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001483 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001484
1485 CONFIG_CDP_CAPABILITIES
1486
1487 A 32bit integer which indicates the device capabilities;
1488 0x00000010 for a normal host which does not forwards.
1489
1490 CONFIG_CDP_VERSION
1491
1492 An ascii string containing the version of the software.
1493
1494 CONFIG_CDP_PLATFORM
1495
1496 An ascii string containing the name of the platform.
1497
1498 CONFIG_CDP_TRIGGER
1499
1500 A 32bit integer sent on the trigger.
1501
1502 CONFIG_CDP_POWER_CONSUMPTION
1503
1504 A 16bit integer containing the power consumption of the
1505 device in .1 of milliwatts.
1506
1507 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1508
1509 A byte containing the id of the VLAN.
1510
wdenkc6097192002-11-03 00:24:07 +00001511- Status LED: CONFIG_STATUS_LED
1512
1513 Several configurations allow to display the current
1514 status using a LED. For instance, the LED will blink
1515 fast while running U-Boot code, stop blinking as
1516 soon as a reply to a BOOTP request was received, and
1517 start blinking slow once the Linux kernel is running
1518 (supported by a status LED driver in the Linux
1519 kernel). Defining CONFIG_STATUS_LED enables this
1520 feature in U-Boot.
1521
1522- CAN Support: CONFIG_CAN_DRIVER
1523
1524 Defining CONFIG_CAN_DRIVER enables CAN driver support
1525 on those systems that support this (optional)
1526 feature, like the TQM8xxL modules.
1527
1528- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1529
wdenkb37c7e52003-06-30 16:24:52 +00001530 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001531 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001532 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001533
wdenk945af8d2003-07-16 21:53:01 +00001534 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001535 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001536 CONFIG_COMMANDS) and communicate with i2c based realtime
1537 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001538 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001539
Ben Warrenbb99ad62006-09-07 16:50:54 -04001540 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001541
wdenk945af8d2003-07-16 21:53:01 +00001542 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001543 bit-banging) driver instead of CPM or similar hardware
1544 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001545
wdenk945af8d2003-07-16 21:53:01 +00001546 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001547 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001549 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001550 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001551 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001552 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001553
Peter Tyser8d321b82010-04-12 22:28:21 -05001554 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001555 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001556 and so its address should therefore be cleared to 0 (See,
1557 eg, MPC823e User's Manual p.16-473). So, set
1558 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001559
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001560 CONFIG_SYS_I2C_INIT_MPC5XXX
1561
1562 When a board is reset during an i2c bus transfer
1563 chips might think that the current transfer is still
1564 in progress. Reset the slave devices by sending start
1565 commands until the slave device responds.
1566
wdenk945af8d2003-07-16 21:53:01 +00001567 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001568
1569 If you use the software i2c interface (CONFIG_SOFT_I2C)
1570 then the following macros need to be defined (examples are
1571 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001572
1573 I2C_INIT
1574
wdenkb37c7e52003-06-30 16:24:52 +00001575 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001576 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001577
wdenkba56f622004-02-06 23:19:44 +00001578 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001579
wdenkc6097192002-11-03 00:24:07 +00001580 I2C_PORT
1581
wdenk43d96162003-03-06 00:02:04 +00001582 (Only for MPC8260 CPU). The I/O port to use (the code
1583 assumes both bits are on the same port). Valid values
1584 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001585
1586 I2C_ACTIVE
1587
1588 The code necessary to make the I2C data line active
1589 (driven). If the data line is open collector, this
1590 define can be null.
1591
wdenkb37c7e52003-06-30 16:24:52 +00001592 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1593
wdenkc6097192002-11-03 00:24:07 +00001594 I2C_TRISTATE
1595
1596 The code necessary to make the I2C data line tri-stated
1597 (inactive). If the data line is open collector, this
1598 define can be null.
1599
wdenkb37c7e52003-06-30 16:24:52 +00001600 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1601
wdenkc6097192002-11-03 00:24:07 +00001602 I2C_READ
1603
1604 Code that returns TRUE if the I2C data line is high,
1605 FALSE if it is low.
1606
wdenkb37c7e52003-06-30 16:24:52 +00001607 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1608
wdenkc6097192002-11-03 00:24:07 +00001609 I2C_SDA(bit)
1610
1611 If <bit> is TRUE, sets the I2C data line high. If it
1612 is FALSE, it clears it (low).
1613
wdenkb37c7e52003-06-30 16:24:52 +00001614 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001615 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001616 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001617
wdenkc6097192002-11-03 00:24:07 +00001618 I2C_SCL(bit)
1619
1620 If <bit> is TRUE, sets the I2C clock line high. If it
1621 is FALSE, it clears it (low).
1622
wdenkb37c7e52003-06-30 16:24:52 +00001623 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001624 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001625 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001626
wdenkc6097192002-11-03 00:24:07 +00001627 I2C_DELAY
1628
1629 This delay is invoked four times per clock cycle so this
1630 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001631 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001632 like:
1633
wdenkb37c7e52003-06-30 16:24:52 +00001634 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001635
Mike Frysinger793b5722010-07-21 13:38:02 -04001636 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1637
1638 If your arch supports the generic GPIO framework (asm/gpio.h),
1639 then you may alternatively define the two GPIOs that are to be
1640 used as SCL / SDA. Any of the previous I2C_xxx macros will
1641 have GPIO-based defaults assigned to them as appropriate.
1642
1643 You should define these to the GPIO value as given directly to
1644 the generic GPIO functions.
1645
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001646 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001647
wdenk8bde7f72003-06-27 21:31:46 +00001648 When a board is reset during an i2c bus transfer
1649 chips might think that the current transfer is still
1650 in progress. On some boards it is possible to access
1651 the i2c SCLK line directly, either by using the
1652 processor pin as a GPIO or by having a second pin
1653 connected to the bus. If this option is defined a
1654 custom i2c_init_board() routine in boards/xxx/board.c
1655 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001656
Richard Retanubun26a33502010-04-12 15:08:17 -04001657 CONFIG_SYS_I2C_BOARD_LATE_INIT
1658
1659 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1660 defined a custom i2c_board_late_init() routine in
1661 boards/xxx/board.c is run AFTER the operations in i2c_init()
1662 is completed. This callpoint can be used to unreset i2c bus
1663 using CPU i2c controller register accesses for CPUs whose i2c
1664 controller provide such a method. It is called at the end of
1665 i2c_init() to allow i2c_init operations to setup the i2c bus
1666 controller on the CPU (e.g. setting bus speed & slave address).
1667
wdenk17ea1172004-06-06 21:51:03 +00001668 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1669
1670 This option enables configuration of bi_iic_fast[] flags
1671 in u-boot bd_info structure based on u-boot environment
1672 variable "i2cfast". (see also i2cfast)
1673
Ben Warrenbb99ad62006-09-07 16:50:54 -04001674 CONFIG_I2C_MULTI_BUS
1675
1676 This option allows the use of multiple I2C buses, each of which
1677 must have a controller. At any point in time, only one bus is
1678 active. To switch to a different bus, use the 'i2c dev' command.
1679 Note that bus numbering is zero-based.
1680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001681 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001682
1683 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001684 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1685 is set, specify a list of bus-device pairs. Otherwise, specify
1686 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001687
1688 e.g.
1689 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001690 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001691
1692 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1693
1694 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001695 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001696
1697 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001699 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001700
1701 If defined, then this indicates the I2C bus number for DDR SPD.
1702 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001704 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001705
1706 If defined, then this indicates the I2C bus number for the RTC.
1707 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001709 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001710
1711 If defined, then this indicates the I2C bus number for the DTT.
1712 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001714 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001715
1716 If defined, specifies the I2C address of the DTT device.
1717 If not defined, then U-Boot uses predefined value for
1718 specified DTT device.
1719
Timur Tabibe5e6182006-11-03 19:15:00 -06001720 CONFIG_FSL_I2C
1721
1722 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001723 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001724
Heiko Schocher67b23a32008-10-15 09:39:47 +02001725 CONFIG_I2C_MUX
1726
1727 Define this option if you have I2C devices reached over 1 .. n
1728 I2C Muxes like the pca9544a. This option addes a new I2C
1729 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1730 new I2C Bus to the existing I2C Busses. If you select the
1731 new Bus with "i2c dev", u-bbot sends first the commandos for
1732 the muxes to activate this new "bus".
1733
1734 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1735 feature!
1736
1737 Example:
1738 Adding a new I2C Bus reached over 2 pca9544a muxes
1739 The First mux with address 70 and channel 6
1740 The Second mux with address 71 and channel 4
1741
1742 => i2c bus pca9544a:70:6:pca9544a:71:4
1743
1744 Use the "i2c bus" command without parameter, to get a list
1745 of I2C Busses with muxes:
1746
1747 => i2c bus
1748 Busses reached over muxes:
1749 Bus ID: 2
1750 reached over Mux(es):
1751 pca9544a@70 ch: 4
1752 Bus ID: 3
1753 reached over Mux(es):
1754 pca9544a@70 ch: 6
1755 pca9544a@71 ch: 4
1756 =>
1757
1758 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001759 u-boot first sends the command to the mux@70 to enable
1760 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001761 the channel 4.
1762
1763 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001764 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001765 the 2 muxes.
1766
1767 This option is actually implemented for the bitbanging
1768 algorithm in common/soft_i2c.c and for the Hardware I2C
1769 Bus on the MPC8260. But it should be not so difficult
1770 to add this option to other architectures.
1771
Andrew Dyer2ac69852008-12-29 17:36:01 -06001772 CONFIG_SOFT_I2C_READ_REPEATED_START
1773
1774 defining this will force the i2c_read() function in
1775 the soft_i2c driver to perform an I2C repeated start
1776 between writing the address pointer and reading the
1777 data. If this define is omitted the default behaviour
1778 of doing a stop-start sequence will be used. Most I2C
1779 devices can use either method, but some require one or
1780 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001781
wdenkc6097192002-11-03 00:24:07 +00001782- SPI Support: CONFIG_SPI
1783
1784 Enables SPI driver (so far only tested with
1785 SPI EEPROM, also an instance works with Crystal A/D and
1786 D/As on the SACSng board)
1787
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001788 CONFIG_SH_SPI
1789
1790 Enables the driver for SPI controller on SuperH. Currently
1791 only SH7757 is supported.
1792
wdenkc6097192002-11-03 00:24:07 +00001793 CONFIG_SPI_X
1794
1795 Enables extended (16-bit) SPI EEPROM addressing.
1796 (symmetrical to CONFIG_I2C_X)
1797
1798 CONFIG_SOFT_SPI
1799
wdenk43d96162003-03-06 00:02:04 +00001800 Enables a software (bit-bang) SPI driver rather than
1801 using hardware support. This is a general purpose
1802 driver that only requires three general I/O port pins
1803 (two outputs, one input) to function. If this is
1804 defined, the board configuration must define several
1805 SPI configuration items (port pins to use, etc). For
1806 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001807
Ben Warren04a9e112008-01-16 22:37:35 -05001808 CONFIG_HARD_SPI
1809
1810 Enables a hardware SPI driver for general-purpose reads
1811 and writes. As with CONFIG_SOFT_SPI, the board configuration
1812 must define a list of chip-select function pointers.
1813 Currently supported on some MPC8xxx processors. For an
1814 example, see include/configs/mpc8349emds.h.
1815
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001816 CONFIG_MXC_SPI
1817
1818 Enables the driver for the SPI controllers on i.MX and MXC
1819 SoCs. Currently only i.MX31 is supported.
1820
Matthias Fuchs01335022007-12-27 17:12:34 +01001821- FPGA Support: CONFIG_FPGA
1822
1823 Enables FPGA subsystem.
1824
1825 CONFIG_FPGA_<vendor>
1826
1827 Enables support for specific chip vendors.
1828 (ALTERA, XILINX)
1829
1830 CONFIG_FPGA_<family>
1831
1832 Enables support for FPGA family.
1833 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1834
1835 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001836
wdenk43d96162003-03-06 00:02:04 +00001837 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001839 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001840
wdenk8bde7f72003-06-27 21:31:46 +00001841 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001843 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001844
wdenk43d96162003-03-06 00:02:04 +00001845 Enable checks on FPGA configuration interface busy
1846 status by the configuration function. This option
1847 will require a board or device specific function to
1848 be written.
wdenkc6097192002-11-03 00:24:07 +00001849
1850 CONFIG_FPGA_DELAY
1851
1852 If defined, a function that provides delays in the FPGA
1853 configuration driver.
1854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001855 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001856 Allow Control-C to interrupt FPGA configuration
1857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001858 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001859
wdenk43d96162003-03-06 00:02:04 +00001860 Check for configuration errors during FPGA bitfile
1861 loading. For example, abort during Virtex II
1862 configuration if the INIT_B line goes low (which
1863 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001865 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001866
wdenk43d96162003-03-06 00:02:04 +00001867 Maximum time to wait for the INIT_B line to deassert
1868 after PROB_B has been deasserted during a Virtex II
1869 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001870 ms.
wdenkc6097192002-11-03 00:24:07 +00001871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001872 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001873
wdenk43d96162003-03-06 00:02:04 +00001874 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001875 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001876
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001877 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001878
wdenk43d96162003-03-06 00:02:04 +00001879 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001880 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001881
1882- Configuration Management:
1883 CONFIG_IDENT_STRING
1884
wdenk43d96162003-03-06 00:02:04 +00001885 If defined, this string will be added to the U-Boot
1886 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001887
1888- Vendor Parameter Protection:
1889
wdenk43d96162003-03-06 00:02:04 +00001890 U-Boot considers the values of the environment
1891 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001892 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001893 are set once by the board vendor / manufacturer, and
1894 protects these variables from casual modification by
1895 the user. Once set, these variables are read-only,
1896 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001897 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001898
1899 If CONFIG_ENV_OVERWRITE is #defined in your config
1900 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001901 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001902 these parameters.
1903
1904 Alternatively, if you #define _both_ CONFIG_ETHADDR
1905 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001906 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001907 which can be changed exactly ONCE by the user. [The
1908 serial# is unaffected by this, i. e. it remains
1909 read-only.]
1910
1911- Protected RAM:
1912 CONFIG_PRAM
1913
1914 Define this variable to enable the reservation of
1915 "protected RAM", i. e. RAM which is not overwritten
1916 by U-Boot. Define CONFIG_PRAM to hold the number of
1917 kB you want to reserve for pRAM. You can overwrite
1918 this default value by defining an environment
1919 variable "pram" to the number of kB you want to
1920 reserve. Note that the board info structure will
1921 still show the full amount of RAM. If pRAM is
1922 reserved, a new environment variable "mem" will
1923 automatically be defined to hold the amount of
1924 remaining RAM in a form that can be passed as boot
1925 argument to Linux, for instance like that:
1926
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001927 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001928 saveenv
1929
1930 This way you can tell Linux not to use this memory,
1931 either, which results in a memory region that will
1932 not be affected by reboots.
1933
1934 *WARNING* If your board configuration uses automatic
1935 detection of the RAM size, you must make sure that
1936 this memory test is non-destructive. So far, the
1937 following board configurations are known to be
1938 "pRAM-clean":
1939
1940 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1941 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001942 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001943
1944- Error Recovery:
1945 CONFIG_PANIC_HANG
1946
1947 Define this variable to stop the system in case of a
1948 fatal error, so that you have to reset it manually.
1949 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001950 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001951 automatically as fast as possible, but it may be
1952 useful during development since you can try to debug
1953 the conditions that lead to the situation.
1954
1955 CONFIG_NET_RETRY_COUNT
1956
wdenk43d96162003-03-06 00:02:04 +00001957 This variable defines the number of retries for
1958 network operations like ARP, RARP, TFTP, or BOOTP
1959 before giving up the operation. If not defined, a
1960 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001961
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001962 CONFIG_ARP_TIMEOUT
1963
1964 Timeout waiting for an ARP reply in milliseconds.
1965
wdenkc6097192002-11-03 00:24:07 +00001966- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001967 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001968
1969 Enable auto completion of commands using TAB.
1970
Wolfgang Denka9398e02006-11-27 15:32:42 +01001971 Note that this feature has NOT been implemented yet
1972 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001973
1974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001975 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001976
1977 Define this variable to enable the "hush" shell (from
1978 Busybox) as command line interpreter, thus enabling
1979 powerful command line syntax like
1980 if...then...else...fi conditionals or `&&' and '||'
1981 constructs ("shell scripts").
1982
1983 If undefined, you get the old, much simpler behaviour
1984 with a somewhat smaller memory footprint.
1985
1986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001987 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001988
1989 This defines the secondary prompt string, which is
1990 printed when the command interpreter needs more input
1991 to complete a command. Usually "> ".
1992
1993 Note:
1994
wdenk8bde7f72003-06-27 21:31:46 +00001995 In the current implementation, the local variables
1996 space and global environment variables space are
1997 separated. Local variables are those you define by
1998 simply typing `name=value'. To access a local
1999 variable later on, you have write `$name' or
2000 `${name}'; to execute the contents of a variable
2001 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002002
wdenk43d96162003-03-06 00:02:04 +00002003 Global environment variables are those you use
2004 setenv/printenv to work with. To run a command stored
2005 in such a variable, you need to use the run command,
2006 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002007
2008 To store commands and special characters in a
2009 variable, please use double quotation marks
2010 surrounding the whole text of the variable, instead
2011 of the backslashes before semicolons and special
2012 symbols.
2013
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002014- Commandline Editing and History:
2015 CONFIG_CMDLINE_EDITING
2016
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002017 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002018 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002019
wdenka8c7c702003-12-06 19:49:23 +00002020- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002021 CONFIG_EXTRA_ENV_SETTINGS
2022
wdenk43d96162003-03-06 00:02:04 +00002023 Define this to contain any number of null terminated
2024 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002025 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002026
wdenk43d96162003-03-06 00:02:04 +00002027 For example, place something like this in your
2028 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002029
2030 #define CONFIG_EXTRA_ENV_SETTINGS \
2031 "myvar1=value1\0" \
2032 "myvar2=value2\0"
2033
wdenk43d96162003-03-06 00:02:04 +00002034 Warning: This method is based on knowledge about the
2035 internal format how the environment is stored by the
2036 U-Boot code. This is NOT an official, exported
2037 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002038 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002039 You better know what you are doing here.
2040
wdenk43d96162003-03-06 00:02:04 +00002041 Note: overly (ab)use of the default environment is
2042 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002043 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002044 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002045
wdenka8c7c702003-12-06 19:49:23 +00002046- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002047 CONFIG_HAS_DATAFLASH
2048
wdenk8bde7f72003-06-27 21:31:46 +00002049 Defining this option enables DataFlash features and
2050 allows to read/write in Dataflash via the standard
2051 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002052
wdenk3f85ce22004-02-23 16:11:30 +00002053- SystemACE Support:
2054 CONFIG_SYSTEMACE
2055
2056 Adding this option adds support for Xilinx SystemACE
2057 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002058 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002059 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002060
2061 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002062 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002063
2064 When SystemACE support is added, the "ace" device type
2065 becomes available to the fat commands, i.e. fatls.
2066
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002067- TFTP Fixed UDP Port:
2068 CONFIG_TFTP_PORT
2069
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002070 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002071 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002072 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002073 number generator is used.
2074
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002075 Also, the environment variable tftpdstp is used to supply
2076 the TFTP UDP destination port value. If tftpdstp isn't
2077 defined, the normal port 69 is used.
2078
2079 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002080 blindly start the TFTP transfer using the pre-configured
2081 target IP address and UDP port. This has the effect of
2082 "punching through" the (Windows XP) firewall, allowing
2083 the remainder of the TFTP transfer to proceed normally.
2084 A better solution is to properly configure the firewall,
2085 but sometimes that is not allowed.
2086
wdenka8c7c702003-12-06 19:49:23 +00002087- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002088 CONFIG_SHOW_BOOT_PROGRESS
2089
wdenk43d96162003-03-06 00:02:04 +00002090 Defining this option allows to add some board-
2091 specific code (calling a user-provided function
2092 "show_boot_progress(int)") that enables you to show
2093 the system's boot progress on some display (for
2094 example, some LED's) on your board. At the moment,
2095 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002096
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002097- Standalone program support:
2098 CONFIG_STANDALONE_LOAD_ADDR
2099
2100 This option allows to define board specific values
2101 for the address where standalone program gets loaded,
2102 thus overwriting the architecutre dependent default
2103 settings.
2104
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002105- Frame Buffer Address:
2106 CONFIG_FB_ADDR
2107
2108 Define CONFIG_FB_ADDR if you want to use specific address for
2109 frame buffer.
2110 Then system will reserve the frame buffer address to defined address
2111 instead of lcd_setmem (this function grab the memory for frame buffer
2112 by panel's size).
2113
2114 Please see board_init_f function.
2115
2116 If you want this config option then,
2117 please define it at your board config file
2118
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002119Legacy uImage format:
2120
wdenkc6097192002-11-03 00:24:07 +00002121 Arg Where When
2122 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002123 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002124 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002125 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002126 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002127 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002128 4 common/cmd_bootm.c Image data has correct checksum
2129 -4 common/cmd_bootm.c Image is for unsupported architecture
2130 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002131 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002132 6 common/cmd_bootm.c Image Type check OK
2133 -6 common/cmd_bootm.c gunzip uncompression error
2134 -7 common/cmd_bootm.c Unimplemented compression type
2135 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002136 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002137 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002138
2139 9 common/image.c Start initial ramdisk verification
2140 -10 common/image.c Ramdisk header has bad magic number
2141 -11 common/image.c Ramdisk header has bad checksum
2142 10 common/image.c Ramdisk header is OK
2143 -12 common/image.c Ramdisk data has bad checksum
2144 11 common/image.c Ramdisk data has correct checksum
2145 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002146 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002147 13 common/image.c Start multifile image verification
2148 14 common/image.c No initial ramdisk, no multifile, continue.
2149
Peter Tyserea0364f2010-04-12 22:28:04 -05002150 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002151
Stefan Roesea47a12b2010-04-15 16:07:28 +02002152 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002153 -31 post/post.c POST test failed, detected by post_output_backlog()
2154 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002155
Heiko Schocher566a4942007-06-22 19:11:54 +02002156 34 common/cmd_doc.c before loading a Image from a DOC device
2157 -35 common/cmd_doc.c Bad usage of "doc" command
2158 35 common/cmd_doc.c correct usage of "doc" command
2159 -36 common/cmd_doc.c No boot device
2160 36 common/cmd_doc.c correct boot device
2161 -37 common/cmd_doc.c Unknown Chip ID on boot device
2162 37 common/cmd_doc.c correct chip ID found, device available
2163 -38 common/cmd_doc.c Read Error on boot device
2164 38 common/cmd_doc.c reading Image header from DOC device OK
2165 -39 common/cmd_doc.c Image header has bad magic number
2166 39 common/cmd_doc.c Image header has correct magic number
2167 -40 common/cmd_doc.c Error reading Image from DOC device
2168 40 common/cmd_doc.c Image header has correct magic number
2169 41 common/cmd_ide.c before loading a Image from a IDE device
2170 -42 common/cmd_ide.c Bad usage of "ide" command
2171 42 common/cmd_ide.c correct usage of "ide" command
2172 -43 common/cmd_ide.c No boot device
2173 43 common/cmd_ide.c boot device found
2174 -44 common/cmd_ide.c Device not available
2175 44 common/cmd_ide.c Device available
2176 -45 common/cmd_ide.c wrong partition selected
2177 45 common/cmd_ide.c partition selected
2178 -46 common/cmd_ide.c Unknown partition table
2179 46 common/cmd_ide.c valid partition table found
2180 -47 common/cmd_ide.c Invalid partition type
2181 47 common/cmd_ide.c correct partition type
2182 -48 common/cmd_ide.c Error reading Image Header on boot device
2183 48 common/cmd_ide.c reading Image Header from IDE device OK
2184 -49 common/cmd_ide.c Image header has bad magic number
2185 49 common/cmd_ide.c Image header has correct magic number
2186 -50 common/cmd_ide.c Image header has bad checksum
2187 50 common/cmd_ide.c Image header has correct checksum
2188 -51 common/cmd_ide.c Error reading Image from IDE device
2189 51 common/cmd_ide.c reading Image from IDE device OK
2190 52 common/cmd_nand.c before loading a Image from a NAND device
2191 -53 common/cmd_nand.c Bad usage of "nand" command
2192 53 common/cmd_nand.c correct usage of "nand" command
2193 -54 common/cmd_nand.c No boot device
2194 54 common/cmd_nand.c boot device found
2195 -55 common/cmd_nand.c Unknown Chip ID on boot device
2196 55 common/cmd_nand.c correct chip ID found, device available
2197 -56 common/cmd_nand.c Error reading Image Header on boot device
2198 56 common/cmd_nand.c reading Image Header from NAND device OK
2199 -57 common/cmd_nand.c Image header has bad magic number
2200 57 common/cmd_nand.c Image header has correct magic number
2201 -58 common/cmd_nand.c Error reading Image from NAND device
2202 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002203
Heiko Schocher566a4942007-06-22 19:11:54 +02002204 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002205
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002206 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002207 -64 net/eth.c no Ethernet found.
2208 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002209
Heiko Schocher566a4942007-06-22 19:11:54 +02002210 -80 common/cmd_net.c usage wrong
2211 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002212 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002213 81 common/cmd_net.c NetLoop() back without error
2214 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2215 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002216 83 common/cmd_net.c running "source" command
2217 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002218 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002219
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002220FIT uImage format:
2221
2222 Arg Where When
2223 100 common/cmd_bootm.c Kernel FIT Image has correct format
2224 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2225 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2226 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2227 102 common/cmd_bootm.c Kernel unit name specified
2228 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002229 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002230 104 common/cmd_bootm.c Got kernel subimage node offset
2231 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2232 105 common/cmd_bootm.c Kernel subimage hash verification OK
2233 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2234 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002235 -106 common/cmd_bootm.c Kernel subimage has wrong type
2236 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002237 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2238 108 common/cmd_bootm.c Got kernel subimage data/size
2239 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2240 -109 common/cmd_bootm.c Can't get kernel subimage type
2241 -110 common/cmd_bootm.c Can't get kernel subimage comp
2242 -111 common/cmd_bootm.c Can't get kernel subimage os
2243 -112 common/cmd_bootm.c Can't get kernel subimage load address
2244 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2245
2246 120 common/image.c Start initial ramdisk verification
2247 -120 common/image.c Ramdisk FIT image has incorrect format
2248 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002249 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002250 -122 common/image.c Can't get configuration for ramdisk subimage
2251 123 common/image.c Ramdisk unit name specified
2252 -124 common/image.c Can't get ramdisk subimage node offset
2253 125 common/image.c Got ramdisk subimage node offset
2254 -125 common/image.c Ramdisk subimage hash verification failed
2255 126 common/image.c Ramdisk subimage hash verification OK
2256 -126 common/image.c Ramdisk subimage for unsupported architecture
2257 127 common/image.c Architecture check OK
2258 -127 common/image.c Can't get ramdisk subimage data/size
2259 128 common/image.c Got ramdisk subimage data/size
2260 129 common/image.c Can't get ramdisk load address
2261 -129 common/image.c Got ramdisk load address
2262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002263 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002264 131 common/cmd_doc.c FIT image format OK
2265
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002266 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002267 141 common/cmd_ide.c FIT image format OK
2268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002269 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002270 151 common/cmd_nand.c FIT image format OK
2271
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002272- Automatic software updates via TFTP server
2273 CONFIG_UPDATE_TFTP
2274 CONFIG_UPDATE_TFTP_CNT_MAX
2275 CONFIG_UPDATE_TFTP_MSEC_MAX
2276
2277 These options enable and control the auto-update feature;
2278 for a more detailed description refer to doc/README.update.
2279
2280- MTD Support (mtdparts command, UBI support)
2281 CONFIG_MTD_DEVICE
2282
2283 Adds the MTD device infrastructure from the Linux kernel.
2284 Needed for mtdparts command support.
2285
2286 CONFIG_MTD_PARTITIONS
2287
2288 Adds the MTD partitioning infrastructure from the Linux
2289 kernel. Needed for UBI support.
2290
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002291- SPL framework
2292 CONFIG_SPL
2293 Enable building of SPL globally.
2294
2295 CONFIG_SPL_TEXT_BASE
2296 TEXT_BASE for linking the SPL binary.
2297
2298 CONFIG_SPL_LDSCRIPT
2299 LDSCRIPT for linking the SPL binary.
2300
2301 CONFIG_SPL_LIBCOMMON_SUPPORT
2302 Support for common/libcommon.o in SPL binary
2303
2304 CONFIG_SPL_LIBDISK_SUPPORT
2305 Support for disk/libdisk.o in SPL binary
2306
2307 CONFIG_SPL_I2C_SUPPORT
2308 Support for drivers/i2c/libi2c.o in SPL binary
2309
2310 CONFIG_SPL_GPIO_SUPPORT
2311 Support for drivers/gpio/libgpio.o in SPL binary
2312
2313 CONFIG_SPL_MMC_SUPPORT
2314 Support for drivers/mmc/libmmc.o in SPL binary
2315
2316 CONFIG_SPL_SERIAL_SUPPORT
2317 Support for drivers/serial/libserial.o in SPL binary
2318
2319 CONFIG_SPL_SPI_FLASH_SUPPORT
2320 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
2321
2322 CONFIG_SPL_SPI_SUPPORT
2323 Support for drivers/spi/libspi.o in SPL binary
2324
2325 CONFIG_SPL_FAT_SUPPORT
2326 Support for fs/fat/libfat.o in SPL binary
2327
2328 CONFIG_SPL_LIBGENERIC_SUPPORT
2329 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002330
wdenkc6097192002-11-03 00:24:07 +00002331Modem Support:
2332--------------
2333
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002334[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002335
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002336- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002337 CONFIG_MODEM_SUPPORT
2338
2339- RTS/CTS Flow control enable:
2340 CONFIG_HWFLOW
2341
2342- Modem debug support:
2343 CONFIG_MODEM_SUPPORT_DEBUG
2344
wdenk43d96162003-03-06 00:02:04 +00002345 Enables debugging stuff (char screen[1024], dbg())
2346 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002347
wdenka8c7c702003-12-06 19:49:23 +00002348- Interrupt support (PPC):
2349
wdenkd4ca31c2004-01-02 14:00:00 +00002350 There are common interrupt_init() and timer_interrupt()
2351 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002352 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002353 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002354 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002355 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002356 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002357 specific handling. If board has watchdog / status_led
2358 / other_activity_monitor it works automatically from
2359 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002360
wdenkc6097192002-11-03 00:24:07 +00002361- General:
2362
wdenk43d96162003-03-06 00:02:04 +00002363 In the target system modem support is enabled when a
2364 specific key (key combination) is pressed during
2365 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002367 board_init(). Currently key_pressed() is a dummy
2368 function, returning 1 and thus enabling modem
2369 initialization.
wdenkc6097192002-11-03 00:24:07 +00002370
wdenk43d96162003-03-06 00:02:04 +00002371 If there are no modem init strings in the
2372 environment, U-Boot proceed to autoboot; the
2373 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002374 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002375
2376 See also: doc/README.Modem
2377
2378
wdenkc6097192002-11-03 00:24:07 +00002379Configuration Settings:
2380-----------------------
2381
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002382- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002383 undefine this when you're short of memory.
2384
Peter Tyser2fb26042009-01-27 18:03:12 -06002385- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2386 width of the commands listed in the 'help' command output.
2387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002389 prompt for user input.
2390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002391- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002395- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002398 the application (usually a Linux kernel) when it is
2399 booted
2400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002402 List of legal baudrate settings for this board.
2403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002405 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002406
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002407- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002408 If the board specific function
2409 extern int overwrite_console (void);
2410 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002411 serial port, else the settings in the environment are used.
2412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002413- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002414 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002416- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002417 Enable overwrite of previous console environment settings.
2418
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002419- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002420 Begin and End addresses of the area used by the
2421 simple memory test.
2422
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002423- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002424 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002426- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002427 Scratch address used by the alternate memory test
2428 You only need to set this if address zero isn't writeable
2429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002430- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2431 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002432 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002433 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002434 fixing up gd->ram_size the Linux kernel should gets passed
2435 the now "corrected" memory size and won't touch it either.
2436 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002437 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002438 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002439 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002440
2441 This option can be used as a workaround for the 440EPx/GRx
2442 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2443 be touched.
2444
2445 WARNING: Please make sure that this value is a multiple of
2446 the Linux page size (normally 4k). If this is not the case,
2447 then the end address of the Linux memory will be located at a
2448 non page size aligned address and this could cause major
2449 problems.
2450
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002451- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002452 Default load address for network file downloads
2453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002454- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002455 Enable temporary baudrate change while serial download
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002458 Physical start address of SDRAM. _Must_ be 0 here.
2459
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002460- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002461 Physical start address of Motherboard I/O (if using a
2462 Cogent motherboard)
2463
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002464- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002465 Physical start address of Flash memory.
2466
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002467- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002468 Physical start address of boot monitor code (set by
2469 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002470 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002471 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002472
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002473- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002474 Size of memory reserved for monitor code, used to
2475 determine _at_compile_time_ (!) if the environment is
2476 embedded within the U-Boot image, or in a separate
2477 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002479- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002480 Size of DRAM reserved for malloc() use.
2481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002482- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002483 Normally compressed uImages are limited to an
2484 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002485 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002486 to adjust this setting to your needs.
2487
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002488- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002489 Maximum size of memory mapped by the startup code of
2490 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002491 the Linux kernel (bd_info, boot arguments, FDT blob if
2492 used) must be put below this limit, unless "bootm_low"
2493 enviroment variable is defined and non-zero. In such case
2494 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002495 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2496 variable "bootm_mapsize" will override the value of
2497 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2498 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002499
John Rigbyfca43cc2010-10-13 13:57:35 -06002500- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2501 Enable initrd_high functionality. If defined then the
2502 initrd_high feature is enabled and the bootm ramdisk subcommand
2503 is enabled.
2504
2505- CONFIG_SYS_BOOT_GET_CMDLINE:
2506 Enables allocating and saving kernel cmdline in space between
2507 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2508
2509- CONFIG_SYS_BOOT_GET_KBD:
2510 Enables allocating and saving a kernel copy of the bd_info in
2511 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002513- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002514 Max number of Flash memory banks
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002517 Max number of sectors on a Flash chip
2518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002519- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002520 Timeout for Flash erase operations (in ms)
2521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002522- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002523 Timeout for Flash write operations (in ms)
2524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002525- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002526 Timeout for Flash set sector lock bit operation (in ms)
2527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002529 Timeout for Flash clear lock bits operation (in ms)
2530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002532 If defined, hardware flash sectors protection is used
2533 instead of U-Boot software protection.
2534
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002535- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002536
2537 Enable TFTP transfers directly to flash memory;
2538 without this option such a download has to be
2539 performed in two steps: (1) download to RAM, and (2)
2540 copy from RAM to flash.
2541
2542 The two-step approach is usually more reliable, since
2543 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002544 the flash, but in some situations (when system RAM is
2545 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002546 downloaded image) this option may be very useful.
2547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002548- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002549 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002550 common flash structure for storing flash geometry.
2551
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002552- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002553 This option also enables the building of the cfi_flash driver
2554 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002555
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002556- CONFIG_FLASH_CFI_MTD
2557 This option enables the building of the cfi_mtd driver
2558 in the drivers directory. The driver exports CFI flash
2559 to the MTD layer.
2560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002561- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002562 Use buffered writes to flash.
2563
2564- CONFIG_FLASH_SPANSION_S29WS_N
2565 s29ws-n MirrorBit flash has non-standard addresses for buffered
2566 write commands.
2567
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002568- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002569 If this option is defined, the common CFI flash doesn't
2570 print it's warning upon not recognized FLASH banks. This
2571 is useful, if some of the configured banks are only
2572 optionally available.
2573
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002574- CONFIG_FLASH_SHOW_PROGRESS
2575 If defined (must be an integer), print out countdown
2576 digits and dots. Recommended value: 45 (9..1) for 80
2577 column displays, 15 (3..1) for 40 column displays.
2578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002579- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002580 Defines the number of Ethernet receive buffers. On some
2581 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002582 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2583 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002584 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002585 Defaults to 4 if not defined.
2586
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002587- CONFIG_ENV_MAX_ENTRIES
2588
Wolfgang Denk071bc922010-10-27 22:48:30 +02002589 Maximum number of entries in the hash table that is used
2590 internally to store the environment settings. The default
2591 setting is supposed to be generous and should work in most
2592 cases. This setting can be used to tune behaviour; see
2593 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002594
wdenkc6097192002-11-03 00:24:07 +00002595The following definitions that deal with the placement and management
2596of environment data (variable area); in general, we support the
2597following configurations:
2598
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002599- CONFIG_BUILD_ENVCRC:
2600
2601 Builds up envcrc with the target environment so that external utils
2602 may easily extract it and embed it in final U-Boot images.
2603
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002604- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002605
2606 Define this if the environment is in flash memory.
2607
2608 a) The environment occupies one whole flash sector, which is
2609 "embedded" in the text segment with the U-Boot code. This
2610 happens usually with "bottom boot sector" or "top boot
2611 sector" type flash chips, which have several smaller
2612 sectors at the start or the end. For instance, such a
2613 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2614 such a case you would place the environment in one of the
2615 4 kB sectors - with U-Boot code before and after it. With
2616 "top boot sector" type flash chips, you would put the
2617 environment in one of the last sectors, leaving a gap
2618 between U-Boot and the environment.
2619
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002620 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002621
2622 Offset of environment data (variable area) to the
2623 beginning of flash memory; for instance, with bottom boot
2624 type flash chips the second sector can be used: the offset
2625 for this sector is given here.
2626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002627 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002628
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002629 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002630
2631 This is just another way to specify the start address of
2632 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002633 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002634
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002635 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002636
2637 Size of the sector containing the environment.
2638
2639
2640 b) Sometimes flash chips have few, equal sized, BIG sectors.
2641 In such a case you don't want to spend a whole sector for
2642 the environment.
2643
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002644 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002645
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002646 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002647 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002648 of this flash sector for the environment. This saves
2649 memory for the RAM copy of the environment.
2650
2651 It may also save flash memory if you decide to use this
2652 when your environment is "embedded" within U-Boot code,
2653 since then the remainder of the flash sector could be used
2654 for U-Boot code. It should be pointed out that this is
2655 STRONGLY DISCOURAGED from a robustness point of view:
2656 updating the environment in flash makes it always
2657 necessary to erase the WHOLE sector. If something goes
2658 wrong before the contents has been restored from a copy in
2659 RAM, your target system will be dead.
2660
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002661 - CONFIG_ENV_ADDR_REDUND
2662 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002663
wdenk43d96162003-03-06 00:02:04 +00002664 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002665 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002666 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002667 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002668
2669BE CAREFUL! Any changes to the flash layout, and some changes to the
2670source code will make it necessary to adapt <board>/u-boot.lds*
2671accordingly!
2672
2673
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002674- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002675
2676 Define this if you have some non-volatile memory device
2677 (NVRAM, battery buffered SRAM) which you want to use for the
2678 environment.
2679
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002680 - CONFIG_ENV_ADDR:
2681 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002682
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002683 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002684 want to use for environment. It is assumed that this memory
2685 can just be read and written to, without any special
2686 provision.
2687
2688BE CAREFUL! The first access to the environment happens quite early
2689in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002690console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002691U-Boot will hang.
2692
2693Please note that even with NVRAM we still use a copy of the
2694environment in RAM: we could work on NVRAM directly, but we want to
2695keep settings there always unmodified except somebody uses "saveenv"
2696to save the current settings.
2697
2698
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002699- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002700
2701 Use this if you have an EEPROM or similar serial access
2702 device and a driver for it.
2703
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002704 - CONFIG_ENV_OFFSET:
2705 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002706
2707 These two #defines specify the offset and size of the
2708 environment area within the total memory of your EEPROM.
2709
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002710 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002711 If defined, specified the chip address of the EEPROM device.
2712 The default address is zero.
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002715 If defined, the number of bits used to address bytes in a
2716 single page in the EEPROM device. A 64 byte page, for example
2717 would require six bits.
2718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002720 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002721 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002723 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002724 The length in bytes of the EEPROM memory array address. Note
2725 that this is NOT the chip address length!
2726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002727 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002728 EEPROM chips that implement "address overflow" are ones
2729 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2730 address and the extra bits end up in the "chip address" bit
2731 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2732 byte chips.
2733
2734 Note that we consider the length of the address field to
2735 still be one byte because the extra address bits are hidden
2736 in the chip address.
2737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002738 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002739 The size in bytes of the EEPROM device.
2740
Heiko Schocher548738b2010-01-07 08:55:40 +01002741 - CONFIG_ENV_EEPROM_IS_ON_I2C
2742 define this, if you have I2C and SPI activated, and your
2743 EEPROM, which holds the environment, is on the I2C bus.
2744
2745 - CONFIG_I2C_ENV_EEPROM_BUS
2746 if you have an Environment on an EEPROM reached over
2747 I2C muxes, you can define here, how to reach this
2748 EEPROM. For example:
2749
Wolfgang Denka9046b92010-06-13 17:48:15 +02002750 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002751
2752 EEPROM which holds the environment, is reached over
2753 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002754
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002755- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002756
wdenkd4ca31c2004-01-02 14:00:00 +00002757 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002758 want to use for the environment.
2759
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002760 - CONFIG_ENV_OFFSET:
2761 - CONFIG_ENV_ADDR:
2762 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002763
2764 These three #defines specify the offset and size of the
2765 environment area within the total memory of your DataFlash placed
2766 at the specified address.
2767
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002768- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002769
2770 Define this if you have a NAND device which you want to use
2771 for the environment.
2772
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002773 - CONFIG_ENV_OFFSET:
2774 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002775
2776 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002777 area within the first NAND device. CONFIG_ENV_OFFSET must be
2778 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002779
Scott Woodfdd813d2010-09-17 14:38:37 -05002780 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002781
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002782 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002783 size used to hold a redundant copy of the environment data, so
2784 that there is a valid backup copy in case there is a power failure
2785 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2786 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002787
Scott Woodfdd813d2010-09-17 14:38:37 -05002788 - CONFIG_ENV_RANGE (optional):
2789
2790 Specifies the length of the region in which the environment
2791 can be written. This should be a multiple of the NAND device's
2792 block size. Specifying a range with more erase blocks than
2793 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2794 the range to be avoided.
2795
2796 - CONFIG_ENV_OFFSET_OOB (optional):
2797
2798 Enables support for dynamically retrieving the offset of the
2799 environment from block zero's out-of-band data. The
2800 "nand env.oob" command can be used to record this offset.
2801 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2802 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002803
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002804- CONFIG_NAND_ENV_DST
2805
2806 Defines address in RAM to which the nand_spl code should copy the
2807 environment. If redundant environment is used, it will be copied to
2808 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002810- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002811
2812 Defines offset to the initial SPI buffer area in DPRAM. The
2813 area is used at an early stage (ROM part) if the environment
2814 is configured to reside in the SPI EEPROM: We need a 520 byte
2815 scratch DPRAM area. It is used between the two initialization
2816 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2817 to be a good choice since it makes it far enough from the
2818 start of the data area as well as from the stack pointer.
2819
Bruce Adlere881cb52007-11-02 13:15:42 -07002820Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002821has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002822created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002823until then to read environment variables.
2824
wdenk85ec0bc2003-03-31 16:34:49 +00002825The environment is protected by a CRC32 checksum. Before the monitor
2826is relocated into RAM, as a result of a bad CRC you will be working
2827with the compiled-in default environment - *silently*!!! [This is
2828necessary, because the first environment variable we need is the
2829"baudrate" setting for the console - if we have a bad CRC, we don't
2830have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002831
2832Note: once the monitor has been relocated, then it will complain if
2833the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002834use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002836- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002837 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002839 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002840 also needs to be defined.
2841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002842- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002843 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002844
Ron Madridf5675aa2009-02-18 14:30:44 -08002845- CONFIG_NS16550_MIN_FUNCTIONS:
2846 Define this if you desire to only have use of the NS16550_init
2847 and NS16550_putc functions for the serial driver located at
2848 drivers/serial/ns16550.c. This option is useful for saving
2849 space for already greatly restricted images, including but not
2850 limited to NAND_SPL configurations.
2851
wdenkc6097192002-11-03 00:24:07 +00002852Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002853---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002855- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002856 Cache Line Size of the CPU.
2857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002858- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002859 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002860
wdenk42d1f032003-10-15 23:53:47 +00002861 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2862 and RPXsuper) to be able to adjust the position of
2863 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002864
wdenk7f6c2cb2002-11-10 22:06:23 +00002865- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002866 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002867
2868 the default drive number (default value 0)
2869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002871
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002872 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002873 (default value 1)
2874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002875 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002876
wdenk43d96162003-03-06 00:02:04 +00002877 defines the offset of register from address. It
2878 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002879 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002881 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2882 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002883 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002885 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002886 fdc_hw_init() is called at the beginning of the FDC
2887 setup. fdc_hw_init() must be provided by the board
2888 source code. It is used to make hardware dependant
2889 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002890
Macpaul Lin0abddf82011-04-11 20:45:32 +00002891- CONFIG_IDE_AHB:
2892 Most IDE controllers were designed to be connected with PCI
2893 interface. Only few of them were designed for AHB interface.
2894 When software is doing ATA command and data transfer to
2895 IDE devices through IDE-AHB controller, some additional
2896 registers accessing to these kind of IDE-AHB controller
2897 is requierd.
2898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002899- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002900 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002901 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002904
wdenk7152b1d2003-09-05 23:19:14 +00002905 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002906 initial data and stack; please note that this must be
2907 writable memory that is working WITHOUT special
2908 initialization, i. e. you CANNOT use normal RAM which
2909 will become available only after programming the
2910 memory controller and running certain initialization
2911 sequences.
2912
2913 U-Boot uses the following memory types:
2914 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2915 - MPC824X: data cache
2916 - PPC4xx: data cache
2917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002918- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002919
2920 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002921 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2922 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002923 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002924 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002925 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2926 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2927 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002928
2929 Note:
2930 On the MPC824X (or other systems that use the data
2931 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002932 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002933 point to an otherwise UNUSED address space between
2934 the top of RAM and the start of the PCI space.
2935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002936- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002937
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002938- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002940- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002942- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002944- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002945
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002946- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002947
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002948- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002949 SDRAM timing
2950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002952 periodic timer for refresh
2953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002954- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002956- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2957 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2958 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2959 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002960 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2961
2962- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002963 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2964 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002965 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002967- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2968 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002969 Machine Mode Register and Memory Periodic Timer
2970 Prescaler definitions (SDRAM timing)
2971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002973 enable I2C microcode relocation patch (MPC8xx);
2974 define relocation offset in DPRAM [DSP2]
2975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002976- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002977 enable SMC microcode relocation patch (MPC8xx);
2978 define relocation offset in DPRAM [SMC1]
2979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002980- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002981 enable SPI microcode relocation patch (MPC8xx);
2982 define relocation offset in DPRAM [SCC4]
2983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002984- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002985 Use OSCM clock mode on MBX8xx board. Be careful,
2986 wrong setting might damage your board. Read
2987 doc/README.MBX before setting this variable!
2988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002989- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002990 Offset of the bootmode word in DPRAM used by post
2991 (Power On Self Tests). This definition overrides
2992 #define'd default value in commproc.h resp.
2993 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002995- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2996 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2997 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2998 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2999 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3000 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3001 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3002 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003003 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003004
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003005- CONFIG_PCI_DISABLE_PCIE:
3006 Disable PCI-Express on systems where it is supported but not
3007 required.
3008
Kumar Galaa09b9b62010-12-30 12:09:53 -06003009- CONFIG_SYS_SRIO:
3010 Chip has SRIO or not
3011
3012- CONFIG_SRIO1:
3013 Board has SRIO 1 port available
3014
3015- CONFIG_SRIO2:
3016 Board has SRIO 2 port available
3017
3018- CONFIG_SYS_SRIOn_MEM_VIRT:
3019 Virtual Address of SRIO port 'n' memory region
3020
3021- CONFIG_SYS_SRIOn_MEM_PHYS:
3022 Physical Address of SRIO port 'n' memory region
3023
3024- CONFIG_SYS_SRIOn_MEM_SIZE:
3025 Size of SRIO port 'n' memory region
3026
Alex Watermaneced4622011-05-19 15:08:36 -04003027- CONFIG_SYS_NDFC_16
3028 Defined to tell the NDFC that the NAND chip is using a
3029 16 bit bus.
3030
3031- CONFIG_SYS_NDFC_EBC0_CFG
3032 Sets the EBC0_CFG register for the NDFC. If not defined
3033 a default value will be used.
3034
Ben Warrenbb99ad62006-09-07 16:50:54 -04003035- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003036 Get DDR timing information from an I2C EEPROM. Common
3037 with pluggable memory modules such as SODIMMs
3038
Ben Warrenbb99ad62006-09-07 16:50:54 -04003039 SPD_EEPROM_ADDRESS
3040 I2C address of the SPD EEPROM
3041
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003042- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003043 If SPD EEPROM is on an I2C bus other than the first
3044 one, specify here. Note that the value must resolve
3045 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003046
York Sun1b3e3c42011-06-07 09:42:16 +08003047- CONFIG_SYS_DDR_RAW_TIMING
3048 Get DDR timing information from other than SPD. Common with
3049 soldered DDR chips onboard without SPD. DDR raw timing
3050 parameters are extracted from datasheet and hard-coded into
3051 header files or board specific files.
3052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003053- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003054 Only for 83xx systems. If specified, then DDR should
3055 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003056
wdenkc26e4542004-04-18 10:13:26 +00003057- CONFIG_ETHER_ON_FEC[12]
3058 Define to enable FEC[12] on a 8xx series processor.
3059
3060- CONFIG_FEC[12]_PHY
3061 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003062 to the given FEC; i. e.
3063 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003064 means that the PHY with address 4 is connected to FEC1
3065
3066 When set to -1, means to probe for first available.
3067
3068- CONFIG_FEC[12]_PHY_NORXERR
3069 The PHY does not have a RXERR line (RMII only).
3070 (so program the FEC to ignore it).
3071
3072- CONFIG_RMII
3073 Enable RMII mode for all FECs.
3074 Note that this is a global option, we can't
3075 have one FEC in standard MII mode and another in RMII mode.
3076
wdenk5cf91d62004-04-23 20:32:05 +00003077- CONFIG_CRC32_VERIFY
3078 Add a verify option to the crc32 command.
3079 The syntax is:
3080
3081 => crc32 -v <address> <count> <crc32>
3082
3083 Where address/count indicate a memory area
3084 and crc32 is the correct crc32 which the
3085 area should have.
3086
wdenk56523f12004-07-11 17:40:54 +00003087- CONFIG_LOOPW
3088 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003089 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003090
stroese7b466642004-12-16 18:46:55 +00003091- CONFIG_MX_CYCLIC
3092 Add the "mdc" and "mwc" memory commands. These are cyclic
3093 "md/mw" commands.
3094 Examples:
3095
wdenkefe2a4d2004-12-16 21:44:03 +00003096 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003097 This command will print 4 bytes (10,11,12,13) each 500 ms.
3098
wdenkefe2a4d2004-12-16 21:44:03 +00003099 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003100 This command will write 12345678 to address 100 all 10 ms.
3101
wdenkefe2a4d2004-12-16 21:44:03 +00003102 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003103 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003104
wdenk8aa1a2d2005-04-04 12:44:11 +00003105- CONFIG_SKIP_LOWLEVEL_INIT
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +02003106 [ARM, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003107 low level initializations (like setting up the memory
3108 controller) are omitted and/or U-Boot does not
3109 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003110
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003111 Normally this variable MUST NOT be defined. The only
3112 exception is when U-Boot is loaded (to RAM) by some
3113 other boot loader or by a debugger which performs
3114 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003115
Aneesh V401bb302011-07-13 05:11:07 +00003116- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003117 Modifies the behaviour of start.S when compiling a loader
3118 that is executed before the actual U-Boot. E.g. when
3119 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003120
Matthias Weisserd8834a12011-03-10 21:36:32 +00003121- CONFIG_USE_ARCH_MEMCPY
3122 CONFIG_USE_ARCH_MEMSET
3123 If these options are used a optimized version of memcpy/memset will
3124 be used if available. These functions may be faster under some
3125 conditions but may increase the binary size.
3126
wdenkc6097192002-11-03 00:24:07 +00003127Building the Software:
3128======================
3129
Wolfgang Denk218ca722008-03-26 10:40:12 +01003130Building U-Boot has been tested in several native build environments
3131and in many different cross environments. Of course we cannot support
3132all possibly existing versions of cross development tools in all
3133(potentially obsolete) versions. In case of tool chain problems we
3134recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3135which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003136
Wolfgang Denk218ca722008-03-26 10:40:12 +01003137If you are not using a native environment, it is assumed that you
3138have GNU cross compiling tools available in your path. In this case,
3139you must set the environment variable CROSS_COMPILE in your shell.
3140Note that no changes to the Makefile or any other source files are
3141necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003142
Wolfgang Denk218ca722008-03-26 10:40:12 +01003143 $ CROSS_COMPILE=ppc_4xx-
3144 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003145
Peter Tyser2f8d3962009-03-13 18:54:51 -05003146Note: If you wish to generate Windows versions of the utilities in
3147 the tools directory you can use the MinGW toolchain
3148 (http://www.mingw.org). Set your HOST tools to the MinGW
3149 toolchain and execute 'make tools'. For example:
3150
3151 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3152
3153 Binaries such as tools/mkimage.exe will be created which can
3154 be executed on computers running Windows.
3155
Wolfgang Denk218ca722008-03-26 10:40:12 +01003156U-Boot is intended to be simple to build. After installing the
3157sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003158is done by typing:
3159
3160 make NAME_config
3161
Wolfgang Denk218ca722008-03-26 10:40:12 +01003162where "NAME_config" is the name of one of the existing configu-
3163rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003164
wdenk2729af92004-05-03 20:45:30 +00003165Note: for some board special configuration names may exist; check if
3166 additional information is available from the board vendor; for
3167 instance, the TQM823L systems are available without (standard)
3168 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003169 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk2729af92004-05-03 20:45:30 +00003171 make TQM823L_config
3172 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003173
wdenk2729af92004-05-03 20:45:30 +00003174 make TQM823L_LCD_config
3175 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177 etc.
wdenkc6097192002-11-03 00:24:07 +00003178
wdenkc6097192002-11-03 00:24:07 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180Finally, type "make all", and you should get some working U-Boot
3181images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003182
wdenk2729af92004-05-03 20:45:30 +00003183- "u-boot.bin" is a raw binary image
3184- "u-boot" is an image in ELF binary format
3185- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003186
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003187By default the build is performed locally and the objects are saved
3188in the source directory. One of the two methods can be used to change
3189this behavior and build U-Boot to some external directory:
3190
31911. Add O= to the make command line invocations:
3192
3193 make O=/tmp/build distclean
3194 make O=/tmp/build NAME_config
3195 make O=/tmp/build all
3196
31972. Set environment variable BUILD_DIR to point to the desired location:
3198
3199 export BUILD_DIR=/tmp/build
3200 make distclean
3201 make NAME_config
3202 make all
3203
3204Note that the command line "O=" setting overrides the BUILD_DIR environment
3205variable.
3206
wdenkc6097192002-11-03 00:24:07 +00003207
wdenk2729af92004-05-03 20:45:30 +00003208Please be aware that the Makefiles assume you are using GNU make, so
3209for instance on NetBSD you might need to use "gmake" instead of
3210native "make".
wdenkc6097192002-11-03 00:24:07 +00003211
wdenkc6097192002-11-03 00:24:07 +00003212
wdenk2729af92004-05-03 20:45:30 +00003213If the system board that you have is not listed, then you will need
3214to port U-Boot to your hardware platform. To do this, follow these
3215steps:
wdenkc6097192002-11-03 00:24:07 +00003216
wdenk2729af92004-05-03 20:45:30 +000032171. Add a new configuration option for your board to the toplevel
3218 "Makefile" and to the "MAKEALL" script, using the existing
3219 entries as examples. Note that here and at many other places
3220 boards and other names are listed in alphabetical sort order. Please
3221 keep this order.
32222. Create a new directory to hold your board specific code. Add any
3223 files you need. In your board directory, you will need at least
3224 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
32253. Create a new configuration file "include/configs/<board>.h" for
3226 your board
32273. If you're porting U-Boot to a new CPU, then also create a new
3228 directory to hold your CPU specific code. Add any files you need.
32294. Run "make <board>_config" with your new name.
32305. Type "make", and you should get a working "u-boot.srec" file
3231 to be installed on your target system.
32326. Debug and solve any problems that might arise.
3233 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003234
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3237==============================================================
wdenkc6097192002-11-03 00:24:07 +00003238
Wolfgang Denk218ca722008-03-26 10:40:12 +01003239If you have modified U-Boot sources (for instance added a new board
3240or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003241provide feedback to the other developers. The feedback normally takes
3242the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003243official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003244
Wolfgang Denk218ca722008-03-26 10:40:12 +01003245But before you submit such a patch, please verify that your modifi-
3246cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003247the supported boards compile WITHOUT ANY compiler warnings. To do so,
3248just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003249for ALL supported system. Be warned, this will take a while. You can
3250select which (cross) compiler to use by passing a `CROSS_COMPILE'
3251environment variable to the script, i. e. to use the ELDK cross tools
3252you can type
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003255
wdenk2729af92004-05-03 20:45:30 +00003256or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003257
wdenk2729af92004-05-03 20:45:30 +00003258 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003259
Wolfgang Denk218ca722008-03-26 10:40:12 +01003260When using the MAKEALL script, the default behaviour is to build
3261U-Boot in the source directory. This location can be changed by
3262setting the BUILD_DIR environment variable. Also, for each target
3263built, the MAKEALL script saves two log files (<target>.ERR and
3264<target>.MAKEALL) in the <source dir>/LOG directory. This default
3265location can be changed by setting the MAKEALL_LOGDIR environment
3266variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003267
3268 export BUILD_DIR=/tmp/build
3269 export MAKEALL_LOGDIR=/tmp/log
3270 CROSS_COMPILE=ppc_8xx- MAKEALL
3271
Wolfgang Denk218ca722008-03-26 10:40:12 +01003272With the above settings build objects are saved in the /tmp/build,
3273log files are saved in the /tmp/log and the source tree remains clean
3274during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003275
3276
wdenk2729af92004-05-03 20:45:30 +00003277See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003278
wdenkc6097192002-11-03 00:24:07 +00003279
wdenk2729af92004-05-03 20:45:30 +00003280Monitor Commands - Overview:
3281============================
wdenkc6097192002-11-03 00:24:07 +00003282
wdenk2729af92004-05-03 20:45:30 +00003283go - start application at address 'addr'
3284run - run commands in an environment variable
3285bootm - boot application image from memory
3286bootp - boot image via network using BootP/TFTP protocol
3287tftpboot- boot image via network using TFTP protocol
3288 and env variables "ipaddr" and "serverip"
3289 (and eventually "gatewayip")
3290rarpboot- boot image via network using RARP/TFTP protocol
3291diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3292loads - load S-Record file over serial line
3293loadb - load binary file over serial line (kermit mode)
3294md - memory display
3295mm - memory modify (auto-incrementing)
3296nm - memory modify (constant address)
3297mw - memory write (fill)
3298cp - memory copy
3299cmp - memory compare
3300crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003301i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003302sspi - SPI utility commands
3303base - print or set address offset
3304printenv- print environment variables
3305setenv - set environment variables
3306saveenv - save environment variables to persistent storage
3307protect - enable or disable FLASH write protection
3308erase - erase FLASH memory
3309flinfo - print FLASH memory information
3310bdinfo - print Board Info structure
3311iminfo - print header information for application image
3312coninfo - print console devices and informations
3313ide - IDE sub-system
3314loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003315loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003316mtest - simple RAM test
3317icache - enable or disable instruction cache
3318dcache - enable or disable data cache
3319reset - Perform RESET of the CPU
3320echo - echo args to console
3321version - print monitor version
3322help - print online help
3323? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003324
wdenkc6097192002-11-03 00:24:07 +00003325
wdenk2729af92004-05-03 20:45:30 +00003326Monitor Commands - Detailed Description:
3327========================================
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329TODO.
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003332
3333
wdenk2729af92004-05-03 20:45:30 +00003334Environment Variables:
3335======================
wdenkc6097192002-11-03 00:24:07 +00003336
wdenk2729af92004-05-03 20:45:30 +00003337U-Boot supports user configuration using Environment Variables which
3338can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk2729af92004-05-03 20:45:30 +00003340Environment Variables are set using "setenv", printed using
3341"printenv", and saved to Flash using "saveenv". Using "setenv"
3342without a value can be used to delete a variable from the
3343environment. As long as you don't save the environment you are
3344working with an in-memory copy. In case the Flash area containing the
3345environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003346
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003347Some configuration options can be set using Environment Variables.
3348
3349List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003352
wdenk2729af92004-05-03 20:45:30 +00003353 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003356
wdenk2729af92004-05-03 20:45:30 +00003357 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003360
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003361 bootm_low - Memory range available for image processing in the bootm
3362 command can be restricted. This variable is given as
3363 a hexadecimal number and defines lowest address allowed
3364 for use by the bootm command. See also "bootm_size"
3365 environment variable. Address defined by "bootm_low" is
3366 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003367 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3368 bootm_mapsize.
3369
3370 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3371 This variable is given as a hexadecimal number and it
3372 defines the size of the memory region starting at base
3373 address bootm_low that is accessible by the Linux kernel
3374 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3375 as the default value if it is defined, and bootm_size is
3376 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003377
3378 bootm_size - Memory range available for image processing in the bootm
3379 command can be restricted. This variable is given as
3380 a hexadecimal number and defines the size of the region
3381 allowed for use by the bootm command. See also "bootm_low"
3382 environment variable.
3383
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003384 updatefile - Location of the software update file on a TFTP server, used
3385 by the automatic software update feature. Please refer to
3386 documentation in doc/README.update for more details.
3387
wdenk2729af92004-05-03 20:45:30 +00003388 autoload - if set to "no" (any string beginning with 'n'),
3389 "bootp" will just load perform a lookup of the
3390 configuration from the BOOTP server, but not try to
3391 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003392
wdenk2729af92004-05-03 20:45:30 +00003393 autostart - if set to "yes", an image loaded using the "bootp",
3394 "rarpboot", "tftpboot" or "diskboot" commands will
3395 be automatically started (by internally calling
3396 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003397
wdenk2729af92004-05-03 20:45:30 +00003398 If set to "no", a standalone image passed to the
3399 "bootm" command will be copied to the load address
3400 (and eventually uncompressed), but NOT be started.
3401 This can be used to load and uncompress arbitrary
3402 data.
wdenkc6097192002-11-03 00:24:07 +00003403
David A. Longa28afca2011-07-09 16:40:19 -04003404 fdt_high - if set this restricts the maximum address that the
3405 flattened device tree will be copied into upon boot.
3406 If this is set to the special value 0xFFFFFFFF then
3407 the fdt will not be copied at all on boot. For this
3408 to work it must reside in writable memory, have
3409 sufficient padding on the end of it for u-boot to
3410 add the information it needs into it, and the memory
3411 must be accessible by the kernel.
3412
wdenk17ea1172004-06-06 21:51:03 +00003413 i2cfast - (PPC405GP|PPC405EP only)
3414 if set to 'y' configures Linux I2C driver for fast
3415 mode (400kHZ). This environment variable is used in
3416 initialization code. So, for changes to be effective
3417 it must be saved and board must be reset.
3418
wdenk2729af92004-05-03 20:45:30 +00003419 initrd_high - restrict positioning of initrd images:
3420 If this variable is not set, initrd images will be
3421 copied to the highest possible address in RAM; this
3422 is usually what you want since it allows for
3423 maximum initrd size. If for some reason you want to
3424 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003425 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003426 variable to a value of "no" or "off" or "0".
3427 Alternatively, you can set it to a maximum upper
3428 address to use (U-Boot will still check that it
3429 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003430
wdenk2729af92004-05-03 20:45:30 +00003431 For instance, when you have a system with 16 MB
3432 RAM, and want to reserve 4 MB from use by Linux,
3433 you can do this by adding "mem=12M" to the value of
3434 the "bootargs" variable. However, now you must make
3435 sure that the initrd image is placed in the first
3436 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003437
wdenk2729af92004-05-03 20:45:30 +00003438 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk2729af92004-05-03 20:45:30 +00003440 If you set initrd_high to 0xFFFFFFFF, this is an
3441 indication to U-Boot that all addresses are legal
3442 for the Linux kernel, including addresses in flash
3443 memory. In this case U-Boot will NOT COPY the
3444 ramdisk at all. This may be useful to reduce the
3445 boot time on your system, but requires that this
3446 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003447
wdenk2729af92004-05-03 20:45:30 +00003448 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450 loadaddr - Default load address for commands like "bootp",
3451 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003454
wdenk2729af92004-05-03 20:45:30 +00003455 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003458
wdenk2729af92004-05-03 20:45:30 +00003459 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003460
wdenk2729af92004-05-03 20:45:30 +00003461 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003462
wdenk2729af92004-05-03 20:45:30 +00003463 ethprime - When CONFIG_NET_MULTI is enabled controls which
3464 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466 ethact - When CONFIG_NET_MULTI is enabled controls which
3467 interface is currently active. For example you
3468 can do the following
wdenkc6097192002-11-03 00:24:07 +00003469
Heiko Schocher48690d82010-07-20 17:45:02 +02003470 => setenv ethact FEC
3471 => ping 192.168.0.1 # traffic sent on FEC
3472 => setenv ethact SCC
3473 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003474
Matthias Fuchse1692572008-01-17 07:45:05 +01003475 ethrotate - When set to "no" U-Boot does not go through all
3476 available network interfaces.
3477 It just stays at the currently selected interface.
3478
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003479 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003480 either succeed or fail without retrying.
3481 When set to "once" the network operation will
3482 fail when all the available network interfaces
3483 are tried once without success.
3484 Useful on scripts which control the retry operation
3485 themselves.
wdenkc6097192002-11-03 00:24:07 +00003486
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003487 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003488
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003489 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003490 UDP source port.
3491
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003492 tftpdstport - If this is set, the value is used for TFTP's UDP
3493 destination port instead of the Well Know Port 69.
3494
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003495 tftpblocksize - Block size to use for TFTP transfers; if not set,
3496 we use the TFTP server's default block size
3497
3498 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3499 seconds, minimum value is 1000 = 1 second). Defines
3500 when a packet is considered to be lost so it has to
3501 be retransmitted. The default is 5000 = 5 seconds.
3502 Lowering this value may make downloads succeed
3503 faster in networks with high packet loss rates or
3504 with unreliable TFTP servers.
3505
3506 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003507 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003508 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510The following environment variables may be used and automatically
3511updated by the network boot commands ("bootp" and "rarpboot"),
3512depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003513
wdenk2729af92004-05-03 20:45:30 +00003514 bootfile - see above
3515 dnsip - IP address of your Domain Name Server
3516 dnsip2 - IP address of your secondary Domain Name Server
3517 gatewayip - IP address of the Gateway (Router) to use
3518 hostname - Target hostname
3519 ipaddr - see above
3520 netmask - Subnet Mask
3521 rootpath - Pathname of the root filesystem on the NFS server
3522 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003523
wdenka3d991b2004-04-15 21:48:45 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003526
wdenk2729af92004-05-03 20:45:30 +00003527 serial# - contains hardware identification information such
3528 as type string and/or serial number
3529 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk2729af92004-05-03 20:45:30 +00003531These variables can be set only once (usually during manufacturing of
3532the board). U-Boot refuses to delete or overwrite these variables
3533once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003534
3535
wdenk2729af92004-05-03 20:45:30 +00003536Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk2729af92004-05-03 20:45:30 +00003538 ver - Contains the U-Boot version string as printed
3539 with the "version" command. This variable is
3540 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003541
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543Please note that changes to some configuration parameters may take
3544only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003545
stroesec1551ea2003-04-04 15:53:41 +00003546
wdenk2729af92004-05-03 20:45:30 +00003547Command Line Parsing:
3548=====================
stroesec1551ea2003-04-04 15:53:41 +00003549
wdenk2729af92004-05-03 20:45:30 +00003550There are two different command line parsers available with U-Boot:
3551the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553Old, simple command line parser:
3554--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556- supports environment variables (through setenv / saveenv commands)
3557- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003558- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003559- special characters ('$', ';') can be escaped by prefixing with '\',
3560 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003561 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003562- You can also escape text by enclosing in single apostrophes, for example:
3563 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003564
wdenk2729af92004-05-03 20:45:30 +00003565Hush shell:
3566-----------
wdenkf07771c2003-05-28 08:06:31 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568- similar to Bourne shell, with control structures like
3569 if...then...else...fi, for...do...done; while...do...done,
3570 until...do...done, ...
3571- supports environment ("global") variables (through setenv / saveenv
3572 commands) and local shell variables (through standard shell syntax
3573 "name=value"); only environment variables can be used with "run"
3574 command
wdenkf07771c2003-05-28 08:06:31 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576General rules:
3577--------------
wdenkf07771c2003-05-28 08:06:31 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579(1) If a command line (or an environment variable executed by a "run"
3580 command) contains several commands separated by semicolon, and
3581 one of these commands fails, then the remaining commands will be
3582 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003583
wdenk2729af92004-05-03 20:45:30 +00003584(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003585 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003586 command will cause "run" to terminate, i. e. the remaining
3587 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589Note for Redundant Ethernet Interfaces:
3590=======================================
wdenkf07771c2003-05-28 08:06:31 +00003591
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003592Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003593such configurations and is capable of automatic selection of a
3594"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003595
wdenk2729af92004-05-03 20:45:30 +00003596Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3597MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3598"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003599
wdenk2729af92004-05-03 20:45:30 +00003600If the network interface stores some valid MAC address (for instance
3601in SROM), this is used as default address if there is NO correspon-
3602ding setting in the environment; if the corresponding environment
3603variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605o If the SROM has a valid MAC address, and there is no address in the
3606 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003607
wdenk2729af92004-05-03 20:45:30 +00003608o If there is no valid address in the SROM, and a definition in the
3609 environment exists, then the value from the environment variable is
3610 used.
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612o If both the SROM and the environment contain a MAC address, and
3613 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615o If both the SROM and the environment contain a MAC address, and the
3616 addresses differ, the value from the environment is used and a
3617 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk2729af92004-05-03 20:45:30 +00003619o If neither SROM nor the environment contain a MAC address, an error
3620 is raised.
wdenkc6097192002-11-03 00:24:07 +00003621
Ben Warrenecee9322010-04-26 11:11:46 -07003622If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3623will be programmed into hardware as part of the initialization process. This
3624may be skipped by setting the appropriate 'ethmacskip' environment variable.
3625The naming convention is as follows:
3626"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003627
wdenk2729af92004-05-03 20:45:30 +00003628Image Formats:
3629==============
wdenkc6097192002-11-03 00:24:07 +00003630
Marian Balakowicz3310c542008-03-12 12:13:13 +01003631U-Boot is capable of booting (and performing other auxiliary operations on)
3632images in two formats:
3633
3634New uImage format (FIT)
3635-----------------------
3636
3637Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3638to Flattened Device Tree). It allows the use of images with multiple
3639components (several kernels, ramdisks, etc.), with contents protected by
3640SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3641
3642
3643Old uImage format
3644-----------------
3645
3646Old image format is based on binary files which can be basically anything,
3647preceded by a special header; see the definitions in include/image.h for
3648details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003649
wdenk2729af92004-05-03 20:45:30 +00003650* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3651 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003652 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3653 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3654 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003655* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003656 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3657 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003658* Compression Type (uncompressed, gzip, bzip2)
3659* Load Address
3660* Entry Point
3661* Image Name
3662* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664The header is marked by a special Magic Number, and both the header
3665and the data portions of the image are secured against corruption by
3666CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003667
wdenkc6097192002-11-03 00:24:07 +00003668
wdenk2729af92004-05-03 20:45:30 +00003669Linux Support:
3670==============
wdenkc6097192002-11-03 00:24:07 +00003671
wdenk2729af92004-05-03 20:45:30 +00003672Although U-Boot should support any OS or standalone application
3673easily, the main focus has always been on Linux during the design of
3674U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676U-Boot includes many features that so far have been part of some
3677special "boot loader" code within the Linux kernel. Also, any
3678"initrd" images to be used are no longer part of one big Linux image;
3679instead, kernel and "initrd" are separate images. This implementation
3680serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003681
wdenk2729af92004-05-03 20:45:30 +00003682- the same features can be used for other OS or standalone
3683 applications (for instance: using compressed images to reduce the
3684 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003685
wdenk2729af92004-05-03 20:45:30 +00003686- it becomes much easier to port new Linux kernel versions because
3687 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689- the same Linux kernel image can now be used with different "initrd"
3690 images; of course this also means that different kernel images can
3691 be run with the same "initrd". This makes testing easier (you don't
3692 have to build a new "zImage.initrd" Linux image when you just
3693 change a file in your "initrd"). Also, a field-upgrade of the
3694 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003695
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697Linux HOWTO:
3698============
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk2729af92004-05-03 20:45:30 +00003700Porting Linux to U-Boot based systems:
3701---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk2729af92004-05-03 20:45:30 +00003703U-Boot cannot save you from doing all the necessary modifications to
3704configure the Linux device drivers for use with your target hardware
3705(no, we don't intend to provide a full virtual machine interface to
3706Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003707
Stefan Roesea47a12b2010-04-15 16:07:28 +02003708But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk2729af92004-05-03 20:45:30 +00003710Just make sure your machine specific header file (for instance
3711include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003712Information structure as we define in include/asm-<arch>/u-boot.h,
3713and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003714as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003715
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk2729af92004-05-03 20:45:30 +00003717Configuring the Linux kernel:
3718-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk2729af92004-05-03 20:45:30 +00003720No specific requirements for U-Boot. Make sure you have some root
3721device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003722
wdenkc6097192002-11-03 00:24:07 +00003723
wdenk2729af92004-05-03 20:45:30 +00003724Building a Linux Image:
3725-----------------------
wdenkc6097192002-11-03 00:24:07 +00003726
wdenk2729af92004-05-03 20:45:30 +00003727With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3728not used. If you use recent kernel source, a new build target
3729"uImage" will exist which automatically builds an image usable by
3730U-Boot. Most older kernels also have support for a "pImage" target,
3731which was introduced for our predecessor project PPCBoot and uses a
3732100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003733
wdenk2729af92004-05-03 20:45:30 +00003734Example:
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736 make TQM850L_config
3737 make oldconfig
3738 make dep
3739 make uImage
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741The "uImage" build target uses a special tool (in 'tools/mkimage') to
3742encapsulate a compressed Linux kernel image with header information,
3743CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003744
wdenk2729af92004-05-03 20:45:30 +00003745* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749 ${CROSS_COMPILE}-objcopy -O binary \
3750 -R .note -R .comment \
3751 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003752
wdenk2729af92004-05-03 20:45:30 +00003753* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003754
wdenk2729af92004-05-03 20:45:30 +00003755 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003756
wdenk2729af92004-05-03 20:45:30 +00003757* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759 mkimage -A ppc -O linux -T kernel -C gzip \
3760 -a 0 -e 0 -n "Linux Kernel Image" \
3761 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003762
wdenk24ee89b2002-11-03 17:56:27 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764The "mkimage" tool can also be used to create ramdisk images for use
3765with U-Boot, either separated from the Linux kernel image, or
3766combined into one file. "mkimage" encapsulates the images with a 64
3767byte header containing information about target architecture,
3768operating system, image type, compression method, entry points, time
3769stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003770
wdenk2729af92004-05-03 20:45:30 +00003771"mkimage" can be called in two ways: to verify existing images and
3772print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003773
wdenk2729af92004-05-03 20:45:30 +00003774In the first form (with "-l" option) mkimage lists the information
3775contained in the header of an existing U-Boot image; this includes
3776checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003777
wdenk2729af92004-05-03 20:45:30 +00003778 tools/mkimage -l image
3779 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003780
wdenk2729af92004-05-03 20:45:30 +00003781The second form (with "-d" option) is used to build a U-Boot image
3782from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3785 -n name -d data_file image
3786 -A ==> set architecture to 'arch'
3787 -O ==> set operating system to 'os'
3788 -T ==> set image type to 'type'
3789 -C ==> set compression type 'comp'
3790 -a ==> set load address to 'addr' (hex)
3791 -e ==> set entry point to 'ep' (hex)
3792 -n ==> set image name to 'name'
3793 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003794
wdenk69459792004-05-29 16:53:29 +00003795Right now, all Linux kernels for PowerPC systems use the same load
3796address (0x00000000), but the entry point address depends on the
3797kernel version:
wdenkc6097192002-11-03 00:24:07 +00003798
wdenk2729af92004-05-03 20:45:30 +00003799- 2.2.x kernels have the entry point at 0x0000000C,
3800- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk2729af92004-05-03 20:45:30 +00003802So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3805 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003806 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003807 > examples/uImage.TQM850L
3808 Image Name: 2.4.4 kernel for TQM850L
3809 Created: Wed Jul 19 02:34:59 2000
3810 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3811 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3812 Load Address: 0x00000000
3813 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk2729af92004-05-03 20:45:30 +00003815To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003816
wdenk2729af92004-05-03 20:45:30 +00003817 -> tools/mkimage -l examples/uImage.TQM850L
3818 Image Name: 2.4.4 kernel for TQM850L
3819 Created: Wed Jul 19 02:34:59 2000
3820 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3821 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3822 Load Address: 0x00000000
3823 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003824
wdenk2729af92004-05-03 20:45:30 +00003825NOTE: for embedded systems where boot time is critical you can trade
3826speed for memory and install an UNCOMPRESSED image instead: this
3827needs more space in Flash, but boots much faster since it does not
3828need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003829
Stefan Roesea47a12b2010-04-15 16:07:28 +02003830 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003831 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3832 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003833 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003834 > examples/uImage.TQM850L-uncompressed
3835 Image Name: 2.4.4 kernel for TQM850L
3836 Created: Wed Jul 19 02:34:59 2000
3837 Image Type: PowerPC Linux Kernel Image (uncompressed)
3838 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3839 Load Address: 0x00000000
3840 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003841
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3844when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003845
wdenk2729af92004-05-03 20:45:30 +00003846 -> tools/mkimage -n 'Simple Ramdisk Image' \
3847 > -A ppc -O linux -T ramdisk -C gzip \
3848 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3849 Image Name: Simple Ramdisk Image
3850 Created: Wed Jan 12 14:01:50 2000
3851 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3852 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3853 Load Address: 0x00000000
3854 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003855
wdenkdb01a2e2004-04-15 23:14:49 +00003856
wdenk2729af92004-05-03 20:45:30 +00003857Installing a Linux Image:
3858-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003859
wdenk2729af92004-05-03 20:45:30 +00003860To downloading a U-Boot image over the serial (console) interface,
3861you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003862
wdenk2729af92004-05-03 20:45:30 +00003863 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003864
wdenk2729af92004-05-03 20:45:30 +00003865The 'objcopy' does not understand the information in the U-Boot
3866image header, so the resulting S-Record file will be relative to
3867address 0x00000000. To load it to a given address, you need to
3868specify the target address as 'offset' parameter with the 'loads'
3869command.
wdenkc6097192002-11-03 00:24:07 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871Example: install the image to address 0x40100000 (which on the
3872TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876 .......... done
3877 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003878
wdenk2729af92004-05-03 20:45:30 +00003879 => loads 40100000
3880 ## Ready for S-Record download ...
3881 ~>examples/image.srec
3882 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3883 ...
3884 15989 15990 15991 15992
3885 [file transfer complete]
3886 [connected]
3887 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003888
3889
wdenk2729af92004-05-03 20:45:30 +00003890You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003891this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003892corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003893
wdenk2729af92004-05-03 20:45:30 +00003894 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896 ## Checking Image at 40100000 ...
3897 Image Name: 2.2.13 for initrd on TQM850L
3898 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3899 Data Size: 335725 Bytes = 327 kB = 0 MB
3900 Load Address: 00000000
3901 Entry Point: 0000000c
3902 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003903
3904
wdenk2729af92004-05-03 20:45:30 +00003905Boot Linux:
3906-----------
wdenkc6097192002-11-03 00:24:07 +00003907
wdenk2729af92004-05-03 20:45:30 +00003908The "bootm" command is used to boot an application that is stored in
3909memory (RAM or Flash). In case of a Linux kernel image, the contents
3910of the "bootargs" environment variable is passed to the kernel as
3911parameters. You can check and modify this variable using the
3912"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003913
3914
wdenk2729af92004-05-03 20:45:30 +00003915 => printenv bootargs
3916 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918 => 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 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920 => printenv bootargs
3921 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 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923 => bootm 40020000
3924 ## Booting Linux kernel at 40020000 ...
3925 Image Name: 2.2.13 for NFS on TQM850L
3926 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3927 Data Size: 381681 Bytes = 372 kB = 0 MB
3928 Load Address: 00000000
3929 Entry Point: 0000000c
3930 Verifying Checksum ... OK
3931 Uncompressing Kernel Image ... OK
3932 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
3933 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3934 time_init: decrementer frequency = 187500000/60
3935 Calibrating delay loop... 49.77 BogoMIPS
3936 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3937 ...
wdenkc6097192002-11-03 00:24:07 +00003938
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003939If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003940the memory addresses of both the kernel and the initrd image (PPBCOOT
3941format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 ## Checking Image at 40100000 ...
3946 Image Name: 2.2.13 for initrd on TQM850L
3947 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3948 Data Size: 335725 Bytes = 327 kB = 0 MB
3949 Load Address: 00000000
3950 Entry Point: 0000000c
3951 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953 ## Checking Image at 40200000 ...
3954 Image Name: Simple Ramdisk Image
3955 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3956 Data Size: 566530 Bytes = 553 kB = 0 MB
3957 Load Address: 00000000
3958 Entry Point: 00000000
3959 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961 => bootm 40100000 40200000
3962 ## Booting Linux kernel at 40100000 ...
3963 Image Name: 2.2.13 for initrd on TQM850L
3964 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3965 Data Size: 335725 Bytes = 327 kB = 0 MB
3966 Load Address: 00000000
3967 Entry Point: 0000000c
3968 Verifying Checksum ... OK
3969 Uncompressing Kernel Image ... OK
3970 ## Loading RAMDisk Image at 40200000 ...
3971 Image Name: Simple Ramdisk Image
3972 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3973 Data Size: 566530 Bytes = 553 kB = 0 MB
3974 Load Address: 00000000
3975 Entry Point: 00000000
3976 Verifying Checksum ... OK
3977 Loading Ramdisk ... OK
3978 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
3979 Boot arguments: root=/dev/ram
3980 time_init: decrementer frequency = 187500000/60
3981 Calibrating delay loop... 49.77 BogoMIPS
3982 ...
3983 RAMDISK: Compressed image found at block 0
3984 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003985
wdenk2729af92004-05-03 20:45:30 +00003986 bash#
wdenkc6097192002-11-03 00:24:07 +00003987
Matthew McClintock02677682006-06-28 10:41:37 -05003988Boot Linux and pass a flat device tree:
3989-----------
3990
3991First, U-Boot must be compiled with the appropriate defines. See the section
3992titled "Linux Kernel Interface" above for a more in depth explanation. The
3993following is an example of how to start a kernel and pass an updated
3994flat device tree:
3995
3996=> print oftaddr
3997oftaddr=0x300000
3998=> print oft
3999oft=oftrees/mpc8540ads.dtb
4000=> tftp $oftaddr $oft
4001Speed: 1000, full duplex
4002Using TSEC0 device
4003TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4004Filename 'oftrees/mpc8540ads.dtb'.
4005Load address: 0x300000
4006Loading: #
4007done
4008Bytes transferred = 4106 (100a hex)
4009=> tftp $loadaddr $bootfile
4010Speed: 1000, full duplex
4011Using TSEC0 device
4012TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4013Filename 'uImage'.
4014Load address: 0x200000
4015Loading:############
4016done
4017Bytes transferred = 1029407 (fb51f hex)
4018=> print loadaddr
4019loadaddr=200000
4020=> print oftaddr
4021oftaddr=0x300000
4022=> bootm $loadaddr - $oftaddr
4023## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004024 Image Name: Linux-2.6.17-dirty
4025 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4026 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004027 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004028 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004029 Verifying Checksum ... OK
4030 Uncompressing Kernel Image ... OK
4031Booting using flat device tree at 0x300000
4032Using MPC85xx ADS machine description
4033Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4034[snip]
4035
4036
wdenk2729af92004-05-03 20:45:30 +00004037More About U-Boot Image Types:
4038------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004039
wdenk2729af92004-05-03 20:45:30 +00004040U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042 "Standalone Programs" are directly runnable in the environment
4043 provided by U-Boot; it is expected that (if they behave
4044 well) you can continue to work in U-Boot after return from
4045 the Standalone Program.
4046 "OS Kernel Images" are usually images of some Embedded OS which
4047 will take over control completely. Usually these programs
4048 will install their own set of exception handlers, device
4049 drivers, set up the MMU, etc. - this means, that you cannot
4050 expect to re-enter U-Boot except by resetting the CPU.
4051 "RAMDisk Images" are more or less just data blocks, and their
4052 parameters (address, size) are passed to an OS kernel that is
4053 being started.
4054 "Multi-File Images" contain several images, typically an OS
4055 (Linux) kernel image and one or more data images like
4056 RAMDisks. This construct is useful for instance when you want
4057 to boot over the network using BOOTP etc., where the boot
4058 server provides just a single image file, but you want to get
4059 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004060
wdenk2729af92004-05-03 20:45:30 +00004061 "Multi-File Images" start with a list of image sizes, each
4062 image size (in bytes) specified by an "uint32_t" in network
4063 byte order. This list is terminated by an "(uint32_t)0".
4064 Immediately after the terminating 0 follow the images, one by
4065 one, all aligned on "uint32_t" boundaries (size rounded up to
4066 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068 "Firmware Images" are binary images containing firmware (like
4069 U-Boot or FPGA images) which usually will be programmed to
4070 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004071
wdenk2729af92004-05-03 20:45:30 +00004072 "Script files" are command sequences that will be executed by
4073 U-Boot's command interpreter; this feature is especially
4074 useful when you configure U-Boot to use a real shell (hush)
4075 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004076
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk2729af92004-05-03 20:45:30 +00004078Standalone HOWTO:
4079=================
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081One of the features of U-Boot is that you can dynamically load and
4082run "standalone" applications, which can use some resources of
4083U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087"Hello World" Demo:
4088-------------------
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090'examples/hello_world.c' contains a small "Hello World" Demo
4091application; it is automatically compiled when you build U-Boot.
4092It's configured to run at address 0x00040004, so you can play with it
4093like that:
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095 => loads
4096 ## Ready for S-Record download ...
4097 ~>examples/hello_world.srec
4098 1 2 3 4 5 6 7 8 9 10 11 ...
4099 [file transfer complete]
4100 [connected]
4101 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103 => go 40004 Hello World! This is a test.
4104 ## Starting application at 0x00040004 ...
4105 Hello World
4106 argc = 7
4107 argv[0] = "40004"
4108 argv[1] = "Hello"
4109 argv[2] = "World!"
4110 argv[3] = "This"
4111 argv[4] = "is"
4112 argv[5] = "a"
4113 argv[6] = "test."
4114 argv[7] = "<NULL>"
4115 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119Another example, which demonstrates how to register a CPM interrupt
4120handler with the U-Boot code, can be found in 'examples/timer.c'.
4121Here, a CPM timer is set up to generate an interrupt every second.
4122The interrupt service routine is trivial, just printing a '.'
4123character, but this is just a demo program. The application can be
4124controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126 ? - print current values og the CPM Timer registers
4127 b - enable interrupts and start timer
4128 e - stop timer and disable interrupts
4129 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131 => loads
4132 ## Ready for S-Record download ...
4133 ~>examples/timer.srec
4134 1 2 3 4 5 6 7 8 9 10 11 ...
4135 [file transfer complete]
4136 [connected]
4137 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139 => go 40004
4140 ## Starting application at 0x00040004 ...
4141 TIMERS=0xfff00980
4142 Using timer 1
4143 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk2729af92004-05-03 20:45:30 +00004145Hit 'b':
4146 [q, b, e, ?] Set interval 1000000 us
4147 Enabling timer
4148Hit '?':
4149 [q, b, e, ?] ........
4150 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4151Hit '?':
4152 [q, b, e, ?] .
4153 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4154Hit '?':
4155 [q, b, e, ?] .
4156 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4157Hit '?':
4158 [q, b, e, ?] .
4159 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4160Hit 'e':
4161 [q, b, e, ?] ...Stopping timer
4162Hit 'q':
4163 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004164
4165
wdenk2729af92004-05-03 20:45:30 +00004166Minicom warning:
4167================
wdenk85ec0bc2003-03-31 16:34:49 +00004168
wdenk2729af92004-05-03 20:45:30 +00004169Over time, many people have reported problems when trying to use the
4170"minicom" terminal emulation program for serial download. I (wd)
4171consider minicom to be broken, and recommend not to use it. Under
4172Unix, I recommend to use C-Kermit for general purpose use (and
4173especially for kermit binary protocol download ("loadb" command), and
4174use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176Nevertheless, if you absolutely want to use it try adding this
4177configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179 Name Program Name U/D FullScr IO-Red. Multi
4180 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4181 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004182
4183
wdenk2729af92004-05-03 20:45:30 +00004184NetBSD Notes:
4185=============
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187Starting at version 0.9.2, U-Boot supports NetBSD both as host
4188(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190Building requires a cross environment; it is known to work on
4191NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4192need gmake since the Makefiles are not compatible with BSD make).
4193Note that the cross-powerpc package does not install include files;
4194attempting to build U-Boot will fail because <machine/ansi.h> is
4195missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 # cd /usr/pkg/cross/powerpc-netbsd/include
4198 # mkdir powerpc
4199 # ln -s powerpc machine
4200 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4201 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk2729af92004-05-03 20:45:30 +00004203Native builds *don't* work due to incompatibilities between native
4204and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206Booting assumes that (the first part of) the image booted is a
4207stage-2 loader which in turn loads and then invokes the kernel
4208proper. Loader sources will eventually appear in the NetBSD source
4209tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004210meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004211
4212
wdenk2729af92004-05-03 20:45:30 +00004213Implementation Internals:
4214=========================
wdenkc6097192002-11-03 00:24:07 +00004215
wdenk2729af92004-05-03 20:45:30 +00004216The following is not intended to be a complete description of every
4217implementation detail. However, it should help to understand the
4218inner workings of U-Boot and make it easier to port it to custom
4219hardware.
wdenkc6097192002-11-03 00:24:07 +00004220
4221
wdenk2729af92004-05-03 20:45:30 +00004222Initial Stack, Global Data:
4223---------------------------
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225The implementation of U-Boot is complicated by the fact that U-Boot
4226starts running out of ROM (flash memory), usually without access to
4227system RAM (because the memory controller is not initialized yet).
4228This means that we don't have writable Data or BSS segments, and BSS
4229is not initialized as zero. To be able to get a C environment working
4230at all, we have to allocate at least a minimal stack. Implementation
4231options for this are defined and restricted by the CPU used: Some CPU
4232models provide on-chip memory (like the IMMR area on MPC8xx and
4233MPC826x processors), on others (parts of) the data cache can be
4234locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004235
Wolfgang Denk218ca722008-03-26 10:40:12 +01004236 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004237 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4240 From: "Chris Hallinan" <clh@net1plus.com>
4241 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4242 ...
wdenk43d96162003-03-06 00:02:04 +00004243
wdenk2729af92004-05-03 20:45:30 +00004244 Correct me if I'm wrong, folks, but the way I understand it
4245 is this: Using DCACHE as initial RAM for Stack, etc, does not
4246 require any physical RAM backing up the cache. The cleverness
4247 is that the cache is being used as a temporary supply of
4248 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004249 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004250 can see how this works by studying the cache architecture and
4251 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4254 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004255 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004256 option should work for you. Using CS 4 should be fine if your
4257 board designers haven't used it for something that would
4258 cause you grief during the initial boot! It is frequently not
4259 used.
wdenk43d96162003-03-06 00:02:04 +00004260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004261 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004262 with your processor/board/system design. The default value
4263 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004264 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004265 than your SDRAM module. If you have a 64MB SDRAM module, set
4266 it above 400_0000. Just make sure your board has no resources
4267 that are supposed to respond to that address! That code in
4268 start.S has been around a while and should work as is when
4269 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004270
wdenk2729af92004-05-03 20:45:30 +00004271 -Chris Hallinan
4272 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274It is essential to remember this, since it has some impact on the C
4275code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277* Initialized global data (data segment) is read-only. Do not attempt
4278 to write it.
wdenkc6097192002-11-03 00:24:07 +00004279
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004280* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004281 as zero data - BSS segment) at all - this is undefined, initiali-
4282 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284* Stack space is very limited. Avoid big data buffers or things like
4285 that.
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287Having only the stack as writable memory limits means we cannot use
4288normal global data to share information beween the code. But it
4289turned out that the implementation of U-Boot can be greatly
4290simplified by making a global data structure (gd_t) available to all
4291functions. We could pass a pointer to this data as argument to _all_
4292functions, but this would bloat the code. Instead we use a feature of
4293the GCC compiler (Global Register Variables) to share the data: we
4294place a pointer (gd) to the global data into a register which we
4295reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk2729af92004-05-03 20:45:30 +00004297When choosing a register for such a purpose we are restricted by the
4298relevant (E)ABI specifications for the current architecture, and by
4299GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301For PowerPC, the following registers have specific use:
4302 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004303 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004304 R3-R4: parameter passing and return values
4305 R5-R10: parameter passing
4306 R13: small data area pointer
4307 R30: GOT pointer
4308 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004309
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004310 (U-Boot also uses R12 as internal GOT pointer. r12
4311 is a volatile register so r12 needs to be reset when
4312 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004313
Wolfgang Denke7670f62008-02-14 22:43:22 +01004314 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004315
wdenk2729af92004-05-03 20:45:30 +00004316 Note: on PPC, we could use a static initializer (since the
4317 address of the global data structure is known at compile time),
4318 but it turned out that reserving a register results in somewhat
4319 smaller code - although the code savings are not that big (on
4320 average for all boards 752 bytes for the whole U-Boot image,
4321 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004322
Robin Getzc4db3352009-08-17 15:23:02 +00004323On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004324 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4325
Robin Getzc4db3352009-08-17 15:23:02 +00004326 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004327
wdenk2729af92004-05-03 20:45:30 +00004328On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk2729af92004-05-03 20:45:30 +00004330 R0: function argument word/integer result
4331 R1-R3: function argument word
4332 R9: GOT pointer
4333 R10: stack limit (used only if stack checking if enabled)
4334 R11: argument (frame) pointer
4335 R12: temporary workspace
4336 R13: stack pointer
4337 R14: link register
4338 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004339
wdenk2729af92004-05-03 20:45:30 +00004340 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004341
Thomas Chou0df01fd2010-05-21 11:08:03 +08004342On Nios II, the ABI is documented here:
4343 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4344
4345 ==> U-Boot will use gp to hold a pointer to the global data
4346
4347 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4348 to access small data sections, so gp is free.
4349
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004350NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4351or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004352
wdenk2729af92004-05-03 20:45:30 +00004353Memory Management:
4354------------------
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356U-Boot runs in system state and uses physical addresses, i.e. the
4357MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk2729af92004-05-03 20:45:30 +00004359The available memory is mapped to fixed addresses using the memory
4360controller. In this process, a contiguous block is formed for each
4361memory type (Flash, SDRAM, SRAM), even when it consists of several
4362physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364U-Boot is installed in the first 128 kB of the first Flash bank (on
4365TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4366booting and sizing and initializing DRAM, the code relocates itself
4367to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004368memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004369configuration setting]. Below that, a structure with global Board
4370Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372Additionally, some exception handler code is copied to the low 8 kB
4373of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk2729af92004-05-03 20:45:30 +00004375So a typical memory configuration with 16 MB of DRAM could look like
4376this:
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk2729af92004-05-03 20:45:30 +00004378 0x0000 0000 Exception Vector code
4379 :
4380 0x0000 1FFF
4381 0x0000 2000 Free for Application Use
4382 :
4383 :
wdenkc6097192002-11-03 00:24:07 +00004384
wdenk2729af92004-05-03 20:45:30 +00004385 :
4386 :
4387 0x00FB FF20 Monitor Stack (Growing downward)
4388 0x00FB FFAC Board Info Data and permanent copy of global data
4389 0x00FC 0000 Malloc Arena
4390 :
4391 0x00FD FFFF
4392 0x00FE 0000 RAM Copy of Monitor Code
4393 ... eventually: LCD or video framebuffer
4394 ... eventually: pRAM (Protected RAM - unchanged by reset)
4395 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004396
4397
wdenk2729af92004-05-03 20:45:30 +00004398System Initialization:
4399----------------------
wdenkc6097192002-11-03 00:24:07 +00004400
wdenk2729af92004-05-03 20:45:30 +00004401In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004402(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004403configuration for CS0# this is a mirror of the onboard Flash memory.
4404To be able to re-map memory U-Boot then jumps to its link address.
4405To be able to implement the initialization code in C, a (small!)
4406initial stack is set up in the internal Dual Ported RAM (in case CPUs
4407which provide such a feature like MPC8xx or MPC8260), or in a locked
4408part of the data cache. After that, U-Boot initializes the CPU core,
4409the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk2729af92004-05-03 20:45:30 +00004411Next, all (potentially) available memory banks are mapped using a
4412preliminary mapping. For example, we put them on 512 MB boundaries
4413(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4414on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4415programmed for SDRAM access. Using the temporary configuration, a
4416simple memory test is run that determines the size of the SDRAM
4417banks.
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419When there is more than one SDRAM bank, and the banks are of
4420different size, the largest is mapped first. For equal size, the first
4421bank (CS2#) is mapped first. The first mapping is always for address
44220x00000000, with any additional banks following immediately to create
4423contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk2729af92004-05-03 20:45:30 +00004425Then, the monitor installs itself at the upper end of the SDRAM area
4426and allocates memory for use by malloc() and for the global Board
4427Info data; also, the exception vector code is copied to the low RAM
4428pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004429
wdenk2729af92004-05-03 20:45:30 +00004430Only after this relocation will you have a "normal" C environment;
4431until that you are restricted in several ways, mostly because you are
4432running from ROM, and because the code will have to be relocated to a
4433new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004434
4435
wdenk2729af92004-05-03 20:45:30 +00004436U-Boot Porting Guide:
4437----------------------
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk2729af92004-05-03 20:45:30 +00004439[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4440list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004441
4442
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004443int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004444{
4445 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004446
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004447 signal(SIGALRM, no_more_time);
4448 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk2729af92004-05-03 20:45:30 +00004450 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004451 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004452 return 0;
4453 }
4454
wdenk2729af92004-05-03 20:45:30 +00004455 Download latest U-Boot source;
4456
Wolfgang Denk06682362008-12-30 22:56:11 +01004457 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004458
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004459 if (clueless)
4460 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462 while (learning) {
4463 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004464 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4465 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004466 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004467 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004468 }
wdenkc6097192002-11-03 00:24:07 +00004469
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004470 if (available_money > toLocalCurrency ($2500))
4471 Buy a BDI3000;
4472 else
wdenk2729af92004-05-03 20:45:30 +00004473 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004474
4475 if (a similar board exists) { /* hopefully... */
4476 cp -a board/<similar> board/<myboard>
4477 cp include/configs/<similar>.h include/configs/<myboard>.h
4478 } else {
4479 Create your own board support subdirectory;
4480 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004481 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004482 Edit new board/<myboard> files
4483 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004484
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004485 while (!accepted) {
4486 while (!running) {
4487 do {
4488 Add / modify source code;
4489 } until (compiles);
4490 Debug;
4491 if (clueless)
4492 email("Hi, I am having problems...");
4493 }
4494 Send patch file to the U-Boot email list;
4495 if (reasonable critiques)
4496 Incorporate improvements from email list code review;
4497 else
4498 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004499 }
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk2729af92004-05-03 20:45:30 +00004501 return 0;
4502}
4503
4504void no_more_time (int sig)
4505{
4506 hire_a_guru();
4507}
wdenkc6097192002-11-03 00:24:07 +00004508
4509
wdenk2729af92004-05-03 20:45:30 +00004510Coding Standards:
4511-----------------
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk2729af92004-05-03 20:45:30 +00004513All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004514coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004515"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004516
Detlev Zundel2c051652006-09-01 15:39:02 +02004517Source files originating from a different project (for example the
4518MTD subsystem) are generally exempt from these guidelines and are not
4519reformated to ease subsequent migration to newer versions of those
4520sources.
4521
4522Please note that U-Boot is implemented in C (and to some small parts in
4523Assembler); no C++ is used, so please do not use C++ style comments (//)
4524in your code.
wdenk2729af92004-05-03 20:45:30 +00004525
4526Please also stick to the following formatting rules:
4527- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004528- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004529- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004530- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004531- do not add trailing empty lines to source files
4532
4533Submissions which do not conform to the standards may be returned
4534with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004535
4536
wdenk2729af92004-05-03 20:45:30 +00004537Submitting Patches:
4538-------------------
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540Since the number of patches for U-Boot is growing, we need to
4541establish some rules. Submissions which do not conform to these rules
4542may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004543
Magnus Lilja0d28f342008-08-06 19:32:33 +02004544Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004545
Wolfgang Denk06682362008-12-30 22:56:11 +01004546Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4547see http://lists.denx.de/mailman/listinfo/u-boot
4548
wdenk2729af92004-05-03 20:45:30 +00004549When you send a patch, please include the following information with
4550it:
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk2729af92004-05-03 20:45:30 +00004552* For bug fixes: a description of the bug and how your patch fixes
4553 this bug. Please try to include a way of demonstrating that the
4554 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004555
wdenk2729af92004-05-03 20:45:30 +00004556* For new features: a description of the feature and your
4557 implementation.
wdenkc6097192002-11-03 00:24:07 +00004558
wdenk2729af92004-05-03 20:45:30 +00004559* A CHANGELOG entry as plaintext (separate from the patch)
4560
4561* For major contributions, your entry to the CREDITS file
4562
4563* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004564 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004565
4566* If your patch adds new configuration options, don't forget to
4567 document these in the README file.
4568
Wolfgang Denk218ca722008-03-26 10:40:12 +01004569* The patch itself. If you are using git (which is *strongly*
4570 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004571 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004572 the U-Boot mailing list, you will avoid most of the common problems
4573 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004574
Wolfgang Denk218ca722008-03-26 10:40:12 +01004575 If you cannot use git, use "diff -purN OLD NEW". If your version of
4576 diff does not support these options, then get the latest version of
4577 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004578
Wolfgang Denk218ca722008-03-26 10:40:12 +01004579 The current directory when running this command shall be the parent
4580 directory of the U-Boot source tree (i. e. please make sure that
4581 your patch includes sufficient directory information for the
4582 affected files).
4583
4584 We prefer patches as plain text. MIME attachments are discouraged,
4585 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004586
4587* If one logical set of modifications affects or creates several
4588 files, all these changes shall be submitted in a SINGLE patch file.
4589
4590* Changesets that contain different, unrelated modifications shall be
4591 submitted as SEPARATE patches, one patch per changeset.
4592
4593
4594Notes:
4595
4596* Before sending the patch, run the MAKEALL script on your patched
4597 source tree and make sure that no errors or warnings are reported
4598 for any of the boards.
4599
4600* Keep your modifications to the necessary minimum: A patch
4601 containing several unrelated changes or arbitrary reformats will be
4602 returned with a request to re-formatting / split it.
4603
4604* If you modify existing code, make sure that your new code does not
4605 add to the memory footprint of the code ;-) Small is beautiful!
4606 When adding new features, these should compile conditionally only
4607 (using #ifdef), and the resulting code with the new feature
4608 disabled must not need more memory than the old code without your
4609 modification.
wdenk90dc6702005-05-03 14:12:25 +00004610
Wolfgang Denk06682362008-12-30 22:56:11 +01004611* Remember that there is a size limit of 100 kB per message on the
4612 u-boot mailing list. Bigger patches will be moderated. If they are
4613 reasonable and not too big, they will be acknowledged. But patches
4614 bigger than the size limit should be avoided.