blob: b025dfc24aec94f06b9f235bfe582c4e0897c3af [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk8c831282012-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
wdenkce4832c2004-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 Denkb240aef2008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denkb240aef2008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschin08337f32008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000126
wdenk24ee89b2002-11-03 17:56:27 +0000127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
129
wdenkc6097192002-11-03 00:24:07 +0000130
wdenk7474aca2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Webere89e6282010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000140
Thomas Webere89e6282010-09-28 08:06:25 +0200141Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russcbfce1d2011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500204 /mpc824x Files specific to Freescale MPC824x CPUs
205 /mpc8260 Files specific to Freescale MPC8260 CPUs
206 /mpc85xx Files specific to Freescale MPC85xx CPUs
207 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
208 /lib Architecture specific library files
209 /sh Files generic to SH architecture
210 /cpu CPU specific files
211 /sh2 Files specific to sh2 CPUs
212 /sh3 Files specific to sh3 CPUs
213 /sh4 Files specific to sh4 CPUs
214 /lib Architecture specific library files
215 /sparc Files generic to SPARC architecture
216 /cpu CPU specific files
217 /leon2 Files specific to Gaisler LEON2 SPARC CPU
218 /leon3 Files specific to Gaisler LEON3 SPARC CPU
219 /lib Architecture specific library files
220/api Machine/arch independent API for external apps
221/board Board dependent files
222/common Misc architecture independent functions
223/disk Code for disk drive partition handling
224/doc Documentation (don't expect too much)
225/drivers Commonly used device drivers
226/examples Example code for standalone applications, etc.
227/fs Filesystem code (cramfs, ext2, jffs2, etc.)
228/include Header Files
229/lib Files generic to all architectures
230 /libfdt Library files to support flattened device trees
231 /lzma Library files to support LZMA decompression
232 /lzo Library files to support LZO decompression
233/net Networking code
234/post Power On Self Test
235/rtc Real Time Clock drivers
236/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000237
wdenkc6097192002-11-03 00:24:07 +0000238Software Configuration:
239=======================
240
241Configuration is usually done using C preprocessor defines; the
242rationale behind that is to avoid dead code whenever possible.
243
244There are two classes of configuration variables:
245
246* Configuration _OPTIONS_:
247 These are selectable by the user and have names beginning with
248 "CONFIG_".
249
250* Configuration _SETTINGS_:
251 These depend on the hardware etc. and should not be meddled with if
252 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200253 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000254
255Later we will add a configuration tool - probably similar to or even
256identical to what's used for the Linux kernel. Right now, we have to
257do the configuration by hand, which means creating some symbolic
258links and editing some configuration files. We use the TQM8xxL boards
259as an example here.
260
261
262Selection of Processor Architecture and Board Type:
263---------------------------------------------------
264
265For all supported boards there are ready-to-use default
266configurations available; just type "make <board_name>_config".
267
268Example: For a TQM823L module type:
269
270 cd u-boot
271 make TQM823L_config
272
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200273For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000274e.g. "make cogent_mpc8xx_config". And also configure the cogent
275directory according to the instructions in cogent/README.
276
277
278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
wdenk2bb11052003-07-17 23:16:40 +0000324- Board flavour: (if CONFIG_MPC8260ADS is defined)
325 CONFIG_ADSTYPE
326 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200327 CONFIG_SYS_8260ADS - original MPC8260ADS
328 CONFIG_SYS_8266ADS - MPC8266ADS
329 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
330 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000331
Lei Wen20014762011-02-09 18:06:58 +0530332- Marvell Family Member
333 CONFIG_SYS_MVFS - define it if you want to enable
334 multiple fs option at one time
335 for marvell soc family
336
wdenkc6097192002-11-03 00:24:07 +0000337- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000340
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200341- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
343 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000346 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
347 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000348
wdenk20bddb32004-09-28 17:59:53 +0000349- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200350 CONFIG_SYS_8xx_CPUCLK_MIN
351 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000352 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000353 See doc/README.MPC866
354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200355 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000356
wdenk544e9732004-02-06 23:19:44 +0000357 Define this to measure the actual CPU clock instead
358 of relying on the correctness of the configured
359 values. Mostly useful for board bringup to make sure
360 the PLL is locked at the intended frequency. Note
361 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200362 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000363
Heiko Schocher734f0272009-03-12 07:37:15 +0100364 CONFIG_SYS_DELAYED_ICACHE
365
366 Define this option if you want to enable the
367 ICache only when Code runs from RAM.
368
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600369- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000370 CONFIG_SYS_PPC64
371
372 Specifies that the core is a 64-bit PowerPC implementation (implements
373 the "64" category of the Power ISA). This is necessary for ePAPR
374 compliance, among other possible reasons.
375
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600376 CONFIG_SYS_FSL_TBCLK_DIV
377
378 Defines the core time base clock divider ratio compared to the
379 system clock. On most PQ3 devices this is 8, on newer QorIQ
380 devices it can be 16 or 32. The ratio varies from SoC to Soc.
381
Kumar Gala179b1b22011-05-20 00:39:21 -0500382 CONFIG_SYS_FSL_PCIE_COMPAT
383
384 Defines the string to utilize when trying to match PCIe device
385 tree nodes for the given platform.
386
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000387 CONFIG_SYS_PPC_E500_DEBUG_TLB
388
389 Enables a temporary TLB entry to be used during boot to work
390 around limitations in e500v1 and e500v2 external debugger
391 support. This reduces the portions of the boot code where
392 breakpoints and single stepping do not work. The value of this
393 symbol should be set to the TLB1 entry to be used for this
394 purpose.
395
Scott Wood80806962012-08-14 10:14:53 +0000396 CONFIG_SYS_FSL_ERRATUM_A004510
397
398 Enables a workaround for erratum A004510. If set,
399 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
400 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
401
402 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
404
405 Defines one or two SoC revisions (low 8 bits of SVR)
406 for which the A004510 workaround should be applied.
407
408 The rest of SVR is either not relevant to the decision
409 of whether the erratum is present (e.g. p2040 versus
410 p2041) or is implied by the build target, which controls
411 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
412
413 See Freescale App Note 4493 for more information about
414 this erratum.
415
416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000421- Generic CPU options:
422 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
423
424 Defines the endianess of the CPU. Implementation of those
425 values is arch specific.
426
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100427- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200428 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100429
430 Defines the Monahans run mode to oscillator
431 ratio. Valid values are 8, 16, 24, 31. The core
432 frequency is this value multiplied by 13 MHz.
433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200434 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200435
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100436 Defines the Monahans turbo mode to oscillator
437 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200438 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100439 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200440
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200441- MIPS CPU options:
442 CONFIG_SYS_INIT_SP_OFFSET
443
444 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
445 pointer. This is needed for the temporary stack before
446 relocation.
447
448 CONFIG_SYS_MIPS_CACHE_MODE
449
450 Cache operation mode for the MIPS CPU.
451 See also arch/mips/include/asm/mipsregs.h.
452 Possible values are:
453 CONF_CM_CACHABLE_NO_WA
454 CONF_CM_CACHABLE_WA
455 CONF_CM_UNCACHED
456 CONF_CM_CACHABLE_NONCOHERENT
457 CONF_CM_CACHABLE_CE
458 CONF_CM_CACHABLE_COW
459 CONF_CM_CACHABLE_CUW
460 CONF_CM_CACHABLE_ACCELERATED
461
462 CONFIG_SYS_XWAY_EBU_BOOTCFG
463
464 Special option for Lantiq XWAY SoCs for booting from NOR flash.
465 See also arch/mips/cpu/mips32/start.S.
466
467 CONFIG_XWAY_SWAP_BYTES
468
469 Enable compilation of tools/xway-swap-bytes needed for Lantiq
470 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
471 be swapped if a flash programmer is used.
472
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000473- ARM options:
474 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
475
476 Select high exception vectors of the ARM core, e.g., do not
477 clear the V bit of the c1 register of CP15.
478
Aneesh Vb8e40802012-03-08 07:20:19 +0000479 CONFIG_SYS_THUMB_BUILD
480
481 Use this flag to build U-Boot using the Thumb instruction
482 set for ARM architectures. Thumb instruction set provides
483 better code density. For ARM architectures that support
484 Thumb2 this flag will result in Thumb2 code generated by
485 GCC.
486
Stephen Warrenc63c3502013-03-04 13:29:40 +0000487 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000488 CONFIG_ARM_ERRATA_742230
489 CONFIG_ARM_ERRATA_743622
490 CONFIG_ARM_ERRATA_751472
491
492 If set, the workarounds for these ARM errata are applied early
493 during U-Boot startup. Note that these options force the
494 workarounds to be applied; no CPU-type/version detection
495 exists, unlike the similar options in the Linux kernel. Do not
496 set these options unless they apply!
497
Stephen Warren445d56c2013-03-27 17:06:41 +0000498- CPU timer options:
499 CONFIG_SYS_HZ
500
501 The frequency of the timer returned by get_timer().
502 get_timer() must operate in milliseconds and this CONFIG
503 option must be set to 1000.
504
wdenk9b7f3842003-10-09 20:09:04 +0000505- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000506 CONFIG_CLOCKS_IN_MHZ
507
508 U-Boot stores all clock information in Hz
509 internally. For binary compatibility with older Linux
510 kernels (which expect the clocks passed in the
511 bd_info data to be in MHz) the environment variable
512 "clocks_in_mhz" can be defined so that U-Boot
513 converts clock data to MHZ before passing it to the
514 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000515 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100516 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000517 default environment.
518
wdenk9b7f3842003-10-09 20:09:04 +0000519 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
520
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200521 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000522 expect it to be in bytes, others in MB.
523 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
524
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400525 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200526
527 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400528 passed using flattened device trees (based on open firmware
529 concepts).
530
531 CONFIG_OF_LIBFDT
532 * New libfdt-based support
533 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500534 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400535
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200536 OF_CPU - The proper name of the cpus node (only required for
537 MPC512X and MPC5xxx based boards).
538 OF_SOC - The proper name of the soc node (only required for
539 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200540 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600541 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200542
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200543 boards with QUICC Engines require OF_QE to set UCC MAC
544 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500545
Kumar Gala1e26aa52006-01-11 13:54:17 -0600546 CONFIG_OF_BOARD_SETUP
547
548 Board code has addition modification that it wants to make
549 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000550
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500551 CONFIG_OF_BOOT_CPU
552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200553 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500554 param header, the default value is zero if undefined.
555
Heiko Schocherffb293a2009-09-23 07:56:08 +0200556 CONFIG_OF_IDE_FIXUP
557
558 U-Boot can detect if an IDE device is present or not.
559 If not, and this new config option is activated, U-Boot
560 removes the ATA node from the DTS before booting Linux,
561 so the Linux IDE driver does not probe the device and
562 crash. This is needed for buggy hardware (uc101) where
563 no pull down resistor is connected to the signal IDE5V_DD7.
564
Igor Grinberg06890672011-07-14 05:45:07 +0000565 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
566
567 This setting is mandatory for all boards that have only one
568 machine type and must be used to specify the machine type
569 number as it appears in the ARM machine registry
570 (see http://www.arm.linux.org.uk/developer/machines/).
571 Only boards that have multiple machine types supported
572 in a single configuration file and the machine type is
573 runtime discoverable, do not have to use this setting.
574
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100575- vxWorks boot parameters:
576
577 bootvx constructs a valid bootline using the following
578 environments variables: bootfile, ipaddr, serverip, hostname.
579 It loads the vxWorks image pointed bootfile.
580
581 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
582 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
583 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
584 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
585
586 CONFIG_SYS_VXWORKS_ADD_PARAMS
587
588 Add it at the end of the bootline. E.g "u=username pw=secret"
589
590 Note: If a "bootargs" environment is defined, it will overwride
591 the defaults discussed just above.
592
Aneesh V960f5c02011-06-16 23:30:47 +0000593- Cache Configuration:
594 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
595 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
596 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
597
Aneesh V686a0752011-06-16 23:30:51 +0000598- Cache Configuration for ARM:
599 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
600 controller
601 CONFIG_SYS_PL310_BASE - Physical base address of PL310
602 controller register space
603
wdenkda04a8b2004-08-02 23:22:59 +0000604- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200605 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000606
607 Define this if you want support for Amba PrimeCell PL010 UARTs.
608
Andreas Engel0813b122008-09-08 14:30:53 +0200609 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000610
611 Define this if you want support for Amba PrimeCell PL011 UARTs.
612
613 CONFIG_PL011_CLOCK
614
615 If you have Amba PrimeCell PL011 UARTs, set this variable to
616 the clock speed of the UARTs.
617
618 CONFIG_PL01x_PORTS
619
620 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
621 define this to a list of base addresses for each (supported)
622 port. See e.g. include/configs/versatile.h
623
John Rigby34e21ee2011-04-19 10:42:39 +0000624 CONFIG_PL011_SERIAL_RLCR
625
626 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
627 have separate receive and transmit line control registers. Set
628 this variable to initialize the extra register.
629
630 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
631
632 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
633 boot loader that has already initialized the UART. Define this
634 variable to flush the UART at init time.
635
wdenkda04a8b2004-08-02 23:22:59 +0000636
wdenkc6097192002-11-03 00:24:07 +0000637- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000638 Depending on board, define exactly one serial port
639 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
640 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
641 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000642
643 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
644 port routines must be defined elsewhere
645 (i.e. serial_init(), serial_getc(), ...)
646
647 CONFIG_CFB_CONSOLE
648 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000649 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000650 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
651 (default big endian)
652 VIDEO_HW_RECTFILL graphic chip supports
653 rectangle fill
654 (cf. smiLynxEM)
655 VIDEO_HW_BITBLT graphic chip supports
656 bit-blit (cf. smiLynxEM)
657 VIDEO_VISIBLE_COLS visible pixel columns
658 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000659 VIDEO_VISIBLE_ROWS visible pixel rows
660 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_DATA_FORMAT graphic data format
662 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000663 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000664 VIDEO_KBD_INIT_FCT keyboard int fct
665 (i.e. i8042_kbd_init())
666 VIDEO_TSTC_FCT test char fct
667 (i.e. i8042_tstc)
668 VIDEO_GETC_FCT get char fct
669 (i.e. i8042_getc)
670 CONFIG_CONSOLE_CURSOR cursor drawing on/off
671 (requires blink timer
672 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200673 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000674 CONFIG_CONSOLE_TIME display time/date info in
675 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500676 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000677 CONFIG_VIDEO_LOGO display Linux logo in
678 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000679 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
680 linux_logo.h for logo.
681 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000682 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200683 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000684 the logo
685
Pali Rohár4a57da32012-10-19 13:30:09 +0000686 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
687 a limited number of ANSI escape sequences (cursor control,
688 erase functions and limited graphics rendition control).
689
wdenk4a5c8a72003-03-06 00:02:04 +0000690 When CONFIG_CFB_CONSOLE is defined, video console is
691 default i/o. Serial console can be forced with
692 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000693
wdenk1ebf41e2004-01-02 14:00:00 +0000694 When CONFIG_SILENT_CONSOLE is defined, all console
695 messages (by U-Boot and Linux!) can be silenced with
696 the "silent" environment variable. See
697 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000698
wdenkc6097192002-11-03 00:24:07 +0000699- Console Baudrate:
700 CONFIG_BAUDRATE - in bps
701 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200702 CONFIG_SYS_BAUDRATE_TABLE, see below.
703 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000704
Heiko Schocher327480a2009-01-30 12:55:38 +0100705- Console Rx buffer length
706 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
707 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100708 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100709 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
710 must be defined, to setup the maximum idle timeout for
711 the SMC.
712
Graeme Russ3c28f482011-09-01 00:48:27 +0000713- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200714 Prior to the console being initialised (i.e. serial UART
715 initialised etc) all console output is silently discarded.
716 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
717 buffer any console messages prior to the console being
718 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
719 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
720 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200721 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200722 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000723
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200724 'Sane' compilers will generate smaller code if
725 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000726
Sonny Raocd55bde2011-11-02 09:52:08 +0000727- Safe printf() functions
728 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
729 the printf() functions. These are defined in
730 include/vsprintf.h and include snprintf(), vsnprintf() and
731 so on. Code size increase is approximately 300-500 bytes.
732 If this option is not given then these functions will
733 silently discard their buffer size argument - this means
734 you are not getting any overflow checking in this case.
735
wdenkc6097192002-11-03 00:24:07 +0000736- Boot Delay: CONFIG_BOOTDELAY - in seconds
737 Delay before automatically booting the default image;
738 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000739 set to -2 to autoboot with no delay and not check for abort
740 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000741
742 See doc/README.autoboot for these options that
743 work with CONFIG_BOOTDELAY. None are required.
744 CONFIG_BOOT_RETRY_TIME
745 CONFIG_BOOT_RETRY_MIN
746 CONFIG_AUTOBOOT_KEYED
747 CONFIG_AUTOBOOT_PROMPT
748 CONFIG_AUTOBOOT_DELAY_STR
749 CONFIG_AUTOBOOT_STOP_STR
750 CONFIG_AUTOBOOT_DELAY_STR2
751 CONFIG_AUTOBOOT_STOP_STR2
752 CONFIG_ZERO_BOOTDELAY_CHECK
753 CONFIG_RESET_TO_RETRY
754
755- Autoboot Command:
756 CONFIG_BOOTCOMMAND
757 Only needed when CONFIG_BOOTDELAY is enabled;
758 define a command string that is automatically executed
759 when no character is read on the console interface
760 within "Boot Delay" after reset.
761
762 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000763 This can be used to pass arguments to the bootm
764 command. The value of CONFIG_BOOTARGS goes into the
765 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000766
767 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000768 The value of these goes into the environment as
769 "ramboot" and "nfsboot" respectively, and can be used
770 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200771 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000772
773- Pre-Boot Commands:
774 CONFIG_PREBOOT
775
776 When this option is #defined, the existence of the
777 environment variable "preboot" will be checked
778 immediately before starting the CONFIG_BOOTDELAY
779 countdown and/or running the auto-boot command resp.
780 entering interactive mode.
781
782 This feature is especially useful when "preboot" is
783 automatically generated or modified. For an example
784 see the LWMON board specific code: here "preboot" is
785 modified when the user holds down a certain
786 combination of keys on the (special) keyboard when
787 booting the systems
788
789- Serial Download Echo Mode:
790 CONFIG_LOADS_ECHO
791 If defined to 1, all characters received during a
792 serial download (using the "loads" command) are
793 echoed back. This might be needed by some terminal
794 emulations (like "cu"), but may as well just take
795 time on others. This setting #define's the initial
796 value of the "loads_echo" environment variable.
797
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500798- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000799 CONFIG_KGDB_BAUDRATE
800 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200801 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000802
803- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500804 Monitor commands can be included or excluded
805 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000806 <config_cmd_all.h> and #undef'ing unwanted
807 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500808 and augmenting with additional #define's
809 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000810
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500811 The default command configuration includes all commands
812 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000813
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500814 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 CONFIG_CMD_BDI bdinfo
816 CONFIG_CMD_BEDBUG * Include BedBug Debugger
817 CONFIG_CMD_BMP * BMP support
818 CONFIG_CMD_BSP * Board specific commands
819 CONFIG_CMD_BOOTD bootd
820 CONFIG_CMD_CACHE * icache, dcache
821 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500822 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500823 CONFIG_CMD_DATE * support for RTC, date/time...
824 CONFIG_CMD_DHCP * DHCP support
825 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600826 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
827 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
828 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
829 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500830 CONFIG_CMD_DTT * Digital Therm and Thermostat
831 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500832 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_EEPROM * EEPROM read/write support
834 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600835 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600836 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500837 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000838 CONFIG_CMD_EXT2 * ext2 command support
839 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500840 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000842 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500843 CONFIG_CMD_FDOS * Dos diskette Support
844 CONFIG_CMD_FLASH flinfo, erase, protect
845 CONFIG_CMD_FPGA FPGA device initialization support
Benoît Thébaudeaua8e88552013-04-23 10:17:40 +0000846 CONFIG_CMD_FUSE Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000847 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500848 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000849 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000850 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500851 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
852 CONFIG_CMD_I2C * I2C serial bus support
853 CONFIG_CMD_IDE * IDE harddisk support
854 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000855 CONFIG_CMD_IMLS List all images found in NOR flash
856 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500857 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500858 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000859 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500860 CONFIG_CMD_IRQ * irqinfo
861 CONFIG_CMD_ITEST Integer/string test of 2 values
862 CONFIG_CMD_JFFS2 * JFFS2 Support
863 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500864 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000865 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
866 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_LOADB loadb
868 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400869 CONFIG_CMD_MD5SUM print md5 message digest
870 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000871 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500872 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000873 loop, loopw
874 CONFIG_CMD_MEMTEST mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500875 CONFIG_CMD_MISC Misc functions like sleep etc
876 CONFIG_CMD_MMC * MMC memory mapped support
877 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100878 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500879 CONFIG_CMD_NAND * NAND support
880 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600881 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000882 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_PCI * pciinfo
884 CONFIG_CMD_PCMCIA * PCMCIA support
885 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
886 host
887 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000888 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500889 CONFIG_CMD_REGINFO * Register dump
890 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000891 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500892 CONFIG_CMD_SAVES * save S record dump
893 CONFIG_CMD_SCSI * SCSI Support
894 CONFIG_CMD_SDRAM * print SDRAM configuration information
895 (requires CONFIG_CMD_I2C)
896 CONFIG_CMD_SETGETDCR Support for DCR Register access
897 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700898 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100899 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400900 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800901 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200902 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500903 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000904 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000905 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000906 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
907 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000910 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Barend6abef42007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000934- Regular expression support:
935 CONFIG_REGEX
936 If this variable is defined, U-Boot is linked against
937 the SLRE (Super Light Regular Expression) library,
938 which adds regex support to some commands, as for
939 example "env grep" and "setexpr".
940
Simon Glass3d686442011-10-15 05:48:20 +0000941- Device tree:
942 CONFIG_OF_CONTROL
943 If this variable is defined, U-Boot will use a device tree
944 to configure its devices, instead of relying on statically
945 compiled #defines in the board file. This option is
946 experimental and only available on a few boards. The device
947 tree is available in the global data as gd->fdt_blob.
948
Simon Glass5cb34db2011-10-24 19:15:31 +0000949 U-Boot needs to get its device tree from somewhere. This can
950 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000951
952 CONFIG_OF_EMBED
953 If this variable is defined, U-Boot will embed a device tree
954 binary in its image. This device tree file should be in the
955 board directory and called <soc>-<board>.dts. The binary file
956 is then picked up in board_init_f() and made available through
957 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000958
Simon Glass5cb34db2011-10-24 19:15:31 +0000959 CONFIG_OF_SEPARATE
960 If this variable is defined, U-Boot will build a device tree
961 binary. It will be called u-boot.dtb. Architecture-specific
962 code will locate it at run-time. Generally this works by:
963
964 cat u-boot.bin u-boot.dtb >image.bin
965
966 and in fact, U-Boot does this for you, creating a file called
967 u-boot-dtb.bin which is useful in the common case. You can
968 still use the individual files if you need something more
969 exotic.
970
wdenkc6097192002-11-03 00:24:07 +0000971- Watchdog:
972 CONFIG_WATCHDOG
973 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000974 support for the SoC. There must be support in the SoC
975 specific code for a watchdog. For the 8xx and 8260
976 CPUs, the SIU Watchdog feature is enabled in the SYPCR
977 register. When supported for a specific SoC is
978 available, then no further board specific code should
979 be needed to use it.
980
981 CONFIG_HW_WATCHDOG
982 When using a watchdog circuitry external to the used
983 SoC, then define this variable and provide board
984 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000985
stroeseb9c17c52003-04-04 15:53:41 +0000986- U-Boot Version:
987 CONFIG_VERSION_VARIABLE
988 If this variable is defined, an environment variable
989 named "ver" is created by U-Boot showing the U-Boot
990 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200991 Any change to this variable will be reverted at the
992 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000993
wdenkc6097192002-11-03 00:24:07 +0000994- Real-Time Clock:
995
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500996 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000997 has to be selected, too. Define exactly one of the
998 following options:
999
1000 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1001 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001002 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001003 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001004 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001005 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001006 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001007 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001008 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001009 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001010 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001011 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1012 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenkb9bbd242003-06-30 16:24:52 +00001014 Note that if the RTC uses I2C, then the I2C interface
1015 must also be configured. See I2C Support, below.
1016
Peter Tyser9902e422008-12-17 16:36:21 -06001017- GPIO Support:
1018 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1019 CONFIG_PCA953X_INFO - enable pca953x info command
1020
Chris Packham9b383202010-12-19 10:12:13 +00001021 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1022 chip-ngpio pairs that tell the PCA953X driver the number of
1023 pins supported by a particular chip.
1024
Peter Tyser9902e422008-12-17 16:36:21 -06001025 Note that if the GPIO device uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
wdenkc6097192002-11-03 00:24:07 +00001028- Timestamp Support:
1029
wdenk4a5c8a72003-03-06 00:02:04 +00001030 When CONFIG_TIMESTAMP is selected, the timestamp
1031 (date and time) of an image is printed by image
1032 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001033 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001034
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001035- Partition Labels (disklabels) Supported:
1036 Zero or more of the following:
1037 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1038 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1039 Intel architecture, USB sticks, etc.
1040 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1041 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1042 bootloader. Note 2TB partition limit; see
1043 disk/part_efi.c
1044 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001045
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001046 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1047 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001048 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001049
1050- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001051 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1052 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001053
wdenk369d43d2004-03-14 14:09:05 +00001054 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1055 be performed by calling the function
1056 ide_set_reset(int reset)
1057 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001058
1059- ATAPI Support:
1060 CONFIG_ATAPI
1061
1062 Set this to enable ATAPI support.
1063
wdenkf602aa02004-03-13 23:29:43 +00001064- LBA48 Support
1065 CONFIG_LBA48
1066
1067 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001068 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001069 Whithout these , LBA48 support uses 32bit variables and will 'only'
1070 support disks up to 2.1TB.
1071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001072 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001073 When enabled, makes the IDE subsystem use 64bit sector addresses.
1074 Default is 32bit.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- SCSI Support:
1077 At the moment only there is only support for the
1078 SYM53C8XX SCSI controller; define
1079 CONFIG_SCSI_SYM53C8XX to enable it.
1080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001081 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1082 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1083 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001084 maximum numbers of LUNs, SCSI ID's and target
1085 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001086 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001087
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001088 The environment variable 'scsidevs' is set to the number of
1089 SCSI devices found during the last scan.
1090
wdenkc6097192002-11-03 00:24:07 +00001091- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001092 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001093 Support for Intel 8254x/8257x gigabit chips.
1094
1095 CONFIG_E1000_SPI
1096 Utility code for direct access to the SPI bus on Intel 8257x.
1097 This does not do anything useful unless you set at least one
1098 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1099
1100 CONFIG_E1000_SPI_GENERIC
1101 Allow generic access to the SPI bus on the Intel 8257x, for
1102 example with the "sspi" command.
1103
1104 CONFIG_CMD_E1000
1105 Management command for E1000 devices. When used on devices
1106 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001107
Andre Schwarz68c2a302008-03-06 16:45:44 +01001108 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001109 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001110
wdenkc6097192002-11-03 00:24:07 +00001111 CONFIG_EEPRO100
1112 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001113 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001114 write routine for first time initialisation.
1115
1116 CONFIG_TULIP
1117 Support for Digital 2114x chips.
1118 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1119 modem chip initialisation (KS8761/QS6611).
1120
1121 CONFIG_NATSEMI
1122 Support for National dp83815 chips.
1123
1124 CONFIG_NS8382X
1125 Support for National dp8382[01] gigabit chips.
1126
wdenkaa603362003-05-12 21:50:16 +00001127- NETWORK Support (other):
1128
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001129 CONFIG_DRIVER_AT91EMAC
1130 Support for AT91RM9200 EMAC.
1131
1132 CONFIG_RMII
1133 Define this to use reduced MII inteface
1134
1135 CONFIG_DRIVER_AT91EMAC_QUIET
1136 If this defined, the driver is quiet.
1137 The driver doen't show link status messages.
1138
Rob Herringc9830dc2011-12-15 11:15:49 +00001139 CONFIG_CALXEDA_XGMAC
1140 Support for the Calxeda XGMAC device
1141
Ashok93fb8722012-10-15 06:20:47 +00001142 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001143 Support for SMSC's LAN91C96 chips.
1144
1145 CONFIG_LAN91C96_BASE
1146 Define this to hold the physical address
1147 of the LAN91C96's I/O space
1148
1149 CONFIG_LAN91C96_USE_32_BIT
1150 Define this to enable 32 bit addressing
1151
Ashok93fb8722012-10-15 06:20:47 +00001152 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001153 Support for SMSC's LAN91C111 chip
1154
1155 CONFIG_SMC91111_BASE
1156 Define this to hold the physical address
1157 of the device (I/O space)
1158
1159 CONFIG_SMC_USE_32_BIT
1160 Define this if data bus is 32 bits
1161
1162 CONFIG_SMC_USE_IOFUNCS
1163 Define this to use i/o functions instead of macros
1164 (some hardware wont work with macros)
1165
Heiko Schocher7d037f72011-11-15 10:00:04 -05001166 CONFIG_DRIVER_TI_EMAC
1167 Support for davinci emac
1168
1169 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1170 Define this if you have more then 3 PHYs.
1171
Macpaul Lin199c6252010-12-21 16:59:46 +08001172 CONFIG_FTGMAC100
1173 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1174
1175 CONFIG_FTGMAC100_EGIGA
1176 Define this to use GE link update with gigabit PHY.
1177 Define this if FTGMAC100 is connected to gigabit PHY.
1178 If your system has 10/100 PHY only, it might not occur
1179 wrong behavior. Because PHY usually return timeout or
1180 useless data when polling gigabit status and gigabit
1181 control registers. This behavior won't affect the
1182 correctnessof 10/100 link speed update.
1183
Mike Rapoportf4761af2009-11-11 10:03:03 +02001184 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001185 Support for SMSC's LAN911x and LAN921x chips
1186
Mike Rapoportf4761af2009-11-11 10:03:03 +02001187 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001188 Define this to hold the physical address
1189 of the device (I/O space)
1190
Mike Rapoportf4761af2009-11-11 10:03:03 +02001191 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001192 Define this if data bus is 32 bits
1193
Mike Rapoportf4761af2009-11-11 10:03:03 +02001194 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001195 Define this if data bus is 16 bits. If your processor
1196 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001197 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001198
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001199 CONFIG_SH_ETHER
1200 Support for Renesas on-chip Ethernet controller
1201
1202 CONFIG_SH_ETHER_USE_PORT
1203 Define the number of ports to be used
1204
1205 CONFIG_SH_ETHER_PHY_ADDR
1206 Define the ETH PHY's address
1207
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001208 CONFIG_SH_ETHER_CACHE_WRITEBACK
1209 If this option is set, the driver enables cache flush.
1210
Vadim Bendeburydac69642011-10-17 08:36:14 +00001211- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001212 CONFIG_TPM
1213 Support TPM devices.
1214
1215 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001216 Support for generic parallel port TPM devices. Only one device
1217 per system is supported at this time.
1218
1219 CONFIG_TPM_TIS_BASE_ADDRESS
1220 Base address where the generic TPM device is mapped
1221 to. Contemporary x86 systems usually map it at
1222 0xfed40000.
1223
wdenkc6097192002-11-03 00:24:07 +00001224- USB Support:
1225 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001226 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001227 CONFIG_USB_UHCI to enable it.
1228 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001229 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001230 storage devices.
1231 Note:
1232 Supported are USB Keyboards and USB Floppy drives
1233 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001234 MPC5200 USB requires additional defines:
1235 CONFIG_USB_CLOCK
1236 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001237 CONFIG_PSC3_USB
1238 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001239 CONFIG_USB_CONFIG
1240 for differential drivers: 0x00001000
1241 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001242 for differential drivers on PSC3: 0x00000100
1243 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001244 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001245 May be defined to allow interrupt polling
1246 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001247
Simon Glass5978cdb2012-02-27 10:52:47 +00001248 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1249 txfilltuning field in the EHCI controller on reset.
1250
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001251- USB Device:
1252 Define the below if you wish to use the USB console.
1253 Once firmware is rebuilt from a serial console issue the
1254 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001255 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001256 it has found a new device. The environment variable usbtty
1257 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001258 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001259 Common Device Class Abstract Control Model serial device.
1260 If you select usbtty = gserial you should be able to enumerate
1261 a Linux host by
1262 # modprobe usbserial vendor=0xVendorID product=0xProductID
1263 else if using cdc_acm, simply setting the environment
1264 variable usbtty to be cdc_acm should suffice. The following
1265 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001266
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001267 CONFIG_USB_DEVICE
1268 Define this to build a UDC device
1269
1270 CONFIG_USB_TTY
1271 Define this to have a tty type of device available to
1272 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001273
Vipin KUMARbdb17702012-03-26 15:38:06 +05301274 CONFIG_USBD_HS
1275 Define this to enable the high speed support for usb
1276 device and usbtty. If this feature is enabled, a routine
1277 int is_usbd_high_speed(void)
1278 also needs to be defined by the driver to dynamically poll
1279 whether the enumeration has succeded at high speed or full
1280 speed.
1281
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001282 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001283 Define this if you want stdin, stdout &/or stderr to
1284 be set to usbtty.
1285
1286 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001287 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001288 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001289 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001291 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001292 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001293 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001294
Wolfgang Denke2601822006-06-14 18:14:56 +02001295 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001296 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001297 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001298 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1299 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1300 should pretend to be a Linux device to it's target host.
1301
1302 CONFIG_USBD_MANUFACTURER
1303 Define this string as the name of your company for
1304 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001305
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001306 CONFIG_USBD_PRODUCT_NAME
1307 Define this string as the name of your product
1308 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001309
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001310 CONFIG_USBD_VENDORID
1311 Define this as your assigned Vendor ID from the USB
1312 Implementors Forum. This *must* be a genuine Vendor ID
1313 to avoid polluting the USB namespace.
1314 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001315
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001316 CONFIG_USBD_PRODUCTID
1317 Define this as the unique Product ID
1318 for your device
1319 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001320
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001321- ULPI Layer Support:
1322 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1323 the generic ULPI layer. The generic layer accesses the ULPI PHY
1324 via the platform viewport, so you need both the genric layer and
1325 the viewport enabled. Currently only Chipidea/ARC based
1326 viewport is supported.
1327 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1328 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001329 If your ULPI phy needs a different reference clock than the
1330 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1331 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001332
wdenk7a428cc2003-06-15 22:40:42 +00001333- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001334 The MMC controller on the Intel PXA is supported. To
1335 enable this define CONFIG_MMC. The MMC can be
1336 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001337 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001338 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1339 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001340
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001341 CONFIG_SH_MMCIF
1342 Support for Renesas on-chip MMCIF controller
1343
1344 CONFIG_SH_MMCIF_ADDR
1345 Define the base address of MMCIF registers
1346
1347 CONFIG_SH_MMCIF_CLK
1348 Define the clock frequency for MMCIF
1349
Tom Rini58a8d322013-03-14 05:32:47 +00001350- USB Device Firmware Update (DFU) class support:
1351 CONFIG_DFU_FUNCTION
1352 This enables the USB portion of the DFU USB class
1353
1354 CONFIG_CMD_DFU
1355 This enables the command "dfu" which is used to have
1356 U-Boot create a DFU class device via USB. This command
1357 requires that the "dfu_alt_info" environment variable be
1358 set and define the alt settings to expose to the host.
1359
1360 CONFIG_DFU_MMC
1361 This enables support for exposing (e)MMC devices via DFU.
1362
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001363 CONFIG_DFU_NAND
1364 This enables support for exposing NAND devices via DFU.
1365
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001366 CONFIG_SYS_DFU_MAX_FILE_SIZE
1367 When updating files rather than the raw storage device,
1368 we use a static buffer to copy the file into and then write
1369 the buffer once we've been given the whole file. Define
1370 this to the maximum filesize (in bytes) for the buffer.
1371 Default is 4 MiB if undefined.
1372
wdenkda04a8b2004-08-02 23:22:59 +00001373- Journaling Flash filesystem support:
1374 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1375 CONFIG_JFFS2_NAND_DEV
1376 Define these for a default partition on a NAND device
1377
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001378 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1379 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001380 Define these for a default partition on a NOR device
1381
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001382 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001383 Define this to create an own partition. You have to provide a
1384 function struct part_info* jffs2_part_info(int part_num)
1385
1386 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001387 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001388 to disable the command chpart. This is the default when you
1389 have not defined a custom partition
1390
Donggeun Kim8f814002011-10-24 21:15:28 +00001391- FAT(File Allocation Table) filesystem write function support:
1392 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001393
1394 Define this to enable support for saving memory data as a
1395 file in FAT formatted partition.
1396
1397 This will also enable the command "fatwrite" enabling the
1398 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001399
Gabe Black7f8574c2012-10-12 14:26:11 +00001400CBFS (Coreboot Filesystem) support
1401 CONFIG_CMD_CBFS
1402
1403 Define this to enable support for reading from a Coreboot
1404 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1405 and cbfsload.
1406
wdenkc6097192002-11-03 00:24:07 +00001407- Keyboard Support:
1408 CONFIG_ISA_KEYBOARD
1409
1410 Define this to enable standard (PC-Style) keyboard
1411 support
1412
1413 CONFIG_I8042_KBD
1414 Standard PC keyboard driver with US (is default) and
1415 GERMAN key layout (switch via environment 'keymap=de') support.
1416 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1417 for cfb_console. Supports cursor blinking.
1418
1419- Video support:
1420 CONFIG_VIDEO
1421
1422 Define this to enable video support (for output to
1423 video).
1424
1425 CONFIG_VIDEO_CT69000
1426
1427 Enable Chips & Technologies 69000 Video chip
1428
1429 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001430 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001431 video output is selected via environment 'videoout'
1432 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1433 assumed.
wdenkc6097192002-11-03 00:24:07 +00001434
wdenkd3602132004-03-25 15:14:43 +00001435 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001436 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001437 are possible:
1438 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001439 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001440
1441 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1442 -------------+---------------------------------------------
1443 8 bits | 0x301* 0x303 0x305 0x161 0x307
1444 15 bits | 0x310 0x313 0x316 0x162 0x319
1445 16 bits | 0x311 0x314 0x317 0x163 0x31A
1446 24 bits | 0x312 0x315 0x318 ? 0x31B
1447 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001448 (i.e. setenv videomode 317; saveenv; reset;)
1449
wdenkd3602132004-03-25 15:14:43 +00001450 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001451 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001452
1453
stroeseb9c17c52003-04-04 15:53:41 +00001454 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001455 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001456 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1457 or CONFIG_VIDEO_SED13806_16BPP
1458
Timur Tabi020edd22011-02-15 17:09:19 -06001459 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001460 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001461 SOCs that have a DIU should define this macro to enable DIU
1462 support, and should also define these other macros:
1463
1464 CONFIG_SYS_DIU_ADDR
1465 CONFIG_VIDEO
1466 CONFIG_CMD_BMP
1467 CONFIG_CFB_CONSOLE
1468 CONFIG_VIDEO_SW_CURSOR
1469 CONFIG_VGA_AS_SINGLE_DEVICE
1470 CONFIG_VIDEO_LOGO
1471 CONFIG_VIDEO_BMP_LOGO
1472
Timur Tabi32f709e2011-04-11 14:18:22 -05001473 The DIU driver will look for the 'video-mode' environment
1474 variable, and if defined, enable the DIU as a console during
1475 boot. See the documentation file README.video for a
1476 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001477
Simon Glass54df8ce2012-12-03 13:59:47 +00001478 CONFIG_VIDEO_VGA
1479
1480 Enable the VGA video / BIOS for x86. The alternative if you
1481 are using coreboot is to use the coreboot frame buffer
1482 driver.
1483
1484
wdenk4e112c12003-06-03 23:54:09 +00001485- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001486 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001487
wdenk57b2d802003-06-27 21:31:46 +00001488 Define this to enable a custom keyboard support.
1489 This simply calls drv_keyboard_init() which must be
1490 defined in your board-specific files.
1491 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001492
wdenkc6097192002-11-03 00:24:07 +00001493- LCD Support: CONFIG_LCD
1494
1495 Define this to enable LCD support (for output to LCD
1496 display); also select one of the supported displays
1497 by defining one of these:
1498
Stelian Popf6f86652008-05-09 21:57:18 +02001499 CONFIG_ATMEL_LCD:
1500
1501 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1502
wdenkc0d54ae2003-11-25 16:55:19 +00001503 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001504
wdenkc0d54ae2003-11-25 16:55:19 +00001505 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001506
wdenkc0d54ae2003-11-25 16:55:19 +00001507 CONFIG_NEC_NL6448BC20
1508
1509 NEC NL6448BC20-08. 6.5", 640x480.
1510 Active, color, single scan.
1511
1512 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001513
wdenkc0d54ae2003-11-25 16:55:19 +00001514 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001515 Active, color, single scan.
1516
1517 CONFIG_SHARP_16x9
1518
1519 Sharp 320x240. Active, color, single scan.
1520 It isn't 16x9, and I am not sure what it is.
1521
1522 CONFIG_SHARP_LQ64D341
1523
1524 Sharp LQ64D341 display, 640x480.
1525 Active, color, single scan.
1526
1527 CONFIG_HLD1045
1528
1529 HLD1045 display, 640x480.
1530 Active, color, single scan.
1531
1532 CONFIG_OPTREX_BW
1533
1534 Optrex CBL50840-2 NF-FW 99 22 M5
1535 or
1536 Hitachi LMG6912RPFC-00T
1537 or
1538 Hitachi SP14Q002
1539
1540 320x240. Black & white.
1541
1542 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001543 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001544
Simon Glass599a4df2012-10-17 13:24:54 +00001545 CONFIG_LCD_ALIGNMENT
1546
1547 Normally the LCD is page-aligned (tyically 4KB). If this is
1548 defined then the LCD will be aligned to this value instead.
1549 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1550 here, since it is cheaper to change data cache settings on
1551 a per-section basis.
1552
Simon Glassaf3e2802012-10-17 13:24:59 +00001553 CONFIG_CONSOLE_SCROLL_LINES
1554
1555 When the console need to be scrolled, this is the number of
1556 lines to scroll by. It defaults to 1. Increasing this makes
1557 the console jump but can help speed up operation when scrolling
1558 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001559
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001560 CONFIG_LCD_BMP_RLE8
1561
1562 Support drawing of RLE8-compressed bitmaps on the LCD.
1563
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001564 CONFIG_I2C_EDID
1565
1566 Enables an 'i2c edid' command which can read EDID
1567 information over I2C from an attached LCD display.
1568
wdenkeb20ad32003-09-05 23:19:14 +00001569- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001570
wdenk57b2d802003-06-27 21:31:46 +00001571 If this option is set, the environment is checked for
1572 a variable "splashimage". If found, the usual display
1573 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001574 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001575 specified in "splashimage" is loaded instead. The
1576 console is redirected to the "nulldev", too. This
1577 allows for a "silent" boot where a splash screen is
1578 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001579
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001580 CONFIG_SPLASHIMAGE_GUARD
1581
1582 If this option is set, then U-Boot will prevent the environment
1583 variable "splashimage" from being set to a problematic address
1584 (see README.displaying-bmps and README.arm-unaligned-accesses).
1585 This option is useful for targets where, due to alignment
1586 restrictions, an improperly aligned BMP image will cause a data
1587 abort. If you think you will not have problems with unaligned
1588 accesses (for example because your toolchain prevents them)
1589 there is no need to set this option.
1590
Matthias Weisser53884182009-07-09 16:07:30 +02001591 CONFIG_SPLASH_SCREEN_ALIGN
1592
1593 If this option is set the splash image can be freely positioned
1594 on the screen. Environment variable "splashpos" specifies the
1595 position as "x,y". If a positive number is given it is used as
1596 number of pixel from left/top. If a negative number is given it
1597 is used as number of pixel from right/bottom. You can also
1598 specify 'm' for centering the image.
1599
1600 Example:
1601 setenv splashpos m,m
1602 => image at center of screen
1603
1604 setenv splashpos 30,20
1605 => image at x = 30 and y = 20
1606
1607 setenv splashpos -10,m
1608 => vertically centered image
1609 at x = dspWidth - bmpWidth - 9
1610
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001611 CONFIG_SPLASH_SCREEN_PREPARE
1612
1613 If this option is set then the board_splash_screen_prepare()
1614 function, which must be defined in your code, is called as part
1615 of the splash screen display sequence. It gives the board an
1616 opportunity to prepare the splash image data before it is
1617 processed and sent to the frame buffer by U-Boot.
1618
Stefan Roesed9d97742005-09-22 09:04:17 +02001619- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1620
1621 If this option is set, additionally to standard BMP
1622 images, gzipped BMP images can be displayed via the
1623 splashscreen support or the bmp command.
1624
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001625- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1626
1627 If this option is set, 8-bit RLE compressed BMP images
1628 can be displayed via the splashscreen support or the
1629 bmp command.
1630
Lei Wene4e248d2012-09-28 04:26:47 +00001631- Do compresssing for memory range:
1632 CONFIG_CMD_ZIP
1633
1634 If this option is set, it would use zlib deflate method
1635 to compress the specified memory at its best effort.
1636
wdenk710e3502003-08-29 20:57:53 +00001637- Compression support:
1638 CONFIG_BZIP2
1639
1640 If this option is set, support for bzip2 compressed
1641 images is included. If not, only uncompressed and gzip
1642 compressed images are supported.
1643
wdenk9c53f402003-10-15 23:53:47 +00001644 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001645 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001646 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001647
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001648 CONFIG_LZMA
1649
1650 If this option is set, support for lzma compressed
1651 images is included.
1652
1653 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1654 requires an amount of dynamic memory that is given by the
1655 formula:
1656
1657 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1658
1659 Where lc and lp stand for, respectively, Literal context bits
1660 and Literal pos bits.
1661
1662 This value is upper-bounded by 14MB in the worst case. Anyway,
1663 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1664 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1665 a very small buffer.
1666
1667 Use the lzmainfo tool to determinate the lc and lp values and
1668 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001669 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001670
wdenk0e2bd9c2004-06-06 21:51:03 +00001671- MII/PHY support:
1672 CONFIG_PHY_ADDR
1673
1674 The address of PHY on MII bus.
1675
1676 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1677
1678 The clock frequency of the MII bus
1679
1680 CONFIG_PHY_GIGE
1681
1682 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001683 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001684
1685 CONFIG_PHY_RESET_DELAY
1686
1687 Some PHY like Intel LXT971A need extra delay after
1688 reset before any MII register access is possible.
1689 For such PHY, set this option to the usec delay
1690 required. (minimum 300usec for LXT971A)
1691
1692 CONFIG_PHY_CMD_DELAY (ppc4xx)
1693
1694 Some PHY like Intel LXT971A need extra delay after
1695 command issued before MII status register can be read
1696
wdenkc6097192002-11-03 00:24:07 +00001697- Ethernet address:
1698 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001699 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001700 CONFIG_ETH2ADDR
1701 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001702 CONFIG_ETH4ADDR
1703 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001704
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001705 Define a default value for Ethernet address to use
1706 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001707 is not determined automatically.
1708
1709- IP address:
1710 CONFIG_IPADDR
1711
1712 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001713 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001714 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001715 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001716
1717- Server IP address:
1718 CONFIG_SERVERIP
1719
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001720 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001721 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001722 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001723
Robin Getz470a6d42009-07-21 12:15:28 -04001724 CONFIG_KEEP_SERVERADDR
1725
1726 Keeps the server's MAC address, in the env 'serveraddr'
1727 for passing to bootargs (like Linux's netconsole option)
1728
Wolfgang Denk26da2992011-10-26 10:21:22 +00001729- Gateway IP address:
1730 CONFIG_GATEWAYIP
1731
1732 Defines a default value for the IP address of the
1733 default router where packets to other networks are
1734 sent to.
1735 (Environment variable "gatewayip")
1736
1737- Subnet mask:
1738 CONFIG_NETMASK
1739
1740 Defines a default value for the subnet mask (or
1741 routing prefix) which is used to determine if an IP
1742 address belongs to the local subnet or needs to be
1743 forwarded through a router.
1744 (Environment variable "netmask")
1745
David Updegraff7280da72007-06-11 10:41:07 -05001746- Multicast TFTP Mode:
1747 CONFIG_MCAST_TFTP
1748
1749 Defines whether you want to support multicast TFTP as per
1750 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001751 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001752 driver in use must provide a function: mcast() to join/leave a
1753 multicast group.
1754
wdenkc6097192002-11-03 00:24:07 +00001755- BOOTP Recovery Mode:
1756 CONFIG_BOOTP_RANDOM_DELAY
1757
1758 If you have many targets in a network that try to
1759 boot using BOOTP, you may want to avoid that all
1760 systems send out BOOTP requests at precisely the same
1761 moment (which would happen for instance at recovery
1762 from a power failure, when all systems will try to
1763 boot, thus flooding the BOOTP server. Defining
1764 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1765 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001766 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001767
1768 1st BOOTP request: delay 0 ... 1 sec
1769 2nd BOOTP request: delay 0 ... 2 sec
1770 3rd BOOTP request: delay 0 ... 4 sec
1771 4th and following
1772 BOOTP requests: delay 0 ... 8 sec
1773
stroesee0aadfb2003-08-28 14:17:32 +00001774- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001775 You can fine tune the DHCP functionality by defining
1776 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001777
Jon Loeliger5336a762007-07-09 22:08:34 -05001778 CONFIG_BOOTP_SUBNETMASK
1779 CONFIG_BOOTP_GATEWAY
1780 CONFIG_BOOTP_HOSTNAME
1781 CONFIG_BOOTP_NISDOMAIN
1782 CONFIG_BOOTP_BOOTPATH
1783 CONFIG_BOOTP_BOOTFILESIZE
1784 CONFIG_BOOTP_DNS
1785 CONFIG_BOOTP_DNS2
1786 CONFIG_BOOTP_SEND_HOSTNAME
1787 CONFIG_BOOTP_NTPSERVER
1788 CONFIG_BOOTP_TIMEOFFSET
1789 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001790 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001791
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001792 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1793 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001794
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001795 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1796 after the configured retry count, the call will fail
1797 instead of starting over. This can be used to fail over
1798 to Link-local IP address configuration if the DHCP server
1799 is not available.
1800
stroesee0aadfb2003-08-28 14:17:32 +00001801 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1802 serverip from a DHCP server, it is possible that more
1803 than one DNS serverip is offered to the client.
1804 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1805 serverip will be stored in the additional environment
1806 variable "dnsip2". The first DNS serverip is always
1807 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001808 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001809
1810 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1811 to do a dynamic update of a DNS server. To do this, they
1812 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001813 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001814 of the "hostname" environment variable is passed as
1815 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001816
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001817 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1818
1819 A 32bit value in microseconds for a delay between
1820 receiving a "DHCP Offer" and sending the "DHCP Request".
1821 This fixes a problem with certain DHCP servers that don't
1822 respond 100% of the time to a "DHCP request". E.g. On an
1823 AT91RM9200 processor running at 180MHz, this delay needed
1824 to be *at least* 15,000 usec before a Windows Server 2003
1825 DHCP server would reply 100% of the time. I recommend at
1826 least 50,000 usec to be safe. The alternative is to hope
1827 that one of the retries will be successful but note that
1828 the DHCP timeout and retry process takes a longer than
1829 this delay.
1830
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001831 - Link-local IP address negotiation:
1832 Negotiate with other link-local clients on the local network
1833 for an address that doesn't require explicit configuration.
1834 This is especially useful if a DHCP server cannot be guaranteed
1835 to exist in all environments that the device must operate.
1836
1837 See doc/README.link-local for more information.
1838
wdenk145d2c12004-04-15 21:48:45 +00001839 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001840 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001841
1842 The device id used in CDP trigger frames.
1843
1844 CONFIG_CDP_DEVICE_ID_PREFIX
1845
1846 A two character string which is prefixed to the MAC address
1847 of the device.
1848
1849 CONFIG_CDP_PORT_ID
1850
1851 A printf format string which contains the ascii name of
1852 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001853 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001854
1855 CONFIG_CDP_CAPABILITIES
1856
1857 A 32bit integer which indicates the device capabilities;
1858 0x00000010 for a normal host which does not forwards.
1859
1860 CONFIG_CDP_VERSION
1861
1862 An ascii string containing the version of the software.
1863
1864 CONFIG_CDP_PLATFORM
1865
1866 An ascii string containing the name of the platform.
1867
1868 CONFIG_CDP_TRIGGER
1869
1870 A 32bit integer sent on the trigger.
1871
1872 CONFIG_CDP_POWER_CONSUMPTION
1873
1874 A 16bit integer containing the power consumption of the
1875 device in .1 of milliwatts.
1876
1877 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1878
1879 A byte containing the id of the VLAN.
1880
wdenkc6097192002-11-03 00:24:07 +00001881- Status LED: CONFIG_STATUS_LED
1882
1883 Several configurations allow to display the current
1884 status using a LED. For instance, the LED will blink
1885 fast while running U-Boot code, stop blinking as
1886 soon as a reply to a BOOTP request was received, and
1887 start blinking slow once the Linux kernel is running
1888 (supported by a status LED driver in the Linux
1889 kernel). Defining CONFIG_STATUS_LED enables this
1890 feature in U-Boot.
1891
1892- CAN Support: CONFIG_CAN_DRIVER
1893
1894 Defining CONFIG_CAN_DRIVER enables CAN driver support
1895 on those systems that support this (optional)
1896 feature, like the TQM8xxL modules.
1897
1898- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1899
wdenkb9bbd242003-06-30 16:24:52 +00001900 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001901 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001902 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001903
wdenk21136db2003-07-16 21:53:01 +00001904 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001905 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001906 CONFIG_COMMANDS) and communicate with i2c based realtime
1907 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001908 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001909
Ben Warren45657152006-09-07 16:50:54 -04001910 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001911
wdenk21136db2003-07-16 21:53:01 +00001912 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001913 bit-banging) driver instead of CPM or similar hardware
1914 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001915
wdenk21136db2003-07-16 21:53:01 +00001916 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001917 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001918
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001919 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001920 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001921 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001922 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001923
Peter Tysere4d1abc2010-04-12 22:28:21 -05001924 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001925 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001926 and so its address should therefore be cleared to 0 (See,
1927 eg, MPC823e User's Manual p.16-473). So, set
1928 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001929
Eric Millbrandt12990a42009-09-03 08:09:44 -05001930 CONFIG_SYS_I2C_INIT_MPC5XXX
1931
1932 When a board is reset during an i2c bus transfer
1933 chips might think that the current transfer is still
1934 in progress. Reset the slave devices by sending start
1935 commands until the slave device responds.
1936
wdenk21136db2003-07-16 21:53:01 +00001937 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001938
wdenkb9bbd242003-06-30 16:24:52 +00001939 If you use the software i2c interface (CONFIG_SOFT_I2C)
1940 then the following macros need to be defined (examples are
1941 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001942
1943 I2C_INIT
1944
wdenkb9bbd242003-06-30 16:24:52 +00001945 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001946 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001947
wdenk544e9732004-02-06 23:19:44 +00001948 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001949
wdenkc6097192002-11-03 00:24:07 +00001950 I2C_PORT
1951
wdenk4a5c8a72003-03-06 00:02:04 +00001952 (Only for MPC8260 CPU). The I/O port to use (the code
1953 assumes both bits are on the same port). Valid values
1954 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001955
1956 I2C_ACTIVE
1957
1958 The code necessary to make the I2C data line active
1959 (driven). If the data line is open collector, this
1960 define can be null.
1961
wdenkb9bbd242003-06-30 16:24:52 +00001962 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1963
wdenkc6097192002-11-03 00:24:07 +00001964 I2C_TRISTATE
1965
1966 The code necessary to make the I2C data line tri-stated
1967 (inactive). If the data line is open collector, this
1968 define can be null.
1969
wdenkb9bbd242003-06-30 16:24:52 +00001970 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1971
wdenkc6097192002-11-03 00:24:07 +00001972 I2C_READ
1973
York Sun4a598092013-04-01 11:29:11 -07001974 Code that returns true if the I2C data line is high,
1975 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001976
wdenkb9bbd242003-06-30 16:24:52 +00001977 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1978
wdenkc6097192002-11-03 00:24:07 +00001979 I2C_SDA(bit)
1980
York Sun4a598092013-04-01 11:29:11 -07001981 If <bit> is true, sets the I2C data line high. If it
1982 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001983
wdenkb9bbd242003-06-30 16:24:52 +00001984 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001985 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001986 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001987
wdenkc6097192002-11-03 00:24:07 +00001988 I2C_SCL(bit)
1989
York Sun4a598092013-04-01 11:29:11 -07001990 If <bit> is true, sets the I2C clock line high. If it
1991 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001992
wdenkb9bbd242003-06-30 16:24:52 +00001993 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001994 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001995 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001996
wdenkc6097192002-11-03 00:24:07 +00001997 I2C_DELAY
1998
1999 This delay is invoked four times per clock cycle so this
2000 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002001 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002002 like:
2003
wdenkb9bbd242003-06-30 16:24:52 +00002004 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002005
Mike Frysingeree12d542010-07-21 13:38:02 -04002006 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2007
2008 If your arch supports the generic GPIO framework (asm/gpio.h),
2009 then you may alternatively define the two GPIOs that are to be
2010 used as SCL / SDA. Any of the previous I2C_xxx macros will
2011 have GPIO-based defaults assigned to them as appropriate.
2012
2013 You should define these to the GPIO value as given directly to
2014 the generic GPIO functions.
2015
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002016 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002017
wdenk57b2d802003-06-27 21:31:46 +00002018 When a board is reset during an i2c bus transfer
2019 chips might think that the current transfer is still
2020 in progress. On some boards it is possible to access
2021 the i2c SCLK line directly, either by using the
2022 processor pin as a GPIO or by having a second pin
2023 connected to the bus. If this option is defined a
2024 custom i2c_init_board() routine in boards/xxx/board.c
2025 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002026
Richard Retanubundf0149c2010-04-12 15:08:17 -04002027 CONFIG_SYS_I2C_BOARD_LATE_INIT
2028
2029 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2030 defined a custom i2c_board_late_init() routine in
2031 boards/xxx/board.c is run AFTER the operations in i2c_init()
2032 is completed. This callpoint can be used to unreset i2c bus
2033 using CPU i2c controller register accesses for CPUs whose i2c
2034 controller provide such a method. It is called at the end of
2035 i2c_init() to allow i2c_init operations to setup the i2c bus
2036 controller on the CPU (e.g. setting bus speed & slave address).
2037
wdenk0e2bd9c2004-06-06 21:51:03 +00002038 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2039
2040 This option enables configuration of bi_iic_fast[] flags
2041 in u-boot bd_info structure based on u-boot environment
2042 variable "i2cfast". (see also i2cfast)
2043
Ben Warren45657152006-09-07 16:50:54 -04002044 CONFIG_I2C_MULTI_BUS
2045
2046 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002047 must have a controller. At any point in time, only one bus is
2048 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002049 Note that bus numbering is zero-based.
2050
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002051 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002052
2053 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002054 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002055 is set, specify a list of bus-device pairs. Otherwise, specify
2056 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002057
2058 e.g.
2059 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002060 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002061
2062 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2063
Wolfgang Denk092ae952011-10-26 10:21:21 +00002064 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002065 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002066
2067 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002069 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002070
2071 If defined, then this indicates the I2C bus number for DDR SPD.
2072 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002074 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002075
2076 If defined, then this indicates the I2C bus number for the RTC.
2077 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2078
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002079 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002080
2081 If defined, then this indicates the I2C bus number for the DTT.
2082 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002084 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002085
2086 If defined, specifies the I2C address of the DTT device.
2087 If not defined, then U-Boot uses predefined value for
2088 specified DTT device.
2089
Timur Tabiab347542006-11-03 19:15:00 -06002090 CONFIG_FSL_I2C
2091
2092 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002093 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002094
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002095 CONFIG_I2C_MUX
2096
2097 Define this option if you have I2C devices reached over 1 .. n
2098 I2C Muxes like the pca9544a. This option addes a new I2C
2099 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2100 new I2C Bus to the existing I2C Busses. If you select the
2101 new Bus with "i2c dev", u-bbot sends first the commandos for
2102 the muxes to activate this new "bus".
2103
2104 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2105 feature!
2106
2107 Example:
2108 Adding a new I2C Bus reached over 2 pca9544a muxes
2109 The First mux with address 70 and channel 6
2110 The Second mux with address 71 and channel 4
2111
2112 => i2c bus pca9544a:70:6:pca9544a:71:4
2113
2114 Use the "i2c bus" command without parameter, to get a list
2115 of I2C Busses with muxes:
2116
2117 => i2c bus
2118 Busses reached over muxes:
2119 Bus ID: 2
2120 reached over Mux(es):
2121 pca9544a@70 ch: 4
2122 Bus ID: 3
2123 reached over Mux(es):
2124 pca9544a@70 ch: 6
2125 pca9544a@71 ch: 4
2126 =>
2127
2128 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002129 u-boot first sends the command to the mux@70 to enable
2130 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002131 the channel 4.
2132
2133 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002134 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002135 the 2 muxes.
2136
2137 This option is actually implemented for the bitbanging
2138 algorithm in common/soft_i2c.c and for the Hardware I2C
2139 Bus on the MPC8260. But it should be not so difficult
2140 to add this option to other architectures.
2141
Andrew Dyer58c41f92008-12-29 17:36:01 -06002142 CONFIG_SOFT_I2C_READ_REPEATED_START
2143
2144 defining this will force the i2c_read() function in
2145 the soft_i2c driver to perform an I2C repeated start
2146 between writing the address pointer and reading the
2147 data. If this define is omitted the default behaviour
2148 of doing a stop-start sequence will be used. Most I2C
2149 devices can use either method, but some require one or
2150 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002151
wdenkc6097192002-11-03 00:24:07 +00002152- SPI Support: CONFIG_SPI
2153
2154 Enables SPI driver (so far only tested with
2155 SPI EEPROM, also an instance works with Crystal A/D and
2156 D/As on the SACSng board)
2157
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002158 CONFIG_SH_SPI
2159
2160 Enables the driver for SPI controller on SuperH. Currently
2161 only SH7757 is supported.
2162
wdenkc6097192002-11-03 00:24:07 +00002163 CONFIG_SPI_X
2164
2165 Enables extended (16-bit) SPI EEPROM addressing.
2166 (symmetrical to CONFIG_I2C_X)
2167
2168 CONFIG_SOFT_SPI
2169
wdenk4a5c8a72003-03-06 00:02:04 +00002170 Enables a software (bit-bang) SPI driver rather than
2171 using hardware support. This is a general purpose
2172 driver that only requires three general I/O port pins
2173 (two outputs, one input) to function. If this is
2174 defined, the board configuration must define several
2175 SPI configuration items (port pins to use, etc). For
2176 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002177
Ben Warren7efe9272008-01-16 22:37:35 -05002178 CONFIG_HARD_SPI
2179
2180 Enables a hardware SPI driver for general-purpose reads
2181 and writes. As with CONFIG_SOFT_SPI, the board configuration
2182 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002183 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002184 example, see include/configs/mpc8349emds.h.
2185
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002186 CONFIG_MXC_SPI
2187
2188 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002189 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002190
Matthias Fuchsa4400872007-12-27 17:12:34 +01002191- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002192
Matthias Fuchsa4400872007-12-27 17:12:34 +01002193 Enables FPGA subsystem.
2194
2195 CONFIG_FPGA_<vendor>
2196
2197 Enables support for specific chip vendors.
2198 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002199
Matthias Fuchsa4400872007-12-27 17:12:34 +01002200 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002201
Matthias Fuchsa4400872007-12-27 17:12:34 +01002202 Enables support for FPGA family.
2203 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2204
2205 CONFIG_FPGA_COUNT
2206
2207 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002208
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002209 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002210
wdenk57b2d802003-06-27 21:31:46 +00002211 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002212
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002213 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002214
wdenk4a5c8a72003-03-06 00:02:04 +00002215 Enable checks on FPGA configuration interface busy
2216 status by the configuration function. This option
2217 will require a board or device specific function to
2218 be written.
wdenkc6097192002-11-03 00:24:07 +00002219
2220 CONFIG_FPGA_DELAY
2221
2222 If defined, a function that provides delays in the FPGA
2223 configuration driver.
2224
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002225 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002226 Allow Control-C to interrupt FPGA configuration
2227
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002228 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002229
wdenk4a5c8a72003-03-06 00:02:04 +00002230 Check for configuration errors during FPGA bitfile
2231 loading. For example, abort during Virtex II
2232 configuration if the INIT_B line goes low (which
2233 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002235 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002236
wdenk4a5c8a72003-03-06 00:02:04 +00002237 Maximum time to wait for the INIT_B line to deassert
2238 after PROB_B has been deasserted during a Virtex II
2239 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002240 ms.
wdenkc6097192002-11-03 00:24:07 +00002241
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002242 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002243
wdenk4a5c8a72003-03-06 00:02:04 +00002244 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002245 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002247 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002248
wdenk4a5c8a72003-03-06 00:02:04 +00002249 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002250 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002251
2252- Configuration Management:
2253 CONFIG_IDENT_STRING
2254
wdenk4a5c8a72003-03-06 00:02:04 +00002255 If defined, this string will be added to the U-Boot
2256 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002257
2258- Vendor Parameter Protection:
2259
wdenk4a5c8a72003-03-06 00:02:04 +00002260 U-Boot considers the values of the environment
2261 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002262 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002263 are set once by the board vendor / manufacturer, and
2264 protects these variables from casual modification by
2265 the user. Once set, these variables are read-only,
2266 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002267 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002268
2269 If CONFIG_ENV_OVERWRITE is #defined in your config
2270 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002271 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002272 these parameters.
2273
2274 Alternatively, if you #define _both_ CONFIG_ETHADDR
2275 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002276 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002277 which can be changed exactly ONCE by the user. [The
2278 serial# is unaffected by this, i. e. it remains
2279 read-only.]
2280
Joe Hershberger71497d02012-12-11 22:16:31 -06002281 The same can be accomplished in a more flexible way
2282 for any variable by configuring the type of access
2283 to allow for those variables in the ".flags" variable
2284 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2285
wdenkc6097192002-11-03 00:24:07 +00002286- Protected RAM:
2287 CONFIG_PRAM
2288
2289 Define this variable to enable the reservation of
2290 "protected RAM", i. e. RAM which is not overwritten
2291 by U-Boot. Define CONFIG_PRAM to hold the number of
2292 kB you want to reserve for pRAM. You can overwrite
2293 this default value by defining an environment
2294 variable "pram" to the number of kB you want to
2295 reserve. Note that the board info structure will
2296 still show the full amount of RAM. If pRAM is
2297 reserved, a new environment variable "mem" will
2298 automatically be defined to hold the amount of
2299 remaining RAM in a form that can be passed as boot
2300 argument to Linux, for instance like that:
2301
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002302 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002303 saveenv
2304
2305 This way you can tell Linux not to use this memory,
2306 either, which results in a memory region that will
2307 not be affected by reboots.
2308
2309 *WARNING* If your board configuration uses automatic
2310 detection of the RAM size, you must make sure that
2311 this memory test is non-destructive. So far, the
2312 following board configurations are known to be
2313 "pRAM-clean":
2314
Wolfgang Denk90326762012-10-24 02:36:15 +00002315 IVMS8, IVML24, SPD8xx, TQM8xxL,
2316 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002317 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002318
Gabe Blacka2f3a932012-12-02 04:55:18 +00002319- Access to physical memory region (> 4GB)
2320 Some basic support is provided for operations on memory not
2321 normally accessible to U-Boot - e.g. some architectures
2322 support access to more than 4GB of memory on 32-bit
2323 machines using physical address extension or similar.
2324 Define CONFIG_PHYSMEM to access this basic support, which
2325 currently only supports clearing the memory.
2326
wdenkc6097192002-11-03 00:24:07 +00002327- Error Recovery:
2328 CONFIG_PANIC_HANG
2329
2330 Define this variable to stop the system in case of a
2331 fatal error, so that you have to reset it manually.
2332 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002333 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002334 automatically as fast as possible, but it may be
2335 useful during development since you can try to debug
2336 the conditions that lead to the situation.
2337
2338 CONFIG_NET_RETRY_COUNT
2339
wdenk4a5c8a72003-03-06 00:02:04 +00002340 This variable defines the number of retries for
2341 network operations like ARP, RARP, TFTP, or BOOTP
2342 before giving up the operation. If not defined, a
2343 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002344
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002345 CONFIG_ARP_TIMEOUT
2346
2347 Timeout waiting for an ARP reply in milliseconds.
2348
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002349 CONFIG_NFS_TIMEOUT
2350
2351 Timeout in milliseconds used in NFS protocol.
2352 If you encounter "ERROR: Cannot umount" in nfs command,
2353 try longer timeout such as
2354 #define CONFIG_NFS_TIMEOUT 10000UL
2355
wdenkc6097192002-11-03 00:24:07 +00002356- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002357 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002358
2359 Enable auto completion of commands using TAB.
2360
Wolfgang Denk018147d2006-11-27 15:32:42 +01002361 Note that this feature has NOT been implemented yet
2362 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002363
2364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002365 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002366
2367 Define this variable to enable the "hush" shell (from
2368 Busybox) as command line interpreter, thus enabling
2369 powerful command line syntax like
2370 if...then...else...fi conditionals or `&&' and '||'
2371 constructs ("shell scripts").
2372
2373 If undefined, you get the old, much simpler behaviour
2374 with a somewhat smaller memory footprint.
2375
2376
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002377 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002378
2379 This defines the secondary prompt string, which is
2380 printed when the command interpreter needs more input
2381 to complete a command. Usually "> ".
2382
2383 Note:
2384
wdenk57b2d802003-06-27 21:31:46 +00002385 In the current implementation, the local variables
2386 space and global environment variables space are
2387 separated. Local variables are those you define by
2388 simply typing `name=value'. To access a local
2389 variable later on, you have write `$name' or
2390 `${name}'; to execute the contents of a variable
2391 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002392
wdenk4a5c8a72003-03-06 00:02:04 +00002393 Global environment variables are those you use
2394 setenv/printenv to work with. To run a command stored
2395 in such a variable, you need to use the run command,
2396 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002397
2398 To store commands and special characters in a
2399 variable, please use double quotation marks
2400 surrounding the whole text of the variable, instead
2401 of the backslashes before semicolons and special
2402 symbols.
2403
Wolfgang Denk2039a072006-07-21 11:35:21 +02002404- Commandline Editing and History:
2405 CONFIG_CMDLINE_EDITING
2406
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002407 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002408 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002409
wdenkc0aa5c52003-12-06 19:49:23 +00002410- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002411 CONFIG_EXTRA_ENV_SETTINGS
2412
wdenk4a5c8a72003-03-06 00:02:04 +00002413 Define this to contain any number of null terminated
2414 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002415 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002416
wdenk4a5c8a72003-03-06 00:02:04 +00002417 For example, place something like this in your
2418 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002419
2420 #define CONFIG_EXTRA_ENV_SETTINGS \
2421 "myvar1=value1\0" \
2422 "myvar2=value2\0"
2423
wdenk4a5c8a72003-03-06 00:02:04 +00002424 Warning: This method is based on knowledge about the
2425 internal format how the environment is stored by the
2426 U-Boot code. This is NOT an official, exported
2427 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002428 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002429 You better know what you are doing here.
2430
wdenk4a5c8a72003-03-06 00:02:04 +00002431 Note: overly (ab)use of the default environment is
2432 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002433 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002434 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002435
Stephen Warren1465d5f2012-05-22 09:21:54 +00002436 CONFIG_ENV_VARS_UBOOT_CONFIG
2437
2438 Define this in order to add variables describing the
2439 U-Boot build configuration to the default environment.
2440 These will be named arch, cpu, board, vendor, and soc.
2441
2442 Enabling this option will cause the following to be defined:
2443
2444 - CONFIG_SYS_ARCH
2445 - CONFIG_SYS_CPU
2446 - CONFIG_SYS_BOARD
2447 - CONFIG_SYS_VENDOR
2448 - CONFIG_SYS_SOC
2449
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002450 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2451
2452 Define this in order to add variables describing certain
2453 run-time determined information about the hardware to the
2454 environment. These will be named board_name, board_rev.
2455
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002456 CONFIG_DELAY_ENVIRONMENT
2457
2458 Normally the environment is loaded when the board is
2459 intialised so that it is available to U-Boot. This inhibits
2460 that so that the environment is not available until
2461 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2462 this is instead controlled by the value of
2463 /config/load-environment.
2464
wdenkc0aa5c52003-12-06 19:49:23 +00002465- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002466 CONFIG_HAS_DATAFLASH
2467
wdenk57b2d802003-06-27 21:31:46 +00002468 Defining this option enables DataFlash features and
2469 allows to read/write in Dataflash via the standard
2470 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002471
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002472- Serial Flash support
2473 CONFIG_CMD_SF
2474
2475 Defining this option enables SPI flash commands
2476 'sf probe/read/write/erase/update'.
2477
2478 Usage requires an initial 'probe' to define the serial
2479 flash parameters, followed by read/write/erase/update
2480 commands.
2481
2482 The following defaults may be provided by the platform
2483 to handle the common case when only a single serial
2484 flash is present on the system.
2485
2486 CONFIG_SF_DEFAULT_BUS Bus identifier
2487 CONFIG_SF_DEFAULT_CS Chip-select
2488 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2489 CONFIG_SF_DEFAULT_SPEED in Hz
2490
Simon Glass4b5545e2012-10-08 13:16:02 +00002491 CONFIG_CMD_SF_TEST
2492
2493 Define this option to include a destructive SPI flash
2494 test ('sf test').
2495
wdenkef893942004-02-23 16:11:30 +00002496- SystemACE Support:
2497 CONFIG_SYSTEMACE
2498
2499 Adding this option adds support for Xilinx SystemACE
2500 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002501 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002502 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002503
2504 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002505 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002506
2507 When SystemACE support is added, the "ace" device type
2508 becomes available to the fat commands, i.e. fatls.
2509
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002510- TFTP Fixed UDP Port:
2511 CONFIG_TFTP_PORT
2512
Wolfgang Denk227b5192005-09-24 23:25:46 +02002513 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002514 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002515 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002516 number generator is used.
2517
Wolfgang Denk227b5192005-09-24 23:25:46 +02002518 Also, the environment variable tftpdstp is used to supply
2519 the TFTP UDP destination port value. If tftpdstp isn't
2520 defined, the normal port 69 is used.
2521
2522 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002523 blindly start the TFTP transfer using the pre-configured
2524 target IP address and UDP port. This has the effect of
2525 "punching through" the (Windows XP) firewall, allowing
2526 the remainder of the TFTP transfer to proceed normally.
2527 A better solution is to properly configure the firewall,
2528 but sometimes that is not allowed.
2529
Simon Glass058bb8d2012-12-05 14:46:38 +00002530- Hashing support:
2531 CONFIG_CMD_HASH
2532
2533 This enables a generic 'hash' command which can produce
2534 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2535
2536 CONFIG_HASH_VERIFY
2537
2538 Enable the hash verify command (hash -v). This adds to code
2539 size a little.
2540
2541 CONFIG_SHA1 - support SHA1 hashing
2542 CONFIG_SHA256 - support SHA256 hashing
2543
2544 Note: There is also a sha1sum command, which should perhaps
2545 be deprecated in favour of 'hash sha1'.
2546
wdenkc0aa5c52003-12-06 19:49:23 +00002547- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002548 CONFIG_SHOW_BOOT_PROGRESS
2549
wdenk4a5c8a72003-03-06 00:02:04 +00002550 Defining this option allows to add some board-
2551 specific code (calling a user-provided function
2552 "show_boot_progress(int)") that enables you to show
2553 the system's boot progress on some display (for
2554 example, some LED's) on your board. At the moment,
2555 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002556
Simon Glass31a870e2012-02-13 13:51:19 +00002557- Detailed boot stage timing
2558 CONFIG_BOOTSTAGE
2559 Define this option to get detailed timing of each stage
2560 of the boot process.
2561
2562 CONFIG_BOOTSTAGE_USER_COUNT
2563 This is the number of available user bootstage records.
2564 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2565 a new ID will be allocated from this stash. If you exceed
2566 the limit, recording will stop.
2567
2568 CONFIG_BOOTSTAGE_REPORT
2569 Define this to print a report before boot, similar to this:
2570
2571 Timer summary in microseconds:
2572 Mark Elapsed Stage
2573 0 0 reset
2574 3,575,678 3,575,678 board_init_f start
2575 3,575,695 17 arch_cpu_init A9
2576 3,575,777 82 arch_cpu_init done
2577 3,659,598 83,821 board_init_r start
2578 3,910,375 250,777 main_loop
2579 29,916,167 26,005,792 bootm_start
2580 30,361,327 445,160 start_kernel
2581
Simon Glass4afd88e2012-09-28 08:56:39 +00002582 CONFIG_CMD_BOOTSTAGE
2583 Add a 'bootstage' command which supports printing a report
2584 and un/stashing of bootstage data.
2585
Simon Glass0fa36a42012-09-28 08:56:37 +00002586 CONFIG_BOOTSTAGE_FDT
2587 Stash the bootstage information in the FDT. A root 'bootstage'
2588 node is created with each bootstage id as a child. Each child
2589 has a 'name' property and either 'mark' containing the
2590 mark time in microsecond, or 'accum' containing the
2591 accumulated time for that bootstage id in microseconds.
2592 For example:
2593
2594 bootstage {
2595 154 {
2596 name = "board_init_f";
2597 mark = <3575678>;
2598 };
2599 170 {
2600 name = "lcd";
2601 accum = <33482>;
2602 };
2603 };
2604
2605 Code in the Linux kernel can find this in /proc/devicetree.
2606
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002607Legacy uImage format:
2608
wdenkc6097192002-11-03 00:24:07 +00002609 Arg Where When
2610 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002611 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002612 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002613 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002614 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002615 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002616 4 common/cmd_bootm.c Image data has correct checksum
2617 -4 common/cmd_bootm.c Image is for unsupported architecture
2618 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002619 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002620 6 common/cmd_bootm.c Image Type check OK
2621 -6 common/cmd_bootm.c gunzip uncompression error
2622 -7 common/cmd_bootm.c Unimplemented compression type
2623 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002624 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002625 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002626
2627 9 common/image.c Start initial ramdisk verification
2628 -10 common/image.c Ramdisk header has bad magic number
2629 -11 common/image.c Ramdisk header has bad checksum
2630 10 common/image.c Ramdisk header is OK
2631 -12 common/image.c Ramdisk data has bad checksum
2632 11 common/image.c Ramdisk data has correct checksum
2633 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002634 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002635 13 common/image.c Start multifile image verification
2636 14 common/image.c No initial ramdisk, no multifile, continue.
2637
Wolfgang Denk092ae952011-10-26 10:21:21 +00002638 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002639
Stefan Roese88fbf932010-04-15 16:07:28 +02002640 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002641 -31 post/post.c POST test failed, detected by post_output_backlog()
2642 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002643
Heiko Schocher633e03a2007-06-22 19:11:54 +02002644 34 common/cmd_doc.c before loading a Image from a DOC device
2645 -35 common/cmd_doc.c Bad usage of "doc" command
2646 35 common/cmd_doc.c correct usage of "doc" command
2647 -36 common/cmd_doc.c No boot device
2648 36 common/cmd_doc.c correct boot device
2649 -37 common/cmd_doc.c Unknown Chip ID on boot device
2650 37 common/cmd_doc.c correct chip ID found, device available
2651 -38 common/cmd_doc.c Read Error on boot device
2652 38 common/cmd_doc.c reading Image header from DOC device OK
2653 -39 common/cmd_doc.c Image header has bad magic number
2654 39 common/cmd_doc.c Image header has correct magic number
2655 -40 common/cmd_doc.c Error reading Image from DOC device
2656 40 common/cmd_doc.c Image header has correct magic number
2657 41 common/cmd_ide.c before loading a Image from a IDE device
2658 -42 common/cmd_ide.c Bad usage of "ide" command
2659 42 common/cmd_ide.c correct usage of "ide" command
2660 -43 common/cmd_ide.c No boot device
2661 43 common/cmd_ide.c boot device found
2662 -44 common/cmd_ide.c Device not available
2663 44 common/cmd_ide.c Device available
2664 -45 common/cmd_ide.c wrong partition selected
2665 45 common/cmd_ide.c partition selected
2666 -46 common/cmd_ide.c Unknown partition table
2667 46 common/cmd_ide.c valid partition table found
2668 -47 common/cmd_ide.c Invalid partition type
2669 47 common/cmd_ide.c correct partition type
2670 -48 common/cmd_ide.c Error reading Image Header on boot device
2671 48 common/cmd_ide.c reading Image Header from IDE device OK
2672 -49 common/cmd_ide.c Image header has bad magic number
2673 49 common/cmd_ide.c Image header has correct magic number
2674 -50 common/cmd_ide.c Image header has bad checksum
2675 50 common/cmd_ide.c Image header has correct checksum
2676 -51 common/cmd_ide.c Error reading Image from IDE device
2677 51 common/cmd_ide.c reading Image from IDE device OK
2678 52 common/cmd_nand.c before loading a Image from a NAND device
2679 -53 common/cmd_nand.c Bad usage of "nand" command
2680 53 common/cmd_nand.c correct usage of "nand" command
2681 -54 common/cmd_nand.c No boot device
2682 54 common/cmd_nand.c boot device found
2683 -55 common/cmd_nand.c Unknown Chip ID on boot device
2684 55 common/cmd_nand.c correct chip ID found, device available
2685 -56 common/cmd_nand.c Error reading Image Header on boot device
2686 56 common/cmd_nand.c reading Image Header from NAND device OK
2687 -57 common/cmd_nand.c Image header has bad magic number
2688 57 common/cmd_nand.c Image header has correct magic number
2689 -58 common/cmd_nand.c Error reading Image from NAND device
2690 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002691
Heiko Schocher633e03a2007-06-22 19:11:54 +02002692 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002693
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002694 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002695 -64 net/eth.c no Ethernet found.
2696 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002697
Heiko Schocher633e03a2007-06-22 19:11:54 +02002698 -80 common/cmd_net.c usage wrong
2699 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002700 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002701 81 common/cmd_net.c NetLoop() back without error
2702 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2703 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002704 83 common/cmd_net.c running "source" command
2705 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002706 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002707
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002708FIT uImage format:
2709
2710 Arg Where When
2711 100 common/cmd_bootm.c Kernel FIT Image has correct format
2712 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2713 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2714 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2715 102 common/cmd_bootm.c Kernel unit name specified
2716 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002717 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002718 104 common/cmd_bootm.c Got kernel subimage node offset
2719 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2720 105 common/cmd_bootm.c Kernel subimage hash verification OK
2721 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2722 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002723 -106 common/cmd_bootm.c Kernel subimage has wrong type
2724 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002725 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2726 108 common/cmd_bootm.c Got kernel subimage data/size
2727 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2728 -109 common/cmd_bootm.c Can't get kernel subimage type
2729 -110 common/cmd_bootm.c Can't get kernel subimage comp
2730 -111 common/cmd_bootm.c Can't get kernel subimage os
2731 -112 common/cmd_bootm.c Can't get kernel subimage load address
2732 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2733
2734 120 common/image.c Start initial ramdisk verification
2735 -120 common/image.c Ramdisk FIT image has incorrect format
2736 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002737 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002738 -122 common/image.c Can't get configuration for ramdisk subimage
2739 123 common/image.c Ramdisk unit name specified
2740 -124 common/image.c Can't get ramdisk subimage node offset
2741 125 common/image.c Got ramdisk subimage node offset
2742 -125 common/image.c Ramdisk subimage hash verification failed
2743 126 common/image.c Ramdisk subimage hash verification OK
2744 -126 common/image.c Ramdisk subimage for unsupported architecture
2745 127 common/image.c Architecture check OK
2746 -127 common/image.c Can't get ramdisk subimage data/size
2747 128 common/image.c Got ramdisk subimage data/size
2748 129 common/image.c Can't get ramdisk load address
2749 -129 common/image.c Got ramdisk load address
2750
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002751 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002752 131 common/cmd_doc.c FIT image format OK
2753
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002754 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002755 141 common/cmd_ide.c FIT image format OK
2756
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002757 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002758 151 common/cmd_nand.c FIT image format OK
2759
Gabe Blackd572e162012-10-25 16:31:10 +00002760- FIT image support:
2761 CONFIG_FIT
2762 Enable support for the FIT uImage format.
2763
2764 CONFIG_FIT_BEST_MATCH
2765 When no configuration is explicitly selected, default to the
2766 one whose fdt's compatibility field best matches that of
2767 U-Boot itself. A match is considered "best" if it matches the
2768 most specific compatibility entry of U-Boot's fdt's root node.
2769 The order of entries in the configuration's fdt is ignored.
2770
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002771- Standalone program support:
2772 CONFIG_STANDALONE_LOAD_ADDR
2773
Wolfgang Denk23f78482011-10-09 21:06:34 +02002774 This option defines a board specific value for the
2775 address where standalone program gets loaded, thus
2776 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002777 settings.
2778
2779- Frame Buffer Address:
2780 CONFIG_FB_ADDR
2781
2782 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002783 address for frame buffer. This is typically the case
2784 when using a graphics controller has separate video
2785 memory. U-Boot will then place the frame buffer at
2786 the given address instead of dynamically reserving it
2787 in system RAM by calling lcd_setmem(), which grabs
2788 the memory for the frame buffer depending on the
2789 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002790
2791 Please see board_init_f function.
2792
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002793- Automatic software updates via TFTP server
2794 CONFIG_UPDATE_TFTP
2795 CONFIG_UPDATE_TFTP_CNT_MAX
2796 CONFIG_UPDATE_TFTP_MSEC_MAX
2797
2798 These options enable and control the auto-update feature;
2799 for a more detailed description refer to doc/README.update.
2800
2801- MTD Support (mtdparts command, UBI support)
2802 CONFIG_MTD_DEVICE
2803
2804 Adds the MTD device infrastructure from the Linux kernel.
2805 Needed for mtdparts command support.
2806
2807 CONFIG_MTD_PARTITIONS
2808
2809 Adds the MTD partitioning infrastructure from the Linux
2810 kernel. Needed for UBI support.
2811
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002812- UBI support
2813 CONFIG_CMD_UBI
2814
2815 Adds commands for interacting with MTD partitions formatted
2816 with the UBI flash translation layer
2817
2818 Requires also defining CONFIG_RBTREE
2819
Joe Hershberger47550fc2013-04-08 10:32:49 +00002820 CONFIG_UBI_SILENCE_MSG
2821
2822 Make the verbose messages from UBI stop printing. This leaves
2823 warnings and errors enabled.
2824
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002825- UBIFS support
2826 CONFIG_CMD_UBIFS
2827
2828 Adds commands for interacting with UBI volumes formatted as
2829 UBIFS. UBIFS is read-only in u-boot.
2830
2831 Requires UBI support as well as CONFIG_LZO
2832
Joe Hershberger47550fc2013-04-08 10:32:49 +00002833 CONFIG_UBIFS_SILENCE_MSG
2834
2835 Make the verbose messages from UBIFS stop printing. This leaves
2836 warnings and errors enabled.
2837
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002838- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002839 CONFIG_SPL
2840 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002841
Tom Rini36853852012-02-14 07:29:40 +00002842 CONFIG_SPL_LDSCRIPT
2843 LDSCRIPT for linking the SPL binary.
2844
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002845 CONFIG_SPL_MAX_FOOTPRINT
2846 Maximum size in memory allocated to the SPL, BSS included.
2847 When defined, the linker checks that the actual memory
2848 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002849 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002850 must not be both defined at the same time.
2851
Tom Rini36853852012-02-14 07:29:40 +00002852 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002853 Maximum size of the SPL image (text, data, rodata, and
2854 linker lists sections), BSS excluded.
2855 When defined, the linker checks that the actual size does
2856 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002857
Wolfgang Denk825223d2011-09-11 21:24:09 +02002858 CONFIG_SPL_TEXT_BASE
2859 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002860
Scott Woodc4f0d002012-09-20 19:05:12 -05002861 CONFIG_SPL_RELOC_TEXT_BASE
2862 Address to relocate to. If unspecified, this is equal to
2863 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2864
Tom Rini36853852012-02-14 07:29:40 +00002865 CONFIG_SPL_BSS_START_ADDR
2866 Link address for the BSS within the SPL binary.
2867
2868 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002869 Maximum size in memory allocated to the SPL BSS.
2870 When defined, the linker checks that the actual memory used
2871 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002872 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002873 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002874
2875 CONFIG_SPL_STACK
2876 Adress of the start of the stack SPL will use
2877
Scott Woodc4f0d002012-09-20 19:05:12 -05002878 CONFIG_SPL_RELOC_STACK
2879 Adress of the start of the stack SPL will use after
2880 relocation. If unspecified, this is equal to
2881 CONFIG_SPL_STACK.
2882
Tom Rini36853852012-02-14 07:29:40 +00002883 CONFIG_SYS_SPL_MALLOC_START
2884 Starting address of the malloc pool used in SPL.
2885
2886 CONFIG_SYS_SPL_MALLOC_SIZE
2887 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002888
Tom Rini28591df2012-08-13 12:03:19 -07002889 CONFIG_SPL_FRAMEWORK
2890 Enable the SPL framework under common/. This framework
2891 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2892 NAND loading of the Linux Kernel.
2893
Tom Rinife3b0c72012-08-13 11:37:56 -07002894 CONFIG_SPL_DISPLAY_PRINT
2895 For ARM, enable an optional function to print more information
2896 about the running system.
2897
Scott Wood7c810902012-09-20 16:35:21 -05002898 CONFIG_SPL_INIT_MINIMAL
2899 Arch init code should be built for a very small image
2900
Wolfgang Denk825223d2011-09-11 21:24:09 +02002901 CONFIG_SPL_LIBCOMMON_SUPPORT
2902 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002903
Wolfgang Denk825223d2011-09-11 21:24:09 +02002904 CONFIG_SPL_LIBDISK_SUPPORT
2905 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002906
Wolfgang Denk825223d2011-09-11 21:24:09 +02002907 CONFIG_SPL_I2C_SUPPORT
2908 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002909
Wolfgang Denk825223d2011-09-11 21:24:09 +02002910 CONFIG_SPL_GPIO_SUPPORT
2911 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002912
Wolfgang Denk825223d2011-09-11 21:24:09 +02002913 CONFIG_SPL_MMC_SUPPORT
2914 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002915
Tom Rini36853852012-02-14 07:29:40 +00002916 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2917 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2918 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2919 Address, size and partition on the MMC to load U-Boot from
2920 when the MMC is being used in raw mode.
2921
2922 CONFIG_SPL_FAT_SUPPORT
2923 Support for fs/fat/libfat.o in SPL binary
2924
2925 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2926 Filename to read to load U-Boot when reading from FAT
2927
Scott Wood2b36fbb2012-12-06 13:33:17 +00002928 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2929 Set this for NAND SPL on PPC mpc83xx targets, so that
2930 start.S waits for the rest of the SPL to load before
2931 continuing (the hardware starts execution after just
2932 loading the first page rather than the full 4K).
2933
Scott Woodc352a0c2012-09-20 19:09:07 -05002934 CONFIG_SPL_NAND_BASE
2935 Include nand_base.c in the SPL. Requires
2936 CONFIG_SPL_NAND_DRIVERS.
2937
2938 CONFIG_SPL_NAND_DRIVERS
2939 SPL uses normal NAND drivers, not minimal drivers.
2940
2941 CONFIG_SPL_NAND_ECC
2942 Include standard software ECC in the SPL
2943
Tom Rini36853852012-02-14 07:29:40 +00002944 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002945 Support for NAND boot using simple NAND drivers that
2946 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002947
2948 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2949 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2950 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2951 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2952 CONFIG_SYS_NAND_ECCBYTES
2953 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002954 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002955
2956 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002957 Location in NAND to read U-Boot from
2958
2959 CONFIG_SYS_NAND_U_BOOT_DST
2960 Location in memory to load U-Boot to
2961
2962 CONFIG_SYS_NAND_U_BOOT_SIZE
2963 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002964
2965 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002966 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002967
2968 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2969 Define this if you need to first read the OOB and then the
2970 data. This is used for example on davinci plattforms.
2971
2972 CONFIG_SPL_OMAP3_ID_NAND
2973 Support for an OMAP3-specific set of functions to return the
2974 ID and MFR of the first attached NAND chip, if present.
2975
Wolfgang Denk825223d2011-09-11 21:24:09 +02002976 CONFIG_SPL_SERIAL_SUPPORT
2977 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002978
Wolfgang Denk825223d2011-09-11 21:24:09 +02002979 CONFIG_SPL_SPI_FLASH_SUPPORT
2980 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002981
Wolfgang Denk825223d2011-09-11 21:24:09 +02002982 CONFIG_SPL_SPI_SUPPORT
2983 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002984
Pavel Machekde997252012-08-30 22:42:11 +02002985 CONFIG_SPL_RAM_DEVICE
2986 Support for running image already present in ram, in SPL binary
2987
Wolfgang Denk825223d2011-09-11 21:24:09 +02002988 CONFIG_SPL_LIBGENERIC_SUPPORT
2989 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002990
Scott Woodeb7bd972012-12-06 13:33:16 +00002991 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002992 Image offset to which the SPL should be padded before appending
2993 the SPL payload. By default, this is defined as
2994 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2995 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2996 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002997
Scott Woodf147eb72012-09-21 16:27:32 -05002998 CONFIG_SPL_TARGET
2999 Final target image containing SPL and payload. Some SPLs
3000 use an arch-specific makefile fragment instead, for
3001 example if more than one image needs to be produced.
3002
Simon Glass82d94532013-05-08 08:05:59 +00003003 CONFIG_FIT_SPL_PRINT
3004 Printing information about a FIT image adds quite a bit of
3005 code to SPL. So this is normally disabled in SPL. Use this
3006 option to re-enable it. This will affect the output of the
3007 bootm command when booting a FIT image.
3008
wdenkc6097192002-11-03 00:24:07 +00003009Modem Support:
3010--------------
3011
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003012[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003013
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003014- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003015 CONFIG_MODEM_SUPPORT
3016
3017- RTS/CTS Flow control enable:
3018 CONFIG_HWFLOW
3019
3020- Modem debug support:
3021 CONFIG_MODEM_SUPPORT_DEBUG
3022
wdenk4a5c8a72003-03-06 00:02:04 +00003023 Enables debugging stuff (char screen[1024], dbg())
3024 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003025
wdenkc0aa5c52003-12-06 19:49:23 +00003026- Interrupt support (PPC):
3027
wdenk1ebf41e2004-01-02 14:00:00 +00003028 There are common interrupt_init() and timer_interrupt()
3029 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003030 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003031 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003032 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003033 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003034 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003035 specific handling. If board has watchdog / status_led
3036 / other_activity_monitor it works automatically from
3037 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003038
wdenkc6097192002-11-03 00:24:07 +00003039- General:
3040
wdenk4a5c8a72003-03-06 00:02:04 +00003041 In the target system modem support is enabled when a
3042 specific key (key combination) is pressed during
3043 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003044 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003045 board_init(). Currently key_pressed() is a dummy
3046 function, returning 1 and thus enabling modem
3047 initialization.
wdenkc6097192002-11-03 00:24:07 +00003048
wdenk4a5c8a72003-03-06 00:02:04 +00003049 If there are no modem init strings in the
3050 environment, U-Boot proceed to autoboot; the
3051 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003052 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003053
3054 See also: doc/README.Modem
3055
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003056Board initialization settings:
3057------------------------------
3058
3059During Initialization u-boot calls a number of board specific functions
3060to allow the preparation of board specific prerequisites, e.g. pin setup
3061before drivers are initialized. To enable these callbacks the
3062following configuration macros have to be defined. Currently this is
3063architecture specific, so please check arch/your_architecture/lib/board.c
3064typically in board_init_f() and board_init_r().
3065
3066- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3067- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3068- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3069- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003070
wdenkc6097192002-11-03 00:24:07 +00003071Configuration Settings:
3072-----------------------
3073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003074- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003075 undefine this when you're short of memory.
3076
Peter Tyserdfb72b82009-01-27 18:03:12 -06003077- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3078 width of the commands listed in the 'help' command output.
3079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003081 prompt for user input.
3082
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003083- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003085- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003087- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003089- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003090 the application (usually a Linux kernel) when it is
3091 booted
3092
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003093- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003094 List of legal baudrate settings for this board.
3095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003096- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003097 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003098
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003099- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003100 If the board specific function
3101 extern int overwrite_console (void);
3102 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003103 serial port, else the settings in the environment are used.
3104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003106 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003108- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003109 Enable overwrite of previous console environment settings.
3110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003111- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003112 Begin and End addresses of the area used by the
3113 simple memory test.
3114
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003115- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003116 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003118- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003119 Scratch address used by the alternate memory test
3120 You only need to set this if address zero isn't writeable
3121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003122- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3123 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003124 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003125 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003126 fixing up gd->ram_size the Linux kernel should gets passed
3127 the now "corrected" memory size and won't touch it either.
3128 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003129 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003130 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003131 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003132
3133 This option can be used as a workaround for the 440EPx/GRx
3134 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3135 be touched.
3136
3137 WARNING: Please make sure that this value is a multiple of
3138 the Linux page size (normally 4k). If this is not the case,
3139 then the end address of the Linux memory will be located at a
3140 non page size aligned address and this could cause major
3141 problems.
3142
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003143- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003144 Enable temporary baudrate change while serial download
3145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003146- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003147 Physical start address of SDRAM. _Must_ be 0 here.
3148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003149- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003150 Physical start address of Motherboard I/O (if using a
3151 Cogent motherboard)
3152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003153- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003154 Physical start address of Flash memory.
3155
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003156- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003157 Physical start address of boot monitor code (set by
3158 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003159 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003160 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003162- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003163 Size of memory reserved for monitor code, used to
3164 determine _at_compile_time_ (!) if the environment is
3165 embedded within the U-Boot image, or in a separate
3166 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003167
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003168- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003169 Size of DRAM reserved for malloc() use.
3170
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003171- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003172 Normally compressed uImages are limited to an
3173 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003174 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003175 to adjust this setting to your needs.
3176
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003177- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003178 Maximum size of memory mapped by the startup code of
3179 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003180 the Linux kernel (bd_info, boot arguments, FDT blob if
3181 used) must be put below this limit, unless "bootm_low"
3182 enviroment variable is defined and non-zero. In such case
3183 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003184 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003185 variable "bootm_mapsize" will override the value of
3186 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3187 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003188
John Rigbyeea8e692010-10-13 13:57:35 -06003189- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3190 Enable initrd_high functionality. If defined then the
3191 initrd_high feature is enabled and the bootm ramdisk subcommand
3192 is enabled.
3193
3194- CONFIG_SYS_BOOT_GET_CMDLINE:
3195 Enables allocating and saving kernel cmdline in space between
3196 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3197
3198- CONFIG_SYS_BOOT_GET_KBD:
3199 Enables allocating and saving a kernel copy of the bd_info in
3200 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003203 Max number of Flash memory banks
3204
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003205- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003206 Max number of sectors on a Flash chip
3207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003208- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003209 Timeout for Flash erase operations (in ms)
3210
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003211- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003212 Timeout for Flash write operations (in ms)
3213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003214- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003215 Timeout for Flash set sector lock bit operation (in ms)
3216
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003217- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003218 Timeout for Flash clear lock bits operation (in ms)
3219
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003220- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003221 If defined, hardware flash sectors protection is used
3222 instead of U-Boot software protection.
3223
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003224- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003225
3226 Enable TFTP transfers directly to flash memory;
3227 without this option such a download has to be
3228 performed in two steps: (1) download to RAM, and (2)
3229 copy from RAM to flash.
3230
3231 The two-step approach is usually more reliable, since
3232 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003233 the flash, but in some situations (when system RAM is
3234 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003235 downloaded image) this option may be very useful.
3236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003237- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003238 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003239 common flash structure for storing flash geometry.
3240
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003241- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003242 This option also enables the building of the cfi_flash driver
3243 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003244
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003245- CONFIG_FLASH_CFI_MTD
3246 This option enables the building of the cfi_mtd driver
3247 in the drivers directory. The driver exports CFI flash
3248 to the MTD layer.
3249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003250- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003251 Use buffered writes to flash.
3252
3253- CONFIG_FLASH_SPANSION_S29WS_N
3254 s29ws-n MirrorBit flash has non-standard addresses for buffered
3255 write commands.
3256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003257- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003258 If this option is defined, the common CFI flash doesn't
3259 print it's warning upon not recognized FLASH banks. This
3260 is useful, if some of the configured banks are only
3261 optionally available.
3262
Jerry Van Barenaae73572008-03-08 13:48:01 -05003263- CONFIG_FLASH_SHOW_PROGRESS
3264 If defined (must be an integer), print out countdown
3265 digits and dots. Recommended value: 45 (9..1) for 80
3266 column displays, 15 (3..1) for 40 column displays.
3267
Stefan Roesed20cba52013-04-04 15:53:14 +02003268- CONFIG_FLASH_VERIFY
3269 If defined, the content of the flash (destination) is compared
3270 against the source after the write operation. An error message
3271 will be printed when the contents are not identical.
3272 Please note that this option is useless in nearly all cases,
3273 since such flash programming errors usually are detected earlier
3274 while unprotecting/erasing/programming. Please only enable
3275 this option if you really know what you are doing.
3276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003277- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003278 Defines the number of Ethernet receive buffers. On some
3279 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003280 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3281 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003282 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003283 Defaults to 4 if not defined.
3284
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003285- CONFIG_ENV_MAX_ENTRIES
3286
Wolfgang Denk1136f692010-10-27 22:48:30 +02003287 Maximum number of entries in the hash table that is used
3288 internally to store the environment settings. The default
3289 setting is supposed to be generous and should work in most
3290 cases. This setting can be used to tune behaviour; see
3291 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003292
Joe Hershberger71497d02012-12-11 22:16:31 -06003293- CONFIG_ENV_FLAGS_LIST_DEFAULT
3294- CONFIG_ENV_FLAGS_LIST_STATIC
3295 Enable validation of the values given to enviroment variables when
3296 calling env set. Variables can be restricted to only decimal,
3297 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3298 the variables can also be restricted to IP address or MAC address.
3299
3300 The format of the list is:
3301 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003302 access_atribute = [a|r|o|c]
3303 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003304 entry = variable_name[:attributes]
3305 list = entry[,list]
3306
3307 The type attributes are:
3308 s - String (default)
3309 d - Decimal
3310 x - Hexadecimal
3311 b - Boolean ([1yYtT|0nNfF])
3312 i - IP address
3313 m - MAC address
3314
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003315 The access attributes are:
3316 a - Any (default)
3317 r - Read-only
3318 o - Write-once
3319 c - Change-default
3320
Joe Hershberger71497d02012-12-11 22:16:31 -06003321 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3322 Define this to a list (string) to define the ".flags"
3323 envirnoment variable in the default or embedded environment.
3324
3325 - CONFIG_ENV_FLAGS_LIST_STATIC
3326 Define this to a list (string) to define validation that
3327 should be done if an entry is not found in the ".flags"
3328 environment variable. To override a setting in the static
3329 list, simply add an entry for the same variable name to the
3330 ".flags" variable.
3331
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003332- CONFIG_ENV_ACCESS_IGNORE_FORCE
3333 If defined, don't allow the -f switch to env set override variable
3334 access flags.
3335
Simon Glass66828322013-03-08 13:45:27 +00003336- CONFIG_SYS_GENERIC_BOARD
3337 This selects the architecture-generic board system instead of the
3338 architecture-specific board files. It is intended to move boards
3339 to this new framework over time. Defining this will disable the
3340 arch/foo/lib/board.c file and use common/board_f.c and
3341 common/board_r.c instead. To use this option your architecture
3342 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3343 its config.mk file). If you find problems enabling this option on
3344 your board please report the problem and send patches!
3345
Simon Glass9c9f44a2013-03-11 07:06:48 +00003346- CONFIG_SYS_SYM_OFFSETS
3347 This is set by architectures that use offsets for link symbols
3348 instead of absolute values. So bss_start is obtained using an
3349 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3350 directly. You should not need to touch this setting.
3351
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003352- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3353 This is set by OMAP boards for the max time that reset should
3354 be asserted. See doc/README.omap-reset-time for details on how
3355 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003356
wdenkc6097192002-11-03 00:24:07 +00003357The following definitions that deal with the placement and management
3358of environment data (variable area); in general, we support the
3359following configurations:
3360
Mike Frysinger63b8f122011-07-08 10:44:25 +00003361- CONFIG_BUILD_ENVCRC:
3362
3363 Builds up envcrc with the target environment so that external utils
3364 may easily extract it and embed it in final U-Boot images.
3365
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003366- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003367
3368 Define this if the environment is in flash memory.
3369
3370 a) The environment occupies one whole flash sector, which is
3371 "embedded" in the text segment with the U-Boot code. This
3372 happens usually with "bottom boot sector" or "top boot
3373 sector" type flash chips, which have several smaller
3374 sectors at the start or the end. For instance, such a
3375 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3376 such a case you would place the environment in one of the
3377 4 kB sectors - with U-Boot code before and after it. With
3378 "top boot sector" type flash chips, you would put the
3379 environment in one of the last sectors, leaving a gap
3380 between U-Boot and the environment.
3381
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003382 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003383
3384 Offset of environment data (variable area) to the
3385 beginning of flash memory; for instance, with bottom boot
3386 type flash chips the second sector can be used: the offset
3387 for this sector is given here.
3388
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003389 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003390
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003391 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003392
3393 This is just another way to specify the start address of
3394 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003395 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003396
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003397 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003398
3399 Size of the sector containing the environment.
3400
3401
3402 b) Sometimes flash chips have few, equal sized, BIG sectors.
3403 In such a case you don't want to spend a whole sector for
3404 the environment.
3405
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003406 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003407
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003408 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003409 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003410 of this flash sector for the environment. This saves
3411 memory for the RAM copy of the environment.
3412
3413 It may also save flash memory if you decide to use this
3414 when your environment is "embedded" within U-Boot code,
3415 since then the remainder of the flash sector could be used
3416 for U-Boot code. It should be pointed out that this is
3417 STRONGLY DISCOURAGED from a robustness point of view:
3418 updating the environment in flash makes it always
3419 necessary to erase the WHOLE sector. If something goes
3420 wrong before the contents has been restored from a copy in
3421 RAM, your target system will be dead.
3422
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003423 - CONFIG_ENV_ADDR_REDUND
3424 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003425
wdenk4a5c8a72003-03-06 00:02:04 +00003426 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003427 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003428 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003429 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003430
3431BE CAREFUL! Any changes to the flash layout, and some changes to the
3432source code will make it necessary to adapt <board>/u-boot.lds*
3433accordingly!
3434
3435
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003436- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003437
3438 Define this if you have some non-volatile memory device
3439 (NVRAM, battery buffered SRAM) which you want to use for the
3440 environment.
3441
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003442 - CONFIG_ENV_ADDR:
3443 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003444
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003445 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003446 want to use for environment. It is assumed that this memory
3447 can just be read and written to, without any special
3448 provision.
3449
3450BE CAREFUL! The first access to the environment happens quite early
3451in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003452console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003453U-Boot will hang.
3454
3455Please note that even with NVRAM we still use a copy of the
3456environment in RAM: we could work on NVRAM directly, but we want to
3457keep settings there always unmodified except somebody uses "saveenv"
3458to save the current settings.
3459
3460
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003461- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003462
3463 Use this if you have an EEPROM or similar serial access
3464 device and a driver for it.
3465
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003466 - CONFIG_ENV_OFFSET:
3467 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003468
3469 These two #defines specify the offset and size of the
3470 environment area within the total memory of your EEPROM.
3471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003472 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003473 If defined, specified the chip address of the EEPROM device.
3474 The default address is zero.
3475
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003476 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003477 If defined, the number of bits used to address bytes in a
3478 single page in the EEPROM device. A 64 byte page, for example
3479 would require six bits.
3480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003481 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003482 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003483 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003484
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003485 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003486 The length in bytes of the EEPROM memory array address. Note
3487 that this is NOT the chip address length!
3488
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003489 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003490 EEPROM chips that implement "address overflow" are ones
3491 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3492 address and the extra bits end up in the "chip address" bit
3493 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3494 byte chips.
3495
3496 Note that we consider the length of the address field to
3497 still be one byte because the extra address bits are hidden
3498 in the chip address.
3499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003500 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003501 The size in bytes of the EEPROM device.
3502
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003503 - CONFIG_ENV_EEPROM_IS_ON_I2C
3504 define this, if you have I2C and SPI activated, and your
3505 EEPROM, which holds the environment, is on the I2C bus.
3506
3507 - CONFIG_I2C_ENV_EEPROM_BUS
3508 if you have an Environment on an EEPROM reached over
3509 I2C muxes, you can define here, how to reach this
3510 EEPROM. For example:
3511
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003512 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003513
3514 EEPROM which holds the environment, is reached over
3515 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003516
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003517- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003518
wdenk1ebf41e2004-01-02 14:00:00 +00003519 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003520 want to use for the environment.
3521
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003522 - CONFIG_ENV_OFFSET:
3523 - CONFIG_ENV_ADDR:
3524 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003525
3526 These three #defines specify the offset and size of the
3527 environment area within the total memory of your DataFlash placed
3528 at the specified address.
3529
Liu Gang85bcd732012-03-08 00:33:20 +00003530- CONFIG_ENV_IS_IN_REMOTE:
3531
3532 Define this if you have a remote memory space which you
3533 want to use for the local device's environment.
3534
3535 - CONFIG_ENV_ADDR:
3536 - CONFIG_ENV_SIZE:
3537
3538 These two #defines specify the address and size of the
3539 environment area within the remote memory space. The
3540 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003541 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003542
3543BE CAREFUL! For some special cases, the local device can not use
3544"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003545environment stored in a remote NOR flash by SRIO or PCIE link,
3546but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003547
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003548- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003549
3550 Define this if you have a NAND device which you want to use
3551 for the environment.
3552
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003553 - CONFIG_ENV_OFFSET:
3554 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003555
3556 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003557 area within the first NAND device. CONFIG_ENV_OFFSET must be
3558 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003559
Scott Wood08239322010-09-17 14:38:37 -05003560 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003561
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003562 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003563 size used to hold a redundant copy of the environment data, so
3564 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003565 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003566 aligned to an erase block boundary.
3567
3568 - CONFIG_ENV_RANGE (optional):
3569
3570 Specifies the length of the region in which the environment
3571 can be written. This should be a multiple of the NAND device's
3572 block size. Specifying a range with more erase blocks than
3573 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3574 the range to be avoided.
3575
3576 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003577
Scott Wood08239322010-09-17 14:38:37 -05003578 Enables support for dynamically retrieving the offset of the
3579 environment from block zero's out-of-band data. The
3580 "nand env.oob" command can be used to record this offset.
3581 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3582 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003583
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003584- CONFIG_NAND_ENV_DST
3585
3586 Defines address in RAM to which the nand_spl code should copy the
3587 environment. If redundant environment is used, it will be copied to
3588 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3589
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003590- CONFIG_ENV_IS_IN_UBI:
3591
3592 Define this if you have an UBI volume that you want to use for the
3593 environment. This has the benefit of wear-leveling the environment
3594 accesses, which is important on NAND.
3595
3596 - CONFIG_ENV_UBI_PART:
3597
3598 Define this to a string that is the mtd partition containing the UBI.
3599
3600 - CONFIG_ENV_UBI_VOLUME:
3601
3602 Define this to the name of the volume that you want to store the
3603 environment in.
3604
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003605 - CONFIG_ENV_UBI_VOLUME_REDUND:
3606
3607 Define this to the name of another volume to store a second copy of
3608 the environment in. This will enable redundant environments in UBI.
3609 It is assumed that both volumes are in the same MTD partition.
3610
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003611 - CONFIG_UBI_SILENCE_MSG
3612 - CONFIG_UBIFS_SILENCE_MSG
3613
3614 You will probably want to define these to avoid a really noisy system
3615 when storing the env in UBI.
3616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003617- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003618
3619 Defines offset to the initial SPI buffer area in DPRAM. The
3620 area is used at an early stage (ROM part) if the environment
3621 is configured to reside in the SPI EEPROM: We need a 520 byte
3622 scratch DPRAM area. It is used between the two initialization
3623 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3624 to be a good choice since it makes it far enough from the
3625 start of the data area as well as from the stack pointer.
3626
Bruce Adleredecc942007-11-02 13:15:42 -07003627Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003628has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003629created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003630until then to read environment variables.
3631
wdenk8dba0502003-03-31 16:34:49 +00003632The environment is protected by a CRC32 checksum. Before the monitor
3633is relocated into RAM, as a result of a bad CRC you will be working
3634with the compiled-in default environment - *silently*!!! [This is
3635necessary, because the first environment variable we need is the
3636"baudrate" setting for the console - if we have a bad CRC, we don't
3637have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003638
3639Note: once the monitor has been relocated, then it will complain if
3640the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003641use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003643- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003644 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003647 also needs to be defined.
3648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003649- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003650 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003651
Ron Madriddfa028a2009-02-18 14:30:44 -08003652- CONFIG_NS16550_MIN_FUNCTIONS:
3653 Define this if you desire to only have use of the NS16550_init
3654 and NS16550_putc functions for the serial driver located at
3655 drivers/serial/ns16550.c. This option is useful for saving
3656 space for already greatly restricted images, including but not
3657 limited to NAND_SPL configurations.
3658
Simon Glass28a9e332012-11-30 13:01:18 +00003659- CONFIG_DISPLAY_BOARDINFO
3660 Display information about the board that U-Boot is running on
3661 when U-Boot starts up. The board function checkboard() is called
3662 to do this.
3663
Simon Glasse8822012012-11-30 13:01:19 +00003664- CONFIG_DISPLAY_BOARDINFO_LATE
3665 Similar to the previous option, but display this information
3666 later, once stdio is running and output goes to the LCD, if
3667 present.
3668
wdenkc6097192002-11-03 00:24:07 +00003669Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003670---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003673 Cache Line Size of the CPU.
3674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003675- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003676 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003677
wdenk9c53f402003-10-15 23:53:47 +00003678 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3679 and RPXsuper) to be able to adjust the position of
3680 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003681
Timur Tabid8f341c2011-08-04 18:03:41 -05003682- CONFIG_SYS_CCSRBAR_DEFAULT:
3683 Default (power-on reset) physical address of CCSR on Freescale
3684 PowerPC SOCs.
3685
3686- CONFIG_SYS_CCSRBAR:
3687 Virtual address of CCSR. On a 32-bit build, this is typically
3688 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3689
3690 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3691 for cross-platform code that uses that macro instead.
3692
3693- CONFIG_SYS_CCSRBAR_PHYS:
3694 Physical address of CCSR. CCSR can be relocated to a new
3695 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003696 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003697 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3698 is typically relocated on 36-bit builds. It is recommended
3699 that this macro be defined via the _HIGH and _LOW macros:
3700
3701 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3702 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3703
3704- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003705 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3706 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003707 used in assembly code, so it must not contain typecasts or
3708 integer size suffixes (e.g. "ULL").
3709
3710- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3711 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3712 used in assembly code, so it must not contain typecasts or
3713 integer size suffixes (e.g. "ULL").
3714
3715- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3716 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3717 forced to a value that ensures that CCSR is not relocated.
3718
wdenk1272e232002-11-10 22:06:23 +00003719- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003720 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003721
3722 the default drive number (default value 0)
3723
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003724 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003725
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003726 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003727 (default value 1)
3728
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003729 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003730
wdenk4a5c8a72003-03-06 00:02:04 +00003731 defines the offset of register from address. It
3732 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003733 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003734
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003735 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3736 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003737 default value.
wdenk1272e232002-11-10 22:06:23 +00003738
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003739 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003740 fdc_hw_init() is called at the beginning of the FDC
3741 setup. fdc_hw_init() must be provided by the board
3742 source code. It is used to make hardware dependant
3743 initializations.
wdenk1272e232002-11-10 22:06:23 +00003744
Macpaul Lind1e49942011-04-11 20:45:32 +00003745- CONFIG_IDE_AHB:
3746 Most IDE controllers were designed to be connected with PCI
3747 interface. Only few of them were designed for AHB interface.
3748 When software is doing ATA command and data transfer to
3749 IDE devices through IDE-AHB controller, some additional
3750 registers accessing to these kind of IDE-AHB controller
3751 is requierd.
3752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003753- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003754 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003755 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003758
wdenkeb20ad32003-09-05 23:19:14 +00003759 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003760 initial data and stack; please note that this must be
3761 writable memory that is working WITHOUT special
3762 initialization, i. e. you CANNOT use normal RAM which
3763 will become available only after programming the
3764 memory controller and running certain initialization
3765 sequences.
3766
3767 U-Boot uses the following memory types:
3768 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3769 - MPC824X: data cache
3770 - PPC4xx: data cache
3771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003772- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003773
3774 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003775 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3776 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003777 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003778 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3780 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3781 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003782
3783 Note:
3784 On the MPC824X (or other systems that use the data
3785 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003786 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003787 point to an otherwise UNUSED address space between
3788 the top of RAM and the start of the PCI space.
3789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003790- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003792- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003794- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003795
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003796- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003798- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003800- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003802- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003803 SDRAM timing
3804
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003805- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003806 periodic timer for refresh
3807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003808- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003809
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003810- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3811 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3812 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3813 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003814 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3815
3816- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3818 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003819 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3820
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003821- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3822 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003823 Machine Mode Register and Memory Periodic Timer
3824 Prescaler definitions (SDRAM timing)
3825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003826- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003827 enable I2C microcode relocation patch (MPC8xx);
3828 define relocation offset in DPRAM [DSP2]
3829
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003830- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003831 enable SMC microcode relocation patch (MPC8xx);
3832 define relocation offset in DPRAM [SMC1]
3833
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003834- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003835 enable SPI microcode relocation patch (MPC8xx);
3836 define relocation offset in DPRAM [SCC4]
3837
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003838- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003839 Use OSCM clock mode on MBX8xx board. Be careful,
3840 wrong setting might damage your board. Read
3841 doc/README.MBX before setting this variable!
3842
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003843- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003844 Offset of the bootmode word in DPRAM used by post
3845 (Power On Self Tests). This definition overrides
3846 #define'd default value in commproc.h resp.
3847 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3850 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3851 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3852 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3853 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3854 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3855 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3856 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003857 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003858
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003859- CONFIG_PCI_DISABLE_PCIE:
3860 Disable PCI-Express on systems where it is supported but not
3861 required.
3862
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003863- CONFIG_PCI_ENUM_ONLY
3864 Only scan through and get the devices on the busses.
3865 Don't do any setup work, presumably because someone or
3866 something has already done it, and we don't need to do it
3867 a second time. Useful for platforms that are pre-booted
3868 by coreboot or similar.
3869
Kumar Gala8975d7a2010-12-30 12:09:53 -06003870- CONFIG_SYS_SRIO:
3871 Chip has SRIO or not
3872
3873- CONFIG_SRIO1:
3874 Board has SRIO 1 port available
3875
3876- CONFIG_SRIO2:
3877 Board has SRIO 2 port available
3878
3879- CONFIG_SYS_SRIOn_MEM_VIRT:
3880 Virtual Address of SRIO port 'n' memory region
3881
3882- CONFIG_SYS_SRIOn_MEM_PHYS:
3883 Physical Address of SRIO port 'n' memory region
3884
3885- CONFIG_SYS_SRIOn_MEM_SIZE:
3886 Size of SRIO port 'n' memory region
3887
Fabio Estevamf17e8782013-04-11 09:35:34 +00003888- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3889 Defined to tell the NAND controller that the NAND chip is using
3890 a 16 bit bus.
3891 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003892 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003893 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003894 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003895
3896- CONFIG_SYS_NDFC_EBC0_CFG
3897 Sets the EBC0_CFG register for the NDFC. If not defined
3898 a default value will be used.
3899
Ben Warren45657152006-09-07 16:50:54 -04003900- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003901 Get DDR timing information from an I2C EEPROM. Common
3902 with pluggable memory modules such as SODIMMs
3903
Ben Warren45657152006-09-07 16:50:54 -04003904 SPD_EEPROM_ADDRESS
3905 I2C address of the SPD EEPROM
3906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003907- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003908 If SPD EEPROM is on an I2C bus other than the first
3909 one, specify here. Note that the value must resolve
3910 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003911
York Sune73cc042011-06-07 09:42:16 +08003912- CONFIG_SYS_DDR_RAW_TIMING
3913 Get DDR timing information from other than SPD. Common with
3914 soldered DDR chips onboard without SPD. DDR raw timing
3915 parameters are extracted from datasheet and hard-coded into
3916 header files or board specific files.
3917
York Sunbd495cf2011-09-16 13:21:35 -07003918- CONFIG_FSL_DDR_INTERACTIVE
3919 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003922 Only for 83xx systems. If specified, then DDR should
3923 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003924
wdenk6203e402004-04-18 10:13:26 +00003925- CONFIG_ETHER_ON_FEC[12]
3926 Define to enable FEC[12] on a 8xx series processor.
3927
3928- CONFIG_FEC[12]_PHY
3929 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003930 to the given FEC; i. e.
3931 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003932 means that the PHY with address 4 is connected to FEC1
3933
3934 When set to -1, means to probe for first available.
3935
3936- CONFIG_FEC[12]_PHY_NORXERR
3937 The PHY does not have a RXERR line (RMII only).
3938 (so program the FEC to ignore it).
3939
3940- CONFIG_RMII
3941 Enable RMII mode for all FECs.
3942 Note that this is a global option, we can't
3943 have one FEC in standard MII mode and another in RMII mode.
3944
wdenk20c98a62004-04-23 20:32:05 +00003945- CONFIG_CRC32_VERIFY
3946 Add a verify option to the crc32 command.
3947 The syntax is:
3948
3949 => crc32 -v <address> <count> <crc32>
3950
3951 Where address/count indicate a memory area
3952 and crc32 is the correct crc32 which the
3953 area should have.
3954
wdenk64519362004-07-11 17:40:54 +00003955- CONFIG_LOOPW
3956 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003957 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003958
stroesecc3af832004-12-16 18:46:55 +00003959- CONFIG_MX_CYCLIC
3960 Add the "mdc" and "mwc" memory commands. These are cyclic
3961 "md/mw" commands.
3962 Examples:
3963
wdenk07d7e6b2004-12-16 21:44:03 +00003964 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003965 This command will print 4 bytes (10,11,12,13) each 500 ms.
3966
wdenk07d7e6b2004-12-16 21:44:03 +00003967 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003968 This command will write 12345678 to address 100 all 10 ms.
3969
wdenk07d7e6b2004-12-16 21:44:03 +00003970 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003971 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003972
wdenk3d3d99f2005-04-04 12:44:11 +00003973- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003974 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003975 low level initializations (like setting up the memory
3976 controller) are omitted and/or U-Boot does not
3977 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003978
Wolfgang Denk302141d2010-11-27 23:30:56 +01003979 Normally this variable MUST NOT be defined. The only
3980 exception is when U-Boot is loaded (to RAM) by some
3981 other boot loader or by a debugger which performs
3982 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003983
Aneesh V552a3192011-07-13 05:11:07 +00003984- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003985 Modifies the behaviour of start.S when compiling a loader
3986 that is executed before the actual U-Boot. E.g. when
3987 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003988
Simon Glass17dabf02013-02-24 17:33:14 +00003989- CONFIG_ARCH_MAP_SYSMEM
3990 Generally U-Boot (and in particular the md command) uses
3991 effective address. It is therefore not necessary to regard
3992 U-Boot address as virtual addresses that need to be translated
3993 to physical addresses. However, sandbox requires this, since
3994 it maintains its own little RAM buffer which contains all
3995 addressable memory. This option causes some memory accesses
3996 to be mapped through map_sysmem() / unmap_sysmem().
3997
Matthias Weisser93416c12011-03-10 21:36:32 +00003998- CONFIG_USE_ARCH_MEMCPY
3999 CONFIG_USE_ARCH_MEMSET
4000 If these options are used a optimized version of memcpy/memset will
4001 be used if available. These functions may be faster under some
4002 conditions but may increase the binary size.
4003
Simon Glassbfb59802013-02-14 04:18:54 +00004004- CONFIG_X86_RESET_VECTOR
4005 If defined, the x86 reset vector code is included. This is not
4006 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004007
Mark Jackson52b003c2013-03-04 01:27:20 +00004008- CONFIG_SYS_MPUCLK
4009 Defines the MPU clock speed (in MHz).
4010
4011 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004012
Timur Tabi275f4bb2011-11-22 09:21:25 -06004013Freescale QE/FMAN Firmware Support:
4014-----------------------------------
4015
4016The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4017loading of "firmware", which is encoded in the QE firmware binary format.
4018This firmware often needs to be loaded during U-Boot booting, so macros
4019are used to identify the storage device (NOR flash, SPI, etc) and the address
4020within that device.
4021
4022- CONFIG_SYS_QE_FMAN_FW_ADDR
4023 The address in the storage device where the firmware is located. The
4024 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4025 is also specified.
4026
4027- CONFIG_SYS_QE_FMAN_FW_LENGTH
4028 The maximum possible size of the firmware. The firmware binary format
4029 has a field that specifies the actual size of the firmware, but it
4030 might not be possible to read any part of the firmware unless some
4031 local storage is allocated to hold the entire firmware first.
4032
4033- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4034 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4035 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4036 virtual address in NOR flash.
4037
4038- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4039 Specifies that QE/FMAN firmware is located in NAND flash.
4040 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4041
4042- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4043 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4044 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4045
4046- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4047 Specifies that QE/FMAN firmware is located on the primary SPI
4048 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4049
Liu Gang1e084582012-03-08 00:33:18 +00004050- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4051 Specifies that QE/FMAN firmware is located in the remote (master)
4052 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004053 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4054 window->master inbound window->master LAW->the ucode address in
4055 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004056
wdenkc6097192002-11-03 00:24:07 +00004057Building the Software:
4058======================
4059
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004060Building U-Boot has been tested in several native build environments
4061and in many different cross environments. Of course we cannot support
4062all possibly existing versions of cross development tools in all
4063(potentially obsolete) versions. In case of tool chain problems we
4064recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4065which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004066
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004067If you are not using a native environment, it is assumed that you
4068have GNU cross compiling tools available in your path. In this case,
4069you must set the environment variable CROSS_COMPILE in your shell.
4070Note that no changes to the Makefile or any other source files are
4071necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004072
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004073 $ CROSS_COMPILE=ppc_4xx-
4074 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004075
Peter Tyserb06976d2009-03-13 18:54:51 -05004076Note: If you wish to generate Windows versions of the utilities in
4077 the tools directory you can use the MinGW toolchain
4078 (http://www.mingw.org). Set your HOST tools to the MinGW
4079 toolchain and execute 'make tools'. For example:
4080
4081 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4082
4083 Binaries such as tools/mkimage.exe will be created which can
4084 be executed on computers running Windows.
4085
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004086U-Boot is intended to be simple to build. After installing the
4087sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004088is done by typing:
4089
4090 make NAME_config
4091
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004092where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004093rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004094
wdenk6c59edc2004-05-03 20:45:30 +00004095Note: for some board special configuration names may exist; check if
4096 additional information is available from the board vendor; for
4097 instance, the TQM823L systems are available without (standard)
4098 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004099 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk6c59edc2004-05-03 20:45:30 +00004101 make TQM823L_config
4102 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004103
wdenk6c59edc2004-05-03 20:45:30 +00004104 make TQM823L_LCD_config
4105 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004106
wdenk6c59edc2004-05-03 20:45:30 +00004107 etc.
wdenkc6097192002-11-03 00:24:07 +00004108
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk6c59edc2004-05-03 20:45:30 +00004110Finally, type "make all", and you should get some working U-Boot
4111images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004112
wdenk6c59edc2004-05-03 20:45:30 +00004113- "u-boot.bin" is a raw binary image
4114- "u-boot" is an image in ELF binary format
4115- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004116
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004117By default the build is performed locally and the objects are saved
4118in the source directory. One of the two methods can be used to change
4119this behavior and build U-Boot to some external directory:
4120
41211. Add O= to the make command line invocations:
4122
4123 make O=/tmp/build distclean
4124 make O=/tmp/build NAME_config
4125 make O=/tmp/build all
4126
41272. Set environment variable BUILD_DIR to point to the desired location:
4128
4129 export BUILD_DIR=/tmp/build
4130 make distclean
4131 make NAME_config
4132 make all
4133
4134Note that the command line "O=" setting overrides the BUILD_DIR environment
4135variable.
4136
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138Please be aware that the Makefiles assume you are using GNU make, so
4139for instance on NetBSD you might need to use "gmake" instead of
4140native "make".
wdenkc6097192002-11-03 00:24:07 +00004141
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk6c59edc2004-05-03 20:45:30 +00004143If the system board that you have is not listed, then you will need
4144to port U-Boot to your hardware platform. To do this, follow these
4145steps:
wdenkc6097192002-11-03 00:24:07 +00004146
wdenk6c59edc2004-05-03 20:45:30 +000041471. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004148 "boards.cfg" file, using the existing entries as examples.
4149 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000041502. Create a new directory to hold your board specific code. Add any
4151 files you need. In your board directory, you will need at least
4152 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
41533. Create a new configuration file "include/configs/<board>.h" for
4154 your board
41553. If you're porting U-Boot to a new CPU, then also create a new
4156 directory to hold your CPU specific code. Add any files you need.
41574. Run "make <board>_config" with your new name.
41585. Type "make", and you should get a working "u-boot.srec" file
4159 to be installed on your target system.
41606. Debug and solve any problems that might arise.
4161 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004162
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk6c59edc2004-05-03 20:45:30 +00004164Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4165==============================================================
wdenkc6097192002-11-03 00:24:07 +00004166
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004167If you have modified U-Boot sources (for instance added a new board
4168or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004169provide feedback to the other developers. The feedback normally takes
4170the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004171official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004172
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004173But before you submit such a patch, please verify that your modifi-
4174cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004175the supported boards compile WITHOUT ANY compiler warnings. To do so,
4176just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004177for ALL supported system. Be warned, this will take a while. You can
4178select which (cross) compiler to use by passing a `CROSS_COMPILE'
4179environment variable to the script, i. e. to use the ELDK cross tools
4180you can type
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk6c59edc2004-05-03 20:45:30 +00004182 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk6c59edc2004-05-03 20:45:30 +00004184or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk6c59edc2004-05-03 20:45:30 +00004186 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004187
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004188When using the MAKEALL script, the default behaviour is to build
4189U-Boot in the source directory. This location can be changed by
4190setting the BUILD_DIR environment variable. Also, for each target
4191built, the MAKEALL script saves two log files (<target>.ERR and
4192<target>.MAKEALL) in the <source dir>/LOG directory. This default
4193location can be changed by setting the MAKEALL_LOGDIR environment
4194variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004195
4196 export BUILD_DIR=/tmp/build
4197 export MAKEALL_LOGDIR=/tmp/log
4198 CROSS_COMPILE=ppc_8xx- MAKEALL
4199
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004200With the above settings build objects are saved in the /tmp/build,
4201log files are saved in the /tmp/log and the source tree remains clean
4202during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004203
4204
wdenk6c59edc2004-05-03 20:45:30 +00004205See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004206
wdenkc6097192002-11-03 00:24:07 +00004207
wdenk6c59edc2004-05-03 20:45:30 +00004208Monitor Commands - Overview:
4209============================
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk6c59edc2004-05-03 20:45:30 +00004211go - start application at address 'addr'
4212run - run commands in an environment variable
4213bootm - boot application image from memory
4214bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004215bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004216tftpboot- boot image via network using TFTP protocol
4217 and env variables "ipaddr" and "serverip"
4218 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004219tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004220rarpboot- boot image via network using RARP/TFTP protocol
4221diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4222loads - load S-Record file over serial line
4223loadb - load binary file over serial line (kermit mode)
4224md - memory display
4225mm - memory modify (auto-incrementing)
4226nm - memory modify (constant address)
4227mw - memory write (fill)
4228cp - memory copy
4229cmp - memory compare
4230crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004231i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004232sspi - SPI utility commands
4233base - print or set address offset
4234printenv- print environment variables
4235setenv - set environment variables
4236saveenv - save environment variables to persistent storage
4237protect - enable or disable FLASH write protection
4238erase - erase FLASH memory
4239flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004240nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004241bdinfo - print Board Info structure
4242iminfo - print header information for application image
4243coninfo - print console devices and informations
4244ide - IDE sub-system
4245loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004246loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004247mtest - simple RAM test
4248icache - enable or disable instruction cache
4249dcache - enable or disable data cache
4250reset - Perform RESET of the CPU
4251echo - echo args to console
4252version - print monitor version
4253help - print online help
4254? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004255
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257Monitor Commands - Detailed Description:
4258========================================
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk6c59edc2004-05-03 20:45:30 +00004260TODO.
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk6c59edc2004-05-03 20:45:30 +00004262For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004263
4264
wdenk6c59edc2004-05-03 20:45:30 +00004265Environment Variables:
4266======================
wdenkc6097192002-11-03 00:24:07 +00004267
wdenk6c59edc2004-05-03 20:45:30 +00004268U-Boot supports user configuration using Environment Variables which
4269can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271Environment Variables are set using "setenv", printed using
4272"printenv", and saved to Flash using "saveenv". Using "setenv"
4273without a value can be used to delete a variable from the
4274environment. As long as you don't save the environment you are
4275working with an in-memory copy. In case the Flash area containing the
4276environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004277
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004278Some configuration options can be set using Environment Variables.
4279
4280List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk6c59edc2004-05-03 20:45:30 +00004282 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk6c59edc2004-05-03 20:45:30 +00004284 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk6c59edc2004-05-03 20:45:30 +00004286 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004287
wdenk6c59edc2004-05-03 20:45:30 +00004288 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk6c59edc2004-05-03 20:45:30 +00004290 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004291
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004292 bootm_low - Memory range available for image processing in the bootm
4293 command can be restricted. This variable is given as
4294 a hexadecimal number and defines lowest address allowed
4295 for use by the bootm command. See also "bootm_size"
4296 environment variable. Address defined by "bootm_low" is
4297 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004298 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4299 bootm_mapsize.
4300
Wolfgang Denk092ae952011-10-26 10:21:21 +00004301 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004302 This variable is given as a hexadecimal number and it
4303 defines the size of the memory region starting at base
4304 address bootm_low that is accessible by the Linux kernel
4305 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4306 as the default value if it is defined, and bootm_size is
4307 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004308
4309 bootm_size - Memory range available for image processing in the bootm
4310 command can be restricted. This variable is given as
4311 a hexadecimal number and defines the size of the region
4312 allowed for use by the bootm command. See also "bootm_low"
4313 environment variable.
4314
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004315 updatefile - Location of the software update file on a TFTP server, used
4316 by the automatic software update feature. Please refer to
4317 documentation in doc/README.update for more details.
4318
wdenk6c59edc2004-05-03 20:45:30 +00004319 autoload - if set to "no" (any string beginning with 'n'),
4320 "bootp" will just load perform a lookup of the
4321 configuration from the BOOTP server, but not try to
4322 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk6c59edc2004-05-03 20:45:30 +00004324 autostart - if set to "yes", an image loaded using the "bootp",
4325 "rarpboot", "tftpboot" or "diskboot" commands will
4326 be automatically started (by internally calling
4327 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk6c59edc2004-05-03 20:45:30 +00004329 If set to "no", a standalone image passed to the
4330 "bootm" command will be copied to the load address
4331 (and eventually uncompressed), but NOT be started.
4332 This can be used to load and uncompress arbitrary
4333 data.
wdenkc6097192002-11-03 00:24:07 +00004334
David A. Longd558a4e2011-07-09 16:40:19 -04004335 fdt_high - if set this restricts the maximum address that the
4336 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004337 For example, if you have a system with 1 GB memory
4338 at physical address 0x10000000, while Linux kernel
4339 only recognizes the first 704 MB as low memory, you
4340 may need to set fdt_high as 0x3C000000 to have the
4341 device tree blob be copied to the maximum address
4342 of the 704 MB low memory, so that Linux kernel can
4343 access it during the boot procedure.
4344
David A. Longd558a4e2011-07-09 16:40:19 -04004345 If this is set to the special value 0xFFFFFFFF then
4346 the fdt will not be copied at all on boot. For this
4347 to work it must reside in writable memory, have
4348 sufficient padding on the end of it for u-boot to
4349 add the information it needs into it, and the memory
4350 must be accessible by the kernel.
4351
Simon Glassdc6fa642011-10-24 19:15:34 +00004352 fdtcontroladdr- if set this is the address of the control flattened
4353 device tree used by U-Boot when CONFIG_OF_CONTROL is
4354 defined.
4355
wdenk0e2bd9c2004-06-06 21:51:03 +00004356 i2cfast - (PPC405GP|PPC405EP only)
4357 if set to 'y' configures Linux I2C driver for fast
4358 mode (400kHZ). This environment variable is used in
4359 initialization code. So, for changes to be effective
4360 it must be saved and board must be reset.
4361
wdenk6c59edc2004-05-03 20:45:30 +00004362 initrd_high - restrict positioning of initrd images:
4363 If this variable is not set, initrd images will be
4364 copied to the highest possible address in RAM; this
4365 is usually what you want since it allows for
4366 maximum initrd size. If for some reason you want to
4367 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004368 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004369 variable to a value of "no" or "off" or "0".
4370 Alternatively, you can set it to a maximum upper
4371 address to use (U-Boot will still check that it
4372 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk6c59edc2004-05-03 20:45:30 +00004374 For instance, when you have a system with 16 MB
4375 RAM, and want to reserve 4 MB from use by Linux,
4376 you can do this by adding "mem=12M" to the value of
4377 the "bootargs" variable. However, now you must make
4378 sure that the initrd image is placed in the first
4379 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk6c59edc2004-05-03 20:45:30 +00004381 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk6c59edc2004-05-03 20:45:30 +00004383 If you set initrd_high to 0xFFFFFFFF, this is an
4384 indication to U-Boot that all addresses are legal
4385 for the Linux kernel, including addresses in flash
4386 memory. In this case U-Boot will NOT COPY the
4387 ramdisk at all. This may be useful to reduce the
4388 boot time on your system, but requires that this
4389 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004390
wdenk6c59edc2004-05-03 20:45:30 +00004391 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk6c59edc2004-05-03 20:45:30 +00004393 loadaddr - Default load address for commands like "bootp",
4394 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004395
wdenk6c59edc2004-05-03 20:45:30 +00004396 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004397
wdenk6c59edc2004-05-03 20:45:30 +00004398 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004399
wdenk6c59edc2004-05-03 20:45:30 +00004400 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk6c59edc2004-05-03 20:45:30 +00004402 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004405
Mike Frysingera23230c2011-10-02 10:01:27 +00004406 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004407
Mike Frysingera23230c2011-10-02 10:01:27 +00004408 ethact - controls which interface is currently active.
4409 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004410
Heiko Schocherc5e84052010-07-20 17:45:02 +02004411 => setenv ethact FEC
4412 => ping 192.168.0.1 # traffic sent on FEC
4413 => setenv ethact SCC
4414 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004415
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004416 ethrotate - When set to "no" U-Boot does not go through all
4417 available network interfaces.
4418 It just stays at the currently selected interface.
4419
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004420 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004421 either succeed or fail without retrying.
4422 When set to "once" the network operation will
4423 fail when all the available network interfaces
4424 are tried once without success.
4425 Useful on scripts which control the retry operation
4426 themselves.
wdenkc6097192002-11-03 00:24:07 +00004427
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004428 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004429
Wolfgang Denk227b5192005-09-24 23:25:46 +02004430 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004431 UDP source port.
4432
Wolfgang Denk227b5192005-09-24 23:25:46 +02004433 tftpdstport - If this is set, the value is used for TFTP's UDP
4434 destination port instead of the Well Know Port 69.
4435
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004436 tftpblocksize - Block size to use for TFTP transfers; if not set,
4437 we use the TFTP server's default block size
4438
4439 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4440 seconds, minimum value is 1000 = 1 second). Defines
4441 when a packet is considered to be lost so it has to
4442 be retransmitted. The default is 5000 = 5 seconds.
4443 Lowering this value may make downloads succeed
4444 faster in networks with high packet loss rates or
4445 with unreliable TFTP servers.
4446
4447 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004448 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004449 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004450
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004451The following image location variables contain the location of images
4452used in booting. The "Image" column gives the role of the image and is
4453not an environment variable name. The other columns are environment
4454variable names. "File Name" gives the name of the file on a TFTP
4455server, "RAM Address" gives the location in RAM the image will be
4456loaded to, and "Flash Location" gives the image's address in NOR
4457flash or offset in NAND flash.
4458
4459*Note* - these variables don't have to be defined for all boards, some
4460boards currenlty use other variables for these purposes, and some
4461boards use these variables for other purposes.
4462
Wolfgang Denk092ae952011-10-26 10:21:21 +00004463Image File Name RAM Address Flash Location
4464----- --------- ----------- --------------
4465u-boot u-boot u-boot_addr_r u-boot_addr
4466Linux kernel bootfile kernel_addr_r kernel_addr
4467device tree blob fdtfile fdt_addr_r fdt_addr
4468ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004469
wdenk6c59edc2004-05-03 20:45:30 +00004470The following environment variables may be used and automatically
4471updated by the network boot commands ("bootp" and "rarpboot"),
4472depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004473
wdenk6c59edc2004-05-03 20:45:30 +00004474 bootfile - see above
4475 dnsip - IP address of your Domain Name Server
4476 dnsip2 - IP address of your secondary Domain Name Server
4477 gatewayip - IP address of the Gateway (Router) to use
4478 hostname - Target hostname
4479 ipaddr - see above
4480 netmask - Subnet Mask
4481 rootpath - Pathname of the root filesystem on the NFS server
4482 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004483
wdenk145d2c12004-04-15 21:48:45 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487 serial# - contains hardware identification information such
4488 as type string and/or serial number
4489 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk6c59edc2004-05-03 20:45:30 +00004491These variables can be set only once (usually during manufacturing of
4492the board). U-Boot refuses to delete or overwrite these variables
4493once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004494
4495
wdenk6c59edc2004-05-03 20:45:30 +00004496Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004497
wdenk6c59edc2004-05-03 20:45:30 +00004498 ver - Contains the U-Boot version string as printed
4499 with the "version" command. This variable is
4500 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004501
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk6c59edc2004-05-03 20:45:30 +00004503Please note that changes to some configuration parameters may take
4504only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004505
stroeseb9c17c52003-04-04 15:53:41 +00004506
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004507Callback functions for environment variables:
4508---------------------------------------------
4509
4510For some environment variables, the behavior of u-boot needs to change
4511when their values are changed. This functionailty allows functions to
4512be associated with arbitrary variables. On creation, overwrite, or
4513deletion, the callback will provide the opportunity for some side
4514effect to happen or for the change to be rejected.
4515
4516The callbacks are named and associated with a function using the
4517U_BOOT_ENV_CALLBACK macro in your board or driver code.
4518
4519These callbacks are associated with variables in one of two ways. The
4520static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4521in the board configuration to a string that defines a list of
4522associations. The list must be in the following format:
4523
4524 entry = variable_name[:callback_name]
4525 list = entry[,list]
4526
4527If the callback name is not specified, then the callback is deleted.
4528Spaces are also allowed anywhere in the list.
4529
4530Callbacks can also be associated by defining the ".callbacks" variable
4531with the same list format above. Any association in ".callbacks" will
4532override any association in the static list. You can define
4533CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4534".callbacks" envirnoment variable in the default or embedded environment.
4535
4536
wdenk6c59edc2004-05-03 20:45:30 +00004537Command Line Parsing:
4538=====================
stroeseb9c17c52003-04-04 15:53:41 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540There are two different command line parsers available with U-Boot:
4541the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543Old, simple command line parser:
4544--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk6c59edc2004-05-03 20:45:30 +00004546- supports environment variables (through setenv / saveenv commands)
4547- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004548- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004549- special characters ('$', ';') can be escaped by prefixing with '\',
4550 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004551 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004552- You can also escape text by enclosing in single apostrophes, for example:
4553 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk6c59edc2004-05-03 20:45:30 +00004555Hush shell:
4556-----------
wdenkf4688a22003-05-28 08:06:31 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558- similar to Bourne shell, with control structures like
4559 if...then...else...fi, for...do...done; while...do...done,
4560 until...do...done, ...
4561- supports environment ("global") variables (through setenv / saveenv
4562 commands) and local shell variables (through standard shell syntax
4563 "name=value"); only environment variables can be used with "run"
4564 command
wdenkf4688a22003-05-28 08:06:31 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566General rules:
4567--------------
wdenkf4688a22003-05-28 08:06:31 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569(1) If a command line (or an environment variable executed by a "run"
4570 command) contains several commands separated by semicolon, and
4571 one of these commands fails, then the remaining commands will be
4572 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004573
wdenk6c59edc2004-05-03 20:45:30 +00004574(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004575 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004576 command will cause "run" to terminate, i. e. the remaining
4577 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004578
wdenk6c59edc2004-05-03 20:45:30 +00004579Note for Redundant Ethernet Interfaces:
4580=======================================
wdenkf4688a22003-05-28 08:06:31 +00004581
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004582Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004583such configurations and is capable of automatic selection of a
4584"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004585
wdenk6c59edc2004-05-03 20:45:30 +00004586Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4587MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4588"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004589
wdenk6c59edc2004-05-03 20:45:30 +00004590If the network interface stores some valid MAC address (for instance
4591in SROM), this is used as default address if there is NO correspon-
4592ding setting in the environment; if the corresponding environment
4593variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004594
wdenk6c59edc2004-05-03 20:45:30 +00004595o If the SROM has a valid MAC address, and there is no address in the
4596 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk6c59edc2004-05-03 20:45:30 +00004598o If there is no valid address in the SROM, and a definition in the
4599 environment exists, then the value from the environment variable is
4600 used.
wdenkc6097192002-11-03 00:24:07 +00004601
wdenk6c59edc2004-05-03 20:45:30 +00004602o If both the SROM and the environment contain a MAC address, and
4603 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk6c59edc2004-05-03 20:45:30 +00004605o If both the SROM and the environment contain a MAC address, and the
4606 addresses differ, the value from the environment is used and a
4607 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk6c59edc2004-05-03 20:45:30 +00004609o If neither SROM nor the environment contain a MAC address, an error
4610 is raised.
wdenkc6097192002-11-03 00:24:07 +00004611
Ben Warren6db991a2010-04-26 11:11:46 -07004612If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004613will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004614may be skipped by setting the appropriate 'ethmacskip' environment variable.
4615The naming convention is as follows:
4616"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk6c59edc2004-05-03 20:45:30 +00004618Image Formats:
4619==============
wdenkc6097192002-11-03 00:24:07 +00004620
Marian Balakowicz18710b82008-03-12 12:13:13 +01004621U-Boot is capable of booting (and performing other auxiliary operations on)
4622images in two formats:
4623
4624New uImage format (FIT)
4625-----------------------
4626
4627Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4628to Flattened Device Tree). It allows the use of images with multiple
4629components (several kernels, ramdisks, etc.), with contents protected by
4630SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4631
4632
4633Old uImage format
4634-----------------
4635
4636Old image format is based on binary files which can be basically anything,
4637preceded by a special header; see the definitions in include/image.h for
4638details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4641 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004642 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4643 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4644 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004645* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004646 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4647 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004648* Compression Type (uncompressed, gzip, bzip2)
4649* Load Address
4650* Entry Point
4651* Image Name
4652* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654The header is marked by a special Magic Number, and both the header
4655and the data portions of the image are secured against corruption by
4656CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004657
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk6c59edc2004-05-03 20:45:30 +00004659Linux Support:
4660==============
wdenkc6097192002-11-03 00:24:07 +00004661
wdenk6c59edc2004-05-03 20:45:30 +00004662Although U-Boot should support any OS or standalone application
4663easily, the main focus has always been on Linux during the design of
4664U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666U-Boot includes many features that so far have been part of some
4667special "boot loader" code within the Linux kernel. Also, any
4668"initrd" images to be used are no longer part of one big Linux image;
4669instead, kernel and "initrd" are separate images. This implementation
4670serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672- the same features can be used for other OS or standalone
4673 applications (for instance: using compressed images to reduce the
4674 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676- it becomes much easier to port new Linux kernel versions because
4677 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004678
wdenk6c59edc2004-05-03 20:45:30 +00004679- the same Linux kernel image can now be used with different "initrd"
4680 images; of course this also means that different kernel images can
4681 be run with the same "initrd". This makes testing easier (you don't
4682 have to build a new "zImage.initrd" Linux image when you just
4683 change a file in your "initrd"). Also, a field-upgrade of the
4684 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004685
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687Linux HOWTO:
4688============
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk6c59edc2004-05-03 20:45:30 +00004690Porting Linux to U-Boot based systems:
4691---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk6c59edc2004-05-03 20:45:30 +00004693U-Boot cannot save you from doing all the necessary modifications to
4694configure the Linux device drivers for use with your target hardware
4695(no, we don't intend to provide a full virtual machine interface to
4696Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004697
Stefan Roese88fbf932010-04-15 16:07:28 +02004698But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700Just make sure your machine specific header file (for instance
4701include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004702Information structure as we define in include/asm-<arch>/u-boot.h,
4703and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004705
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk6c59edc2004-05-03 20:45:30 +00004707Configuring the Linux kernel:
4708-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710No specific requirements for U-Boot. Make sure you have some root
4711device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004712
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714Building a Linux Image:
4715-----------------------
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4718not used. If you use recent kernel source, a new build target
4719"uImage" will exist which automatically builds an image usable by
4720U-Boot. Most older kernels also have support for a "pImage" target,
4721which was introduced for our predecessor project PPCBoot and uses a
4722100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk6c59edc2004-05-03 20:45:30 +00004724Example:
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk6c59edc2004-05-03 20:45:30 +00004726 make TQM850L_config
4727 make oldconfig
4728 make dep
4729 make uImage
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk6c59edc2004-05-03 20:45:30 +00004731The "uImage" build target uses a special tool (in 'tools/mkimage') to
4732encapsulate a compressed Linux kernel image with header information,
4733CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004736
wdenk6c59edc2004-05-03 20:45:30 +00004737* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk6c59edc2004-05-03 20:45:30 +00004739 ${CROSS_COMPILE}-objcopy -O binary \
4740 -R .note -R .comment \
4741 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004742
wdenk6c59edc2004-05-03 20:45:30 +00004743* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004748
wdenk6c59edc2004-05-03 20:45:30 +00004749 mkimage -A ppc -O linux -T kernel -C gzip \
4750 -a 0 -e 0 -n "Linux Kernel Image" \
4751 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004752
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk6c59edc2004-05-03 20:45:30 +00004754The "mkimage" tool can also be used to create ramdisk images for use
4755with U-Boot, either separated from the Linux kernel image, or
4756combined into one file. "mkimage" encapsulates the images with a 64
4757byte header containing information about target architecture,
4758operating system, image type, compression method, entry points, time
4759stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk6c59edc2004-05-03 20:45:30 +00004761"mkimage" can be called in two ways: to verify existing images and
4762print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004763
wdenk6c59edc2004-05-03 20:45:30 +00004764In the first form (with "-l" option) mkimage lists the information
4765contained in the header of an existing U-Boot image; this includes
4766checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004767
wdenk6c59edc2004-05-03 20:45:30 +00004768 tools/mkimage -l image
4769 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004770
wdenk6c59edc2004-05-03 20:45:30 +00004771The second form (with "-d" option) is used to build a U-Boot image
4772from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004773
wdenk6c59edc2004-05-03 20:45:30 +00004774 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4775 -n name -d data_file image
4776 -A ==> set architecture to 'arch'
4777 -O ==> set operating system to 'os'
4778 -T ==> set image type to 'type'
4779 -C ==> set compression type 'comp'
4780 -a ==> set load address to 'addr' (hex)
4781 -e ==> set entry point to 'ep' (hex)
4782 -n ==> set image name to 'name'
4783 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004784
wdenkcd914452004-05-29 16:53:29 +00004785Right now, all Linux kernels for PowerPC systems use the same load
4786address (0x00000000), but the entry point address depends on the
4787kernel version:
wdenkc6097192002-11-03 00:24:07 +00004788
wdenk6c59edc2004-05-03 20:45:30 +00004789- 2.2.x kernels have the entry point at 0x0000000C,
4790- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk6c59edc2004-05-03 20:45:30 +00004792So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004793
wdenk6c59edc2004-05-03 20:45:30 +00004794 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4795 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004796 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004797 > examples/uImage.TQM850L
4798 Image Name: 2.4.4 kernel for TQM850L
4799 Created: Wed Jul 19 02:34:59 2000
4800 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4801 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4802 Load Address: 0x00000000
4803 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004804
wdenk6c59edc2004-05-03 20:45:30 +00004805To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk6c59edc2004-05-03 20:45:30 +00004807 -> tools/mkimage -l examples/uImage.TQM850L
4808 Image Name: 2.4.4 kernel for TQM850L
4809 Created: Wed Jul 19 02:34:59 2000
4810 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4811 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4812 Load Address: 0x00000000
4813 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk6c59edc2004-05-03 20:45:30 +00004815NOTE: for embedded systems where boot time is critical you can trade
4816speed for memory and install an UNCOMPRESSED image instead: this
4817needs more space in Flash, but boots much faster since it does not
4818need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004819
Stefan Roese88fbf932010-04-15 16:07:28 +02004820 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004821 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4822 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004823 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004824 > examples/uImage.TQM850L-uncompressed
4825 Image Name: 2.4.4 kernel for TQM850L
4826 Created: Wed Jul 19 02:34:59 2000
4827 Image Type: PowerPC Linux Kernel Image (uncompressed)
4828 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4829 Load Address: 0x00000000
4830 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004831
wdenkc6097192002-11-03 00:24:07 +00004832
wdenk6c59edc2004-05-03 20:45:30 +00004833Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4834when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk6c59edc2004-05-03 20:45:30 +00004836 -> tools/mkimage -n 'Simple Ramdisk Image' \
4837 > -A ppc -O linux -T ramdisk -C gzip \
4838 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4839 Image Name: Simple Ramdisk Image
4840 Created: Wed Jan 12 14:01:50 2000
4841 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4842 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4843 Load Address: 0x00000000
4844 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004845
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk6c59edc2004-05-03 20:45:30 +00004847Installing a Linux Image:
4848-------------------------
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk6c59edc2004-05-03 20:45:30 +00004850To downloading a U-Boot image over the serial (console) interface,
4851you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004852
wdenk6c59edc2004-05-03 20:45:30 +00004853 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk6c59edc2004-05-03 20:45:30 +00004855The 'objcopy' does not understand the information in the U-Boot
4856image header, so the resulting S-Record file will be relative to
4857address 0x00000000. To load it to a given address, you need to
4858specify the target address as 'offset' parameter with the 'loads'
4859command.
wdenkc6097192002-11-03 00:24:07 +00004860
wdenk6c59edc2004-05-03 20:45:30 +00004861Example: install the image to address 0x40100000 (which on the
4862TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004863
wdenk6c59edc2004-05-03 20:45:30 +00004864 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866 .......... done
4867 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk6c59edc2004-05-03 20:45:30 +00004869 => loads 40100000
4870 ## Ready for S-Record download ...
4871 ~>examples/image.srec
4872 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4873 ...
4874 15989 15990 15991 15992
4875 [file transfer complete]
4876 [connected]
4877 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004878
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004881this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004882corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk6c59edc2004-05-03 20:45:30 +00004884 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886 ## Checking Image at 40100000 ...
4887 Image Name: 2.2.13 for initrd on TQM850L
4888 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4889 Data Size: 335725 Bytes = 327 kB = 0 MB
4890 Load Address: 00000000
4891 Entry Point: 0000000c
4892 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004893
4894
wdenk6c59edc2004-05-03 20:45:30 +00004895Boot Linux:
4896-----------
wdenkc6097192002-11-03 00:24:07 +00004897
wdenk6c59edc2004-05-03 20:45:30 +00004898The "bootm" command is used to boot an application that is stored in
4899memory (RAM or Flash). In case of a Linux kernel image, the contents
4900of the "bootargs" environment variable is passed to the kernel as
4901parameters. You can check and modify this variable using the
4902"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004903
wdenkc6097192002-11-03 00:24:07 +00004904
wdenk6c59edc2004-05-03 20:45:30 +00004905 => printenv bootargs
4906 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk6c59edc2004-05-03 20:45:30 +00004908 => 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 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910 => printenv bootargs
4911 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 +00004912
wdenk6c59edc2004-05-03 20:45:30 +00004913 => bootm 40020000
4914 ## Booting Linux kernel at 40020000 ...
4915 Image Name: 2.2.13 for NFS on TQM850L
4916 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4917 Data Size: 381681 Bytes = 372 kB = 0 MB
4918 Load Address: 00000000
4919 Entry Point: 0000000c
4920 Verifying Checksum ... OK
4921 Uncompressing Kernel Image ... OK
4922 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
4923 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4924 time_init: decrementer frequency = 187500000/60
4925 Calibrating delay loop... 49.77 BogoMIPS
4926 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4927 ...
wdenkc6097192002-11-03 00:24:07 +00004928
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004929If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004930the memory addresses of both the kernel and the initrd image (PPBCOOT
4931format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004932
wdenk6c59edc2004-05-03 20:45:30 +00004933 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935 ## Checking Image at 40100000 ...
4936 Image Name: 2.2.13 for initrd on TQM850L
4937 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4938 Data Size: 335725 Bytes = 327 kB = 0 MB
4939 Load Address: 00000000
4940 Entry Point: 0000000c
4941 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004942
wdenk6c59edc2004-05-03 20:45:30 +00004943 ## Checking Image at 40200000 ...
4944 Image Name: Simple Ramdisk Image
4945 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4946 Data Size: 566530 Bytes = 553 kB = 0 MB
4947 Load Address: 00000000
4948 Entry Point: 00000000
4949 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk6c59edc2004-05-03 20:45:30 +00004951 => bootm 40100000 40200000
4952 ## Booting Linux kernel at 40100000 ...
4953 Image Name: 2.2.13 for initrd on TQM850L
4954 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4955 Data Size: 335725 Bytes = 327 kB = 0 MB
4956 Load Address: 00000000
4957 Entry Point: 0000000c
4958 Verifying Checksum ... OK
4959 Uncompressing Kernel Image ... OK
4960 ## Loading RAMDisk Image at 40200000 ...
4961 Image Name: Simple Ramdisk Image
4962 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4963 Data Size: 566530 Bytes = 553 kB = 0 MB
4964 Load Address: 00000000
4965 Entry Point: 00000000
4966 Verifying Checksum ... OK
4967 Loading Ramdisk ... OK
4968 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
4969 Boot arguments: root=/dev/ram
4970 time_init: decrementer frequency = 187500000/60
4971 Calibrating delay loop... 49.77 BogoMIPS
4972 ...
4973 RAMDISK: Compressed image found at block 0
4974 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976 bash#
wdenkc6097192002-11-03 00:24:07 +00004977
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004978Boot Linux and pass a flat device tree:
4979-----------
4980
4981First, U-Boot must be compiled with the appropriate defines. See the section
4982titled "Linux Kernel Interface" above for a more in depth explanation. The
4983following is an example of how to start a kernel and pass an updated
4984flat device tree:
4985
4986=> print oftaddr
4987oftaddr=0x300000
4988=> print oft
4989oft=oftrees/mpc8540ads.dtb
4990=> tftp $oftaddr $oft
4991Speed: 1000, full duplex
4992Using TSEC0 device
4993TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4994Filename 'oftrees/mpc8540ads.dtb'.
4995Load address: 0x300000
4996Loading: #
4997done
4998Bytes transferred = 4106 (100a hex)
4999=> tftp $loadaddr $bootfile
5000Speed: 1000, full duplex
5001Using TSEC0 device
5002TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5003Filename 'uImage'.
5004Load address: 0x200000
5005Loading:############
5006done
5007Bytes transferred = 1029407 (fb51f hex)
5008=> print loadaddr
5009loadaddr=200000
5010=> print oftaddr
5011oftaddr=0x300000
5012=> bootm $loadaddr - $oftaddr
5013## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005014 Image Name: Linux-2.6.17-dirty
5015 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5016 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005017 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005018 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005019 Verifying Checksum ... OK
5020 Uncompressing Kernel Image ... OK
5021Booting using flat device tree at 0x300000
5022Using MPC85xx ADS machine description
5023Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5024[snip]
5025
5026
wdenk6c59edc2004-05-03 20:45:30 +00005027More About U-Boot Image Types:
5028------------------------------
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk6c59edc2004-05-03 20:45:30 +00005030U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk6c59edc2004-05-03 20:45:30 +00005032 "Standalone Programs" are directly runnable in the environment
5033 provided by U-Boot; it is expected that (if they behave
5034 well) you can continue to work in U-Boot after return from
5035 the Standalone Program.
5036 "OS Kernel Images" are usually images of some Embedded OS which
5037 will take over control completely. Usually these programs
5038 will install their own set of exception handlers, device
5039 drivers, set up the MMU, etc. - this means, that you cannot
5040 expect to re-enter U-Boot except by resetting the CPU.
5041 "RAMDisk Images" are more or less just data blocks, and their
5042 parameters (address, size) are passed to an OS kernel that is
5043 being started.
5044 "Multi-File Images" contain several images, typically an OS
5045 (Linux) kernel image and one or more data images like
5046 RAMDisks. This construct is useful for instance when you want
5047 to boot over the network using BOOTP etc., where the boot
5048 server provides just a single image file, but you want to get
5049 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051 "Multi-File Images" start with a list of image sizes, each
5052 image size (in bytes) specified by an "uint32_t" in network
5053 byte order. This list is terminated by an "(uint32_t)0".
5054 Immediately after the terminating 0 follow the images, one by
5055 one, all aligned on "uint32_t" boundaries (size rounded up to
5056 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005057
wdenk6c59edc2004-05-03 20:45:30 +00005058 "Firmware Images" are binary images containing firmware (like
5059 U-Boot or FPGA images) which usually will be programmed to
5060 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062 "Script files" are command sequences that will be executed by
5063 U-Boot's command interpreter; this feature is especially
5064 useful when you configure U-Boot to use a real shell (hush)
5065 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005066
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005067Booting the Linux zImage:
5068-------------------------
5069
5070On some platforms, it's possible to boot Linux zImage. This is done
5071using the "bootz" command. The syntax of "bootz" command is the same
5072as the syntax of "bootm" command.
5073
Tom Rini45f46d12013-05-16 11:40:11 -04005074Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005075kernel with raw initrd images. The syntax is slightly different, the
5076address of the initrd must be augmented by it's size, in the following
5077format: "<initrd addres>:<initrd size>".
5078
stroeseb9c17c52003-04-04 15:53:41 +00005079
wdenk6c59edc2004-05-03 20:45:30 +00005080Standalone HOWTO:
5081=================
stroeseb9c17c52003-04-04 15:53:41 +00005082
wdenk6c59edc2004-05-03 20:45:30 +00005083One of the features of U-Boot is that you can dynamically load and
5084run "standalone" applications, which can use some resources of
5085U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005086
wdenk6c59edc2004-05-03 20:45:30 +00005087Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005088
wdenk6c59edc2004-05-03 20:45:30 +00005089"Hello World" Demo:
5090-------------------
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk6c59edc2004-05-03 20:45:30 +00005092'examples/hello_world.c' contains a small "Hello World" Demo
5093application; it is automatically compiled when you build U-Boot.
5094It's configured to run at address 0x00040004, so you can play with it
5095like that:
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097 => loads
5098 ## Ready for S-Record download ...
5099 ~>examples/hello_world.srec
5100 1 2 3 4 5 6 7 8 9 10 11 ...
5101 [file transfer complete]
5102 [connected]
5103 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005104
wdenk6c59edc2004-05-03 20:45:30 +00005105 => go 40004 Hello World! This is a test.
5106 ## Starting application at 0x00040004 ...
5107 Hello World
5108 argc = 7
5109 argv[0] = "40004"
5110 argv[1] = "Hello"
5111 argv[2] = "World!"
5112 argv[3] = "This"
5113 argv[4] = "is"
5114 argv[5] = "a"
5115 argv[6] = "test."
5116 argv[7] = "<NULL>"
5117 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005118
wdenk6c59edc2004-05-03 20:45:30 +00005119 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121Another example, which demonstrates how to register a CPM interrupt
5122handler with the U-Boot code, can be found in 'examples/timer.c'.
5123Here, a CPM timer is set up to generate an interrupt every second.
5124The interrupt service routine is trivial, just printing a '.'
5125character, but this is just a demo program. The application can be
5126controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128 ? - print current values og the CPM Timer registers
5129 b - enable interrupts and start timer
5130 e - stop timer and disable interrupts
5131 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133 => loads
5134 ## Ready for S-Record download ...
5135 ~>examples/timer.srec
5136 1 2 3 4 5 6 7 8 9 10 11 ...
5137 [file transfer complete]
5138 [connected]
5139 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141 => go 40004
5142 ## Starting application at 0x00040004 ...
5143 TIMERS=0xfff00980
5144 Using timer 1
5145 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147Hit 'b':
5148 [q, b, e, ?] Set interval 1000000 us
5149 Enabling timer
5150Hit '?':
5151 [q, b, e, ?] ........
5152 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5153Hit '?':
5154 [q, b, e, ?] .
5155 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5156Hit '?':
5157 [q, b, e, ?] .
5158 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5159Hit '?':
5160 [q, b, e, ?] .
5161 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5162Hit 'e':
5163 [q, b, e, ?] ...Stopping timer
5164Hit 'q':
5165 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005166
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168Minicom warning:
5169================
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +00005171Over time, many people have reported problems when trying to use the
5172"minicom" terminal emulation program for serial download. I (wd)
5173consider minicom to be broken, and recommend not to use it. Under
5174Unix, I recommend to use C-Kermit for general purpose use (and
5175especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005176use "cu" for S-Record download ("loads" command). See
5177http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5178for help with kermit.
5179
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk6c59edc2004-05-03 20:45:30 +00005181Nevertheless, if you absolutely want to use it try adding this
5182configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184 Name Program Name U/D FullScr IO-Red. Multi
5185 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5186 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005187
wdenk8dba0502003-03-31 16:34:49 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189NetBSD Notes:
5190=============
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk6c59edc2004-05-03 20:45:30 +00005192Starting at version 0.9.2, U-Boot supports NetBSD both as host
5193(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195Building requires a cross environment; it is known to work on
5196NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5197need gmake since the Makefiles are not compatible with BSD make).
5198Note that the cross-powerpc package does not install include files;
5199attempting to build U-Boot will fail because <machine/ansi.h> is
5200missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005201
wdenk6c59edc2004-05-03 20:45:30 +00005202 # cd /usr/pkg/cross/powerpc-netbsd/include
5203 # mkdir powerpc
5204 # ln -s powerpc machine
5205 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5206 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208Native builds *don't* work due to incompatibilities between native
5209and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211Booting assumes that (the first part of) the image booted is a
5212stage-2 loader which in turn loads and then invokes the kernel
5213proper. Loader sources will eventually appear in the NetBSD source
5214tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005215meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005216
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218Implementation Internals:
5219=========================
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221The following is not intended to be a complete description of every
5222implementation detail. However, it should help to understand the
5223inner workings of U-Boot and make it easier to port it to custom
5224hardware.
wdenkc6097192002-11-03 00:24:07 +00005225
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227Initial Stack, Global Data:
5228---------------------------
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk6c59edc2004-05-03 20:45:30 +00005230The implementation of U-Boot is complicated by the fact that U-Boot
5231starts running out of ROM (flash memory), usually without access to
5232system RAM (because the memory controller is not initialized yet).
5233This means that we don't have writable Data or BSS segments, and BSS
5234is not initialized as zero. To be able to get a C environment working
5235at all, we have to allocate at least a minimal stack. Implementation
5236options for this are defined and restricted by the CPU used: Some CPU
5237models provide on-chip memory (like the IMMR area on MPC8xx and
5238MPC826x processors), on others (parts of) the data cache can be
5239locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005240
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005241 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005242 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5245 From: "Chris Hallinan" <clh@net1plus.com>
5246 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5247 ...
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk6c59edc2004-05-03 20:45:30 +00005249 Correct me if I'm wrong, folks, but the way I understand it
5250 is this: Using DCACHE as initial RAM for Stack, etc, does not
5251 require any physical RAM backing up the cache. The cleverness
5252 is that the cache is being used as a temporary supply of
5253 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005254 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005255 can see how this works by studying the cache architecture and
5256 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk6c59edc2004-05-03 20:45:30 +00005258 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5259 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005260 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005261 option should work for you. Using CS 4 should be fine if your
5262 board designers haven't used it for something that would
5263 cause you grief during the initial boot! It is frequently not
5264 used.
wdenkc6097192002-11-03 00:24:07 +00005265
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005266 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005267 with your processor/board/system design. The default value
5268 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005269 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005270 than your SDRAM module. If you have a 64MB SDRAM module, set
5271 it above 400_0000. Just make sure your board has no resources
5272 that are supposed to respond to that address! That code in
5273 start.S has been around a while and should work as is when
5274 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276 -Chris Hallinan
5277 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279It is essential to remember this, since it has some impact on the C
5280code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282* Initialized global data (data segment) is read-only. Do not attempt
5283 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005284
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005285* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005286 as zero data - BSS segment) at all - this is undefined, initiali-
5287 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289* Stack space is very limited. Avoid big data buffers or things like
5290 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292Having only the stack as writable memory limits means we cannot use
5293normal global data to share information beween the code. But it
5294turned out that the implementation of U-Boot can be greatly
5295simplified by making a global data structure (gd_t) available to all
5296functions. We could pass a pointer to this data as argument to _all_
5297functions, but this would bloat the code. Instead we use a feature of
5298the GCC compiler (Global Register Variables) to share the data: we
5299place a pointer (gd) to the global data into a register which we
5300reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk6c59edc2004-05-03 20:45:30 +00005302When choosing a register for such a purpose we are restricted by the
5303relevant (E)ABI specifications for the current architecture, and by
5304GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk6c59edc2004-05-03 20:45:30 +00005306For PowerPC, the following registers have specific use:
5307 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005308 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005309 R3-R4: parameter passing and return values
5310 R5-R10: parameter passing
5311 R13: small data area pointer
5312 R30: GOT pointer
5313 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005314
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005315 (U-Boot also uses R12 as internal GOT pointer. r12
5316 is a volatile register so r12 needs to be reset when
5317 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005318
Wolfgang Denk69c09642008-02-14 22:43:22 +01005319 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk6c59edc2004-05-03 20:45:30 +00005321 Note: on PPC, we could use a static initializer (since the
5322 address of the global data structure is known at compile time),
5323 but it turned out that reserving a register results in somewhat
5324 smaller code - although the code savings are not that big (on
5325 average for all boards 752 bytes for the whole U-Boot image,
5326 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005327
Robin Getz2773d5f2009-08-17 15:23:02 +00005328On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005329 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5330
Robin Getz2773d5f2009-08-17 15:23:02 +00005331 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005332
wdenk6c59edc2004-05-03 20:45:30 +00005333On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk6c59edc2004-05-03 20:45:30 +00005335 R0: function argument word/integer result
5336 R1-R3: function argument word
5337 R9: GOT pointer
5338 R10: stack limit (used only if stack checking if enabled)
5339 R11: argument (frame) pointer
5340 R12: temporary workspace
5341 R13: stack pointer
5342 R14: link register
5343 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005346
Thomas Chou8fa38582010-05-21 11:08:03 +08005347On Nios II, the ABI is documented here:
5348 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5349
5350 ==> U-Boot will use gp to hold a pointer to the global data
5351
5352 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5353 to access small data sections, so gp is free.
5354
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005355On NDS32, the following registers are used:
5356
5357 R0-R1: argument/return
5358 R2-R5: argument
5359 R15: temporary register for assembler
5360 R16: trampoline register
5361 R28: frame pointer (FP)
5362 R29: global pointer (GP)
5363 R30: link register (LP)
5364 R31: stack pointer (SP)
5365 PC: program counter (PC)
5366
5367 ==> U-Boot will use R10 to hold a pointer to the global data
5368
Wolfgang Denk6405a152006-03-31 18:32:53 +02005369NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5370or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372Memory Management:
5373------------------
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375U-Boot runs in system state and uses physical addresses, i.e. the
5376MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378The available memory is mapped to fixed addresses using the memory
5379controller. In this process, a contiguous block is formed for each
5380memory type (Flash, SDRAM, SRAM), even when it consists of several
5381physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk6c59edc2004-05-03 20:45:30 +00005383U-Boot is installed in the first 128 kB of the first Flash bank (on
5384TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5385booting and sizing and initializing DRAM, the code relocates itself
5386to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005387memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005388configuration setting]. Below that, a structure with global Board
5389Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391Additionally, some exception handler code is copied to the low 8 kB
5392of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394So a typical memory configuration with 16 MB of DRAM could look like
5395this:
wdenkc6097192002-11-03 00:24:07 +00005396
wdenk6c59edc2004-05-03 20:45:30 +00005397 0x0000 0000 Exception Vector code
5398 :
5399 0x0000 1FFF
5400 0x0000 2000 Free for Application Use
5401 :
5402 :
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404 :
5405 :
5406 0x00FB FF20 Monitor Stack (Growing downward)
5407 0x00FB FFAC Board Info Data and permanent copy of global data
5408 0x00FC 0000 Malloc Arena
5409 :
5410 0x00FD FFFF
5411 0x00FE 0000 RAM Copy of Monitor Code
5412 ... eventually: LCD or video framebuffer
5413 ... eventually: pRAM (Protected RAM - unchanged by reset)
5414 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005415
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417System Initialization:
5418----------------------
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005421(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005422configuration for CS0# this is a mirror of the onboard Flash memory.
5423To be able to re-map memory U-Boot then jumps to its link address.
5424To be able to implement the initialization code in C, a (small!)
5425initial stack is set up in the internal Dual Ported RAM (in case CPUs
5426which provide such a feature like MPC8xx or MPC8260), or in a locked
5427part of the data cache. After that, U-Boot initializes the CPU core,
5428the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430Next, all (potentially) available memory banks are mapped using a
5431preliminary mapping. For example, we put them on 512 MB boundaries
5432(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5433on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5434programmed for SDRAM access. Using the temporary configuration, a
5435simple memory test is run that determines the size of the SDRAM
5436banks.
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438When there is more than one SDRAM bank, and the banks are of
5439different size, the largest is mapped first. For equal size, the first
5440bank (CS2#) is mapped first. The first mapping is always for address
54410x00000000, with any additional banks following immediately to create
5442contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444Then, the monitor installs itself at the upper end of the SDRAM area
5445and allocates memory for use by malloc() and for the global Board
5446Info data; also, the exception vector code is copied to the low RAM
5447pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005448
wdenk6c59edc2004-05-03 20:45:30 +00005449Only after this relocation will you have a "normal" C environment;
5450until that you are restricted in several ways, mostly because you are
5451running from ROM, and because the code will have to be relocated to a
5452new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005453
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455U-Boot Porting Guide:
5456----------------------
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5459list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005460
wdenkc6097192002-11-03 00:24:07 +00005461
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005462int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005463{
5464 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005465
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005466 signal(SIGALRM, no_more_time);
5467 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005470 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005471 return 0;
5472 }
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk6c59edc2004-05-03 20:45:30 +00005474 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005475
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005476 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005477
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005478 if (clueless)
5479 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005480
wdenk6c59edc2004-05-03 20:45:30 +00005481 while (learning) {
5482 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005483 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5484 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005485 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005486 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005487 }
wdenkc6097192002-11-03 00:24:07 +00005488
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005489 if (available_money > toLocalCurrency ($2500))
5490 Buy a BDI3000;
5491 else
wdenk6c59edc2004-05-03 20:45:30 +00005492 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005493
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005494 if (a similar board exists) { /* hopefully... */
5495 cp -a board/<similar> board/<myboard>
5496 cp include/configs/<similar>.h include/configs/<myboard>.h
5497 } else {
5498 Create your own board support subdirectory;
5499 Create your own board include/configs/<myboard>.h file;
5500 }
5501 Edit new board/<myboard> files
5502 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005503
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005504 while (!accepted) {
5505 while (!running) {
5506 do {
5507 Add / modify source code;
5508 } until (compiles);
5509 Debug;
5510 if (clueless)
5511 email("Hi, I am having problems...");
5512 }
5513 Send patch file to the U-Boot email list;
5514 if (reasonable critiques)
5515 Incorporate improvements from email list code review;
5516 else
5517 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005518 }
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520 return 0;
5521}
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523void no_more_time (int sig)
5524{
5525 hire_a_guru();
5526}
wdenkc6097192002-11-03 00:24:07 +00005527
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529Coding Standards:
5530-----------------
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005533coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005534"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005535
5536Source files originating from a different project (for example the
5537MTD subsystem) are generally exempt from these guidelines and are not
5538reformated to ease subsequent migration to newer versions of those
5539sources.
wdenkc6097192002-11-03 00:24:07 +00005540
Detlev Zundelaa63d482006-09-01 15:39:02 +02005541Please note that U-Boot is implemented in C (and to some small parts in
5542Assembler); no C++ is used, so please do not use C++ style comments (//)
5543in your code.
wdenkad276f22004-01-04 16:28:35 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545Please also stick to the following formatting rules:
5546- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005547- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005548- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005549- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005550- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552Submissions which do not conform to the standards may be returned
5553with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005554
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556Submitting Patches:
5557-------------------
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559Since the number of patches for U-Boot is growing, we need to
5560establish some rules. Submissions which do not conform to these rules
5561may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005562
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005563Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005564
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005565Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5566see http://lists.denx.de/mailman/listinfo/u-boot
5567
wdenk6c59edc2004-05-03 20:45:30 +00005568When you send a patch, please include the following information with
5569it:
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571* For bug fixes: a description of the bug and how your patch fixes
5572 this bug. Please try to include a way of demonstrating that the
5573 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk6c59edc2004-05-03 20:45:30 +00005575* For new features: a description of the feature and your
5576 implementation.
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk6c59edc2004-05-03 20:45:30 +00005578* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005583 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005584
wdenk6c59edc2004-05-03 20:45:30 +00005585* If your patch adds new configuration options, don't forget to
5586 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005587
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005588* The patch itself. If you are using git (which is *strongly*
5589 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005590 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005591 the U-Boot mailing list, you will avoid most of the common problems
5592 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005593
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005594 If you cannot use git, use "diff -purN OLD NEW". If your version of
5595 diff does not support these options, then get the latest version of
5596 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005597
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005598 The current directory when running this command shall be the parent
5599 directory of the U-Boot source tree (i. e. please make sure that
5600 your patch includes sufficient directory information for the
5601 affected files).
5602
5603 We prefer patches as plain text. MIME attachments are discouraged,
5604 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606* If one logical set of modifications affects or creates several
5607 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609* Changesets that contain different, unrelated modifications shall be
5610 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005611
wdenkc6097192002-11-03 00:24:07 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613Notes:
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615* Before sending the patch, run the MAKEALL script on your patched
5616 source tree and make sure that no errors or warnings are reported
5617 for any of the boards.
5618
5619* Keep your modifications to the necessary minimum: A patch
5620 containing several unrelated changes or arbitrary reformats will be
5621 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623* If you modify existing code, make sure that your new code does not
5624 add to the memory footprint of the code ;-) Small is beautiful!
5625 When adding new features, these should compile conditionally only
5626 (using #ifdef), and the resulting code with the new feature
5627 disabled must not need more memory than the old code without your
5628 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005629
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005630* Remember that there is a size limit of 100 kB per message on the
5631 u-boot mailing list. Bigger patches will be moderated. If they are
5632 reasonable and not too big, they will be acknowledged. But patches
5633 bigger than the size limit should be avoided.