blob: 4428205b86aa5273c95ca6f820667ffb5d63e2d8 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000377 CONFIG_SYS_PPC_E500_DEBUG_TLB
378
379 Enables a temporary TLB entry to be used during boot to work
380 around limitations in e500v1 and e500v2 external debugger
381 support. This reduces the portions of the boot code where
382 breakpoints and single stepping do not work. The value of this
383 symbol should be set to the TLB1 entry to be used for this
384 purpose.
385
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000386- Generic CPU options:
387 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
388
389 Defines the endianess of the CPU. Implementation of those
390 values is arch specific.
391
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100392- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200393 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100394
395 Defines the Monahans run mode to oscillator
396 ratio. Valid values are 8, 16, 24, 31. The core
397 frequency is this value multiplied by 13 MHz.
398
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200399 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200400
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100401 Defines the Monahans turbo mode to oscillator
402 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200403 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100404 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200405
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200406- MIPS CPU options:
407 CONFIG_SYS_INIT_SP_OFFSET
408
409 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
410 pointer. This is needed for the temporary stack before
411 relocation.
412
413 CONFIG_SYS_MIPS_CACHE_MODE
414
415 Cache operation mode for the MIPS CPU.
416 See also arch/mips/include/asm/mipsregs.h.
417 Possible values are:
418 CONF_CM_CACHABLE_NO_WA
419 CONF_CM_CACHABLE_WA
420 CONF_CM_UNCACHED
421 CONF_CM_CACHABLE_NONCOHERENT
422 CONF_CM_CACHABLE_CE
423 CONF_CM_CACHABLE_COW
424 CONF_CM_CACHABLE_CUW
425 CONF_CM_CACHABLE_ACCELERATED
426
427 CONFIG_SYS_XWAY_EBU_BOOTCFG
428
429 Special option for Lantiq XWAY SoCs for booting from NOR flash.
430 See also arch/mips/cpu/mips32/start.S.
431
432 CONFIG_XWAY_SWAP_BYTES
433
434 Enable compilation of tools/xway-swap-bytes needed for Lantiq
435 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
436 be swapped if a flash programmer is used.
437
Christian Rieschb67d8812012-02-02 00:44:39 +0000438- ARM options:
439 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
440
441 Select high exception vectors of the ARM core, e.g., do not
442 clear the V bit of the c1 register of CP15.
443
Aneesh V5356f542012-03-08 07:20:19 +0000444 CONFIG_SYS_THUMB_BUILD
445
446 Use this flag to build U-Boot using the Thumb instruction
447 set for ARM architectures. Thumb instruction set provides
448 better code density. For ARM architectures that support
449 Thumb2 this flag will result in Thumb2 code generated by
450 GCC.
451
wdenk5da627a2003-10-09 20:09:04 +0000452- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000453 CONFIG_CLOCKS_IN_MHZ
454
455 U-Boot stores all clock information in Hz
456 internally. For binary compatibility with older Linux
457 kernels (which expect the clocks passed in the
458 bd_info data to be in MHz) the environment variable
459 "clocks_in_mhz" can be defined so that U-Boot
460 converts clock data to MHZ before passing it to the
461 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000462 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100463 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000464 default environment.
465
wdenk5da627a2003-10-09 20:09:04 +0000466 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
467
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200468 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000469 expect it to be in bytes, others in MB.
470 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
471
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400472 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200473
474 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400475 passed using flattened device trees (based on open firmware
476 concepts).
477
478 CONFIG_OF_LIBFDT
479 * New libfdt-based support
480 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500481 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400482
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200483 OF_CPU - The proper name of the cpus node (only required for
484 MPC512X and MPC5xxx based boards).
485 OF_SOC - The proper name of the soc node (only required for
486 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200487 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600488 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200489
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200490 boards with QUICC Engines require OF_QE to set UCC MAC
491 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500492
Kumar Gala4e253132006-01-11 13:54:17 -0600493 CONFIG_OF_BOARD_SETUP
494
495 Board code has addition modification that it wants to make
496 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000497
Matthew McClintock02677682006-06-28 10:41:37 -0500498 CONFIG_OF_BOOT_CPU
499
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200500 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500501 param header, the default value is zero if undefined.
502
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200503 CONFIG_OF_IDE_FIXUP
504
505 U-Boot can detect if an IDE device is present or not.
506 If not, and this new config option is activated, U-Boot
507 removes the ATA node from the DTS before booting Linux,
508 so the Linux IDE driver does not probe the device and
509 crash. This is needed for buggy hardware (uc101) where
510 no pull down resistor is connected to the signal IDE5V_DD7.
511
Igor Grinberg7eb29392011-07-14 05:45:07 +0000512 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
513
514 This setting is mandatory for all boards that have only one
515 machine type and must be used to specify the machine type
516 number as it appears in the ARM machine registry
517 (see http://www.arm.linux.org.uk/developer/machines/).
518 Only boards that have multiple machine types supported
519 in a single configuration file and the machine type is
520 runtime discoverable, do not have to use this setting.
521
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100522- vxWorks boot parameters:
523
524 bootvx constructs a valid bootline using the following
525 environments variables: bootfile, ipaddr, serverip, hostname.
526 It loads the vxWorks image pointed bootfile.
527
528 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
529 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
530 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
531 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
532
533 CONFIG_SYS_VXWORKS_ADD_PARAMS
534
535 Add it at the end of the bootline. E.g "u=username pw=secret"
536
537 Note: If a "bootargs" environment is defined, it will overwride
538 the defaults discussed just above.
539
Aneesh V2c451f72011-06-16 23:30:47 +0000540- Cache Configuration:
541 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
542 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
543 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
544
Aneesh V93bc2192011-06-16 23:30:51 +0000545- Cache Configuration for ARM:
546 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
547 controller
548 CONFIG_SYS_PL310_BASE - Physical base address of PL310
549 controller register space
550
wdenk6705d812004-08-02 23:22:59 +0000551- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200552 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000553
554 Define this if you want support for Amba PrimeCell PL010 UARTs.
555
Andreas Engel48d01922008-09-08 14:30:53 +0200556 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000557
558 Define this if you want support for Amba PrimeCell PL011 UARTs.
559
560 CONFIG_PL011_CLOCK
561
562 If you have Amba PrimeCell PL011 UARTs, set this variable to
563 the clock speed of the UARTs.
564
565 CONFIG_PL01x_PORTS
566
567 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
568 define this to a list of base addresses for each (supported)
569 port. See e.g. include/configs/versatile.h
570
John Rigby910f1ae2011-04-19 10:42:39 +0000571 CONFIG_PL011_SERIAL_RLCR
572
573 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
574 have separate receive and transmit line control registers. Set
575 this variable to initialize the extra register.
576
577 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
578
579 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
580 boot loader that has already initialized the UART. Define this
581 variable to flush the UART at init time.
582
wdenk6705d812004-08-02 23:22:59 +0000583
wdenkc6097192002-11-03 00:24:07 +0000584- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000585 Depending on board, define exactly one serial port
586 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
587 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
588 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000589
590 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
591 port routines must be defined elsewhere
592 (i.e. serial_init(), serial_getc(), ...)
593
594 CONFIG_CFB_CONSOLE
595 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000596 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000597 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
598 (default big endian)
599 VIDEO_HW_RECTFILL graphic chip supports
600 rectangle fill
601 (cf. smiLynxEM)
602 VIDEO_HW_BITBLT graphic chip supports
603 bit-blit (cf. smiLynxEM)
604 VIDEO_VISIBLE_COLS visible pixel columns
605 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000606 VIDEO_VISIBLE_ROWS visible pixel rows
607 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000608 VIDEO_DATA_FORMAT graphic data format
609 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000610 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000611 VIDEO_KBD_INIT_FCT keyboard int fct
612 (i.e. i8042_kbd_init())
613 VIDEO_TSTC_FCT test char fct
614 (i.e. i8042_tstc)
615 VIDEO_GETC_FCT get char fct
616 (i.e. i8042_getc)
617 CONFIG_CONSOLE_CURSOR cursor drawing on/off
618 (requires blink timer
619 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200620 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000621 CONFIG_CONSOLE_TIME display time/date info in
622 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500623 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000624 CONFIG_VIDEO_LOGO display Linux logo in
625 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000626 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
627 linux_logo.h for logo.
628 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000629 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200630 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000631 the logo
632
wdenk43d96162003-03-06 00:02:04 +0000633 When CONFIG_CFB_CONSOLE is defined, video console is
634 default i/o. Serial console can be forced with
635 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000636
wdenkd4ca31c2004-01-02 14:00:00 +0000637 When CONFIG_SILENT_CONSOLE is defined, all console
638 messages (by U-Boot and Linux!) can be silenced with
639 the "silent" environment variable. See
640 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000641
wdenkc6097192002-11-03 00:24:07 +0000642- Console Baudrate:
643 CONFIG_BAUDRATE - in bps
644 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200645 CONFIG_SYS_BAUDRATE_TABLE, see below.
646 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000647
Heiko Schocherc92fac92009-01-30 12:55:38 +0100648- Console Rx buffer length
649 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
650 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100651 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100652 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
653 must be defined, to setup the maximum idle timeout for
654 the SMC.
655
Graeme Russ9558b482011-09-01 00:48:27 +0000656- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200657 Prior to the console being initialised (i.e. serial UART
658 initialised etc) all console output is silently discarded.
659 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
660 buffer any console messages prior to the console being
661 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
662 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
663 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200664 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200665 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000666
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200667 'Sane' compilers will generate smaller code if
668 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000669
Sonny Rao046a37b2011-11-02 09:52:08 +0000670- Safe printf() functions
671 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
672 the printf() functions. These are defined in
673 include/vsprintf.h and include snprintf(), vsnprintf() and
674 so on. Code size increase is approximately 300-500 bytes.
675 If this option is not given then these functions will
676 silently discard their buffer size argument - this means
677 you are not getting any overflow checking in this case.
678
wdenkc6097192002-11-03 00:24:07 +0000679- Boot Delay: CONFIG_BOOTDELAY - in seconds
680 Delay before automatically booting the default image;
681 set to -1 to disable autoboot.
682
683 See doc/README.autoboot for these options that
684 work with CONFIG_BOOTDELAY. None are required.
685 CONFIG_BOOT_RETRY_TIME
686 CONFIG_BOOT_RETRY_MIN
687 CONFIG_AUTOBOOT_KEYED
688 CONFIG_AUTOBOOT_PROMPT
689 CONFIG_AUTOBOOT_DELAY_STR
690 CONFIG_AUTOBOOT_STOP_STR
691 CONFIG_AUTOBOOT_DELAY_STR2
692 CONFIG_AUTOBOOT_STOP_STR2
693 CONFIG_ZERO_BOOTDELAY_CHECK
694 CONFIG_RESET_TO_RETRY
695
696- Autoboot Command:
697 CONFIG_BOOTCOMMAND
698 Only needed when CONFIG_BOOTDELAY is enabled;
699 define a command string that is automatically executed
700 when no character is read on the console interface
701 within "Boot Delay" after reset.
702
703 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000704 This can be used to pass arguments to the bootm
705 command. The value of CONFIG_BOOTARGS goes into the
706 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000707
708 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000709 The value of these goes into the environment as
710 "ramboot" and "nfsboot" respectively, and can be used
711 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200712 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000713
714- Pre-Boot Commands:
715 CONFIG_PREBOOT
716
717 When this option is #defined, the existence of the
718 environment variable "preboot" will be checked
719 immediately before starting the CONFIG_BOOTDELAY
720 countdown and/or running the auto-boot command resp.
721 entering interactive mode.
722
723 This feature is especially useful when "preboot" is
724 automatically generated or modified. For an example
725 see the LWMON board specific code: here "preboot" is
726 modified when the user holds down a certain
727 combination of keys on the (special) keyboard when
728 booting the systems
729
730- Serial Download Echo Mode:
731 CONFIG_LOADS_ECHO
732 If defined to 1, all characters received during a
733 serial download (using the "loads" command) are
734 echoed back. This might be needed by some terminal
735 emulations (like "cu"), but may as well just take
736 time on others. This setting #define's the initial
737 value of the "loads_echo" environment variable.
738
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000740 CONFIG_KGDB_BAUDRATE
741 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200742 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000743
744- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500745 Monitor commands can be included or excluded
746 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000747 <config_cmd_all.h> and #undef'ing unwanted
748 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500749 and augmenting with additional #define's
750 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000751
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500752 The default command configuration includes all commands
753 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000754
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500755 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500756 CONFIG_CMD_BDI bdinfo
757 CONFIG_CMD_BEDBUG * Include BedBug Debugger
758 CONFIG_CMD_BMP * BMP support
759 CONFIG_CMD_BSP * Board specific commands
760 CONFIG_CMD_BOOTD bootd
761 CONFIG_CMD_CACHE * icache, dcache
762 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500763 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500764 CONFIG_CMD_DATE * support for RTC, date/time...
765 CONFIG_CMD_DHCP * DHCP support
766 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600767 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
768 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
769 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
770 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500771 CONFIG_CMD_DTT * Digital Therm and Thermostat
772 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500773 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500774 CONFIG_CMD_EEPROM * EEPROM read/write support
775 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500776 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500777 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500778 CONFIG_CMD_FDC * Floppy Disk Support
779 CONFIG_CMD_FAT * FAT partition support
780 CONFIG_CMD_FDOS * Dos diskette Support
781 CONFIG_CMD_FLASH flinfo, erase, protect
782 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500783 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000784 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500785 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
786 CONFIG_CMD_I2C * I2C serial bus support
787 CONFIG_CMD_IDE * IDE harddisk support
788 CONFIG_CMD_IMI iminfo
789 CONFIG_CMD_IMLS List all found images
790 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500791 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500792 CONFIG_CMD_IRQ * irqinfo
793 CONFIG_CMD_ITEST Integer/string test of 2 values
794 CONFIG_CMD_JFFS2 * JFFS2 Support
795 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500796 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000797 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
798 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500799 CONFIG_CMD_LOADB loadb
800 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400801 CONFIG_CMD_MD5SUM print md5 message digest
802 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500803 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
804 loop, loopw, mtest
805 CONFIG_CMD_MISC Misc functions like sleep etc
806 CONFIG_CMD_MMC * MMC memory mapped support
807 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100808 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 CONFIG_CMD_NAND * NAND support
810 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600811 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000812 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 CONFIG_CMD_PCI * pciinfo
814 CONFIG_CMD_PCMCIA * PCMCIA support
815 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
816 host
817 CONFIG_CMD_PORTIO * Port I/O
818 CONFIG_CMD_REGINFO * Register dump
819 CONFIG_CMD_RUN run command in env variable
820 CONFIG_CMD_SAVES * save S record dump
821 CONFIG_CMD_SCSI * SCSI Support
822 CONFIG_CMD_SDRAM * print SDRAM configuration information
823 (requires CONFIG_CMD_I2C)
824 CONFIG_CMD_SETGETDCR Support for DCR Register access
825 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700826 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100827 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400828 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200829 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000831 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000832 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000833 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500835 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000836 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000837
wdenkc6097192002-11-03 00:24:07 +0000838
839 EXAMPLE: If you want all functions except of network
840 support you can write:
841
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500842 #include "config_cmd_all.h"
843 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000844
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400845 Other Commands:
846 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000847
848 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500849 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000850 what you (and your U-Boot users) are doing. Data
851 cache cannot be enabled on systems like the 8xx or
852 8260 (where accesses to the IMMR region must be
853 uncached), and it cannot be disabled on all other
854 systems where we (mis-) use the data cache to hold an
855 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000856
857
858 XXX - this list needs to get updated!
859
Simon Glass45ba8072011-10-15 05:48:20 +0000860- Device tree:
861 CONFIG_OF_CONTROL
862 If this variable is defined, U-Boot will use a device tree
863 to configure its devices, instead of relying on statically
864 compiled #defines in the board file. This option is
865 experimental and only available on a few boards. The device
866 tree is available in the global data as gd->fdt_blob.
867
Simon Glass2c0f79e2011-10-24 19:15:31 +0000868 U-Boot needs to get its device tree from somewhere. This can
869 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000870
871 CONFIG_OF_EMBED
872 If this variable is defined, U-Boot will embed a device tree
873 binary in its image. This device tree file should be in the
874 board directory and called <soc>-<board>.dts. The binary file
875 is then picked up in board_init_f() and made available through
876 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000877
Simon Glass2c0f79e2011-10-24 19:15:31 +0000878 CONFIG_OF_SEPARATE
879 If this variable is defined, U-Boot will build a device tree
880 binary. It will be called u-boot.dtb. Architecture-specific
881 code will locate it at run-time. Generally this works by:
882
883 cat u-boot.bin u-boot.dtb >image.bin
884
885 and in fact, U-Boot does this for you, creating a file called
886 u-boot-dtb.bin which is useful in the common case. You can
887 still use the individual files if you need something more
888 exotic.
889
wdenkc6097192002-11-03 00:24:07 +0000890- Watchdog:
891 CONFIG_WATCHDOG
892 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000893 support for the SoC. There must be support in the SoC
894 specific code for a watchdog. For the 8xx and 8260
895 CPUs, the SIU Watchdog feature is enabled in the SYPCR
896 register. When supported for a specific SoC is
897 available, then no further board specific code should
898 be needed to use it.
899
900 CONFIG_HW_WATCHDOG
901 When using a watchdog circuitry external to the used
902 SoC, then define this variable and provide board
903 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000904
stroesec1551ea2003-04-04 15:53:41 +0000905- U-Boot Version:
906 CONFIG_VERSION_VARIABLE
907 If this variable is defined, an environment variable
908 named "ver" is created by U-Boot showing the U-Boot
909 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200910 Any change to this variable will be reverted at the
911 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000912
wdenkc6097192002-11-03 00:24:07 +0000913- Real-Time Clock:
914
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000916 has to be selected, too. Define exactly one of the
917 following options:
918
919 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
920 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000921 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000922 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000923 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000924 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000925 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000926 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100927 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000928 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200929 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200930 CONFIG_SYS_RV3029_TCR - enable trickle charger on
931 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000932
wdenkb37c7e52003-06-30 16:24:52 +0000933 Note that if the RTC uses I2C, then the I2C interface
934 must also be configured. See I2C Support, below.
935
Peter Tysere92739d2008-12-17 16:36:21 -0600936- GPIO Support:
937 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
938 CONFIG_PCA953X_INFO - enable pca953x info command
939
Chris Packham5dec49c2010-12-19 10:12:13 +0000940 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
941 chip-ngpio pairs that tell the PCA953X driver the number of
942 pins supported by a particular chip.
943
Peter Tysere92739d2008-12-17 16:36:21 -0600944 Note that if the GPIO device uses I2C, then the I2C interface
945 must also be configured. See I2C Support, below.
946
wdenkc6097192002-11-03 00:24:07 +0000947- Timestamp Support:
948
wdenk43d96162003-03-06 00:02:04 +0000949 When CONFIG_TIMESTAMP is selected, the timestamp
950 (date and time) of an image is printed by image
951 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000953
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000954- Partition Labels (disklabels) Supported:
955 Zero or more of the following:
956 CONFIG_MAC_PARTITION Apple's MacOS partition table.
957 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
958 Intel architecture, USB sticks, etc.
959 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
960 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
961 bootloader. Note 2TB partition limit; see
962 disk/part_efi.c
963 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000964
Wolfgang Denk218ca722008-03-26 10:40:12 +0100965 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
966 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000967 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000968
969- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000970 CONFIG_IDE_RESET_ROUTINE - this is defined in several
971 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000972
wdenk4d13cba2004-03-14 14:09:05 +0000973 CONFIG_IDE_RESET - is this is defined, IDE Reset will
974 be performed by calling the function
975 ide_set_reset(int reset)
976 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000977
978- ATAPI Support:
979 CONFIG_ATAPI
980
981 Set this to enable ATAPI support.
982
wdenkc40b2952004-03-13 23:29:43 +0000983- LBA48 Support
984 CONFIG_LBA48
985
986 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100987 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000988 Whithout these , LBA48 support uses 32bit variables and will 'only'
989 support disks up to 2.1TB.
990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200991 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000992 When enabled, makes the IDE subsystem use 64bit sector addresses.
993 Default is 32bit.
994
wdenkc6097192002-11-03 00:24:07 +0000995- SCSI Support:
996 At the moment only there is only support for the
997 SYM53C8XX SCSI controller; define
998 CONFIG_SCSI_SYM53C8XX to enable it.
999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001000 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1001 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1002 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001003 maximum numbers of LUNs, SCSI ID's and target
1004 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001005 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001006
1007- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001008 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001009 Support for Intel 8254x/8257x gigabit chips.
1010
1011 CONFIG_E1000_SPI
1012 Utility code for direct access to the SPI bus on Intel 8257x.
1013 This does not do anything useful unless you set at least one
1014 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1015
1016 CONFIG_E1000_SPI_GENERIC
1017 Allow generic access to the SPI bus on the Intel 8257x, for
1018 example with the "sspi" command.
1019
1020 CONFIG_CMD_E1000
1021 Management command for E1000 devices. When used on devices
1022 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001023
Andre Schwarzac3315c2008-03-06 16:45:44 +01001024 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001025 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001026
wdenkc6097192002-11-03 00:24:07 +00001027 CONFIG_EEPRO100
1028 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001029 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001030 write routine for first time initialisation.
1031
1032 CONFIG_TULIP
1033 Support for Digital 2114x chips.
1034 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1035 modem chip initialisation (KS8761/QS6611).
1036
1037 CONFIG_NATSEMI
1038 Support for National dp83815 chips.
1039
1040 CONFIG_NS8382X
1041 Support for National dp8382[01] gigabit chips.
1042
wdenk45219c42003-05-12 21:50:16 +00001043- NETWORK Support (other):
1044
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001045 CONFIG_DRIVER_AT91EMAC
1046 Support for AT91RM9200 EMAC.
1047
1048 CONFIG_RMII
1049 Define this to use reduced MII inteface
1050
1051 CONFIG_DRIVER_AT91EMAC_QUIET
1052 If this defined, the driver is quiet.
1053 The driver doen't show link status messages.
1054
Rob Herringefdd7312011-12-15 11:15:49 +00001055 CONFIG_CALXEDA_XGMAC
1056 Support for the Calxeda XGMAC device
1057
wdenk45219c42003-05-12 21:50:16 +00001058 CONFIG_DRIVER_LAN91C96
1059 Support for SMSC's LAN91C96 chips.
1060
1061 CONFIG_LAN91C96_BASE
1062 Define this to hold the physical address
1063 of the LAN91C96's I/O space
1064
1065 CONFIG_LAN91C96_USE_32_BIT
1066 Define this to enable 32 bit addressing
1067
wdenkf39748a2004-06-09 13:37:52 +00001068 CONFIG_DRIVER_SMC91111
1069 Support for SMSC's LAN91C111 chip
1070
1071 CONFIG_SMC91111_BASE
1072 Define this to hold the physical address
1073 of the device (I/O space)
1074
1075 CONFIG_SMC_USE_32_BIT
1076 Define this if data bus is 32 bits
1077
1078 CONFIG_SMC_USE_IOFUNCS
1079 Define this to use i/o functions instead of macros
1080 (some hardware wont work with macros)
1081
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001082 CONFIG_DRIVER_TI_EMAC
1083 Support for davinci emac
1084
1085 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1086 Define this if you have more then 3 PHYs.
1087
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001088 CONFIG_FTGMAC100
1089 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1090
1091 CONFIG_FTGMAC100_EGIGA
1092 Define this to use GE link update with gigabit PHY.
1093 Define this if FTGMAC100 is connected to gigabit PHY.
1094 If your system has 10/100 PHY only, it might not occur
1095 wrong behavior. Because PHY usually return timeout or
1096 useless data when polling gigabit status and gigabit
1097 control registers. This behavior won't affect the
1098 correctnessof 10/100 link speed update.
1099
Mike Rapoportc2fff332009-11-11 10:03:03 +02001100 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001101 Support for SMSC's LAN911x and LAN921x chips
1102
Mike Rapoportc2fff332009-11-11 10:03:03 +02001103 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001104 Define this to hold the physical address
1105 of the device (I/O space)
1106
Mike Rapoportc2fff332009-11-11 10:03:03 +02001107 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001108 Define this if data bus is 32 bits
1109
Mike Rapoportc2fff332009-11-11 10:03:03 +02001110 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001111 Define this if data bus is 16 bits. If your processor
1112 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001113 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001114
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001115 CONFIG_SH_ETHER
1116 Support for Renesas on-chip Ethernet controller
1117
1118 CONFIG_SH_ETHER_USE_PORT
1119 Define the number of ports to be used
1120
1121 CONFIG_SH_ETHER_PHY_ADDR
1122 Define the ETH PHY's address
1123
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001124 CONFIG_SH_ETHER_CACHE_WRITEBACK
1125 If this option is set, the driver enables cache flush.
1126
Vadim Bendebury5e124722011-10-17 08:36:14 +00001127- TPM Support:
1128 CONFIG_GENERIC_LPC_TPM
1129 Support for generic parallel port TPM devices. Only one device
1130 per system is supported at this time.
1131
1132 CONFIG_TPM_TIS_BASE_ADDRESS
1133 Base address where the generic TPM device is mapped
1134 to. Contemporary x86 systems usually map it at
1135 0xfed40000.
1136
wdenkc6097192002-11-03 00:24:07 +00001137- USB Support:
1138 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001139 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001140 CONFIG_USB_UHCI to enable it.
1141 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001142 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001143 storage devices.
1144 Note:
1145 Supported are USB Keyboards and USB Floppy drives
1146 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001147 MPC5200 USB requires additional defines:
1148 CONFIG_USB_CLOCK
1149 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001150 CONFIG_PSC3_USB
1151 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001152 CONFIG_USB_CONFIG
1153 for differential drivers: 0x00001000
1154 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001155 for differential drivers on PSC3: 0x00000100
1156 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001157 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001158 May be defined to allow interrupt polling
1159 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001160
Simon Glass9ab4ce22012-02-27 10:52:47 +00001161 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1162 txfilltuning field in the EHCI controller on reset.
1163
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164- USB Device:
1165 Define the below if you wish to use the USB console.
1166 Once firmware is rebuilt from a serial console issue the
1167 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001168 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001169 it has found a new device. The environment variable usbtty
1170 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001171 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001172 Common Device Class Abstract Control Model serial device.
1173 If you select usbtty = gserial you should be able to enumerate
1174 a Linux host by
1175 # modprobe usbserial vendor=0xVendorID product=0xProductID
1176 else if using cdc_acm, simply setting the environment
1177 variable usbtty to be cdc_acm should suffice. The following
1178 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001179
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001180 CONFIG_USB_DEVICE
1181 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001182
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001183 CONFIG_USB_TTY
1184 Define this to have a tty type of device available to
1185 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001186
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301187 CONFIG_USBD_HS
1188 Define this to enable the high speed support for usb
1189 device and usbtty. If this feature is enabled, a routine
1190 int is_usbd_high_speed(void)
1191 also needs to be defined by the driver to dynamically poll
1192 whether the enumeration has succeded at high speed or full
1193 speed.
1194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001195 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001196 Define this if you want stdin, stdout &/or stderr to
1197 be set to usbtty.
1198
1199 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001200 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001201 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001202 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001204 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001205 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001206 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001207
Wolfgang Denk386eda02006-06-14 18:14:56 +02001208 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001209 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001210 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001211 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1212 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1213 should pretend to be a Linux device to it's target host.
1214
1215 CONFIG_USBD_MANUFACTURER
1216 Define this string as the name of your company for
1217 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001218
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001219 CONFIG_USBD_PRODUCT_NAME
1220 Define this string as the name of your product
1221 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1222
1223 CONFIG_USBD_VENDORID
1224 Define this as your assigned Vendor ID from the USB
1225 Implementors Forum. This *must* be a genuine Vendor ID
1226 to avoid polluting the USB namespace.
1227 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001228
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001229 CONFIG_USBD_PRODUCTID
1230 Define this as the unique Product ID
1231 for your device
1232 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001233
Igor Grinbergd70a5602011-12-12 12:08:35 +02001234- ULPI Layer Support:
1235 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1236 the generic ULPI layer. The generic layer accesses the ULPI PHY
1237 via the platform viewport, so you need both the genric layer and
1238 the viewport enabled. Currently only Chipidea/ARC based
1239 viewport is supported.
1240 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1241 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001242
1243- MMC Support:
1244 The MMC controller on the Intel PXA is supported. To
1245 enable this define CONFIG_MMC. The MMC can be
1246 accessed from the boot prompt by mapping the device
1247 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001248 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1249 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001250
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001251 CONFIG_SH_MMCIF
1252 Support for Renesas on-chip MMCIF controller
1253
1254 CONFIG_SH_MMCIF_ADDR
1255 Define the base address of MMCIF registers
1256
1257 CONFIG_SH_MMCIF_CLK
1258 Define the clock frequency for MMCIF
1259
wdenk6705d812004-08-02 23:22:59 +00001260- Journaling Flash filesystem support:
1261 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1262 CONFIG_JFFS2_NAND_DEV
1263 Define these for a default partition on a NAND device
1264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001265 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1266 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001267 Define these for a default partition on a NOR device
1268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001269 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001270 Define this to create an own partition. You have to provide a
1271 function struct part_info* jffs2_part_info(int part_num)
1272
1273 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001274 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001275 to disable the command chpart. This is the default when you
1276 have not defined a custom partition
1277
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001278- FAT(File Allocation Table) filesystem write function support:
1279 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001280
1281 Define this to enable support for saving memory data as a
1282 file in FAT formatted partition.
1283
1284 This will also enable the command "fatwrite" enabling the
1285 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001286
wdenkc6097192002-11-03 00:24:07 +00001287- Keyboard Support:
1288 CONFIG_ISA_KEYBOARD
1289
1290 Define this to enable standard (PC-Style) keyboard
1291 support
1292
1293 CONFIG_I8042_KBD
1294 Standard PC keyboard driver with US (is default) and
1295 GERMAN key layout (switch via environment 'keymap=de') support.
1296 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1297 for cfb_console. Supports cursor blinking.
1298
1299- Video support:
1300 CONFIG_VIDEO
1301
1302 Define this to enable video support (for output to
1303 video).
1304
1305 CONFIG_VIDEO_CT69000
1306
1307 Enable Chips & Technologies 69000 Video chip
1308
1309 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001310 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001311 video output is selected via environment 'videoout'
1312 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1313 assumed.
wdenkc6097192002-11-03 00:24:07 +00001314
wdenkb79a11c2004-03-25 15:14:43 +00001315 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001316 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001317 are possible:
1318 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001319 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001320
1321 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1322 -------------+---------------------------------------------
1323 8 bits | 0x301* 0x303 0x305 0x161 0x307
1324 15 bits | 0x310 0x313 0x316 0x162 0x319
1325 16 bits | 0x311 0x314 0x317 0x163 0x31A
1326 24 bits | 0x312 0x315 0x318 ? 0x31B
1327 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001328 (i.e. setenv videomode 317; saveenv; reset;)
1329
wdenkb79a11c2004-03-25 15:14:43 +00001330 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001331 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001332
1333
stroesec1551ea2003-04-04 15:53:41 +00001334 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001335 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001336 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1337 or CONFIG_VIDEO_SED13806_16BPP
1338
Timur Tabi7d3053f2011-02-15 17:09:19 -06001339 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001340 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001341 SOCs that have a DIU should define this macro to enable DIU
1342 support, and should also define these other macros:
1343
1344 CONFIG_SYS_DIU_ADDR
1345 CONFIG_VIDEO
1346 CONFIG_CMD_BMP
1347 CONFIG_CFB_CONSOLE
1348 CONFIG_VIDEO_SW_CURSOR
1349 CONFIG_VGA_AS_SINGLE_DEVICE
1350 CONFIG_VIDEO_LOGO
1351 CONFIG_VIDEO_BMP_LOGO
1352
Timur Tabiba8e76b2011-04-11 14:18:22 -05001353 The DIU driver will look for the 'video-mode' environment
1354 variable, and if defined, enable the DIU as a console during
1355 boot. See the documentation file README.video for a
1356 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001357
wdenk682011f2003-06-03 23:54:09 +00001358- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001359 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001360
wdenk8bde7f72003-06-27 21:31:46 +00001361 Define this to enable a custom keyboard support.
1362 This simply calls drv_keyboard_init() which must be
1363 defined in your board-specific files.
1364 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001365
wdenkc6097192002-11-03 00:24:07 +00001366- LCD Support: CONFIG_LCD
1367
1368 Define this to enable LCD support (for output to LCD
1369 display); also select one of the supported displays
1370 by defining one of these:
1371
Stelian Pop39cf4802008-05-09 21:57:18 +02001372 CONFIG_ATMEL_LCD:
1373
1374 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1375
wdenkfd3103b2003-11-25 16:55:19 +00001376 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001377
wdenkfd3103b2003-11-25 16:55:19 +00001378 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001379
wdenkfd3103b2003-11-25 16:55:19 +00001380 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001381
wdenkfd3103b2003-11-25 16:55:19 +00001382 NEC NL6448BC20-08. 6.5", 640x480.
1383 Active, color, single scan.
1384
1385 CONFIG_NEC_NL6448BC33_54
1386
1387 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001388 Active, color, single scan.
1389
1390 CONFIG_SHARP_16x9
1391
1392 Sharp 320x240. Active, color, single scan.
1393 It isn't 16x9, and I am not sure what it is.
1394
1395 CONFIG_SHARP_LQ64D341
1396
1397 Sharp LQ64D341 display, 640x480.
1398 Active, color, single scan.
1399
1400 CONFIG_HLD1045
1401
1402 HLD1045 display, 640x480.
1403 Active, color, single scan.
1404
1405 CONFIG_OPTREX_BW
1406
1407 Optrex CBL50840-2 NF-FW 99 22 M5
1408 or
1409 Hitachi LMG6912RPFC-00T
1410 or
1411 Hitachi SP14Q002
1412
1413 320x240. Black & white.
1414
1415 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001416 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001417
wdenk7152b1d2003-09-05 23:19:14 +00001418- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001419
wdenk8bde7f72003-06-27 21:31:46 +00001420 If this option is set, the environment is checked for
1421 a variable "splashimage". If found, the usual display
1422 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001423 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001424 specified in "splashimage" is loaded instead. The
1425 console is redirected to the "nulldev", too. This
1426 allows for a "silent" boot where a splash screen is
1427 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001428
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001429 CONFIG_SPLASH_SCREEN_ALIGN
1430
1431 If this option is set the splash image can be freely positioned
1432 on the screen. Environment variable "splashpos" specifies the
1433 position as "x,y". If a positive number is given it is used as
1434 number of pixel from left/top. If a negative number is given it
1435 is used as number of pixel from right/bottom. You can also
1436 specify 'm' for centering the image.
1437
1438 Example:
1439 setenv splashpos m,m
1440 => image at center of screen
1441
1442 setenv splashpos 30,20
1443 => image at x = 30 and y = 20
1444
1445 setenv splashpos -10,m
1446 => vertically centered image
1447 at x = dspWidth - bmpWidth - 9
1448
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001449- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1450
1451 If this option is set, additionally to standard BMP
1452 images, gzipped BMP images can be displayed via the
1453 splashscreen support or the bmp command.
1454
Anatolij Gustschind5011762010-03-15 14:50:25 +01001455- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1456
1457 If this option is set, 8-bit RLE compressed BMP images
1458 can be displayed via the splashscreen support or the
1459 bmp command.
1460
wdenkc29fdfc2003-08-29 20:57:53 +00001461- Compression support:
1462 CONFIG_BZIP2
1463
1464 If this option is set, support for bzip2 compressed
1465 images is included. If not, only uncompressed and gzip
1466 compressed images are supported.
1467
wdenk42d1f032003-10-15 23:53:47 +00001468 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001469 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001470 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001471
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001472 CONFIG_LZMA
1473
1474 If this option is set, support for lzma compressed
1475 images is included.
1476
1477 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1478 requires an amount of dynamic memory that is given by the
1479 formula:
1480
1481 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1482
1483 Where lc and lp stand for, respectively, Literal context bits
1484 and Literal pos bits.
1485
1486 This value is upper-bounded by 14MB in the worst case. Anyway,
1487 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1488 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1489 a very small buffer.
1490
1491 Use the lzmainfo tool to determinate the lc and lp values and
1492 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001493 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001494
wdenk17ea1172004-06-06 21:51:03 +00001495- MII/PHY support:
1496 CONFIG_PHY_ADDR
1497
1498 The address of PHY on MII bus.
1499
1500 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1501
1502 The clock frequency of the MII bus
1503
1504 CONFIG_PHY_GIGE
1505
1506 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001507 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001508
1509 CONFIG_PHY_RESET_DELAY
1510
1511 Some PHY like Intel LXT971A need extra delay after
1512 reset before any MII register access is possible.
1513 For such PHY, set this option to the usec delay
1514 required. (minimum 300usec for LXT971A)
1515
1516 CONFIG_PHY_CMD_DELAY (ppc4xx)
1517
1518 Some PHY like Intel LXT971A need extra delay after
1519 command issued before MII status register can be read
1520
wdenkc6097192002-11-03 00:24:07 +00001521- Ethernet address:
1522 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001523 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001524 CONFIG_ETH2ADDR
1525 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001526 CONFIG_ETH4ADDR
1527 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001528
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001529 Define a default value for Ethernet address to use
1530 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001531 is not determined automatically.
1532
1533- IP address:
1534 CONFIG_IPADDR
1535
1536 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001537 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001538 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001539 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001540
1541- Server IP address:
1542 CONFIG_SERVERIP
1543
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001544 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001545 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001546 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001547
Robin Getz97cfe862009-07-21 12:15:28 -04001548 CONFIG_KEEP_SERVERADDR
1549
1550 Keeps the server's MAC address, in the env 'serveraddr'
1551 for passing to bootargs (like Linux's netconsole option)
1552
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001553- Gateway IP address:
1554 CONFIG_GATEWAYIP
1555
1556 Defines a default value for the IP address of the
1557 default router where packets to other networks are
1558 sent to.
1559 (Environment variable "gatewayip")
1560
1561- Subnet mask:
1562 CONFIG_NETMASK
1563
1564 Defines a default value for the subnet mask (or
1565 routing prefix) which is used to determine if an IP
1566 address belongs to the local subnet or needs to be
1567 forwarded through a router.
1568 (Environment variable "netmask")
1569
David Updegraff53a5c422007-06-11 10:41:07 -05001570- Multicast TFTP Mode:
1571 CONFIG_MCAST_TFTP
1572
1573 Defines whether you want to support multicast TFTP as per
1574 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001575 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001576 driver in use must provide a function: mcast() to join/leave a
1577 multicast group.
1578
wdenkc6097192002-11-03 00:24:07 +00001579- BOOTP Recovery Mode:
1580 CONFIG_BOOTP_RANDOM_DELAY
1581
1582 If you have many targets in a network that try to
1583 boot using BOOTP, you may want to avoid that all
1584 systems send out BOOTP requests at precisely the same
1585 moment (which would happen for instance at recovery
1586 from a power failure, when all systems will try to
1587 boot, thus flooding the BOOTP server. Defining
1588 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1589 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001590 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001591
1592 1st BOOTP request: delay 0 ... 1 sec
1593 2nd BOOTP request: delay 0 ... 2 sec
1594 3rd BOOTP request: delay 0 ... 4 sec
1595 4th and following
1596 BOOTP requests: delay 0 ... 8 sec
1597
stroesefe389a82003-08-28 14:17:32 +00001598- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001599 You can fine tune the DHCP functionality by defining
1600 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001601
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001602 CONFIG_BOOTP_SUBNETMASK
1603 CONFIG_BOOTP_GATEWAY
1604 CONFIG_BOOTP_HOSTNAME
1605 CONFIG_BOOTP_NISDOMAIN
1606 CONFIG_BOOTP_BOOTPATH
1607 CONFIG_BOOTP_BOOTFILESIZE
1608 CONFIG_BOOTP_DNS
1609 CONFIG_BOOTP_DNS2
1610 CONFIG_BOOTP_SEND_HOSTNAME
1611 CONFIG_BOOTP_NTPSERVER
1612 CONFIG_BOOTP_TIMEOFFSET
1613 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001614 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001615
Wilson Callan5d110f02007-07-28 10:56:13 -04001616 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1617 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001618
Joe Hershberger2c00e092012-05-23 07:59:19 +00001619 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1620 after the configured retry count, the call will fail
1621 instead of starting over. This can be used to fail over
1622 to Link-local IP address configuration if the DHCP server
1623 is not available.
1624
stroesefe389a82003-08-28 14:17:32 +00001625 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1626 serverip from a DHCP server, it is possible that more
1627 than one DNS serverip is offered to the client.
1628 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1629 serverip will be stored in the additional environment
1630 variable "dnsip2". The first DNS serverip is always
1631 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001632 is defined.
stroesefe389a82003-08-28 14:17:32 +00001633
1634 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1635 to do a dynamic update of a DNS server. To do this, they
1636 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001637 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001638 of the "hostname" environment variable is passed as
1639 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001640
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001641 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1642
1643 A 32bit value in microseconds for a delay between
1644 receiving a "DHCP Offer" and sending the "DHCP Request".
1645 This fixes a problem with certain DHCP servers that don't
1646 respond 100% of the time to a "DHCP request". E.g. On an
1647 AT91RM9200 processor running at 180MHz, this delay needed
1648 to be *at least* 15,000 usec before a Windows Server 2003
1649 DHCP server would reply 100% of the time. I recommend at
1650 least 50,000 usec to be safe. The alternative is to hope
1651 that one of the retries will be successful but note that
1652 the DHCP timeout and retry process takes a longer than
1653 this delay.
1654
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001655 - Link-local IP address negotiation:
1656 Negotiate with other link-local clients on the local network
1657 for an address that doesn't require explicit configuration.
1658 This is especially useful if a DHCP server cannot be guaranteed
1659 to exist in all environments that the device must operate.
1660
1661 See doc/README.link-local for more information.
1662
wdenka3d991b2004-04-15 21:48:45 +00001663 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001664 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001665
1666 The device id used in CDP trigger frames.
1667
1668 CONFIG_CDP_DEVICE_ID_PREFIX
1669
1670 A two character string which is prefixed to the MAC address
1671 of the device.
1672
1673 CONFIG_CDP_PORT_ID
1674
1675 A printf format string which contains the ascii name of
1676 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001677 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001678
1679 CONFIG_CDP_CAPABILITIES
1680
1681 A 32bit integer which indicates the device capabilities;
1682 0x00000010 for a normal host which does not forwards.
1683
1684 CONFIG_CDP_VERSION
1685
1686 An ascii string containing the version of the software.
1687
1688 CONFIG_CDP_PLATFORM
1689
1690 An ascii string containing the name of the platform.
1691
1692 CONFIG_CDP_TRIGGER
1693
1694 A 32bit integer sent on the trigger.
1695
1696 CONFIG_CDP_POWER_CONSUMPTION
1697
1698 A 16bit integer containing the power consumption of the
1699 device in .1 of milliwatts.
1700
1701 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1702
1703 A byte containing the id of the VLAN.
1704
wdenkc6097192002-11-03 00:24:07 +00001705- Status LED: CONFIG_STATUS_LED
1706
1707 Several configurations allow to display the current
1708 status using a LED. For instance, the LED will blink
1709 fast while running U-Boot code, stop blinking as
1710 soon as a reply to a BOOTP request was received, and
1711 start blinking slow once the Linux kernel is running
1712 (supported by a status LED driver in the Linux
1713 kernel). Defining CONFIG_STATUS_LED enables this
1714 feature in U-Boot.
1715
1716- CAN Support: CONFIG_CAN_DRIVER
1717
1718 Defining CONFIG_CAN_DRIVER enables CAN driver support
1719 on those systems that support this (optional)
1720 feature, like the TQM8xxL modules.
1721
1722- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1723
wdenkb37c7e52003-06-30 16:24:52 +00001724 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001725 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001726 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001727
wdenk945af8d2003-07-16 21:53:01 +00001728 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001729 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001730 CONFIG_COMMANDS) and communicate with i2c based realtime
1731 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001732 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001733
Ben Warrenbb99ad62006-09-07 16:50:54 -04001734 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001735
wdenk945af8d2003-07-16 21:53:01 +00001736 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001737 bit-banging) driver instead of CPM or similar hardware
1738 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001739
wdenk945af8d2003-07-16 21:53:01 +00001740 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001741 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001743 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001744 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001745 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001746 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001747
Peter Tyser8d321b82010-04-12 22:28:21 -05001748 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001749 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001750 and so its address should therefore be cleared to 0 (See,
1751 eg, MPC823e User's Manual p.16-473). So, set
1752 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001753
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001754 CONFIG_SYS_I2C_INIT_MPC5XXX
1755
1756 When a board is reset during an i2c bus transfer
1757 chips might think that the current transfer is still
1758 in progress. Reset the slave devices by sending start
1759 commands until the slave device responds.
1760
wdenk945af8d2003-07-16 21:53:01 +00001761 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001762
1763 If you use the software i2c interface (CONFIG_SOFT_I2C)
1764 then the following macros need to be defined (examples are
1765 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001766
1767 I2C_INIT
1768
wdenkb37c7e52003-06-30 16:24:52 +00001769 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001770 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001771
wdenkba56f622004-02-06 23:19:44 +00001772 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001773
wdenkc6097192002-11-03 00:24:07 +00001774 I2C_PORT
1775
wdenk43d96162003-03-06 00:02:04 +00001776 (Only for MPC8260 CPU). The I/O port to use (the code
1777 assumes both bits are on the same port). Valid values
1778 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001779
1780 I2C_ACTIVE
1781
1782 The code necessary to make the I2C data line active
1783 (driven). If the data line is open collector, this
1784 define can be null.
1785
wdenkb37c7e52003-06-30 16:24:52 +00001786 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1787
wdenkc6097192002-11-03 00:24:07 +00001788 I2C_TRISTATE
1789
1790 The code necessary to make the I2C data line tri-stated
1791 (inactive). If the data line is open collector, this
1792 define can be null.
1793
wdenkb37c7e52003-06-30 16:24:52 +00001794 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1795
wdenkc6097192002-11-03 00:24:07 +00001796 I2C_READ
1797
1798 Code that returns TRUE if the I2C data line is high,
1799 FALSE if it is low.
1800
wdenkb37c7e52003-06-30 16:24:52 +00001801 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1802
wdenkc6097192002-11-03 00:24:07 +00001803 I2C_SDA(bit)
1804
1805 If <bit> is TRUE, sets the I2C data line high. If it
1806 is FALSE, it clears it (low).
1807
wdenkb37c7e52003-06-30 16:24:52 +00001808 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001809 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001810 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001811
wdenkc6097192002-11-03 00:24:07 +00001812 I2C_SCL(bit)
1813
1814 If <bit> is TRUE, sets the I2C clock line high. If it
1815 is FALSE, it clears it (low).
1816
wdenkb37c7e52003-06-30 16:24:52 +00001817 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001818 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001819 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001820
wdenkc6097192002-11-03 00:24:07 +00001821 I2C_DELAY
1822
1823 This delay is invoked four times per clock cycle so this
1824 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001825 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001826 like:
1827
wdenkb37c7e52003-06-30 16:24:52 +00001828 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001829
Mike Frysinger793b5722010-07-21 13:38:02 -04001830 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1831
1832 If your arch supports the generic GPIO framework (asm/gpio.h),
1833 then you may alternatively define the two GPIOs that are to be
1834 used as SCL / SDA. Any of the previous I2C_xxx macros will
1835 have GPIO-based defaults assigned to them as appropriate.
1836
1837 You should define these to the GPIO value as given directly to
1838 the generic GPIO functions.
1839
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001840 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001841
wdenk8bde7f72003-06-27 21:31:46 +00001842 When a board is reset during an i2c bus transfer
1843 chips might think that the current transfer is still
1844 in progress. On some boards it is possible to access
1845 the i2c SCLK line directly, either by using the
1846 processor pin as a GPIO or by having a second pin
1847 connected to the bus. If this option is defined a
1848 custom i2c_init_board() routine in boards/xxx/board.c
1849 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001850
Richard Retanubun26a33502010-04-12 15:08:17 -04001851 CONFIG_SYS_I2C_BOARD_LATE_INIT
1852
1853 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1854 defined a custom i2c_board_late_init() routine in
1855 boards/xxx/board.c is run AFTER the operations in i2c_init()
1856 is completed. This callpoint can be used to unreset i2c bus
1857 using CPU i2c controller register accesses for CPUs whose i2c
1858 controller provide such a method. It is called at the end of
1859 i2c_init() to allow i2c_init operations to setup the i2c bus
1860 controller on the CPU (e.g. setting bus speed & slave address).
1861
wdenk17ea1172004-06-06 21:51:03 +00001862 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1863
1864 This option enables configuration of bi_iic_fast[] flags
1865 in u-boot bd_info structure based on u-boot environment
1866 variable "i2cfast". (see also i2cfast)
1867
Ben Warrenbb99ad62006-09-07 16:50:54 -04001868 CONFIG_I2C_MULTI_BUS
1869
1870 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001871 must have a controller. At any point in time, only one bus is
1872 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001873 Note that bus numbering is zero-based.
1874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001875 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001876
1877 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001878 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001879 is set, specify a list of bus-device pairs. Otherwise, specify
1880 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001881
1882 e.g.
1883 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001884 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001885
1886 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1887
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001888 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001889 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001890
1891 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001893 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001894
1895 If defined, then this indicates the I2C bus number for DDR SPD.
1896 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001898 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001899
1900 If defined, then this indicates the I2C bus number for the RTC.
1901 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001903 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001904
1905 If defined, then this indicates the I2C bus number for the DTT.
1906 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001908 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001909
1910 If defined, specifies the I2C address of the DTT device.
1911 If not defined, then U-Boot uses predefined value for
1912 specified DTT device.
1913
Timur Tabibe5e6182006-11-03 19:15:00 -06001914 CONFIG_FSL_I2C
1915
1916 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001917 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001918
Heiko Schocher67b23a32008-10-15 09:39:47 +02001919 CONFIG_I2C_MUX
1920
1921 Define this option if you have I2C devices reached over 1 .. n
1922 I2C Muxes like the pca9544a. This option addes a new I2C
1923 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1924 new I2C Bus to the existing I2C Busses. If you select the
1925 new Bus with "i2c dev", u-bbot sends first the commandos for
1926 the muxes to activate this new "bus".
1927
1928 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1929 feature!
1930
1931 Example:
1932 Adding a new I2C Bus reached over 2 pca9544a muxes
1933 The First mux with address 70 and channel 6
1934 The Second mux with address 71 and channel 4
1935
1936 => i2c bus pca9544a:70:6:pca9544a:71:4
1937
1938 Use the "i2c bus" command without parameter, to get a list
1939 of I2C Busses with muxes:
1940
1941 => i2c bus
1942 Busses reached over muxes:
1943 Bus ID: 2
1944 reached over Mux(es):
1945 pca9544a@70 ch: 4
1946 Bus ID: 3
1947 reached over Mux(es):
1948 pca9544a@70 ch: 6
1949 pca9544a@71 ch: 4
1950 =>
1951
1952 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001953 u-boot first sends the command to the mux@70 to enable
1954 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001955 the channel 4.
1956
1957 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001958 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001959 the 2 muxes.
1960
1961 This option is actually implemented for the bitbanging
1962 algorithm in common/soft_i2c.c and for the Hardware I2C
1963 Bus on the MPC8260. But it should be not so difficult
1964 to add this option to other architectures.
1965
Andrew Dyer2ac69852008-12-29 17:36:01 -06001966 CONFIG_SOFT_I2C_READ_REPEATED_START
1967
1968 defining this will force the i2c_read() function in
1969 the soft_i2c driver to perform an I2C repeated start
1970 between writing the address pointer and reading the
1971 data. If this define is omitted the default behaviour
1972 of doing a stop-start sequence will be used. Most I2C
1973 devices can use either method, but some require one or
1974 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001975
wdenkc6097192002-11-03 00:24:07 +00001976- SPI Support: CONFIG_SPI
1977
1978 Enables SPI driver (so far only tested with
1979 SPI EEPROM, also an instance works with Crystal A/D and
1980 D/As on the SACSng board)
1981
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001982 CONFIG_SH_SPI
1983
1984 Enables the driver for SPI controller on SuperH. Currently
1985 only SH7757 is supported.
1986
wdenkc6097192002-11-03 00:24:07 +00001987 CONFIG_SPI_X
1988
1989 Enables extended (16-bit) SPI EEPROM addressing.
1990 (symmetrical to CONFIG_I2C_X)
1991
1992 CONFIG_SOFT_SPI
1993
wdenk43d96162003-03-06 00:02:04 +00001994 Enables a software (bit-bang) SPI driver rather than
1995 using hardware support. This is a general purpose
1996 driver that only requires three general I/O port pins
1997 (two outputs, one input) to function. If this is
1998 defined, the board configuration must define several
1999 SPI configuration items (port pins to use, etc). For
2000 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002001
Ben Warren04a9e112008-01-16 22:37:35 -05002002 CONFIG_HARD_SPI
2003
2004 Enables a hardware SPI driver for general-purpose reads
2005 and writes. As with CONFIG_SOFT_SPI, the board configuration
2006 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002007 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002008 example, see include/configs/mpc8349emds.h.
2009
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002010 CONFIG_MXC_SPI
2011
2012 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002013 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002014
Matthias Fuchs01335022007-12-27 17:12:34 +01002015- FPGA Support: CONFIG_FPGA
2016
2017 Enables FPGA subsystem.
2018
2019 CONFIG_FPGA_<vendor>
2020
2021 Enables support for specific chip vendors.
2022 (ALTERA, XILINX)
2023
2024 CONFIG_FPGA_<family>
2025
2026 Enables support for FPGA family.
2027 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2028
2029 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002030
wdenk43d96162003-03-06 00:02:04 +00002031 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002033 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002034
wdenk8bde7f72003-06-27 21:31:46 +00002035 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002037 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002038
wdenk43d96162003-03-06 00:02:04 +00002039 Enable checks on FPGA configuration interface busy
2040 status by the configuration function. This option
2041 will require a board or device specific function to
2042 be written.
wdenkc6097192002-11-03 00:24:07 +00002043
2044 CONFIG_FPGA_DELAY
2045
2046 If defined, a function that provides delays in the FPGA
2047 configuration driver.
2048
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002049 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002050 Allow Control-C to interrupt FPGA configuration
2051
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002052 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002053
wdenk43d96162003-03-06 00:02:04 +00002054 Check for configuration errors during FPGA bitfile
2055 loading. For example, abort during Virtex II
2056 configuration if the INIT_B line goes low (which
2057 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002059 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002060
wdenk43d96162003-03-06 00:02:04 +00002061 Maximum time to wait for the INIT_B line to deassert
2062 after PROB_B has been deasserted during a Virtex II
2063 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002064 ms.
wdenkc6097192002-11-03 00:24:07 +00002065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002066 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002067
wdenk43d96162003-03-06 00:02:04 +00002068 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002069 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002071 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002072
wdenk43d96162003-03-06 00:02:04 +00002073 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002074 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002075
2076- Configuration Management:
2077 CONFIG_IDENT_STRING
2078
wdenk43d96162003-03-06 00:02:04 +00002079 If defined, this string will be added to the U-Boot
2080 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002081
2082- Vendor Parameter Protection:
2083
wdenk43d96162003-03-06 00:02:04 +00002084 U-Boot considers the values of the environment
2085 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002086 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002087 are set once by the board vendor / manufacturer, and
2088 protects these variables from casual modification by
2089 the user. Once set, these variables are read-only,
2090 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002091 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002092
2093 If CONFIG_ENV_OVERWRITE is #defined in your config
2094 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002095 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002096 these parameters.
2097
2098 Alternatively, if you #define _both_ CONFIG_ETHADDR
2099 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002100 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002101 which can be changed exactly ONCE by the user. [The
2102 serial# is unaffected by this, i. e. it remains
2103 read-only.]
2104
2105- Protected RAM:
2106 CONFIG_PRAM
2107
2108 Define this variable to enable the reservation of
2109 "protected RAM", i. e. RAM which is not overwritten
2110 by U-Boot. Define CONFIG_PRAM to hold the number of
2111 kB you want to reserve for pRAM. You can overwrite
2112 this default value by defining an environment
2113 variable "pram" to the number of kB you want to
2114 reserve. Note that the board info structure will
2115 still show the full amount of RAM. If pRAM is
2116 reserved, a new environment variable "mem" will
2117 automatically be defined to hold the amount of
2118 remaining RAM in a form that can be passed as boot
2119 argument to Linux, for instance like that:
2120
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002121 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002122 saveenv
2123
2124 This way you can tell Linux not to use this memory,
2125 either, which results in a memory region that will
2126 not be affected by reboots.
2127
2128 *WARNING* If your board configuration uses automatic
2129 detection of the RAM size, you must make sure that
2130 this memory test is non-destructive. So far, the
2131 following board configurations are known to be
2132 "pRAM-clean":
2133
2134 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2135 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002136 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002137
2138- Error Recovery:
2139 CONFIG_PANIC_HANG
2140
2141 Define this variable to stop the system in case of a
2142 fatal error, so that you have to reset it manually.
2143 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002145 automatically as fast as possible, but it may be
2146 useful during development since you can try to debug
2147 the conditions that lead to the situation.
2148
2149 CONFIG_NET_RETRY_COUNT
2150
wdenk43d96162003-03-06 00:02:04 +00002151 This variable defines the number of retries for
2152 network operations like ARP, RARP, TFTP, or BOOTP
2153 before giving up the operation. If not defined, a
2154 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002155
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002156 CONFIG_ARP_TIMEOUT
2157
2158 Timeout waiting for an ARP reply in milliseconds.
2159
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002160 CONFIG_NFS_TIMEOUT
2161
2162 Timeout in milliseconds used in NFS protocol.
2163 If you encounter "ERROR: Cannot umount" in nfs command,
2164 try longer timeout such as
2165 #define CONFIG_NFS_TIMEOUT 10000UL
2166
wdenkc6097192002-11-03 00:24:07 +00002167- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002168 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002169
2170 Enable auto completion of commands using TAB.
2171
Wolfgang Denka9398e02006-11-27 15:32:42 +01002172 Note that this feature has NOT been implemented yet
2173 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002174
2175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002176 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002177
2178 Define this variable to enable the "hush" shell (from
2179 Busybox) as command line interpreter, thus enabling
2180 powerful command line syntax like
2181 if...then...else...fi conditionals or `&&' and '||'
2182 constructs ("shell scripts").
2183
2184 If undefined, you get the old, much simpler behaviour
2185 with a somewhat smaller memory footprint.
2186
2187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002188 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002189
2190 This defines the secondary prompt string, which is
2191 printed when the command interpreter needs more input
2192 to complete a command. Usually "> ".
2193
2194 Note:
2195
wdenk8bde7f72003-06-27 21:31:46 +00002196 In the current implementation, the local variables
2197 space and global environment variables space are
2198 separated. Local variables are those you define by
2199 simply typing `name=value'. To access a local
2200 variable later on, you have write `$name' or
2201 `${name}'; to execute the contents of a variable
2202 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002203
wdenk43d96162003-03-06 00:02:04 +00002204 Global environment variables are those you use
2205 setenv/printenv to work with. To run a command stored
2206 in such a variable, you need to use the run command,
2207 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002208
2209 To store commands and special characters in a
2210 variable, please use double quotation marks
2211 surrounding the whole text of the variable, instead
2212 of the backslashes before semicolons and special
2213 symbols.
2214
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002215- Commandline Editing and History:
2216 CONFIG_CMDLINE_EDITING
2217
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002218 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002219 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002220
wdenka8c7c702003-12-06 19:49:23 +00002221- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002222 CONFIG_EXTRA_ENV_SETTINGS
2223
wdenk43d96162003-03-06 00:02:04 +00002224 Define this to contain any number of null terminated
2225 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002226 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002227
wdenk43d96162003-03-06 00:02:04 +00002228 For example, place something like this in your
2229 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002230
2231 #define CONFIG_EXTRA_ENV_SETTINGS \
2232 "myvar1=value1\0" \
2233 "myvar2=value2\0"
2234
wdenk43d96162003-03-06 00:02:04 +00002235 Warning: This method is based on knowledge about the
2236 internal format how the environment is stored by the
2237 U-Boot code. This is NOT an official, exported
2238 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002239 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002240 You better know what you are doing here.
2241
wdenk43d96162003-03-06 00:02:04 +00002242 Note: overly (ab)use of the default environment is
2243 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002244 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002245 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002246
Stephen Warren5e724ca2012-05-22 09:21:54 +00002247 CONFIG_ENV_VARS_UBOOT_CONFIG
2248
2249 Define this in order to add variables describing the
2250 U-Boot build configuration to the default environment.
2251 These will be named arch, cpu, board, vendor, and soc.
2252
2253 Enabling this option will cause the following to be defined:
2254
2255 - CONFIG_SYS_ARCH
2256 - CONFIG_SYS_CPU
2257 - CONFIG_SYS_BOARD
2258 - CONFIG_SYS_VENDOR
2259 - CONFIG_SYS_SOC
2260
wdenka8c7c702003-12-06 19:49:23 +00002261- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002262 CONFIG_HAS_DATAFLASH
2263
wdenk8bde7f72003-06-27 21:31:46 +00002264 Defining this option enables DataFlash features and
2265 allows to read/write in Dataflash via the standard
2266 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002267
Eric Nelsonf61ec452012-01-31 10:52:08 -07002268- Serial Flash support
2269 CONFIG_CMD_SF
2270
2271 Defining this option enables SPI flash commands
2272 'sf probe/read/write/erase/update'.
2273
2274 Usage requires an initial 'probe' to define the serial
2275 flash parameters, followed by read/write/erase/update
2276 commands.
2277
2278 The following defaults may be provided by the platform
2279 to handle the common case when only a single serial
2280 flash is present on the system.
2281
2282 CONFIG_SF_DEFAULT_BUS Bus identifier
2283 CONFIG_SF_DEFAULT_CS Chip-select
2284 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2285 CONFIG_SF_DEFAULT_SPEED in Hz
2286
wdenk3f85ce22004-02-23 16:11:30 +00002287- SystemACE Support:
2288 CONFIG_SYSTEMACE
2289
2290 Adding this option adds support for Xilinx SystemACE
2291 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002292 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002293 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002294
2295 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002296 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002297
2298 When SystemACE support is added, the "ace" device type
2299 becomes available to the fat commands, i.e. fatls.
2300
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002301- TFTP Fixed UDP Port:
2302 CONFIG_TFTP_PORT
2303
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002304 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002305 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002306 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002307 number generator is used.
2308
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002309 Also, the environment variable tftpdstp is used to supply
2310 the TFTP UDP destination port value. If tftpdstp isn't
2311 defined, the normal port 69 is used.
2312
2313 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002314 blindly start the TFTP transfer using the pre-configured
2315 target IP address and UDP port. This has the effect of
2316 "punching through" the (Windows XP) firewall, allowing
2317 the remainder of the TFTP transfer to proceed normally.
2318 A better solution is to properly configure the firewall,
2319 but sometimes that is not allowed.
2320
wdenka8c7c702003-12-06 19:49:23 +00002321- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002322 CONFIG_SHOW_BOOT_PROGRESS
2323
wdenk43d96162003-03-06 00:02:04 +00002324 Defining this option allows to add some board-
2325 specific code (calling a user-provided function
2326 "show_boot_progress(int)") that enables you to show
2327 the system's boot progress on some display (for
2328 example, some LED's) on your board. At the moment,
2329 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002330
Simon Glass3a608ca2012-02-13 13:51:19 +00002331- Detailed boot stage timing
2332 CONFIG_BOOTSTAGE
2333 Define this option to get detailed timing of each stage
2334 of the boot process.
2335
2336 CONFIG_BOOTSTAGE_USER_COUNT
2337 This is the number of available user bootstage records.
2338 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2339 a new ID will be allocated from this stash. If you exceed
2340 the limit, recording will stop.
2341
2342 CONFIG_BOOTSTAGE_REPORT
2343 Define this to print a report before boot, similar to this:
2344
2345 Timer summary in microseconds:
2346 Mark Elapsed Stage
2347 0 0 reset
2348 3,575,678 3,575,678 board_init_f start
2349 3,575,695 17 arch_cpu_init A9
2350 3,575,777 82 arch_cpu_init done
2351 3,659,598 83,821 board_init_r start
2352 3,910,375 250,777 main_loop
2353 29,916,167 26,005,792 bootm_start
2354 30,361,327 445,160 start_kernel
2355
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002356Legacy uImage format:
2357
wdenkc6097192002-11-03 00:24:07 +00002358 Arg Where When
2359 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002360 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002361 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002362 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002363 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002364 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002365 4 common/cmd_bootm.c Image data has correct checksum
2366 -4 common/cmd_bootm.c Image is for unsupported architecture
2367 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002368 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002369 6 common/cmd_bootm.c Image Type check OK
2370 -6 common/cmd_bootm.c gunzip uncompression error
2371 -7 common/cmd_bootm.c Unimplemented compression type
2372 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002373 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002374 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002375
2376 9 common/image.c Start initial ramdisk verification
2377 -10 common/image.c Ramdisk header has bad magic number
2378 -11 common/image.c Ramdisk header has bad checksum
2379 10 common/image.c Ramdisk header is OK
2380 -12 common/image.c Ramdisk data has bad checksum
2381 11 common/image.c Ramdisk data has correct checksum
2382 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002383 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002384 13 common/image.c Start multifile image verification
2385 14 common/image.c No initial ramdisk, no multifile, continue.
2386
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002387 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002388
Stefan Roesea47a12b2010-04-15 16:07:28 +02002389 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002390 -31 post/post.c POST test failed, detected by post_output_backlog()
2391 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002392
Heiko Schocher566a4942007-06-22 19:11:54 +02002393 34 common/cmd_doc.c before loading a Image from a DOC device
2394 -35 common/cmd_doc.c Bad usage of "doc" command
2395 35 common/cmd_doc.c correct usage of "doc" command
2396 -36 common/cmd_doc.c No boot device
2397 36 common/cmd_doc.c correct boot device
2398 -37 common/cmd_doc.c Unknown Chip ID on boot device
2399 37 common/cmd_doc.c correct chip ID found, device available
2400 -38 common/cmd_doc.c Read Error on boot device
2401 38 common/cmd_doc.c reading Image header from DOC device OK
2402 -39 common/cmd_doc.c Image header has bad magic number
2403 39 common/cmd_doc.c Image header has correct magic number
2404 -40 common/cmd_doc.c Error reading Image from DOC device
2405 40 common/cmd_doc.c Image header has correct magic number
2406 41 common/cmd_ide.c before loading a Image from a IDE device
2407 -42 common/cmd_ide.c Bad usage of "ide" command
2408 42 common/cmd_ide.c correct usage of "ide" command
2409 -43 common/cmd_ide.c No boot device
2410 43 common/cmd_ide.c boot device found
2411 -44 common/cmd_ide.c Device not available
2412 44 common/cmd_ide.c Device available
2413 -45 common/cmd_ide.c wrong partition selected
2414 45 common/cmd_ide.c partition selected
2415 -46 common/cmd_ide.c Unknown partition table
2416 46 common/cmd_ide.c valid partition table found
2417 -47 common/cmd_ide.c Invalid partition type
2418 47 common/cmd_ide.c correct partition type
2419 -48 common/cmd_ide.c Error reading Image Header on boot device
2420 48 common/cmd_ide.c reading Image Header from IDE device OK
2421 -49 common/cmd_ide.c Image header has bad magic number
2422 49 common/cmd_ide.c Image header has correct magic number
2423 -50 common/cmd_ide.c Image header has bad checksum
2424 50 common/cmd_ide.c Image header has correct checksum
2425 -51 common/cmd_ide.c Error reading Image from IDE device
2426 51 common/cmd_ide.c reading Image from IDE device OK
2427 52 common/cmd_nand.c before loading a Image from a NAND device
2428 -53 common/cmd_nand.c Bad usage of "nand" command
2429 53 common/cmd_nand.c correct usage of "nand" command
2430 -54 common/cmd_nand.c No boot device
2431 54 common/cmd_nand.c boot device found
2432 -55 common/cmd_nand.c Unknown Chip ID on boot device
2433 55 common/cmd_nand.c correct chip ID found, device available
2434 -56 common/cmd_nand.c Error reading Image Header on boot device
2435 56 common/cmd_nand.c reading Image Header from NAND device OK
2436 -57 common/cmd_nand.c Image header has bad magic number
2437 57 common/cmd_nand.c Image header has correct magic number
2438 -58 common/cmd_nand.c Error reading Image from NAND device
2439 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002440
Heiko Schocher566a4942007-06-22 19:11:54 +02002441 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002442
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002443 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002444 -64 net/eth.c no Ethernet found.
2445 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002446
Heiko Schocher566a4942007-06-22 19:11:54 +02002447 -80 common/cmd_net.c usage wrong
2448 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002449 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002450 81 common/cmd_net.c NetLoop() back without error
2451 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2452 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002453 83 common/cmd_net.c running "source" command
2454 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002455 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002456
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002457FIT uImage format:
2458
2459 Arg Where When
2460 100 common/cmd_bootm.c Kernel FIT Image has correct format
2461 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2462 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2463 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2464 102 common/cmd_bootm.c Kernel unit name specified
2465 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002466 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002467 104 common/cmd_bootm.c Got kernel subimage node offset
2468 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2469 105 common/cmd_bootm.c Kernel subimage hash verification OK
2470 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2471 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002472 -106 common/cmd_bootm.c Kernel subimage has wrong type
2473 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002474 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2475 108 common/cmd_bootm.c Got kernel subimage data/size
2476 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2477 -109 common/cmd_bootm.c Can't get kernel subimage type
2478 -110 common/cmd_bootm.c Can't get kernel subimage comp
2479 -111 common/cmd_bootm.c Can't get kernel subimage os
2480 -112 common/cmd_bootm.c Can't get kernel subimage load address
2481 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2482
2483 120 common/image.c Start initial ramdisk verification
2484 -120 common/image.c Ramdisk FIT image has incorrect format
2485 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002486 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002487 -122 common/image.c Can't get configuration for ramdisk subimage
2488 123 common/image.c Ramdisk unit name specified
2489 -124 common/image.c Can't get ramdisk subimage node offset
2490 125 common/image.c Got ramdisk subimage node offset
2491 -125 common/image.c Ramdisk subimage hash verification failed
2492 126 common/image.c Ramdisk subimage hash verification OK
2493 -126 common/image.c Ramdisk subimage for unsupported architecture
2494 127 common/image.c Architecture check OK
2495 -127 common/image.c Can't get ramdisk subimage data/size
2496 128 common/image.c Got ramdisk subimage data/size
2497 129 common/image.c Can't get ramdisk load address
2498 -129 common/image.c Got ramdisk load address
2499
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002500 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002501 131 common/cmd_doc.c FIT image format OK
2502
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002503 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002504 141 common/cmd_ide.c FIT image format OK
2505
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002506 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002507 151 common/cmd_nand.c FIT image format OK
2508
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002509- Standalone program support:
2510 CONFIG_STANDALONE_LOAD_ADDR
2511
Wolfgang Denk6feff892011-10-09 21:06:34 +02002512 This option defines a board specific value for the
2513 address where standalone program gets loaded, thus
2514 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002515 settings.
2516
2517- Frame Buffer Address:
2518 CONFIG_FB_ADDR
2519
2520 Define CONFIG_FB_ADDR if you want to use specific
2521 address for frame buffer.
2522 Then system will reserve the frame buffer address to
2523 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002524 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002525
2526 Please see board_init_f function.
2527
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002528- Automatic software updates via TFTP server
2529 CONFIG_UPDATE_TFTP
2530 CONFIG_UPDATE_TFTP_CNT_MAX
2531 CONFIG_UPDATE_TFTP_MSEC_MAX
2532
2533 These options enable and control the auto-update feature;
2534 for a more detailed description refer to doc/README.update.
2535
2536- MTD Support (mtdparts command, UBI support)
2537 CONFIG_MTD_DEVICE
2538
2539 Adds the MTD device infrastructure from the Linux kernel.
2540 Needed for mtdparts command support.
2541
2542 CONFIG_MTD_PARTITIONS
2543
2544 Adds the MTD partitioning infrastructure from the Linux
2545 kernel. Needed for UBI support.
2546
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002547- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002548 CONFIG_SPL
2549 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002550
Tom Rini95579792012-02-14 07:29:40 +00002551 CONFIG_SPL_LDSCRIPT
2552 LDSCRIPT for linking the SPL binary.
2553
2554 CONFIG_SPL_MAX_SIZE
2555 Maximum binary size (text, data and rodata) of the SPL binary.
2556
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002557 CONFIG_SPL_TEXT_BASE
2558 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002559
Tom Rini95579792012-02-14 07:29:40 +00002560 CONFIG_SPL_BSS_START_ADDR
2561 Link address for the BSS within the SPL binary.
2562
2563 CONFIG_SPL_BSS_MAX_SIZE
2564 Maximum binary size of the BSS section of the SPL binary.
2565
2566 CONFIG_SPL_STACK
2567 Adress of the start of the stack SPL will use
2568
2569 CONFIG_SYS_SPL_MALLOC_START
2570 Starting address of the malloc pool used in SPL.
2571
2572 CONFIG_SYS_SPL_MALLOC_SIZE
2573 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002574
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002575 CONFIG_SPL_LIBCOMMON_SUPPORT
2576 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002577
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002578 CONFIG_SPL_LIBDISK_SUPPORT
2579 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002580
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002581 CONFIG_SPL_I2C_SUPPORT
2582 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002583
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002584 CONFIG_SPL_GPIO_SUPPORT
2585 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002586
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002587 CONFIG_SPL_MMC_SUPPORT
2588 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002589
Tom Rini95579792012-02-14 07:29:40 +00002590 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2591 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2592 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2593 Address, size and partition on the MMC to load U-Boot from
2594 when the MMC is being used in raw mode.
2595
2596 CONFIG_SPL_FAT_SUPPORT
2597 Support for fs/fat/libfat.o in SPL binary
2598
2599 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2600 Filename to read to load U-Boot when reading from FAT
2601
2602 CONFIG_SPL_NAND_SIMPLE
2603 Support for drivers/mtd/nand/libnand.o in SPL binary
2604
2605 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2606 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2607 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2608 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2609 CONFIG_SYS_NAND_ECCBYTES
2610 Defines the size and behavior of the NAND that SPL uses
2611 to read U-Boot with CONFIG_SPL_NAND_SIMPLE
2612
2613 CONFIG_SYS_NAND_U_BOOT_OFFS
2614 Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
2615 from.
2616
2617 CONFIG_SYS_NAND_U_BOOT_START
2618 Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
2619 to.
2620
2621 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2622 Define this if you need to first read the OOB and then the
2623 data. This is used for example on davinci plattforms.
2624
2625 CONFIG_SPL_OMAP3_ID_NAND
2626 Support for an OMAP3-specific set of functions to return the
2627 ID and MFR of the first attached NAND chip, if present.
2628
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002629 CONFIG_SPL_SERIAL_SUPPORT
2630 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002631
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002632 CONFIG_SPL_SPI_FLASH_SUPPORT
2633 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002634
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002635 CONFIG_SPL_SPI_SUPPORT
2636 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002637
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002638 CONFIG_SPL_LIBGENERIC_SUPPORT
2639 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002640
wdenkc6097192002-11-03 00:24:07 +00002641Modem Support:
2642--------------
2643
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002644[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002645
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002646- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002647 CONFIG_MODEM_SUPPORT
2648
2649- RTS/CTS Flow control enable:
2650 CONFIG_HWFLOW
2651
2652- Modem debug support:
2653 CONFIG_MODEM_SUPPORT_DEBUG
2654
wdenk43d96162003-03-06 00:02:04 +00002655 Enables debugging stuff (char screen[1024], dbg())
2656 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002657
wdenka8c7c702003-12-06 19:49:23 +00002658- Interrupt support (PPC):
2659
wdenkd4ca31c2004-01-02 14:00:00 +00002660 There are common interrupt_init() and timer_interrupt()
2661 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002662 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002663 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002664 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002665 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002666 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002667 specific handling. If board has watchdog / status_led
2668 / other_activity_monitor it works automatically from
2669 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002670
wdenkc6097192002-11-03 00:24:07 +00002671- General:
2672
wdenk43d96162003-03-06 00:02:04 +00002673 In the target system modem support is enabled when a
2674 specific key (key combination) is pressed during
2675 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002676 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002677 board_init(). Currently key_pressed() is a dummy
2678 function, returning 1 and thus enabling modem
2679 initialization.
wdenkc6097192002-11-03 00:24:07 +00002680
wdenk43d96162003-03-06 00:02:04 +00002681 If there are no modem init strings in the
2682 environment, U-Boot proceed to autoboot; the
2683 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002684 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002685
2686 See also: doc/README.Modem
2687
Helmut Raiger9660e442011-10-20 04:19:47 +00002688Board initialization settings:
2689------------------------------
2690
2691During Initialization u-boot calls a number of board specific functions
2692to allow the preparation of board specific prerequisites, e.g. pin setup
2693before drivers are initialized. To enable these callbacks the
2694following configuration macros have to be defined. Currently this is
2695architecture specific, so please check arch/your_architecture/lib/board.c
2696typically in board_init_f() and board_init_r().
2697
2698- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2699- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2700- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2701- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002702
wdenkc6097192002-11-03 00:24:07 +00002703Configuration Settings:
2704-----------------------
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002707 undefine this when you're short of memory.
2708
Peter Tyser2fb26042009-01-27 18:03:12 -06002709- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2710 width of the commands listed in the 'help' command output.
2711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002713 prompt for user input.
2714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002715- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002716
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002717- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002722 the application (usually a Linux kernel) when it is
2723 booted
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002726 List of legal baudrate settings for this board.
2727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002729 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002732 If the board specific function
2733 extern int overwrite_console (void);
2734 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002735 serial port, else the settings in the environment are used.
2736
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002737- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002738 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002741 Enable overwrite of previous console environment settings.
2742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002744 Begin and End addresses of the area used by the
2745 simple memory test.
2746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002747- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002748 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002751 Scratch address used by the alternate memory test
2752 You only need to set this if address zero isn't writeable
2753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2755 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002756 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002757 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002758 fixing up gd->ram_size the Linux kernel should gets passed
2759 the now "corrected" memory size and won't touch it either.
2760 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002761 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002762 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002763 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002764
2765 This option can be used as a workaround for the 440EPx/GRx
2766 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2767 be touched.
2768
2769 WARNING: Please make sure that this value is a multiple of
2770 the Linux page size (normally 4k). If this is not the case,
2771 then the end address of the Linux memory will be located at a
2772 non page size aligned address and this could cause major
2773 problems.
2774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002775- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002776 Default load address for network file downloads
2777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002778- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002779 Enable temporary baudrate change while serial download
2780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002781- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002782 Physical start address of SDRAM. _Must_ be 0 here.
2783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002784- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002785 Physical start address of Motherboard I/O (if using a
2786 Cogent motherboard)
2787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002788- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002789 Physical start address of Flash memory.
2790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002792 Physical start address of boot monitor code (set by
2793 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002794 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002797- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002798 Size of memory reserved for monitor code, used to
2799 determine _at_compile_time_ (!) if the environment is
2800 embedded within the U-Boot image, or in a separate
2801 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002804 Size of DRAM reserved for malloc() use.
2805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002807 Normally compressed uImages are limited to an
2808 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002810 to adjust this setting to your needs.
2811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002812- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002813 Maximum size of memory mapped by the startup code of
2814 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002815 the Linux kernel (bd_info, boot arguments, FDT blob if
2816 used) must be put below this limit, unless "bootm_low"
2817 enviroment variable is defined and non-zero. In such case
2818 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002819 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002820 variable "bootm_mapsize" will override the value of
2821 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2822 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002823
John Rigbyfca43cc2010-10-13 13:57:35 -06002824- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2825 Enable initrd_high functionality. If defined then the
2826 initrd_high feature is enabled and the bootm ramdisk subcommand
2827 is enabled.
2828
2829- CONFIG_SYS_BOOT_GET_CMDLINE:
2830 Enables allocating and saving kernel cmdline in space between
2831 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2832
2833- CONFIG_SYS_BOOT_GET_KBD:
2834 Enables allocating and saving a kernel copy of the bd_info in
2835 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002837- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002838 Max number of Flash memory banks
2839
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002840- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002841 Max number of sectors on a Flash chip
2842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002843- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002844 Timeout for Flash erase operations (in ms)
2845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002846- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002847 Timeout for Flash write operations (in ms)
2848
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002849- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002850 Timeout for Flash set sector lock bit operation (in ms)
2851
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002852- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002853 Timeout for Flash clear lock bits operation (in ms)
2854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002855- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002856 If defined, hardware flash sectors protection is used
2857 instead of U-Boot software protection.
2858
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002859- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002860
2861 Enable TFTP transfers directly to flash memory;
2862 without this option such a download has to be
2863 performed in two steps: (1) download to RAM, and (2)
2864 copy from RAM to flash.
2865
2866 The two-step approach is usually more reliable, since
2867 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002868 the flash, but in some situations (when system RAM is
2869 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002870 downloaded image) this option may be very useful.
2871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002872- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002873 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002874 common flash structure for storing flash geometry.
2875
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002876- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002877 This option also enables the building of the cfi_flash driver
2878 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002879
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002880- CONFIG_FLASH_CFI_MTD
2881 This option enables the building of the cfi_mtd driver
2882 in the drivers directory. The driver exports CFI flash
2883 to the MTD layer.
2884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002885- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002886 Use buffered writes to flash.
2887
2888- CONFIG_FLASH_SPANSION_S29WS_N
2889 s29ws-n MirrorBit flash has non-standard addresses for buffered
2890 write commands.
2891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002892- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002893 If this option is defined, the common CFI flash doesn't
2894 print it's warning upon not recognized FLASH banks. This
2895 is useful, if some of the configured banks are only
2896 optionally available.
2897
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002898- CONFIG_FLASH_SHOW_PROGRESS
2899 If defined (must be an integer), print out countdown
2900 digits and dots. Recommended value: 45 (9..1) for 80
2901 column displays, 15 (3..1) for 40 column displays.
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002904 Defines the number of Ethernet receive buffers. On some
2905 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002906 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2907 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002908 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002909 Defaults to 4 if not defined.
2910
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002911- CONFIG_ENV_MAX_ENTRIES
2912
Wolfgang Denk071bc922010-10-27 22:48:30 +02002913 Maximum number of entries in the hash table that is used
2914 internally to store the environment settings. The default
2915 setting is supposed to be generous and should work in most
2916 cases. This setting can be used to tune behaviour; see
2917 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002918
wdenkc6097192002-11-03 00:24:07 +00002919The following definitions that deal with the placement and management
2920of environment data (variable area); in general, we support the
2921following configurations:
2922
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002923- CONFIG_BUILD_ENVCRC:
2924
2925 Builds up envcrc with the target environment so that external utils
2926 may easily extract it and embed it in final U-Boot images.
2927
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002928- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002929
2930 Define this if the environment is in flash memory.
2931
2932 a) The environment occupies one whole flash sector, which is
2933 "embedded" in the text segment with the U-Boot code. This
2934 happens usually with "bottom boot sector" or "top boot
2935 sector" type flash chips, which have several smaller
2936 sectors at the start or the end. For instance, such a
2937 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2938 such a case you would place the environment in one of the
2939 4 kB sectors - with U-Boot code before and after it. With
2940 "top boot sector" type flash chips, you would put the
2941 environment in one of the last sectors, leaving a gap
2942 between U-Boot and the environment.
2943
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002944 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002945
2946 Offset of environment data (variable area) to the
2947 beginning of flash memory; for instance, with bottom boot
2948 type flash chips the second sector can be used: the offset
2949 for this sector is given here.
2950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002952
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002953 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002954
2955 This is just another way to specify the start address of
2956 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002957 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002958
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002959 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002960
2961 Size of the sector containing the environment.
2962
2963
2964 b) Sometimes flash chips have few, equal sized, BIG sectors.
2965 In such a case you don't want to spend a whole sector for
2966 the environment.
2967
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002968 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002969
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002970 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002971 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002972 of this flash sector for the environment. This saves
2973 memory for the RAM copy of the environment.
2974
2975 It may also save flash memory if you decide to use this
2976 when your environment is "embedded" within U-Boot code,
2977 since then the remainder of the flash sector could be used
2978 for U-Boot code. It should be pointed out that this is
2979 STRONGLY DISCOURAGED from a robustness point of view:
2980 updating the environment in flash makes it always
2981 necessary to erase the WHOLE sector. If something goes
2982 wrong before the contents has been restored from a copy in
2983 RAM, your target system will be dead.
2984
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002985 - CONFIG_ENV_ADDR_REDUND
2986 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002987
wdenk43d96162003-03-06 00:02:04 +00002988 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002989 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002990 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002991 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002992
2993BE CAREFUL! Any changes to the flash layout, and some changes to the
2994source code will make it necessary to adapt <board>/u-boot.lds*
2995accordingly!
2996
2997
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002998- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002999
3000 Define this if you have some non-volatile memory device
3001 (NVRAM, battery buffered SRAM) which you want to use for the
3002 environment.
3003
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003004 - CONFIG_ENV_ADDR:
3005 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003006
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003007 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003008 want to use for environment. It is assumed that this memory
3009 can just be read and written to, without any special
3010 provision.
3011
3012BE CAREFUL! The first access to the environment happens quite early
3013in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003014console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003015U-Boot will hang.
3016
3017Please note that even with NVRAM we still use a copy of the
3018environment in RAM: we could work on NVRAM directly, but we want to
3019keep settings there always unmodified except somebody uses "saveenv"
3020to save the current settings.
3021
3022
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003023- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003024
3025 Use this if you have an EEPROM or similar serial access
3026 device and a driver for it.
3027
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003028 - CONFIG_ENV_OFFSET:
3029 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003030
3031 These two #defines specify the offset and size of the
3032 environment area within the total memory of your EEPROM.
3033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003034 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003035 If defined, specified the chip address of the EEPROM device.
3036 The default address is zero.
3037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003038 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003039 If defined, the number of bits used to address bytes in a
3040 single page in the EEPROM device. A 64 byte page, for example
3041 would require six bits.
3042
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003043 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003044 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003045 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003046
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003047 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003048 The length in bytes of the EEPROM memory array address. Note
3049 that this is NOT the chip address length!
3050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003051 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003052 EEPROM chips that implement "address overflow" are ones
3053 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3054 address and the extra bits end up in the "chip address" bit
3055 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3056 byte chips.
3057
3058 Note that we consider the length of the address field to
3059 still be one byte because the extra address bits are hidden
3060 in the chip address.
3061
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003062 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003063 The size in bytes of the EEPROM device.
3064
Heiko Schocher548738b2010-01-07 08:55:40 +01003065 - CONFIG_ENV_EEPROM_IS_ON_I2C
3066 define this, if you have I2C and SPI activated, and your
3067 EEPROM, which holds the environment, is on the I2C bus.
3068
3069 - CONFIG_I2C_ENV_EEPROM_BUS
3070 if you have an Environment on an EEPROM reached over
3071 I2C muxes, you can define here, how to reach this
3072 EEPROM. For example:
3073
Wolfgang Denka9046b92010-06-13 17:48:15 +02003074 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003075
3076 EEPROM which holds the environment, is reached over
3077 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003078
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003079- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003080
wdenkd4ca31c2004-01-02 14:00:00 +00003081 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003082 want to use for the environment.
3083
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003084 - CONFIG_ENV_OFFSET:
3085 - CONFIG_ENV_ADDR:
3086 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003087
3088 These three #defines specify the offset and size of the
3089 environment area within the total memory of your DataFlash placed
3090 at the specified address.
3091
Liu Gang0a85a9e2012-03-08 00:33:20 +00003092- CONFIG_ENV_IS_IN_REMOTE:
3093
3094 Define this if you have a remote memory space which you
3095 want to use for the local device's environment.
3096
3097 - CONFIG_ENV_ADDR:
3098 - CONFIG_ENV_SIZE:
3099
3100 These two #defines specify the address and size of the
3101 environment area within the remote memory space. The
3102 local device can get the environment from remote memory
3103 space by SRIO or other links.
3104
3105BE CAREFUL! For some special cases, the local device can not use
3106"saveenv" command. For example, the local device will get the
3107environment stored in a remote NOR flash by SRIO link, but it can
3108not erase, write this NOR flash by SRIO interface.
3109
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003110- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003111
3112 Define this if you have a NAND device which you want to use
3113 for the environment.
3114
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003115 - CONFIG_ENV_OFFSET:
3116 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003117
3118 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003119 area within the first NAND device. CONFIG_ENV_OFFSET must be
3120 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003121
Scott Woodfdd813d2010-09-17 14:38:37 -05003122 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003123
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003124 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003125 size used to hold a redundant copy of the environment data, so
3126 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003127 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003128 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003129
Scott Woodfdd813d2010-09-17 14:38:37 -05003130 - CONFIG_ENV_RANGE (optional):
3131
3132 Specifies the length of the region in which the environment
3133 can be written. This should be a multiple of the NAND device's
3134 block size. Specifying a range with more erase blocks than
3135 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3136 the range to be avoided.
3137
3138 - CONFIG_ENV_OFFSET_OOB (optional):
3139
3140 Enables support for dynamically retrieving the offset of the
3141 environment from block zero's out-of-band data. The
3142 "nand env.oob" command can be used to record this offset.
3143 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3144 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003145
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003146- CONFIG_NAND_ENV_DST
3147
3148 Defines address in RAM to which the nand_spl code should copy the
3149 environment. If redundant environment is used, it will be copied to
3150 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003152- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003153
3154 Defines offset to the initial SPI buffer area in DPRAM. The
3155 area is used at an early stage (ROM part) if the environment
3156 is configured to reside in the SPI EEPROM: We need a 520 byte
3157 scratch DPRAM area. It is used between the two initialization
3158 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3159 to be a good choice since it makes it far enough from the
3160 start of the data area as well as from the stack pointer.
3161
Bruce Adlere881cb52007-11-02 13:15:42 -07003162Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003163has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003164created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003165until then to read environment variables.
3166
wdenk85ec0bc2003-03-31 16:34:49 +00003167The environment is protected by a CRC32 checksum. Before the monitor
3168is relocated into RAM, as a result of a bad CRC you will be working
3169with the compiled-in default environment - *silently*!!! [This is
3170necessary, because the first environment variable we need is the
3171"baudrate" setting for the console - if we have a bad CRC, we don't
3172have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003173
3174Note: once the monitor has been relocated, then it will complain if
3175the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003176use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003178- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003179 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003180
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003181 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003182 also needs to be defined.
3183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003184- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003185 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003186
Ron Madridf5675aa2009-02-18 14:30:44 -08003187- CONFIG_NS16550_MIN_FUNCTIONS:
3188 Define this if you desire to only have use of the NS16550_init
3189 and NS16550_putc functions for the serial driver located at
3190 drivers/serial/ns16550.c. This option is useful for saving
3191 space for already greatly restricted images, including but not
3192 limited to NAND_SPL configurations.
3193
wdenkc6097192002-11-03 00:24:07 +00003194Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003195---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003197- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003198 Cache Line Size of the CPU.
3199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003200- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003201 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003202
wdenk42d1f032003-10-15 23:53:47 +00003203 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3204 and RPXsuper) to be able to adjust the position of
3205 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003206
Timur Tabie46fedf2011-08-04 18:03:41 -05003207- CONFIG_SYS_CCSRBAR_DEFAULT:
3208 Default (power-on reset) physical address of CCSR on Freescale
3209 PowerPC SOCs.
3210
3211- CONFIG_SYS_CCSRBAR:
3212 Virtual address of CCSR. On a 32-bit build, this is typically
3213 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3214
3215 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3216 for cross-platform code that uses that macro instead.
3217
3218- CONFIG_SYS_CCSRBAR_PHYS:
3219 Physical address of CCSR. CCSR can be relocated to a new
3220 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003221 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003222 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3223 is typically relocated on 36-bit builds. It is recommended
3224 that this macro be defined via the _HIGH and _LOW macros:
3225
3226 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3227 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3228
3229- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003230 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3231 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003232 used in assembly code, so it must not contain typecasts or
3233 integer size suffixes (e.g. "ULL").
3234
3235- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3236 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3237 used in assembly code, so it must not contain typecasts or
3238 integer size suffixes (e.g. "ULL").
3239
3240- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3241 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3242 forced to a value that ensures that CCSR is not relocated.
3243
wdenk7f6c2cb2002-11-10 22:06:23 +00003244- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003245 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003246
3247 the default drive number (default value 0)
3248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003250
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003251 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003252 (default value 1)
3253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003254 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003255
wdenk43d96162003-03-06 00:02:04 +00003256 defines the offset of register from address. It
3257 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003258 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003260 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3261 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003262 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003263
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003264 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003265 fdc_hw_init() is called at the beginning of the FDC
3266 setup. fdc_hw_init() must be provided by the board
3267 source code. It is used to make hardware dependant
3268 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003269
Macpaul Lin0abddf82011-04-11 20:45:32 +00003270- CONFIG_IDE_AHB:
3271 Most IDE controllers were designed to be connected with PCI
3272 interface. Only few of them were designed for AHB interface.
3273 When software is doing ATA command and data transfer to
3274 IDE devices through IDE-AHB controller, some additional
3275 registers accessing to these kind of IDE-AHB controller
3276 is requierd.
3277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003279 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003280 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003283
wdenk7152b1d2003-09-05 23:19:14 +00003284 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003285 initial data and stack; please note that this must be
3286 writable memory that is working WITHOUT special
3287 initialization, i. e. you CANNOT use normal RAM which
3288 will become available only after programming the
3289 memory controller and running certain initialization
3290 sequences.
3291
3292 U-Boot uses the following memory types:
3293 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3294 - MPC824X: data cache
3295 - PPC4xx: data cache
3296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003297- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003298
3299 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003300 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3301 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003302 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003303 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003304 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3305 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3306 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003307
3308 Note:
3309 On the MPC824X (or other systems that use the data
3310 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003311 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003312 point to an otherwise UNUSED address space between
3313 the top of RAM and the start of the PCI space.
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003316
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003317- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003319- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003321- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003323- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003325- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003327- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003328 SDRAM timing
3329
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003330- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003331 periodic timer for refresh
3332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003333- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003335- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3336 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3337 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3338 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003339 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3340
3341- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003342 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3343 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003344 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003346- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3347 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003348 Machine Mode Register and Memory Periodic Timer
3349 Prescaler definitions (SDRAM timing)
3350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003351- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003352 enable I2C microcode relocation patch (MPC8xx);
3353 define relocation offset in DPRAM [DSP2]
3354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003355- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003356 enable SMC microcode relocation patch (MPC8xx);
3357 define relocation offset in DPRAM [SMC1]
3358
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003359- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003360 enable SPI microcode relocation patch (MPC8xx);
3361 define relocation offset in DPRAM [SCC4]
3362
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003363- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003364 Use OSCM clock mode on MBX8xx board. Be careful,
3365 wrong setting might damage your board. Read
3366 doc/README.MBX before setting this variable!
3367
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003368- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003369 Offset of the bootmode word in DPRAM used by post
3370 (Power On Self Tests). This definition overrides
3371 #define'd default value in commproc.h resp.
3372 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003374- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3375 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3376 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3377 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3378 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3379 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3380 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3381 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003382 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003383
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003384- CONFIG_PCI_DISABLE_PCIE:
3385 Disable PCI-Express on systems where it is supported but not
3386 required.
3387
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003388- CONFIG_PCI_ENUM_ONLY
3389 Only scan through and get the devices on the busses.
3390 Don't do any setup work, presumably because someone or
3391 something has already done it, and we don't need to do it
3392 a second time. Useful for platforms that are pre-booted
3393 by coreboot or similar.
3394
Kumar Galaa09b9b62010-12-30 12:09:53 -06003395- CONFIG_SYS_SRIO:
3396 Chip has SRIO or not
3397
3398- CONFIG_SRIO1:
3399 Board has SRIO 1 port available
3400
3401- CONFIG_SRIO2:
3402 Board has SRIO 2 port available
3403
3404- CONFIG_SYS_SRIOn_MEM_VIRT:
3405 Virtual Address of SRIO port 'n' memory region
3406
3407- CONFIG_SYS_SRIOn_MEM_PHYS:
3408 Physical Address of SRIO port 'n' memory region
3409
3410- CONFIG_SYS_SRIOn_MEM_SIZE:
3411 Size of SRIO port 'n' memory region
3412
Alex Watermaneced4622011-05-19 15:08:36 -04003413- CONFIG_SYS_NDFC_16
3414 Defined to tell the NDFC that the NAND chip is using a
3415 16 bit bus.
3416
3417- CONFIG_SYS_NDFC_EBC0_CFG
3418 Sets the EBC0_CFG register for the NDFC. If not defined
3419 a default value will be used.
3420
Ben Warrenbb99ad62006-09-07 16:50:54 -04003421- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003422 Get DDR timing information from an I2C EEPROM. Common
3423 with pluggable memory modules such as SODIMMs
3424
Ben Warrenbb99ad62006-09-07 16:50:54 -04003425 SPD_EEPROM_ADDRESS
3426 I2C address of the SPD EEPROM
3427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003428- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003429 If SPD EEPROM is on an I2C bus other than the first
3430 one, specify here. Note that the value must resolve
3431 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003432
York Sun1b3e3c42011-06-07 09:42:16 +08003433- CONFIG_SYS_DDR_RAW_TIMING
3434 Get DDR timing information from other than SPD. Common with
3435 soldered DDR chips onboard without SPD. DDR raw timing
3436 parameters are extracted from datasheet and hard-coded into
3437 header files or board specific files.
3438
York Sun6f5e1dc2011-09-16 13:21:35 -07003439- CONFIG_FSL_DDR_INTERACTIVE
3440 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003442- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003443 Only for 83xx systems. If specified, then DDR should
3444 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003445
wdenkc26e4542004-04-18 10:13:26 +00003446- CONFIG_ETHER_ON_FEC[12]
3447 Define to enable FEC[12] on a 8xx series processor.
3448
3449- CONFIG_FEC[12]_PHY
3450 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003451 to the given FEC; i. e.
3452 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003453 means that the PHY with address 4 is connected to FEC1
3454
3455 When set to -1, means to probe for first available.
3456
3457- CONFIG_FEC[12]_PHY_NORXERR
3458 The PHY does not have a RXERR line (RMII only).
3459 (so program the FEC to ignore it).
3460
3461- CONFIG_RMII
3462 Enable RMII mode for all FECs.
3463 Note that this is a global option, we can't
3464 have one FEC in standard MII mode and another in RMII mode.
3465
wdenk5cf91d62004-04-23 20:32:05 +00003466- CONFIG_CRC32_VERIFY
3467 Add a verify option to the crc32 command.
3468 The syntax is:
3469
3470 => crc32 -v <address> <count> <crc32>
3471
3472 Where address/count indicate a memory area
3473 and crc32 is the correct crc32 which the
3474 area should have.
3475
wdenk56523f12004-07-11 17:40:54 +00003476- CONFIG_LOOPW
3477 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003478 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003479
stroese7b466642004-12-16 18:46:55 +00003480- CONFIG_MX_CYCLIC
3481 Add the "mdc" and "mwc" memory commands. These are cyclic
3482 "md/mw" commands.
3483 Examples:
3484
wdenkefe2a4d2004-12-16 21:44:03 +00003485 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003486 This command will print 4 bytes (10,11,12,13) each 500 ms.
3487
wdenkefe2a4d2004-12-16 21:44:03 +00003488 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003489 This command will write 12345678 to address 100 all 10 ms.
3490
wdenkefe2a4d2004-12-16 21:44:03 +00003491 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003492 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003493
wdenk8aa1a2d2005-04-04 12:44:11 +00003494- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003495 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003496 low level initializations (like setting up the memory
3497 controller) are omitted and/or U-Boot does not
3498 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003499
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003500 Normally this variable MUST NOT be defined. The only
3501 exception is when U-Boot is loaded (to RAM) by some
3502 other boot loader or by a debugger which performs
3503 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003504
Aneesh V401bb302011-07-13 05:11:07 +00003505- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003506 Modifies the behaviour of start.S when compiling a loader
3507 that is executed before the actual U-Boot. E.g. when
3508 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003509
Matthias Weisserd8834a12011-03-10 21:36:32 +00003510- CONFIG_USE_ARCH_MEMCPY
3511 CONFIG_USE_ARCH_MEMSET
3512 If these options are used a optimized version of memcpy/memset will
3513 be used if available. These functions may be faster under some
3514 conditions but may increase the binary size.
3515
Timur Tabif2717b42011-11-22 09:21:25 -06003516Freescale QE/FMAN Firmware Support:
3517-----------------------------------
3518
3519The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3520loading of "firmware", which is encoded in the QE firmware binary format.
3521This firmware often needs to be loaded during U-Boot booting, so macros
3522are used to identify the storage device (NOR flash, SPI, etc) and the address
3523within that device.
3524
3525- CONFIG_SYS_QE_FMAN_FW_ADDR
3526 The address in the storage device where the firmware is located. The
3527 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3528 is also specified.
3529
3530- CONFIG_SYS_QE_FMAN_FW_LENGTH
3531 The maximum possible size of the firmware. The firmware binary format
3532 has a field that specifies the actual size of the firmware, but it
3533 might not be possible to read any part of the firmware unless some
3534 local storage is allocated to hold the entire firmware first.
3535
3536- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3537 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3538 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3539 virtual address in NOR flash.
3540
3541- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3542 Specifies that QE/FMAN firmware is located in NAND flash.
3543 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3544
3545- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3546 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3547 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3548
3549- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3550 Specifies that QE/FMAN firmware is located on the primary SPI
3551 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3552
Liu Gang292dc6c2012-03-08 00:33:18 +00003553- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3554 Specifies that QE/FMAN firmware is located in the remote (master)
3555 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3556 can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3557 ->master inbound window->master LAW->the ucode address in master's
3558 NOR flash.
Timur Tabif2717b42011-11-22 09:21:25 -06003559
wdenkc6097192002-11-03 00:24:07 +00003560Building the Software:
3561======================
3562
Wolfgang Denk218ca722008-03-26 10:40:12 +01003563Building U-Boot has been tested in several native build environments
3564and in many different cross environments. Of course we cannot support
3565all possibly existing versions of cross development tools in all
3566(potentially obsolete) versions. In case of tool chain problems we
3567recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3568which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003569
Wolfgang Denk218ca722008-03-26 10:40:12 +01003570If you are not using a native environment, it is assumed that you
3571have GNU cross compiling tools available in your path. In this case,
3572you must set the environment variable CROSS_COMPILE in your shell.
3573Note that no changes to the Makefile or any other source files are
3574necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003575
Wolfgang Denk218ca722008-03-26 10:40:12 +01003576 $ CROSS_COMPILE=ppc_4xx-
3577 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003578
Peter Tyser2f8d3962009-03-13 18:54:51 -05003579Note: If you wish to generate Windows versions of the utilities in
3580 the tools directory you can use the MinGW toolchain
3581 (http://www.mingw.org). Set your HOST tools to the MinGW
3582 toolchain and execute 'make tools'. For example:
3583
3584 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3585
3586 Binaries such as tools/mkimage.exe will be created which can
3587 be executed on computers running Windows.
3588
Wolfgang Denk218ca722008-03-26 10:40:12 +01003589U-Boot is intended to be simple to build. After installing the
3590sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003591is done by typing:
3592
3593 make NAME_config
3594
Wolfgang Denk218ca722008-03-26 10:40:12 +01003595where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003596rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003597
wdenk2729af92004-05-03 20:45:30 +00003598Note: for some board special configuration names may exist; check if
3599 additional information is available from the board vendor; for
3600 instance, the TQM823L systems are available without (standard)
3601 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003602 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003603
wdenk2729af92004-05-03 20:45:30 +00003604 make TQM823L_config
3605 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003606
wdenk2729af92004-05-03 20:45:30 +00003607 make TQM823L_LCD_config
3608 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk2729af92004-05-03 20:45:30 +00003610 etc.
wdenkc6097192002-11-03 00:24:07 +00003611
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613Finally, type "make all", and you should get some working U-Boot
3614images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk2729af92004-05-03 20:45:30 +00003616- "u-boot.bin" is a raw binary image
3617- "u-boot" is an image in ELF binary format
3618- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003619
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003620By default the build is performed locally and the objects are saved
3621in the source directory. One of the two methods can be used to change
3622this behavior and build U-Boot to some external directory:
3623
36241. Add O= to the make command line invocations:
3625
3626 make O=/tmp/build distclean
3627 make O=/tmp/build NAME_config
3628 make O=/tmp/build all
3629
36302. Set environment variable BUILD_DIR to point to the desired location:
3631
3632 export BUILD_DIR=/tmp/build
3633 make distclean
3634 make NAME_config
3635 make all
3636
3637Note that the command line "O=" setting overrides the BUILD_DIR environment
3638variable.
3639
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641Please be aware that the Makefiles assume you are using GNU make, so
3642for instance on NetBSD you might need to use "gmake" instead of
3643native "make".
wdenkc6097192002-11-03 00:24:07 +00003644
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646If the system board that you have is not listed, then you will need
3647to port U-Boot to your hardware platform. To do this, follow these
3648steps:
wdenkc6097192002-11-03 00:24:07 +00003649
wdenk2729af92004-05-03 20:45:30 +000036501. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003651 "boards.cfg" file, using the existing entries as examples.
3652 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000036532. Create a new directory to hold your board specific code. Add any
3654 files you need. In your board directory, you will need at least
3655 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
36563. Create a new configuration file "include/configs/<board>.h" for
3657 your board
36583. If you're porting U-Boot to a new CPU, then also create a new
3659 directory to hold your CPU specific code. Add any files you need.
36604. Run "make <board>_config" with your new name.
36615. Type "make", and you should get a working "u-boot.srec" file
3662 to be installed on your target system.
36636. Debug and solve any problems that might arise.
3664 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003665
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3668==============================================================
wdenkc6097192002-11-03 00:24:07 +00003669
Wolfgang Denk218ca722008-03-26 10:40:12 +01003670If you have modified U-Boot sources (for instance added a new board
3671or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003672provide feedback to the other developers. The feedback normally takes
3673the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003674official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003675
Wolfgang Denk218ca722008-03-26 10:40:12 +01003676But before you submit such a patch, please verify that your modifi-
3677cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003678the supported boards compile WITHOUT ANY compiler warnings. To do so,
3679just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003680for ALL supported system. Be warned, this will take a while. You can
3681select which (cross) compiler to use by passing a `CROSS_COMPILE'
3682environment variable to the script, i. e. to use the ELDK cross tools
3683you can type
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk2729af92004-05-03 20:45:30 +00003685 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003686
wdenk2729af92004-05-03 20:45:30 +00003687or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003690
Wolfgang Denk218ca722008-03-26 10:40:12 +01003691When using the MAKEALL script, the default behaviour is to build
3692U-Boot in the source directory. This location can be changed by
3693setting the BUILD_DIR environment variable. Also, for each target
3694built, the MAKEALL script saves two log files (<target>.ERR and
3695<target>.MAKEALL) in the <source dir>/LOG directory. This default
3696location can be changed by setting the MAKEALL_LOGDIR environment
3697variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003698
3699 export BUILD_DIR=/tmp/build
3700 export MAKEALL_LOGDIR=/tmp/log
3701 CROSS_COMPILE=ppc_8xx- MAKEALL
3702
Wolfgang Denk218ca722008-03-26 10:40:12 +01003703With the above settings build objects are saved in the /tmp/build,
3704log files are saved in the /tmp/log and the source tree remains clean
3705during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003706
3707
wdenk2729af92004-05-03 20:45:30 +00003708See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003709
wdenkc6097192002-11-03 00:24:07 +00003710
wdenk2729af92004-05-03 20:45:30 +00003711Monitor Commands - Overview:
3712============================
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk2729af92004-05-03 20:45:30 +00003714go - start application at address 'addr'
3715run - run commands in an environment variable
3716bootm - boot application image from memory
3717bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003718bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003719tftpboot- boot image via network using TFTP protocol
3720 and env variables "ipaddr" and "serverip"
3721 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003722tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003723rarpboot- boot image via network using RARP/TFTP protocol
3724diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3725loads - load S-Record file over serial line
3726loadb - load binary file over serial line (kermit mode)
3727md - memory display
3728mm - memory modify (auto-incrementing)
3729nm - memory modify (constant address)
3730mw - memory write (fill)
3731cp - memory copy
3732cmp - memory compare
3733crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003734i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003735sspi - SPI utility commands
3736base - print or set address offset
3737printenv- print environment variables
3738setenv - set environment variables
3739saveenv - save environment variables to persistent storage
3740protect - enable or disable FLASH write protection
3741erase - erase FLASH memory
3742flinfo - print FLASH memory information
3743bdinfo - print Board Info structure
3744iminfo - print header information for application image
3745coninfo - print console devices and informations
3746ide - IDE sub-system
3747loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003748loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003749mtest - simple RAM test
3750icache - enable or disable instruction cache
3751dcache - enable or disable data cache
3752reset - Perform RESET of the CPU
3753echo - echo args to console
3754version - print monitor version
3755help - print online help
3756? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003757
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759Monitor Commands - Detailed Description:
3760========================================
wdenkc6097192002-11-03 00:24:07 +00003761
wdenk2729af92004-05-03 20:45:30 +00003762TODO.
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003765
3766
wdenk2729af92004-05-03 20:45:30 +00003767Environment Variables:
3768======================
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770U-Boot supports user configuration using Environment Variables which
3771can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773Environment Variables are set using "setenv", printed using
3774"printenv", and saved to Flash using "saveenv". Using "setenv"
3775without a value can be used to delete a variable from the
3776environment. As long as you don't save the environment you are
3777working with an in-memory copy. In case the Flash area containing the
3778environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003779
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003780Some configuration options can be set using Environment Variables.
3781
3782List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003785
wdenk2729af92004-05-03 20:45:30 +00003786 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk2729af92004-05-03 20:45:30 +00003790 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk2729af92004-05-03 20:45:30 +00003792 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003793
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003794 bootm_low - Memory range available for image processing in the bootm
3795 command can be restricted. This variable is given as
3796 a hexadecimal number and defines lowest address allowed
3797 for use by the bootm command. See also "bootm_size"
3798 environment variable. Address defined by "bootm_low" is
3799 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003800 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3801 bootm_mapsize.
3802
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003803 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003804 This variable is given as a hexadecimal number and it
3805 defines the size of the memory region starting at base
3806 address bootm_low that is accessible by the Linux kernel
3807 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3808 as the default value if it is defined, and bootm_size is
3809 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003810
3811 bootm_size - Memory range available for image processing in the bootm
3812 command can be restricted. This variable is given as
3813 a hexadecimal number and defines the size of the region
3814 allowed for use by the bootm command. See also "bootm_low"
3815 environment variable.
3816
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003817 updatefile - Location of the software update file on a TFTP server, used
3818 by the automatic software update feature. Please refer to
3819 documentation in doc/README.update for more details.
3820
wdenk2729af92004-05-03 20:45:30 +00003821 autoload - if set to "no" (any string beginning with 'n'),
3822 "bootp" will just load perform a lookup of the
3823 configuration from the BOOTP server, but not try to
3824 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826 autostart - if set to "yes", an image loaded using the "bootp",
3827 "rarpboot", "tftpboot" or "diskboot" commands will
3828 be automatically started (by internally calling
3829 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk2729af92004-05-03 20:45:30 +00003831 If set to "no", a standalone image passed to the
3832 "bootm" command will be copied to the load address
3833 (and eventually uncompressed), but NOT be started.
3834 This can be used to load and uncompress arbitrary
3835 data.
wdenkc6097192002-11-03 00:24:07 +00003836
David A. Longa28afca2011-07-09 16:40:19 -04003837 fdt_high - if set this restricts the maximum address that the
3838 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003839 For example, if you have a system with 1 GB memory
3840 at physical address 0x10000000, while Linux kernel
3841 only recognizes the first 704 MB as low memory, you
3842 may need to set fdt_high as 0x3C000000 to have the
3843 device tree blob be copied to the maximum address
3844 of the 704 MB low memory, so that Linux kernel can
3845 access it during the boot procedure.
3846
David A. Longa28afca2011-07-09 16:40:19 -04003847 If this is set to the special value 0xFFFFFFFF then
3848 the fdt will not be copied at all on boot. For this
3849 to work it must reside in writable memory, have
3850 sufficient padding on the end of it for u-boot to
3851 add the information it needs into it, and the memory
3852 must be accessible by the kernel.
3853
Simon Glasseea63e02011-10-24 19:15:34 +00003854 fdtcontroladdr- if set this is the address of the control flattened
3855 device tree used by U-Boot when CONFIG_OF_CONTROL is
3856 defined.
3857
wdenk17ea1172004-06-06 21:51:03 +00003858 i2cfast - (PPC405GP|PPC405EP only)
3859 if set to 'y' configures Linux I2C driver for fast
3860 mode (400kHZ). This environment variable is used in
3861 initialization code. So, for changes to be effective
3862 it must be saved and board must be reset.
3863
wdenk2729af92004-05-03 20:45:30 +00003864 initrd_high - restrict positioning of initrd images:
3865 If this variable is not set, initrd images will be
3866 copied to the highest possible address in RAM; this
3867 is usually what you want since it allows for
3868 maximum initrd size. If for some reason you want to
3869 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003870 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003871 variable to a value of "no" or "off" or "0".
3872 Alternatively, you can set it to a maximum upper
3873 address to use (U-Boot will still check that it
3874 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876 For instance, when you have a system with 16 MB
3877 RAM, and want to reserve 4 MB from use by Linux,
3878 you can do this by adding "mem=12M" to the value of
3879 the "bootargs" variable. However, now you must make
3880 sure that the initrd image is placed in the first
3881 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk2729af92004-05-03 20:45:30 +00003883 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk2729af92004-05-03 20:45:30 +00003885 If you set initrd_high to 0xFFFFFFFF, this is an
3886 indication to U-Boot that all addresses are legal
3887 for the Linux kernel, including addresses in flash
3888 memory. In this case U-Boot will NOT COPY the
3889 ramdisk at all. This may be useful to reduce the
3890 boot time on your system, but requires that this
3891 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895 loadaddr - Default load address for commands like "bootp",
3896 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003897
wdenk2729af92004-05-03 20:45:30 +00003898 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003907
Mike Frysingere2a53452011-10-02 10:01:27 +00003908 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003909
Mike Frysingere2a53452011-10-02 10:01:27 +00003910 ethact - controls which interface is currently active.
3911 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003912
Heiko Schocher48690d82010-07-20 17:45:02 +02003913 => setenv ethact FEC
3914 => ping 192.168.0.1 # traffic sent on FEC
3915 => setenv ethact SCC
3916 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003917
Matthias Fuchse1692572008-01-17 07:45:05 +01003918 ethrotate - When set to "no" U-Boot does not go through all
3919 available network interfaces.
3920 It just stays at the currently selected interface.
3921
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003922 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003923 either succeed or fail without retrying.
3924 When set to "once" the network operation will
3925 fail when all the available network interfaces
3926 are tried once without success.
3927 Useful on scripts which control the retry operation
3928 themselves.
wdenkc6097192002-11-03 00:24:07 +00003929
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003930 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003931
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003932 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003933 UDP source port.
3934
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003935 tftpdstport - If this is set, the value is used for TFTP's UDP
3936 destination port instead of the Well Know Port 69.
3937
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003938 tftpblocksize - Block size to use for TFTP transfers; if not set,
3939 we use the TFTP server's default block size
3940
3941 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3942 seconds, minimum value is 1000 = 1 second). Defines
3943 when a packet is considered to be lost so it has to
3944 be retransmitted. The default is 5000 = 5 seconds.
3945 Lowering this value may make downloads succeed
3946 faster in networks with high packet loss rates or
3947 with unreliable TFTP servers.
3948
3949 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003950 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003951 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003952
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003953The following image location variables contain the location of images
3954used in booting. The "Image" column gives the role of the image and is
3955not an environment variable name. The other columns are environment
3956variable names. "File Name" gives the name of the file on a TFTP
3957server, "RAM Address" gives the location in RAM the image will be
3958loaded to, and "Flash Location" gives the image's address in NOR
3959flash or offset in NAND flash.
3960
3961*Note* - these variables don't have to be defined for all boards, some
3962boards currenlty use other variables for these purposes, and some
3963boards use these variables for other purposes.
3964
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003965Image File Name RAM Address Flash Location
3966----- --------- ----------- --------------
3967u-boot u-boot u-boot_addr_r u-boot_addr
3968Linux kernel bootfile kernel_addr_r kernel_addr
3969device tree blob fdtfile fdt_addr_r fdt_addr
3970ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972The following environment variables may be used and automatically
3973updated by the network boot commands ("bootp" and "rarpboot"),
3974depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976 bootfile - see above
3977 dnsip - IP address of your Domain Name Server
3978 dnsip2 - IP address of your secondary Domain Name Server
3979 gatewayip - IP address of the Gateway (Router) to use
3980 hostname - Target hostname
3981 ipaddr - see above
3982 netmask - Subnet Mask
3983 rootpath - Pathname of the root filesystem on the NFS server
3984 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003985
wdenka3d991b2004-04-15 21:48:45 +00003986
wdenk2729af92004-05-03 20:45:30 +00003987There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk2729af92004-05-03 20:45:30 +00003989 serial# - contains hardware identification information such
3990 as type string and/or serial number
3991 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003992
wdenk2729af92004-05-03 20:45:30 +00003993These variables can be set only once (usually during manufacturing of
3994the board). U-Boot refuses to delete or overwrite these variables
3995once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003996
3997
wdenk2729af92004-05-03 20:45:30 +00003998Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk2729af92004-05-03 20:45:30 +00004000 ver - Contains the U-Boot version string as printed
4001 with the "version" command. This variable is
4002 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004003
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005Please note that changes to some configuration parameters may take
4006only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004007
stroesec1551ea2003-04-04 15:53:41 +00004008
wdenk2729af92004-05-03 20:45:30 +00004009Command Line Parsing:
4010=====================
stroesec1551ea2003-04-04 15:53:41 +00004011
wdenk2729af92004-05-03 20:45:30 +00004012There are two different command line parsers available with U-Boot:
4013the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015Old, simple command line parser:
4016--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk2729af92004-05-03 20:45:30 +00004018- supports environment variables (through setenv / saveenv commands)
4019- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004020- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004021- special characters ('$', ';') can be escaped by prefixing with '\',
4022 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004023 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004024- You can also escape text by enclosing in single apostrophes, for example:
4025 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027Hush shell:
4028-----------
wdenkf07771c2003-05-28 08:06:31 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030- similar to Bourne shell, with control structures like
4031 if...then...else...fi, for...do...done; while...do...done,
4032 until...do...done, ...
4033- supports environment ("global") variables (through setenv / saveenv
4034 commands) and local shell variables (through standard shell syntax
4035 "name=value"); only environment variables can be used with "run"
4036 command
wdenkf07771c2003-05-28 08:06:31 +00004037
wdenk2729af92004-05-03 20:45:30 +00004038General rules:
4039--------------
wdenkf07771c2003-05-28 08:06:31 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041(1) If a command line (or an environment variable executed by a "run"
4042 command) contains several commands separated by semicolon, and
4043 one of these commands fails, then the remaining commands will be
4044 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004045
wdenk2729af92004-05-03 20:45:30 +00004046(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004047 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004048 command will cause "run" to terminate, i. e. the remaining
4049 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051Note for Redundant Ethernet Interfaces:
4052=======================================
wdenkf07771c2003-05-28 08:06:31 +00004053
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004054Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004055such configurations and is capable of automatic selection of a
4056"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4059MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4060"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004061
wdenk2729af92004-05-03 20:45:30 +00004062If the network interface stores some valid MAC address (for instance
4063in SROM), this is used as default address if there is NO correspon-
4064ding setting in the environment; if the corresponding environment
4065variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067o If the SROM has a valid MAC address, and there is no address in the
4068 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk2729af92004-05-03 20:45:30 +00004070o If there is no valid address in the SROM, and a definition in the
4071 environment exists, then the value from the environment variable is
4072 used.
wdenkc6097192002-11-03 00:24:07 +00004073
wdenk2729af92004-05-03 20:45:30 +00004074o If both the SROM and the environment contain a MAC address, and
4075 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077o If both the SROM and the environment contain a MAC address, and the
4078 addresses differ, the value from the environment is used and a
4079 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081o If neither SROM nor the environment contain a MAC address, an error
4082 is raised.
wdenkc6097192002-11-03 00:24:07 +00004083
Ben Warrenecee9322010-04-26 11:11:46 -07004084If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004085will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004086may be skipped by setting the appropriate 'ethmacskip' environment variable.
4087The naming convention is as follows:
4088"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090Image Formats:
4091==============
wdenkc6097192002-11-03 00:24:07 +00004092
Marian Balakowicz3310c542008-03-12 12:13:13 +01004093U-Boot is capable of booting (and performing other auxiliary operations on)
4094images in two formats:
4095
4096New uImage format (FIT)
4097-----------------------
4098
4099Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4100to Flattened Device Tree). It allows the use of images with multiple
4101components (several kernels, ramdisks, etc.), with contents protected by
4102SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4103
4104
4105Old uImage format
4106-----------------
4107
4108Old image format is based on binary files which can be basically anything,
4109preceded by a special header; see the definitions in include/image.h for
4110details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk2729af92004-05-03 20:45:30 +00004112* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4113 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004114 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4115 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4116 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004117* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004118 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4119 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004120* Compression Type (uncompressed, gzip, bzip2)
4121* Load Address
4122* Entry Point
4123* Image Name
4124* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126The header is marked by a special Magic Number, and both the header
4127and the data portions of the image are secured against corruption by
4128CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004129
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131Linux Support:
4132==============
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134Although U-Boot should support any OS or standalone application
4135easily, the main focus has always been on Linux during the design of
4136U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138U-Boot includes many features that so far have been part of some
4139special "boot loader" code within the Linux kernel. Also, any
4140"initrd" images to be used are no longer part of one big Linux image;
4141instead, kernel and "initrd" are separate images. This implementation
4142serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004143
wdenk2729af92004-05-03 20:45:30 +00004144- the same features can be used for other OS or standalone
4145 applications (for instance: using compressed images to reduce the
4146 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004147
wdenk2729af92004-05-03 20:45:30 +00004148- it becomes much easier to port new Linux kernel versions because
4149 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004150
wdenk2729af92004-05-03 20:45:30 +00004151- the same Linux kernel image can now be used with different "initrd"
4152 images; of course this also means that different kernel images can
4153 be run with the same "initrd". This makes testing easier (you don't
4154 have to build a new "zImage.initrd" Linux image when you just
4155 change a file in your "initrd"). Also, a field-upgrade of the
4156 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004157
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159Linux HOWTO:
4160============
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162Porting Linux to U-Boot based systems:
4163---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004164
wdenk2729af92004-05-03 20:45:30 +00004165U-Boot cannot save you from doing all the necessary modifications to
4166configure the Linux device drivers for use with your target hardware
4167(no, we don't intend to provide a full virtual machine interface to
4168Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004169
Stefan Roesea47a12b2010-04-15 16:07:28 +02004170But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172Just make sure your machine specific header file (for instance
4173include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004174Information structure as we define in include/asm-<arch>/u-boot.h,
4175and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004176as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004177
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179Configuring the Linux kernel:
4180-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182No specific requirements for U-Boot. Make sure you have some root
4183device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004184
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk2729af92004-05-03 20:45:30 +00004186Building a Linux Image:
4187-----------------------
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk2729af92004-05-03 20:45:30 +00004189With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4190not used. If you use recent kernel source, a new build target
4191"uImage" will exist which automatically builds an image usable by
4192U-Boot. Most older kernels also have support for a "pImage" target,
4193which was introduced for our predecessor project PPCBoot and uses a
4194100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004195
wdenk2729af92004-05-03 20:45:30 +00004196Example:
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198 make TQM850L_config
4199 make oldconfig
4200 make dep
4201 make uImage
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk2729af92004-05-03 20:45:30 +00004203The "uImage" build target uses a special tool (in 'tools/mkimage') to
4204encapsulate a compressed Linux kernel image with header information,
4205CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk2729af92004-05-03 20:45:30 +00004207* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk2729af92004-05-03 20:45:30 +00004211 ${CROSS_COMPILE}-objcopy -O binary \
4212 -R .note -R .comment \
4213 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004214
wdenk2729af92004-05-03 20:45:30 +00004215* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk2729af92004-05-03 20:45:30 +00004219* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221 mkimage -A ppc -O linux -T kernel -C gzip \
4222 -a 0 -e 0 -n "Linux Kernel Image" \
4223 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004224
wdenk24ee89b2002-11-03 17:56:27 +00004225
wdenk2729af92004-05-03 20:45:30 +00004226The "mkimage" tool can also be used to create ramdisk images for use
4227with U-Boot, either separated from the Linux kernel image, or
4228combined into one file. "mkimage" encapsulates the images with a 64
4229byte header containing information about target architecture,
4230operating system, image type, compression method, entry points, time
4231stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004232
wdenk2729af92004-05-03 20:45:30 +00004233"mkimage" can be called in two ways: to verify existing images and
4234print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004235
wdenk2729af92004-05-03 20:45:30 +00004236In the first form (with "-l" option) mkimage lists the information
4237contained in the header of an existing U-Boot image; this includes
4238checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004239
wdenk2729af92004-05-03 20:45:30 +00004240 tools/mkimage -l image
4241 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243The second form (with "-d" option) is used to build a U-Boot image
4244from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4247 -n name -d data_file image
4248 -A ==> set architecture to 'arch'
4249 -O ==> set operating system to 'os'
4250 -T ==> set image type to 'type'
4251 -C ==> set compression type 'comp'
4252 -a ==> set load address to 'addr' (hex)
4253 -e ==> set entry point to 'ep' (hex)
4254 -n ==> set image name to 'name'
4255 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004256
wdenk69459792004-05-29 16:53:29 +00004257Right now, all Linux kernels for PowerPC systems use the same load
4258address (0x00000000), but the entry point address depends on the
4259kernel version:
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261- 2.2.x kernels have the entry point at 0x0000000C,
4262- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004265
wdenk2729af92004-05-03 20:45:30 +00004266 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4267 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004268 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004269 > examples/uImage.TQM850L
4270 Image Name: 2.4.4 kernel for TQM850L
4271 Created: Wed Jul 19 02:34:59 2000
4272 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4273 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4274 Load Address: 0x00000000
4275 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 -> tools/mkimage -l examples/uImage.TQM850L
4280 Image Name: 2.4.4 kernel for TQM850L
4281 Created: Wed Jul 19 02:34:59 2000
4282 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4283 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4284 Load Address: 0x00000000
4285 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004286
wdenk2729af92004-05-03 20:45:30 +00004287NOTE: for embedded systems where boot time is critical you can trade
4288speed for memory and install an UNCOMPRESSED image instead: this
4289needs more space in Flash, but boots much faster since it does not
4290need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004291
Stefan Roesea47a12b2010-04-15 16:07:28 +02004292 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004293 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4294 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004295 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004296 > examples/uImage.TQM850L-uncompressed
4297 Image Name: 2.4.4 kernel for TQM850L
4298 Created: Wed Jul 19 02:34:59 2000
4299 Image Type: PowerPC Linux Kernel Image (uncompressed)
4300 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4301 Load Address: 0x00000000
4302 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004303
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4306when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004307
wdenk2729af92004-05-03 20:45:30 +00004308 -> tools/mkimage -n 'Simple Ramdisk Image' \
4309 > -A ppc -O linux -T ramdisk -C gzip \
4310 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4311 Image Name: Simple Ramdisk Image
4312 Created: Wed Jan 12 14:01:50 2000
4313 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4314 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4315 Load Address: 0x00000000
4316 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004317
wdenkdb01a2e2004-04-15 23:14:49 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319Installing a Linux Image:
4320-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004321
wdenk2729af92004-05-03 20:45:30 +00004322To downloading a U-Boot image over the serial (console) interface,
4323you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004324
wdenk2729af92004-05-03 20:45:30 +00004325 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327The 'objcopy' does not understand the information in the U-Boot
4328image header, so the resulting S-Record file will be relative to
4329address 0x00000000. To load it to a given address, you need to
4330specify the target address as 'offset' parameter with the 'loads'
4331command.
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333Example: install the image to address 0x40100000 (which on the
4334TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk2729af92004-05-03 20:45:30 +00004336 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338 .......... done
4339 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004340
wdenk2729af92004-05-03 20:45:30 +00004341 => loads 40100000
4342 ## Ready for S-Record download ...
4343 ~>examples/image.srec
4344 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4345 ...
4346 15989 15990 15991 15992
4347 [file transfer complete]
4348 [connected]
4349 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004350
4351
wdenk2729af92004-05-03 20:45:30 +00004352You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004353this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004354corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358 ## Checking Image at 40100000 ...
4359 Image Name: 2.2.13 for initrd on TQM850L
4360 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4361 Data Size: 335725 Bytes = 327 kB = 0 MB
4362 Load Address: 00000000
4363 Entry Point: 0000000c
4364 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004365
4366
wdenk2729af92004-05-03 20:45:30 +00004367Boot Linux:
4368-----------
wdenkc6097192002-11-03 00:24:07 +00004369
wdenk2729af92004-05-03 20:45:30 +00004370The "bootm" command is used to boot an application that is stored in
4371memory (RAM or Flash). In case of a Linux kernel image, the contents
4372of the "bootargs" environment variable is passed to the kernel as
4373parameters. You can check and modify this variable using the
4374"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004375
4376
wdenk2729af92004-05-03 20:45:30 +00004377 => printenv bootargs
4378 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk2729af92004-05-03 20:45:30 +00004380 => 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 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382 => printenv bootargs
4383 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 +00004384
wdenk2729af92004-05-03 20:45:30 +00004385 => bootm 40020000
4386 ## Booting Linux kernel at 40020000 ...
4387 Image Name: 2.2.13 for NFS on TQM850L
4388 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4389 Data Size: 381681 Bytes = 372 kB = 0 MB
4390 Load Address: 00000000
4391 Entry Point: 0000000c
4392 Verifying Checksum ... OK
4393 Uncompressing Kernel Image ... OK
4394 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
4395 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4396 time_init: decrementer frequency = 187500000/60
4397 Calibrating delay loop... 49.77 BogoMIPS
4398 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4399 ...
wdenkc6097192002-11-03 00:24:07 +00004400
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004401If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004402the memory addresses of both the kernel and the initrd image (PPBCOOT
4403format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk2729af92004-05-03 20:45:30 +00004405 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407 ## Checking Image at 40100000 ...
4408 Image Name: 2.2.13 for initrd on TQM850L
4409 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4410 Data Size: 335725 Bytes = 327 kB = 0 MB
4411 Load Address: 00000000
4412 Entry Point: 0000000c
4413 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004414
wdenk2729af92004-05-03 20:45:30 +00004415 ## Checking Image at 40200000 ...
4416 Image Name: Simple Ramdisk Image
4417 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4418 Data Size: 566530 Bytes = 553 kB = 0 MB
4419 Load Address: 00000000
4420 Entry Point: 00000000
4421 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004422
wdenk2729af92004-05-03 20:45:30 +00004423 => bootm 40100000 40200000
4424 ## Booting Linux kernel at 40100000 ...
4425 Image Name: 2.2.13 for initrd on TQM850L
4426 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4427 Data Size: 335725 Bytes = 327 kB = 0 MB
4428 Load Address: 00000000
4429 Entry Point: 0000000c
4430 Verifying Checksum ... OK
4431 Uncompressing Kernel Image ... OK
4432 ## Loading RAMDisk Image at 40200000 ...
4433 Image Name: Simple Ramdisk Image
4434 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4435 Data Size: 566530 Bytes = 553 kB = 0 MB
4436 Load Address: 00000000
4437 Entry Point: 00000000
4438 Verifying Checksum ... OK
4439 Loading Ramdisk ... OK
4440 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
4441 Boot arguments: root=/dev/ram
4442 time_init: decrementer frequency = 187500000/60
4443 Calibrating delay loop... 49.77 BogoMIPS
4444 ...
4445 RAMDISK: Compressed image found at block 0
4446 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448 bash#
wdenkc6097192002-11-03 00:24:07 +00004449
Matthew McClintock02677682006-06-28 10:41:37 -05004450Boot Linux and pass a flat device tree:
4451-----------
4452
4453First, U-Boot must be compiled with the appropriate defines. See the section
4454titled "Linux Kernel Interface" above for a more in depth explanation. The
4455following is an example of how to start a kernel and pass an updated
4456flat device tree:
4457
4458=> print oftaddr
4459oftaddr=0x300000
4460=> print oft
4461oft=oftrees/mpc8540ads.dtb
4462=> tftp $oftaddr $oft
4463Speed: 1000, full duplex
4464Using TSEC0 device
4465TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4466Filename 'oftrees/mpc8540ads.dtb'.
4467Load address: 0x300000
4468Loading: #
4469done
4470Bytes transferred = 4106 (100a hex)
4471=> tftp $loadaddr $bootfile
4472Speed: 1000, full duplex
4473Using TSEC0 device
4474TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4475Filename 'uImage'.
4476Load address: 0x200000
4477Loading:############
4478done
4479Bytes transferred = 1029407 (fb51f hex)
4480=> print loadaddr
4481loadaddr=200000
4482=> print oftaddr
4483oftaddr=0x300000
4484=> bootm $loadaddr - $oftaddr
4485## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004486 Image Name: Linux-2.6.17-dirty
4487 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4488 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004489 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004490 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004491 Verifying Checksum ... OK
4492 Uncompressing Kernel Image ... OK
4493Booting using flat device tree at 0x300000
4494Using MPC85xx ADS machine description
4495Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4496[snip]
4497
4498
wdenk2729af92004-05-03 20:45:30 +00004499More About U-Boot Image Types:
4500------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004501
wdenk2729af92004-05-03 20:45:30 +00004502U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504 "Standalone Programs" are directly runnable in the environment
4505 provided by U-Boot; it is expected that (if they behave
4506 well) you can continue to work in U-Boot after return from
4507 the Standalone Program.
4508 "OS Kernel Images" are usually images of some Embedded OS which
4509 will take over control completely. Usually these programs
4510 will install their own set of exception handlers, device
4511 drivers, set up the MMU, etc. - this means, that you cannot
4512 expect to re-enter U-Boot except by resetting the CPU.
4513 "RAMDisk Images" are more or less just data blocks, and their
4514 parameters (address, size) are passed to an OS kernel that is
4515 being started.
4516 "Multi-File Images" contain several images, typically an OS
4517 (Linux) kernel image and one or more data images like
4518 RAMDisks. This construct is useful for instance when you want
4519 to boot over the network using BOOTP etc., where the boot
4520 server provides just a single image file, but you want to get
4521 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004522
wdenk2729af92004-05-03 20:45:30 +00004523 "Multi-File Images" start with a list of image sizes, each
4524 image size (in bytes) specified by an "uint32_t" in network
4525 byte order. This list is terminated by an "(uint32_t)0".
4526 Immediately after the terminating 0 follow the images, one by
4527 one, all aligned on "uint32_t" boundaries (size rounded up to
4528 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004529
wdenk2729af92004-05-03 20:45:30 +00004530 "Firmware Images" are binary images containing firmware (like
4531 U-Boot or FPGA images) which usually will be programmed to
4532 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004533
wdenk2729af92004-05-03 20:45:30 +00004534 "Script files" are command sequences that will be executed by
4535 U-Boot's command interpreter; this feature is especially
4536 useful when you configure U-Boot to use a real shell (hush)
4537 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004538
Marek Vasut44f074c2012-03-14 21:52:45 +00004539Booting the Linux zImage:
4540-------------------------
4541
4542On some platforms, it's possible to boot Linux zImage. This is done
4543using the "bootz" command. The syntax of "bootz" command is the same
4544as the syntax of "bootm" command.
4545
Marek Vasut017e1f32012-03-18 11:47:58 +00004546Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4547kernel with raw initrd images. The syntax is slightly different, the
4548address of the initrd must be augmented by it's size, in the following
4549format: "<initrd addres>:<initrd size>".
4550
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk2729af92004-05-03 20:45:30 +00004552Standalone HOWTO:
4553=================
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555One of the features of U-Boot is that you can dynamically load and
4556run "standalone" applications, which can use some resources of
4557U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004558
wdenk2729af92004-05-03 20:45:30 +00004559Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004560
wdenk2729af92004-05-03 20:45:30 +00004561"Hello World" Demo:
4562-------------------
wdenkc6097192002-11-03 00:24:07 +00004563
wdenk2729af92004-05-03 20:45:30 +00004564'examples/hello_world.c' contains a small "Hello World" Demo
4565application; it is automatically compiled when you build U-Boot.
4566It's configured to run at address 0x00040004, so you can play with it
4567like that:
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569 => loads
4570 ## Ready for S-Record download ...
4571 ~>examples/hello_world.srec
4572 1 2 3 4 5 6 7 8 9 10 11 ...
4573 [file transfer complete]
4574 [connected]
4575 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004576
wdenk2729af92004-05-03 20:45:30 +00004577 => go 40004 Hello World! This is a test.
4578 ## Starting application at 0x00040004 ...
4579 Hello World
4580 argc = 7
4581 argv[0] = "40004"
4582 argv[1] = "Hello"
4583 argv[2] = "World!"
4584 argv[3] = "This"
4585 argv[4] = "is"
4586 argv[5] = "a"
4587 argv[6] = "test."
4588 argv[7] = "<NULL>"
4589 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004590
wdenk2729af92004-05-03 20:45:30 +00004591 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593Another example, which demonstrates how to register a CPM interrupt
4594handler with the U-Boot code, can be found in 'examples/timer.c'.
4595Here, a CPM timer is set up to generate an interrupt every second.
4596The interrupt service routine is trivial, just printing a '.'
4597character, but this is just a demo program. The application can be
4598controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600 ? - print current values og the CPM Timer registers
4601 b - enable interrupts and start timer
4602 e - stop timer and disable interrupts
4603 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk2729af92004-05-03 20:45:30 +00004605 => loads
4606 ## Ready for S-Record download ...
4607 ~>examples/timer.srec
4608 1 2 3 4 5 6 7 8 9 10 11 ...
4609 [file transfer complete]
4610 [connected]
4611 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004612
wdenk2729af92004-05-03 20:45:30 +00004613 => go 40004
4614 ## Starting application at 0x00040004 ...
4615 TIMERS=0xfff00980
4616 Using timer 1
4617 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk2729af92004-05-03 20:45:30 +00004619Hit 'b':
4620 [q, b, e, ?] Set interval 1000000 us
4621 Enabling timer
4622Hit '?':
4623 [q, b, e, ?] ........
4624 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4625Hit '?':
4626 [q, b, e, ?] .
4627 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4628Hit '?':
4629 [q, b, e, ?] .
4630 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4631Hit '?':
4632 [q, b, e, ?] .
4633 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4634Hit 'e':
4635 [q, b, e, ?] ...Stopping timer
4636Hit 'q':
4637 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004638
4639
wdenk2729af92004-05-03 20:45:30 +00004640Minicom warning:
4641================
wdenk85ec0bc2003-03-31 16:34:49 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643Over time, many people have reported problems when trying to use the
4644"minicom" terminal emulation program for serial download. I (wd)
4645consider minicom to be broken, and recommend not to use it. Under
4646Unix, I recommend to use C-Kermit for general purpose use (and
4647especially for kermit binary protocol download ("loadb" command), and
4648use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650Nevertheless, if you absolutely want to use it try adding this
4651configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004652
wdenk2729af92004-05-03 20:45:30 +00004653 Name Program Name U/D FullScr IO-Red. Multi
4654 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4655 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004656
4657
wdenk2729af92004-05-03 20:45:30 +00004658NetBSD Notes:
4659=============
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk2729af92004-05-03 20:45:30 +00004661Starting at version 0.9.2, U-Boot supports NetBSD both as host
4662(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk2729af92004-05-03 20:45:30 +00004664Building requires a cross environment; it is known to work on
4665NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4666need gmake since the Makefiles are not compatible with BSD make).
4667Note that the cross-powerpc package does not install include files;
4668attempting to build U-Boot will fail because <machine/ansi.h> is
4669missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004670
wdenk2729af92004-05-03 20:45:30 +00004671 # cd /usr/pkg/cross/powerpc-netbsd/include
4672 # mkdir powerpc
4673 # ln -s powerpc machine
4674 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4675 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004676
wdenk2729af92004-05-03 20:45:30 +00004677Native builds *don't* work due to incompatibilities between native
4678and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004679
wdenk2729af92004-05-03 20:45:30 +00004680Booting assumes that (the first part of) the image booted is a
4681stage-2 loader which in turn loads and then invokes the kernel
4682proper. Loader sources will eventually appear in the NetBSD source
4683tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004684meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004685
4686
wdenk2729af92004-05-03 20:45:30 +00004687Implementation Internals:
4688=========================
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690The following is not intended to be a complete description of every
4691implementation detail. However, it should help to understand the
4692inner workings of U-Boot and make it easier to port it to custom
4693hardware.
wdenkc6097192002-11-03 00:24:07 +00004694
4695
wdenk2729af92004-05-03 20:45:30 +00004696Initial Stack, Global Data:
4697---------------------------
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk2729af92004-05-03 20:45:30 +00004699The implementation of U-Boot is complicated by the fact that U-Boot
4700starts running out of ROM (flash memory), usually without access to
4701system RAM (because the memory controller is not initialized yet).
4702This means that we don't have writable Data or BSS segments, and BSS
4703is not initialized as zero. To be able to get a C environment working
4704at all, we have to allocate at least a minimal stack. Implementation
4705options for this are defined and restricted by the CPU used: Some CPU
4706models provide on-chip memory (like the IMMR area on MPC8xx and
4707MPC826x processors), on others (parts of) the data cache can be
4708locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004709
Wolfgang Denk218ca722008-03-26 10:40:12 +01004710 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004711 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004712
wdenk2729af92004-05-03 20:45:30 +00004713 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4714 From: "Chris Hallinan" <clh@net1plus.com>
4715 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4716 ...
wdenk43d96162003-03-06 00:02:04 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718 Correct me if I'm wrong, folks, but the way I understand it
4719 is this: Using DCACHE as initial RAM for Stack, etc, does not
4720 require any physical RAM backing up the cache. The cleverness
4721 is that the cache is being used as a temporary supply of
4722 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004723 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004724 can see how this works by studying the cache architecture and
4725 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004726
wdenk2729af92004-05-03 20:45:30 +00004727 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4728 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004729 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004730 option should work for you. Using CS 4 should be fine if your
4731 board designers haven't used it for something that would
4732 cause you grief during the initial boot! It is frequently not
4733 used.
wdenk43d96162003-03-06 00:02:04 +00004734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004735 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004736 with your processor/board/system design. The default value
4737 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004738 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004739 than your SDRAM module. If you have a 64MB SDRAM module, set
4740 it above 400_0000. Just make sure your board has no resources
4741 that are supposed to respond to that address! That code in
4742 start.S has been around a while and should work as is when
4743 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004744
wdenk2729af92004-05-03 20:45:30 +00004745 -Chris Hallinan
4746 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748It is essential to remember this, since it has some impact on the C
4749code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751* Initialized global data (data segment) is read-only. Do not attempt
4752 to write it.
wdenkc6097192002-11-03 00:24:07 +00004753
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004754* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004755 as zero data - BSS segment) at all - this is undefined, initiali-
4756 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004757
wdenk2729af92004-05-03 20:45:30 +00004758* Stack space is very limited. Avoid big data buffers or things like
4759 that.
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761Having only the stack as writable memory limits means we cannot use
4762normal global data to share information beween the code. But it
4763turned out that the implementation of U-Boot can be greatly
4764simplified by making a global data structure (gd_t) available to all
4765functions. We could pass a pointer to this data as argument to _all_
4766functions, but this would bloat the code. Instead we use a feature of
4767the GCC compiler (Global Register Variables) to share the data: we
4768place a pointer (gd) to the global data into a register which we
4769reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk2729af92004-05-03 20:45:30 +00004771When choosing a register for such a purpose we are restricted by the
4772relevant (E)ABI specifications for the current architecture, and by
4773GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004774
wdenk2729af92004-05-03 20:45:30 +00004775For PowerPC, the following registers have specific use:
4776 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004777 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004778 R3-R4: parameter passing and return values
4779 R5-R10: parameter passing
4780 R13: small data area pointer
4781 R30: GOT pointer
4782 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004783
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004784 (U-Boot also uses R12 as internal GOT pointer. r12
4785 is a volatile register so r12 needs to be reset when
4786 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004787
Wolfgang Denke7670f62008-02-14 22:43:22 +01004788 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790 Note: on PPC, we could use a static initializer (since the
4791 address of the global data structure is known at compile time),
4792 but it turned out that reserving a register results in somewhat
4793 smaller code - although the code savings are not that big (on
4794 average for all boards 752 bytes for the whole U-Boot image,
4795 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004796
Robin Getzc4db3352009-08-17 15:23:02 +00004797On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004798 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4799
Robin Getzc4db3352009-08-17 15:23:02 +00004800 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004801
wdenk2729af92004-05-03 20:45:30 +00004802On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk2729af92004-05-03 20:45:30 +00004804 R0: function argument word/integer result
4805 R1-R3: function argument word
4806 R9: GOT pointer
4807 R10: stack limit (used only if stack checking if enabled)
4808 R11: argument (frame) pointer
4809 R12: temporary workspace
4810 R13: stack pointer
4811 R14: link register
4812 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk2729af92004-05-03 20:45:30 +00004814 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004815
Thomas Chou0df01fd2010-05-21 11:08:03 +08004816On Nios II, the ABI is documented here:
4817 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4818
4819 ==> U-Boot will use gp to hold a pointer to the global data
4820
4821 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4822 to access small data sections, so gp is free.
4823
Macpaul Linafc1ce82011-10-19 20:41:11 +00004824On NDS32, the following registers are used:
4825
4826 R0-R1: argument/return
4827 R2-R5: argument
4828 R15: temporary register for assembler
4829 R16: trampoline register
4830 R28: frame pointer (FP)
4831 R29: global pointer (GP)
4832 R30: link register (LP)
4833 R31: stack pointer (SP)
4834 PC: program counter (PC)
4835
4836 ==> U-Boot will use R10 to hold a pointer to the global data
4837
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004838NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4839or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841Memory Management:
4842------------------
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844U-Boot runs in system state and uses physical addresses, i.e. the
4845MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk2729af92004-05-03 20:45:30 +00004847The available memory is mapped to fixed addresses using the memory
4848controller. In this process, a contiguous block is formed for each
4849memory type (Flash, SDRAM, SRAM), even when it consists of several
4850physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852U-Boot is installed in the first 128 kB of the first Flash bank (on
4853TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4854booting and sizing and initializing DRAM, the code relocates itself
4855to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004856memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004857configuration setting]. Below that, a structure with global Board
4858Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk2729af92004-05-03 20:45:30 +00004860Additionally, some exception handler code is copied to the low 8 kB
4861of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863So a typical memory configuration with 16 MB of DRAM could look like
4864this:
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866 0x0000 0000 Exception Vector code
4867 :
4868 0x0000 1FFF
4869 0x0000 2000 Free for Application Use
4870 :
4871 :
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk2729af92004-05-03 20:45:30 +00004873 :
4874 :
4875 0x00FB FF20 Monitor Stack (Growing downward)
4876 0x00FB FFAC Board Info Data and permanent copy of global data
4877 0x00FC 0000 Malloc Arena
4878 :
4879 0x00FD FFFF
4880 0x00FE 0000 RAM Copy of Monitor Code
4881 ... eventually: LCD or video framebuffer
4882 ... eventually: pRAM (Protected RAM - unchanged by reset)
4883 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004884
4885
wdenk2729af92004-05-03 20:45:30 +00004886System Initialization:
4887----------------------
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk2729af92004-05-03 20:45:30 +00004889In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004890(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004891configuration for CS0# this is a mirror of the onboard Flash memory.
4892To be able to re-map memory U-Boot then jumps to its link address.
4893To be able to implement the initialization code in C, a (small!)
4894initial stack is set up in the internal Dual Ported RAM (in case CPUs
4895which provide such a feature like MPC8xx or MPC8260), or in a locked
4896part of the data cache. After that, U-Boot initializes the CPU core,
4897the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004898
wdenk2729af92004-05-03 20:45:30 +00004899Next, all (potentially) available memory banks are mapped using a
4900preliminary mapping. For example, we put them on 512 MB boundaries
4901(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4902on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4903programmed for SDRAM access. Using the temporary configuration, a
4904simple memory test is run that determines the size of the SDRAM
4905banks.
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk2729af92004-05-03 20:45:30 +00004907When there is more than one SDRAM bank, and the banks are of
4908different size, the largest is mapped first. For equal size, the first
4909bank (CS2#) is mapped first. The first mapping is always for address
49100x00000000, with any additional banks following immediately to create
4911contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913Then, the monitor installs itself at the upper end of the SDRAM area
4914and allocates memory for use by malloc() and for the global Board
4915Info data; also, the exception vector code is copied to the low RAM
4916pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk2729af92004-05-03 20:45:30 +00004918Only after this relocation will you have a "normal" C environment;
4919until that you are restricted in several ways, mostly because you are
4920running from ROM, and because the code will have to be relocated to a
4921new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004922
4923
wdenk2729af92004-05-03 20:45:30 +00004924U-Boot Porting Guide:
4925----------------------
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk2729af92004-05-03 20:45:30 +00004927[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4928list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004929
4930
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004931int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004932{
4933 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004934
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004935 signal(SIGALRM, no_more_time);
4936 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004937
wdenk2729af92004-05-03 20:45:30 +00004938 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004939 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004940 return 0;
4941 }
4942
wdenk2729af92004-05-03 20:45:30 +00004943 Download latest U-Boot source;
4944
Wolfgang Denk06682362008-12-30 22:56:11 +01004945 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004946
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004947 if (clueless)
4948 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk2729af92004-05-03 20:45:30 +00004950 while (learning) {
4951 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004952 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4953 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004954 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004955 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004956 }
wdenkc6097192002-11-03 00:24:07 +00004957
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004958 if (available_money > toLocalCurrency ($2500))
4959 Buy a BDI3000;
4960 else
wdenk2729af92004-05-03 20:45:30 +00004961 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004962
4963 if (a similar board exists) { /* hopefully... */
4964 cp -a board/<similar> board/<myboard>
4965 cp include/configs/<similar>.h include/configs/<myboard>.h
4966 } else {
4967 Create your own board support subdirectory;
4968 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004969 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004970 Edit new board/<myboard> files
4971 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004972
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004973 while (!accepted) {
4974 while (!running) {
4975 do {
4976 Add / modify source code;
4977 } until (compiles);
4978 Debug;
4979 if (clueless)
4980 email("Hi, I am having problems...");
4981 }
4982 Send patch file to the U-Boot email list;
4983 if (reasonable critiques)
4984 Incorporate improvements from email list code review;
4985 else
4986 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004987 }
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989 return 0;
4990}
4991
4992void no_more_time (int sig)
4993{
4994 hire_a_guru();
4995}
wdenkc6097192002-11-03 00:24:07 +00004996
4997
wdenk2729af92004-05-03 20:45:30 +00004998Coding Standards:
4999-----------------
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk2729af92004-05-03 20:45:30 +00005001All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005002coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005003"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005004
Detlev Zundel2c051652006-09-01 15:39:02 +02005005Source files originating from a different project (for example the
5006MTD subsystem) are generally exempt from these guidelines and are not
5007reformated to ease subsequent migration to newer versions of those
5008sources.
5009
5010Please note that U-Boot is implemented in C (and to some small parts in
5011Assembler); no C++ is used, so please do not use C++ style comments (//)
5012in your code.
wdenk2729af92004-05-03 20:45:30 +00005013
5014Please also stick to the following formatting rules:
5015- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005016- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005017- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005018- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005019- do not add trailing empty lines to source files
5020
5021Submissions which do not conform to the standards may be returned
5022with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005023
5024
wdenk2729af92004-05-03 20:45:30 +00005025Submitting Patches:
5026-------------------
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028Since the number of patches for U-Boot is growing, we need to
5029establish some rules. Submissions which do not conform to these rules
5030may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005031
Magnus Lilja0d28f342008-08-06 19:32:33 +02005032Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005033
Wolfgang Denk06682362008-12-30 22:56:11 +01005034Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5035see http://lists.denx.de/mailman/listinfo/u-boot
5036
wdenk2729af92004-05-03 20:45:30 +00005037When you send a patch, please include the following information with
5038it:
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk2729af92004-05-03 20:45:30 +00005040* For bug fixes: a description of the bug and how your patch fixes
5041 this bug. Please try to include a way of demonstrating that the
5042 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044* For new features: a description of the feature and your
5045 implementation.
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047* A CHANGELOG entry as plaintext (separate from the patch)
5048
5049* For major contributions, your entry to the CREDITS file
5050
5051* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005052 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005053
5054* If your patch adds new configuration options, don't forget to
5055 document these in the README file.
5056
Wolfgang Denk218ca722008-03-26 10:40:12 +01005057* The patch itself. If you are using git (which is *strongly*
5058 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005059 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005060 the U-Boot mailing list, you will avoid most of the common problems
5061 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005062
Wolfgang Denk218ca722008-03-26 10:40:12 +01005063 If you cannot use git, use "diff -purN OLD NEW". If your version of
5064 diff does not support these options, then get the latest version of
5065 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005066
Wolfgang Denk218ca722008-03-26 10:40:12 +01005067 The current directory when running this command shall be the parent
5068 directory of the U-Boot source tree (i. e. please make sure that
5069 your patch includes sufficient directory information for the
5070 affected files).
5071
5072 We prefer patches as plain text. MIME attachments are discouraged,
5073 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005074
5075* If one logical set of modifications affects or creates several
5076 files, all these changes shall be submitted in a SINGLE patch file.
5077
5078* Changesets that contain different, unrelated modifications shall be
5079 submitted as SEPARATE patches, one patch per changeset.
5080
5081
5082Notes:
5083
5084* Before sending the patch, run the MAKEALL script on your patched
5085 source tree and make sure that no errors or warnings are reported
5086 for any of the boards.
5087
5088* Keep your modifications to the necessary minimum: A patch
5089 containing several unrelated changes or arbitrary reformats will be
5090 returned with a request to re-formatting / split it.
5091
5092* If you modify existing code, make sure that your new code does not
5093 add to the memory footprint of the code ;-) Small is beautiful!
5094 When adding new features, these should compile conditionally only
5095 (using #ifdef), and the resulting code with the new feature
5096 disabled must not need more memory than the old code without your
5097 modification.
wdenk90dc6702005-05-03 14:12:25 +00005098
Wolfgang Denk06682362008-12-30 22:56:11 +01005099* Remember that there is a size limit of 100 kB per message on the
5100 u-boot mailing list. Bigger patches will be moderated. If they are
5101 reasonable and not too big, they will be acknowledged. But patches
5102 bigger than the size limit should be avoided.