blob: 657faaa0d999538c0f81800dac0238ac53358a03 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Dayadb9d852012-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 Tyser0c325652008-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 Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
126
127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000129
130
wdenk93f19cc2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000140
Thomas Weber360d8832010-09-28 08:06:25 +0200141Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-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
wdenk93f19cc2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tyser8d321b82010-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ßmann6eb09212011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-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 Russfea25722011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-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 Schwierzeck92bbd642011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Linafc1ce82011-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 Tyser8d321b82010-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 Roesea47a12b2010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-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 Tyser8d321b82010-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-VILLARD6d0f6bc2008-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 Ziswiler11ccc332008-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
wdenk7f6c2cb2002-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 Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-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 Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
wdenk2535d602003-07-17 23:16:40 +0000324- Board flavour: (if CONFIG_MPC8260ADS is defined)
325 CONFIG_ADSTYPE
326 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-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
wdenk2535d602003-07-17 23:16:40 +0000331
Lei Wencf946c62011-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)
wdenk5da627a2003-10-09 20:09:04 +0000338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000340
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200341- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
343 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000349- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200350 CONFIG_SYS_8xx_CPUCLK_MIN
351 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000352 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000353 See doc/README.MPC866
354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200355 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000356
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200362 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000363
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600369- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530416 CONFIG_A003399_NOR_WORKAROUND
417 Enables a workaround for IFC erratum A003399. It is only
418 requred during NOR boot.
419
Scott Wood33eee332012-08-14 10:14:53 +0000420 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
421
422 This is the value to write into CCSR offset 0x18600
423 according to the A004510 workaround.
424
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000432- Generic CPU options:
433 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
434
435 Defines the endianess of the CPU. Implementation of those
436 values is arch specific.
437
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100438- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200439 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100440
441 Defines the Monahans run mode to oscillator
442 ratio. Valid values are 8, 16, 24, 31. The core
443 frequency is this value multiplied by 13 MHz.
444
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200445 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200446
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100447 Defines the Monahans turbo mode to oscillator
448 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200449 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100450 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200451
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200452- MIPS CPU options:
453 CONFIG_SYS_INIT_SP_OFFSET
454
455 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
456 pointer. This is needed for the temporary stack before
457 relocation.
458
459 CONFIG_SYS_MIPS_CACHE_MODE
460
461 Cache operation mode for the MIPS CPU.
462 See also arch/mips/include/asm/mipsregs.h.
463 Possible values are:
464 CONF_CM_CACHABLE_NO_WA
465 CONF_CM_CACHABLE_WA
466 CONF_CM_UNCACHED
467 CONF_CM_CACHABLE_NONCOHERENT
468 CONF_CM_CACHABLE_CE
469 CONF_CM_CACHABLE_COW
470 CONF_CM_CACHABLE_CUW
471 CONF_CM_CACHABLE_ACCELERATED
472
473 CONFIG_SYS_XWAY_EBU_BOOTCFG
474
475 Special option for Lantiq XWAY SoCs for booting from NOR flash.
476 See also arch/mips/cpu/mips32/start.S.
477
478 CONFIG_XWAY_SWAP_BYTES
479
480 Enable compilation of tools/xway-swap-bytes needed for Lantiq
481 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
482 be swapped if a flash programmer is used.
483
Christian Rieschb67d8812012-02-02 00:44:39 +0000484- ARM options:
485 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
486
487 Select high exception vectors of the ARM core, e.g., do not
488 clear the V bit of the c1 register of CP15.
489
Aneesh V5356f542012-03-08 07:20:19 +0000490 CONFIG_SYS_THUMB_BUILD
491
492 Use this flag to build U-Boot using the Thumb instruction
493 set for ARM architectures. Thumb instruction set provides
494 better code density. For ARM architectures that support
495 Thumb2 this flag will result in Thumb2 code generated by
496 GCC.
497
Stephen Warrenc5d47522013-03-04 13:29:40 +0000498 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000499 CONFIG_ARM_ERRATA_742230
500 CONFIG_ARM_ERRATA_743622
501 CONFIG_ARM_ERRATA_751472
502
503 If set, the workarounds for these ARM errata are applied early
504 during U-Boot startup. Note that these options force the
505 workarounds to be applied; no CPU-type/version detection
506 exists, unlike the similar options in the Linux kernel. Do not
507 set these options unless they apply!
508
Stephen Warren795659d2013-03-27 17:06:41 +0000509- CPU timer options:
510 CONFIG_SYS_HZ
511
512 The frequency of the timer returned by get_timer().
513 get_timer() must operate in milliseconds and this CONFIG
514 option must be set to 1000.
515
wdenk5da627a2003-10-09 20:09:04 +0000516- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CLOCKS_IN_MHZ
518
519 U-Boot stores all clock information in Hz
520 internally. For binary compatibility with older Linux
521 kernels (which expect the clocks passed in the
522 bd_info data to be in MHz) the environment variable
523 "clocks_in_mhz" can be defined so that U-Boot
524 converts clock data to MHZ before passing it to the
525 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000526 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100527 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000528 default environment.
529
wdenk5da627a2003-10-09 20:09:04 +0000530 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
531
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200532 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000533 expect it to be in bytes, others in MB.
534 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
535
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400536 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200537
538 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400539 passed using flattened device trees (based on open firmware
540 concepts).
541
542 CONFIG_OF_LIBFDT
543 * New libfdt-based support
544 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500545 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400546
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200547 OF_CPU - The proper name of the cpus node (only required for
548 MPC512X and MPC5xxx based boards).
549 OF_SOC - The proper name of the soc node (only required for
550 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200551 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600552 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200553
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200554 boards with QUICC Engines require OF_QE to set UCC MAC
555 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500556
Kumar Gala4e253132006-01-11 13:54:17 -0600557 CONFIG_OF_BOARD_SETUP
558
559 Board code has addition modification that it wants to make
560 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000561
Matthew McClintock02677682006-06-28 10:41:37 -0500562 CONFIG_OF_BOOT_CPU
563
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200564 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500565 param header, the default value is zero if undefined.
566
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200567 CONFIG_OF_IDE_FIXUP
568
569 U-Boot can detect if an IDE device is present or not.
570 If not, and this new config option is activated, U-Boot
571 removes the ATA node from the DTS before booting Linux,
572 so the Linux IDE driver does not probe the device and
573 crash. This is needed for buggy hardware (uc101) where
574 no pull down resistor is connected to the signal IDE5V_DD7.
575
Igor Grinberg7eb29392011-07-14 05:45:07 +0000576 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
577
578 This setting is mandatory for all boards that have only one
579 machine type and must be used to specify the machine type
580 number as it appears in the ARM machine registry
581 (see http://www.arm.linux.org.uk/developer/machines/).
582 Only boards that have multiple machine types supported
583 in a single configuration file and the machine type is
584 runtime discoverable, do not have to use this setting.
585
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100586- vxWorks boot parameters:
587
588 bootvx constructs a valid bootline using the following
589 environments variables: bootfile, ipaddr, serverip, hostname.
590 It loads the vxWorks image pointed bootfile.
591
592 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
593 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
594 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
595 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
596
597 CONFIG_SYS_VXWORKS_ADD_PARAMS
598
599 Add it at the end of the bootline. E.g "u=username pw=secret"
600
601 Note: If a "bootargs" environment is defined, it will overwride
602 the defaults discussed just above.
603
Aneesh V2c451f72011-06-16 23:30:47 +0000604- Cache Configuration:
605 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
606 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
607 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
608
Aneesh V93bc2192011-06-16 23:30:51 +0000609- Cache Configuration for ARM:
610 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
611 controller
612 CONFIG_SYS_PL310_BASE - Physical base address of PL310
613 controller register space
614
wdenk6705d812004-08-02 23:22:59 +0000615- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200616 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000617
618 Define this if you want support for Amba PrimeCell PL010 UARTs.
619
Andreas Engel48d01922008-09-08 14:30:53 +0200620 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000621
622 Define this if you want support for Amba PrimeCell PL011 UARTs.
623
624 CONFIG_PL011_CLOCK
625
626 If you have Amba PrimeCell PL011 UARTs, set this variable to
627 the clock speed of the UARTs.
628
629 CONFIG_PL01x_PORTS
630
631 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
632 define this to a list of base addresses for each (supported)
633 port. See e.g. include/configs/versatile.h
634
John Rigby910f1ae2011-04-19 10:42:39 +0000635 CONFIG_PL011_SERIAL_RLCR
636
637 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
638 have separate receive and transmit line control registers. Set
639 this variable to initialize the extra register.
640
641 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
642
643 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
644 boot loader that has already initialized the UART. Define this
645 variable to flush the UART at init time.
646
wdenk6705d812004-08-02 23:22:59 +0000647
wdenkc6097192002-11-03 00:24:07 +0000648- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000649 Depending on board, define exactly one serial port
650 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
651 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
652 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000653
654 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
655 port routines must be defined elsewhere
656 (i.e. serial_init(), serial_getc(), ...)
657
658 CONFIG_CFB_CONSOLE
659 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000660 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
662 (default big endian)
663 VIDEO_HW_RECTFILL graphic chip supports
664 rectangle fill
665 (cf. smiLynxEM)
666 VIDEO_HW_BITBLT graphic chip supports
667 bit-blit (cf. smiLynxEM)
668 VIDEO_VISIBLE_COLS visible pixel columns
669 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000670 VIDEO_VISIBLE_ROWS visible pixel rows
671 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000672 VIDEO_DATA_FORMAT graphic data format
673 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000674 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000675 VIDEO_KBD_INIT_FCT keyboard int fct
676 (i.e. i8042_kbd_init())
677 VIDEO_TSTC_FCT test char fct
678 (i.e. i8042_tstc)
679 VIDEO_GETC_FCT get char fct
680 (i.e. i8042_getc)
681 CONFIG_CONSOLE_CURSOR cursor drawing on/off
682 (requires blink timer
683 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200684 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000685 CONFIG_CONSOLE_TIME display time/date info in
686 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500687 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000688 CONFIG_VIDEO_LOGO display Linux logo in
689 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000690 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
691 linux_logo.h for logo.
692 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000693 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200694 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000695 the logo
696
Pali Rohár33a35bb2012-10-19 13:30:09 +0000697 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
698 a limited number of ANSI escape sequences (cursor control,
699 erase functions and limited graphics rendition control).
700
wdenk43d96162003-03-06 00:02:04 +0000701 When CONFIG_CFB_CONSOLE is defined, video console is
702 default i/o. Serial console can be forced with
703 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000704
wdenkd4ca31c2004-01-02 14:00:00 +0000705 When CONFIG_SILENT_CONSOLE is defined, all console
706 messages (by U-Boot and Linux!) can be silenced with
707 the "silent" environment variable. See
708 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000709
wdenkc6097192002-11-03 00:24:07 +0000710- Console Baudrate:
711 CONFIG_BAUDRATE - in bps
712 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200713 CONFIG_SYS_BAUDRATE_TABLE, see below.
714 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000715
Heiko Schocherc92fac92009-01-30 12:55:38 +0100716- Console Rx buffer length
717 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
718 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100719 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100720 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
721 must be defined, to setup the maximum idle timeout for
722 the SMC.
723
Graeme Russ9558b482011-09-01 00:48:27 +0000724- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200725 Prior to the console being initialised (i.e. serial UART
726 initialised etc) all console output is silently discarded.
727 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
728 buffer any console messages prior to the console being
729 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
730 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
731 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200732 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200733 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000734
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200735 'Sane' compilers will generate smaller code if
736 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000737
Sonny Rao046a37b2011-11-02 09:52:08 +0000738- Safe printf() functions
739 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
740 the printf() functions. These are defined in
741 include/vsprintf.h and include snprintf(), vsnprintf() and
742 so on. Code size increase is approximately 300-500 bytes.
743 If this option is not given then these functions will
744 silently discard their buffer size argument - this means
745 you are not getting any overflow checking in this case.
746
wdenkc6097192002-11-03 00:24:07 +0000747- Boot Delay: CONFIG_BOOTDELAY - in seconds
748 Delay before automatically booting the default image;
749 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000750 set to -2 to autoboot with no delay and not check for abort
751 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000752
753 See doc/README.autoboot for these options that
754 work with CONFIG_BOOTDELAY. None are required.
755 CONFIG_BOOT_RETRY_TIME
756 CONFIG_BOOT_RETRY_MIN
757 CONFIG_AUTOBOOT_KEYED
758 CONFIG_AUTOBOOT_PROMPT
759 CONFIG_AUTOBOOT_DELAY_STR
760 CONFIG_AUTOBOOT_STOP_STR
761 CONFIG_AUTOBOOT_DELAY_STR2
762 CONFIG_AUTOBOOT_STOP_STR2
763 CONFIG_ZERO_BOOTDELAY_CHECK
764 CONFIG_RESET_TO_RETRY
765
766- Autoboot Command:
767 CONFIG_BOOTCOMMAND
768 Only needed when CONFIG_BOOTDELAY is enabled;
769 define a command string that is automatically executed
770 when no character is read on the console interface
771 within "Boot Delay" after reset.
772
773 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000774 This can be used to pass arguments to the bootm
775 command. The value of CONFIG_BOOTARGS goes into the
776 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000777
778 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000779 The value of these goes into the environment as
780 "ramboot" and "nfsboot" respectively, and can be used
781 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200782 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000783
784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
818 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500819 and augmenting with additional #define's
820 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000821
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500822 The default command configuration includes all commands
823 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000824
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500825 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_BDI bdinfo
827 CONFIG_CMD_BEDBUG * Include BedBug Debugger
828 CONFIG_CMD_BMP * BMP support
829 CONFIG_CMD_BSP * Board specific commands
830 CONFIG_CMD_BOOTD bootd
831 CONFIG_CMD_CACHE * icache, dcache
832 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500833 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 CONFIG_CMD_DATE * support for RTC, date/time...
835 CONFIG_CMD_DHCP * DHCP support
836 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600837 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
838 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
839 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
840 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 CONFIG_CMD_DTT * Digital Therm and Thermostat
842 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500843 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_EEPROM * EEPROM read/write support
845 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600846 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600847 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500848 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000849 CONFIG_CMD_EXT2 * ext2 command support
850 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500851 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500852 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000853 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500854 CONFIG_CMD_FDOS * Dos diskette Support
855 CONFIG_CMD_FLASH flinfo, erase, protect
856 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200857 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500862 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
863 CONFIG_CMD_I2C * I2C serial bus support
864 CONFIG_CMD_IDE * IDE harddisk support
865 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000866 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200867 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500868 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500871 CONFIG_CMD_IRQ * irqinfo
872 CONFIG_CMD_ITEST Integer/string test of 2 values
873 CONFIG_CMD_JFFS2 * JFFS2 Support
874 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200875 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200880 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000884 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200885 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500886 CONFIG_CMD_MISC Misc functions like sleep etc
887 CONFIG_CMD_MMC * MMC memory mapped support
888 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200892 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600893 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000894 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500895 CONFIG_CMD_PCI * pciinfo
896 CONFIG_CMD_PCMCIA * PCMCIA support
897 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
898 host
899 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000900 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500901 CONFIG_CMD_REGINFO * Register dump
902 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000903 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500904 CONFIG_CMD_SAVES * save S record dump
905 CONFIG_CMD_SCSI * SCSI Support
906 CONFIG_CMD_SDRAM * print SDRAM configuration information
907 (requires CONFIG_CMD_I2C)
908 CONFIG_CMD_SETGETDCR Support for DCR Register access
909 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700910 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200911 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400912 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800913 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200914 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000916 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000917 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000918 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
919 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500921 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000922 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200923 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000924
wdenkc6097192002-11-03 00:24:07 +0000925
926 EXAMPLE: If you want all functions except of network
927 support you can write:
928
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500929 #include "config_cmd_all.h"
930 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000931
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400932 Other Commands:
933 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000934
935 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500936 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000937 what you (and your U-Boot users) are doing. Data
938 cache cannot be enabled on systems like the 8xx or
939 8260 (where accesses to the IMMR region must be
940 uncached), and it cannot be disabled on all other
941 systems where we (mis-) use the data cache to hold an
942 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000943
944
945 XXX - this list needs to get updated!
946
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000947- Regular expression support:
948 CONFIG_REGEX
949 If this variable is defined, U-Boot is linked against
950 the SLRE (Super Light Regular Expression) library,
951 which adds regex support to some commands, as for
952 example "env grep" and "setexpr".
953
Simon Glass45ba8072011-10-15 05:48:20 +0000954- Device tree:
955 CONFIG_OF_CONTROL
956 If this variable is defined, U-Boot will use a device tree
957 to configure its devices, instead of relying on statically
958 compiled #defines in the board file. This option is
959 experimental and only available on a few boards. The device
960 tree is available in the global data as gd->fdt_blob.
961
Simon Glass2c0f79e2011-10-24 19:15:31 +0000962 U-Boot needs to get its device tree from somewhere. This can
963 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000964
965 CONFIG_OF_EMBED
966 If this variable is defined, U-Boot will embed a device tree
967 binary in its image. This device tree file should be in the
968 board directory and called <soc>-<board>.dts. The binary file
969 is then picked up in board_init_f() and made available through
970 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000971
Simon Glass2c0f79e2011-10-24 19:15:31 +0000972 CONFIG_OF_SEPARATE
973 If this variable is defined, U-Boot will build a device tree
974 binary. It will be called u-boot.dtb. Architecture-specific
975 code will locate it at run-time. Generally this works by:
976
977 cat u-boot.bin u-boot.dtb >image.bin
978
979 and in fact, U-Boot does this for you, creating a file called
980 u-boot-dtb.bin which is useful in the common case. You can
981 still use the individual files if you need something more
982 exotic.
983
wdenkc6097192002-11-03 00:24:07 +0000984- Watchdog:
985 CONFIG_WATCHDOG
986 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000987 support for the SoC. There must be support in the SoC
988 specific code for a watchdog. For the 8xx and 8260
989 CPUs, the SIU Watchdog feature is enabled in the SYPCR
990 register. When supported for a specific SoC is
991 available, then no further board specific code should
992 be needed to use it.
993
994 CONFIG_HW_WATCHDOG
995 When using a watchdog circuitry external to the used
996 SoC, then define this variable and provide board
997 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000998
stroesec1551ea2003-04-04 15:53:41 +0000999- U-Boot Version:
1000 CONFIG_VERSION_VARIABLE
1001 If this variable is defined, an environment variable
1002 named "ver" is created by U-Boot showing the U-Boot
1003 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001004 Any change to this variable will be reverted at the
1005 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001006
wdenkc6097192002-11-03 00:24:07 +00001007- Real-Time Clock:
1008
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001009 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001010 has to be selected, too. Define exactly one of the
1011 following options:
1012
1013 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1014 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001015 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001017 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001018 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001019 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001020 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001021 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001022 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001023 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001024 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1025 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001026
wdenkb37c7e52003-06-30 16:24:52 +00001027 Note that if the RTC uses I2C, then the I2C interface
1028 must also be configured. See I2C Support, below.
1029
Peter Tysere92739d2008-12-17 16:36:21 -06001030- GPIO Support:
1031 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1032 CONFIG_PCA953X_INFO - enable pca953x info command
1033
Chris Packham5dec49c2010-12-19 10:12:13 +00001034 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1035 chip-ngpio pairs that tell the PCA953X driver the number of
1036 pins supported by a particular chip.
1037
Peter Tysere92739d2008-12-17 16:36:21 -06001038 Note that if the GPIO device uses I2C, then the I2C interface
1039 must also be configured. See I2C Support, below.
1040
wdenkc6097192002-11-03 00:24:07 +00001041- Timestamp Support:
1042
wdenk43d96162003-03-06 00:02:04 +00001043 When CONFIG_TIMESTAMP is selected, the timestamp
1044 (date and time) of an image is printed by image
1045 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001046 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001047
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001048- Partition Labels (disklabels) Supported:
1049 Zero or more of the following:
1050 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1051 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1052 Intel architecture, USB sticks, etc.
1053 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1054 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1055 bootloader. Note 2TB partition limit; see
1056 disk/part_efi.c
1057 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001058
Wolfgang Denk218ca722008-03-26 10:40:12 +01001059 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1060 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001061 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001062
1063- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001064 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1065 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001066
wdenk4d13cba2004-03-14 14:09:05 +00001067 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1068 be performed by calling the function
1069 ide_set_reset(int reset)
1070 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001071
1072- ATAPI Support:
1073 CONFIG_ATAPI
1074
1075 Set this to enable ATAPI support.
1076
wdenkc40b2952004-03-13 23:29:43 +00001077- LBA48 Support
1078 CONFIG_LBA48
1079
1080 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001081 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001082 Whithout these , LBA48 support uses 32bit variables and will 'only'
1083 support disks up to 2.1TB.
1084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001085 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001086 When enabled, makes the IDE subsystem use 64bit sector addresses.
1087 Default is 32bit.
1088
wdenkc6097192002-11-03 00:24:07 +00001089- SCSI Support:
1090 At the moment only there is only support for the
1091 SYM53C8XX SCSI controller; define
1092 CONFIG_SCSI_SYM53C8XX to enable it.
1093
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001094 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1095 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1096 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001097 maximum numbers of LUNs, SCSI ID's and target
1098 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001099 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001100
Stefan Reinauer447c0312012-10-29 05:23:48 +00001101 The environment variable 'scsidevs' is set to the number of
1102 SCSI devices found during the last scan.
1103
wdenkc6097192002-11-03 00:24:07 +00001104- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001105 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001106 Support for Intel 8254x/8257x gigabit chips.
1107
1108 CONFIG_E1000_SPI
1109 Utility code for direct access to the SPI bus on Intel 8257x.
1110 This does not do anything useful unless you set at least one
1111 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1112
1113 CONFIG_E1000_SPI_GENERIC
1114 Allow generic access to the SPI bus on the Intel 8257x, for
1115 example with the "sspi" command.
1116
1117 CONFIG_CMD_E1000
1118 Management command for E1000 devices. When used on devices
1119 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001120
Andre Schwarzac3315c2008-03-06 16:45:44 +01001121 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001122 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001123
wdenkc6097192002-11-03 00:24:07 +00001124 CONFIG_EEPRO100
1125 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001126 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001127 write routine for first time initialisation.
1128
1129 CONFIG_TULIP
1130 Support for Digital 2114x chips.
1131 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1132 modem chip initialisation (KS8761/QS6611).
1133
1134 CONFIG_NATSEMI
1135 Support for National dp83815 chips.
1136
1137 CONFIG_NS8382X
1138 Support for National dp8382[01] gigabit chips.
1139
wdenk45219c42003-05-12 21:50:16 +00001140- NETWORK Support (other):
1141
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001142 CONFIG_DRIVER_AT91EMAC
1143 Support for AT91RM9200 EMAC.
1144
1145 CONFIG_RMII
1146 Define this to use reduced MII inteface
1147
1148 CONFIG_DRIVER_AT91EMAC_QUIET
1149 If this defined, the driver is quiet.
1150 The driver doen't show link status messages.
1151
Rob Herringefdd7312011-12-15 11:15:49 +00001152 CONFIG_CALXEDA_XGMAC
1153 Support for the Calxeda XGMAC device
1154
Ashok3bb46d22012-10-15 06:20:47 +00001155 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001156 Support for SMSC's LAN91C96 chips.
1157
1158 CONFIG_LAN91C96_BASE
1159 Define this to hold the physical address
1160 of the LAN91C96's I/O space
1161
1162 CONFIG_LAN91C96_USE_32_BIT
1163 Define this to enable 32 bit addressing
1164
Ashok3bb46d22012-10-15 06:20:47 +00001165 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001166 Support for SMSC's LAN91C111 chip
1167
1168 CONFIG_SMC91111_BASE
1169 Define this to hold the physical address
1170 of the device (I/O space)
1171
1172 CONFIG_SMC_USE_32_BIT
1173 Define this if data bus is 32 bits
1174
1175 CONFIG_SMC_USE_IOFUNCS
1176 Define this to use i/o functions instead of macros
1177 (some hardware wont work with macros)
1178
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001179 CONFIG_DRIVER_TI_EMAC
1180 Support for davinci emac
1181
1182 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1183 Define this if you have more then 3 PHYs.
1184
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001185 CONFIG_FTGMAC100
1186 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1187
1188 CONFIG_FTGMAC100_EGIGA
1189 Define this to use GE link update with gigabit PHY.
1190 Define this if FTGMAC100 is connected to gigabit PHY.
1191 If your system has 10/100 PHY only, it might not occur
1192 wrong behavior. Because PHY usually return timeout or
1193 useless data when polling gigabit status and gigabit
1194 control registers. This behavior won't affect the
1195 correctnessof 10/100 link speed update.
1196
Mike Rapoportc2fff332009-11-11 10:03:03 +02001197 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001198 Support for SMSC's LAN911x and LAN921x chips
1199
Mike Rapoportc2fff332009-11-11 10:03:03 +02001200 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001201 Define this to hold the physical address
1202 of the device (I/O space)
1203
Mike Rapoportc2fff332009-11-11 10:03:03 +02001204 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001205 Define this if data bus is 32 bits
1206
Mike Rapoportc2fff332009-11-11 10:03:03 +02001207 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001208 Define this if data bus is 16 bits. If your processor
1209 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001210 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001211
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001212 CONFIG_SH_ETHER
1213 Support for Renesas on-chip Ethernet controller
1214
1215 CONFIG_SH_ETHER_USE_PORT
1216 Define the number of ports to be used
1217
1218 CONFIG_SH_ETHER_PHY_ADDR
1219 Define the ETH PHY's address
1220
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001221 CONFIG_SH_ETHER_CACHE_WRITEBACK
1222 If this option is set, the driver enables cache flush.
1223
Vadim Bendebury5e124722011-10-17 08:36:14 +00001224- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001225 CONFIG_TPM
1226 Support TPM devices.
1227
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001228 CONFIG_TPM_TIS_I2C
1229 Support for i2c bus TPM devices. Only one device
1230 per system is supported at this time.
1231
1232 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1233 Define the the i2c bus number for the TPM device
1234
1235 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1236 Define the TPM's address on the i2c bus
1237
1238 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1239 Define the burst count bytes upper limit
1240
Dirk Eibachc01939c2013-06-26 15:55:15 +02001241 CONFIG_TPM_ATMEL_TWI
1242 Support for Atmel TWI TPM device. Requires I2C support.
1243
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001244 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001245 Support for generic parallel port TPM devices. Only one device
1246 per system is supported at this time.
1247
1248 CONFIG_TPM_TIS_BASE_ADDRESS
1249 Base address where the generic TPM device is mapped
1250 to. Contemporary x86 systems usually map it at
1251 0xfed40000.
1252
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001253 CONFIG_CMD_TPM
1254 Add tpm monitor functions.
1255 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1256 provides monitor access to authorized functions.
1257
1258 CONFIG_TPM
1259 Define this to enable the TPM support library which provides
1260 functional interfaces to some TPM commands.
1261 Requires support for a TPM device.
1262
1263 CONFIG_TPM_AUTH_SESSIONS
1264 Define this to enable authorized functions in the TPM library.
1265 Requires CONFIG_TPM and CONFIG_SHA1.
1266
wdenkc6097192002-11-03 00:24:07 +00001267- USB Support:
1268 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001269 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001270 CONFIG_USB_UHCI to enable it.
1271 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001272 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001273 storage devices.
1274 Note:
1275 Supported are USB Keyboards and USB Floppy drives
1276 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001277 MPC5200 USB requires additional defines:
1278 CONFIG_USB_CLOCK
1279 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001280 CONFIG_PSC3_USB
1281 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001282 CONFIG_USB_CONFIG
1283 for differential drivers: 0x00001000
1284 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001285 for differential drivers on PSC3: 0x00000100
1286 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001287 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001288 May be defined to allow interrupt polling
1289 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001290
Simon Glass9ab4ce22012-02-27 10:52:47 +00001291 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1292 txfilltuning field in the EHCI controller on reset.
1293
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001294 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1295 interval for usb hub power-on delay.(minimum 100msec)
1296
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001297- USB Device:
1298 Define the below if you wish to use the USB console.
1299 Once firmware is rebuilt from a serial console issue the
1300 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001301 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001302 it has found a new device. The environment variable usbtty
1303 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001304 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001305 Common Device Class Abstract Control Model serial device.
1306 If you select usbtty = gserial you should be able to enumerate
1307 a Linux host by
1308 # modprobe usbserial vendor=0xVendorID product=0xProductID
1309 else if using cdc_acm, simply setting the environment
1310 variable usbtty to be cdc_acm should suffice. The following
1311 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001312
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001313 CONFIG_USB_DEVICE
1314 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001315
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001316 CONFIG_USB_TTY
1317 Define this to have a tty type of device available to
1318 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001319
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301320 CONFIG_USBD_HS
1321 Define this to enable the high speed support for usb
1322 device and usbtty. If this feature is enabled, a routine
1323 int is_usbd_high_speed(void)
1324 also needs to be defined by the driver to dynamically poll
1325 whether the enumeration has succeded at high speed or full
1326 speed.
1327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001328 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001329 Define this if you want stdin, stdout &/or stderr to
1330 be set to usbtty.
1331
1332 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001333 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001334 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001335 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001337 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001338 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001339 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001340
Wolfgang Denk386eda02006-06-14 18:14:56 +02001341 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001342 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001343 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001344 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1345 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1346 should pretend to be a Linux device to it's target host.
1347
1348 CONFIG_USBD_MANUFACTURER
1349 Define this string as the name of your company for
1350 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001351
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001352 CONFIG_USBD_PRODUCT_NAME
1353 Define this string as the name of your product
1354 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1355
1356 CONFIG_USBD_VENDORID
1357 Define this as your assigned Vendor ID from the USB
1358 Implementors Forum. This *must* be a genuine Vendor ID
1359 to avoid polluting the USB namespace.
1360 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001361
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001362 CONFIG_USBD_PRODUCTID
1363 Define this as the unique Product ID
1364 for your device
1365 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001366
Igor Grinbergd70a5602011-12-12 12:08:35 +02001367- ULPI Layer Support:
1368 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1369 the generic ULPI layer. The generic layer accesses the ULPI PHY
1370 via the platform viewport, so you need both the genric layer and
1371 the viewport enabled. Currently only Chipidea/ARC based
1372 viewport is supported.
1373 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1374 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001375 If your ULPI phy needs a different reference clock than the
1376 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1377 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001378
1379- MMC Support:
1380 The MMC controller on the Intel PXA is supported. To
1381 enable this define CONFIG_MMC. The MMC can be
1382 accessed from the boot prompt by mapping the device
1383 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001384 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1385 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001386
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001387 CONFIG_SH_MMCIF
1388 Support for Renesas on-chip MMCIF controller
1389
1390 CONFIG_SH_MMCIF_ADDR
1391 Define the base address of MMCIF registers
1392
1393 CONFIG_SH_MMCIF_CLK
1394 Define the clock frequency for MMCIF
1395
Tom Rinib3ba6e92013-03-14 05:32:47 +00001396- USB Device Firmware Update (DFU) class support:
1397 CONFIG_DFU_FUNCTION
1398 This enables the USB portion of the DFU USB class
1399
1400 CONFIG_CMD_DFU
1401 This enables the command "dfu" which is used to have
1402 U-Boot create a DFU class device via USB. This command
1403 requires that the "dfu_alt_info" environment variable be
1404 set and define the alt settings to expose to the host.
1405
1406 CONFIG_DFU_MMC
1407 This enables support for exposing (e)MMC devices via DFU.
1408
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001409 CONFIG_DFU_NAND
1410 This enables support for exposing NAND devices via DFU.
1411
Heiko Schochere7e75c72013-06-12 06:05:51 +02001412 CONFIG_SYS_DFU_DATA_BUF_SIZE
1413 Dfu transfer uses a buffer before writing data to the
1414 raw storage device. Make the size (in bytes) of this buffer
1415 configurable. The size of this buffer is also configurable
1416 through the "dfu_bufsiz" environment variable.
1417
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001418 CONFIG_SYS_DFU_MAX_FILE_SIZE
1419 When updating files rather than the raw storage device,
1420 we use a static buffer to copy the file into and then write
1421 the buffer once we've been given the whole file. Define
1422 this to the maximum filesize (in bytes) for the buffer.
1423 Default is 4 MiB if undefined.
1424
wdenk6705d812004-08-02 23:22:59 +00001425- Journaling Flash filesystem support:
1426 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1427 CONFIG_JFFS2_NAND_DEV
1428 Define these for a default partition on a NAND device
1429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001430 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1431 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001432 Define these for a default partition on a NOR device
1433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001434 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001435 Define this to create an own partition. You have to provide a
1436 function struct part_info* jffs2_part_info(int part_num)
1437
1438 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001439 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001440 to disable the command chpart. This is the default when you
1441 have not defined a custom partition
1442
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001443- FAT(File Allocation Table) filesystem write function support:
1444 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001445
1446 Define this to enable support for saving memory data as a
1447 file in FAT formatted partition.
1448
1449 This will also enable the command "fatwrite" enabling the
1450 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001451
Gabe Black84cd9322012-10-12 14:26:11 +00001452CBFS (Coreboot Filesystem) support
1453 CONFIG_CMD_CBFS
1454
1455 Define this to enable support for reading from a Coreboot
1456 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1457 and cbfsload.
1458
wdenkc6097192002-11-03 00:24:07 +00001459- Keyboard Support:
1460 CONFIG_ISA_KEYBOARD
1461
1462 Define this to enable standard (PC-Style) keyboard
1463 support
1464
1465 CONFIG_I8042_KBD
1466 Standard PC keyboard driver with US (is default) and
1467 GERMAN key layout (switch via environment 'keymap=de') support.
1468 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1469 for cfb_console. Supports cursor blinking.
1470
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001471 CONFIG_CROS_EC_KEYB
1472 Enables a Chrome OS keyboard using the CROS_EC interface.
1473 This uses CROS_EC to communicate with a second microcontroller
1474 which provides key scans on request.
1475
wdenkc6097192002-11-03 00:24:07 +00001476- Video support:
1477 CONFIG_VIDEO
1478
1479 Define this to enable video support (for output to
1480 video).
1481
1482 CONFIG_VIDEO_CT69000
1483
1484 Enable Chips & Technologies 69000 Video chip
1485
1486 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001487 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001488 video output is selected via environment 'videoout'
1489 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1490 assumed.
wdenkc6097192002-11-03 00:24:07 +00001491
wdenkb79a11c2004-03-25 15:14:43 +00001492 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001493 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001494 are possible:
1495 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001496 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001497
1498 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1499 -------------+---------------------------------------------
1500 8 bits | 0x301* 0x303 0x305 0x161 0x307
1501 15 bits | 0x310 0x313 0x316 0x162 0x319
1502 16 bits | 0x311 0x314 0x317 0x163 0x31A
1503 24 bits | 0x312 0x315 0x318 ? 0x31B
1504 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001505 (i.e. setenv videomode 317; saveenv; reset;)
1506
wdenkb79a11c2004-03-25 15:14:43 +00001507 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001508 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001509
1510
stroesec1551ea2003-04-04 15:53:41 +00001511 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001512 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001513 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1514 or CONFIG_VIDEO_SED13806_16BPP
1515
Timur Tabi7d3053f2011-02-15 17:09:19 -06001516 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001517 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001518 SOCs that have a DIU should define this macro to enable DIU
1519 support, and should also define these other macros:
1520
1521 CONFIG_SYS_DIU_ADDR
1522 CONFIG_VIDEO
1523 CONFIG_CMD_BMP
1524 CONFIG_CFB_CONSOLE
1525 CONFIG_VIDEO_SW_CURSOR
1526 CONFIG_VGA_AS_SINGLE_DEVICE
1527 CONFIG_VIDEO_LOGO
1528 CONFIG_VIDEO_BMP_LOGO
1529
Timur Tabiba8e76b2011-04-11 14:18:22 -05001530 The DIU driver will look for the 'video-mode' environment
1531 variable, and if defined, enable the DIU as a console during
1532 boot. See the documentation file README.video for a
1533 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001534
Simon Glass058d59b2012-12-03 13:59:47 +00001535 CONFIG_VIDEO_VGA
1536
1537 Enable the VGA video / BIOS for x86. The alternative if you
1538 are using coreboot is to use the coreboot frame buffer
1539 driver.
1540
1541
wdenk682011f2003-06-03 23:54:09 +00001542- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001543 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001544
wdenk8bde7f72003-06-27 21:31:46 +00001545 Define this to enable a custom keyboard support.
1546 This simply calls drv_keyboard_init() which must be
1547 defined in your board-specific files.
1548 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001549
wdenkc6097192002-11-03 00:24:07 +00001550- LCD Support: CONFIG_LCD
1551
1552 Define this to enable LCD support (for output to LCD
1553 display); also select one of the supported displays
1554 by defining one of these:
1555
Stelian Pop39cf4802008-05-09 21:57:18 +02001556 CONFIG_ATMEL_LCD:
1557
1558 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1559
wdenkfd3103b2003-11-25 16:55:19 +00001560 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001561
wdenkfd3103b2003-11-25 16:55:19 +00001562 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001563
wdenkfd3103b2003-11-25 16:55:19 +00001564 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001565
wdenkfd3103b2003-11-25 16:55:19 +00001566 NEC NL6448BC20-08. 6.5", 640x480.
1567 Active, color, single scan.
1568
1569 CONFIG_NEC_NL6448BC33_54
1570
1571 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001572 Active, color, single scan.
1573
1574 CONFIG_SHARP_16x9
1575
1576 Sharp 320x240. Active, color, single scan.
1577 It isn't 16x9, and I am not sure what it is.
1578
1579 CONFIG_SHARP_LQ64D341
1580
1581 Sharp LQ64D341 display, 640x480.
1582 Active, color, single scan.
1583
1584 CONFIG_HLD1045
1585
1586 HLD1045 display, 640x480.
1587 Active, color, single scan.
1588
1589 CONFIG_OPTREX_BW
1590
1591 Optrex CBL50840-2 NF-FW 99 22 M5
1592 or
1593 Hitachi LMG6912RPFC-00T
1594 or
1595 Hitachi SP14Q002
1596
1597 320x240. Black & white.
1598
1599 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001600 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001601
Simon Glass676d3192012-10-17 13:24:54 +00001602 CONFIG_LCD_ALIGNMENT
1603
1604 Normally the LCD is page-aligned (tyically 4KB). If this is
1605 defined then the LCD will be aligned to this value instead.
1606 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1607 here, since it is cheaper to change data cache settings on
1608 a per-section basis.
1609
Simon Glass0d89efe2012-10-17 13:24:59 +00001610 CONFIG_CONSOLE_SCROLL_LINES
1611
1612 When the console need to be scrolled, this is the number of
1613 lines to scroll by. It defaults to 1. Increasing this makes
1614 the console jump but can help speed up operation when scrolling
1615 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001616
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001617 CONFIG_LCD_BMP_RLE8
1618
1619 Support drawing of RLE8-compressed bitmaps on the LCD.
1620
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001621 CONFIG_I2C_EDID
1622
1623 Enables an 'i2c edid' command which can read EDID
1624 information over I2C from an attached LCD display.
1625
wdenk7152b1d2003-09-05 23:19:14 +00001626- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001627
wdenk8bde7f72003-06-27 21:31:46 +00001628 If this option is set, the environment is checked for
1629 a variable "splashimage". If found, the usual display
1630 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001631 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001632 specified in "splashimage" is loaded instead. The
1633 console is redirected to the "nulldev", too. This
1634 allows for a "silent" boot where a splash screen is
1635 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001636
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001637 CONFIG_SPLASHIMAGE_GUARD
1638
1639 If this option is set, then U-Boot will prevent the environment
1640 variable "splashimage" from being set to a problematic address
1641 (see README.displaying-bmps and README.arm-unaligned-accesses).
1642 This option is useful for targets where, due to alignment
1643 restrictions, an improperly aligned BMP image will cause a data
1644 abort. If you think you will not have problems with unaligned
1645 accesses (for example because your toolchain prevents them)
1646 there is no need to set this option.
1647
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001648 CONFIG_SPLASH_SCREEN_ALIGN
1649
1650 If this option is set the splash image can be freely positioned
1651 on the screen. Environment variable "splashpos" specifies the
1652 position as "x,y". If a positive number is given it is used as
1653 number of pixel from left/top. If a negative number is given it
1654 is used as number of pixel from right/bottom. You can also
1655 specify 'm' for centering the image.
1656
1657 Example:
1658 setenv splashpos m,m
1659 => image at center of screen
1660
1661 setenv splashpos 30,20
1662 => image at x = 30 and y = 20
1663
1664 setenv splashpos -10,m
1665 => vertically centered image
1666 at x = dspWidth - bmpWidth - 9
1667
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001668- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1669
1670 If this option is set, additionally to standard BMP
1671 images, gzipped BMP images can be displayed via the
1672 splashscreen support or the bmp command.
1673
Anatolij Gustschind5011762010-03-15 14:50:25 +01001674- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1675
1676 If this option is set, 8-bit RLE compressed BMP images
1677 can be displayed via the splashscreen support or the
1678 bmp command.
1679
Lei Wenf2b96df2012-09-28 04:26:47 +00001680- Do compresssing for memory range:
1681 CONFIG_CMD_ZIP
1682
1683 If this option is set, it would use zlib deflate method
1684 to compress the specified memory at its best effort.
1685
wdenkc29fdfc2003-08-29 20:57:53 +00001686- Compression support:
1687 CONFIG_BZIP2
1688
1689 If this option is set, support for bzip2 compressed
1690 images is included. If not, only uncompressed and gzip
1691 compressed images are supported.
1692
wdenk42d1f032003-10-15 23:53:47 +00001693 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001694 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001695 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001696
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001697 CONFIG_LZMA
1698
1699 If this option is set, support for lzma compressed
1700 images is included.
1701
1702 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1703 requires an amount of dynamic memory that is given by the
1704 formula:
1705
1706 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1707
1708 Where lc and lp stand for, respectively, Literal context bits
1709 and Literal pos bits.
1710
1711 This value is upper-bounded by 14MB in the worst case. Anyway,
1712 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1713 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1714 a very small buffer.
1715
1716 Use the lzmainfo tool to determinate the lc and lp values and
1717 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001718 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001719
wdenk17ea1172004-06-06 21:51:03 +00001720- MII/PHY support:
1721 CONFIG_PHY_ADDR
1722
1723 The address of PHY on MII bus.
1724
1725 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1726
1727 The clock frequency of the MII bus
1728
1729 CONFIG_PHY_GIGE
1730
1731 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001732 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001733
1734 CONFIG_PHY_RESET_DELAY
1735
1736 Some PHY like Intel LXT971A need extra delay after
1737 reset before any MII register access is possible.
1738 For such PHY, set this option to the usec delay
1739 required. (minimum 300usec for LXT971A)
1740
1741 CONFIG_PHY_CMD_DELAY (ppc4xx)
1742
1743 Some PHY like Intel LXT971A need extra delay after
1744 command issued before MII status register can be read
1745
wdenkc6097192002-11-03 00:24:07 +00001746- Ethernet address:
1747 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001748 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001749 CONFIG_ETH2ADDR
1750 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001751 CONFIG_ETH4ADDR
1752 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001753
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001754 Define a default value for Ethernet address to use
1755 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001756 is not determined automatically.
1757
1758- IP address:
1759 CONFIG_IPADDR
1760
1761 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001762 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001763 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001764 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001765
1766- Server IP address:
1767 CONFIG_SERVERIP
1768
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001769 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001770 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001771 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001772
Robin Getz97cfe862009-07-21 12:15:28 -04001773 CONFIG_KEEP_SERVERADDR
1774
1775 Keeps the server's MAC address, in the env 'serveraddr'
1776 for passing to bootargs (like Linux's netconsole option)
1777
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001778- Gateway IP address:
1779 CONFIG_GATEWAYIP
1780
1781 Defines a default value for the IP address of the
1782 default router where packets to other networks are
1783 sent to.
1784 (Environment variable "gatewayip")
1785
1786- Subnet mask:
1787 CONFIG_NETMASK
1788
1789 Defines a default value for the subnet mask (or
1790 routing prefix) which is used to determine if an IP
1791 address belongs to the local subnet or needs to be
1792 forwarded through a router.
1793 (Environment variable "netmask")
1794
David Updegraff53a5c422007-06-11 10:41:07 -05001795- Multicast TFTP Mode:
1796 CONFIG_MCAST_TFTP
1797
1798 Defines whether you want to support multicast TFTP as per
1799 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001800 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001801 driver in use must provide a function: mcast() to join/leave a
1802 multicast group.
1803
wdenkc6097192002-11-03 00:24:07 +00001804- BOOTP Recovery Mode:
1805 CONFIG_BOOTP_RANDOM_DELAY
1806
1807 If you have many targets in a network that try to
1808 boot using BOOTP, you may want to avoid that all
1809 systems send out BOOTP requests at precisely the same
1810 moment (which would happen for instance at recovery
1811 from a power failure, when all systems will try to
1812 boot, thus flooding the BOOTP server. Defining
1813 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1814 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001815 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001816
1817 1st BOOTP request: delay 0 ... 1 sec
1818 2nd BOOTP request: delay 0 ... 2 sec
1819 3rd BOOTP request: delay 0 ... 4 sec
1820 4th and following
1821 BOOTP requests: delay 0 ... 8 sec
1822
stroesefe389a82003-08-28 14:17:32 +00001823- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001824 You can fine tune the DHCP functionality by defining
1825 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001826
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001827 CONFIG_BOOTP_SUBNETMASK
1828 CONFIG_BOOTP_GATEWAY
1829 CONFIG_BOOTP_HOSTNAME
1830 CONFIG_BOOTP_NISDOMAIN
1831 CONFIG_BOOTP_BOOTPATH
1832 CONFIG_BOOTP_BOOTFILESIZE
1833 CONFIG_BOOTP_DNS
1834 CONFIG_BOOTP_DNS2
1835 CONFIG_BOOTP_SEND_HOSTNAME
1836 CONFIG_BOOTP_NTPSERVER
1837 CONFIG_BOOTP_TIMEOFFSET
1838 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001839 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001840
Wilson Callan5d110f02007-07-28 10:56:13 -04001841 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1842 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001843
Joe Hershberger2c00e092012-05-23 07:59:19 +00001844 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1845 after the configured retry count, the call will fail
1846 instead of starting over. This can be used to fail over
1847 to Link-local IP address configuration if the DHCP server
1848 is not available.
1849
stroesefe389a82003-08-28 14:17:32 +00001850 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1851 serverip from a DHCP server, it is possible that more
1852 than one DNS serverip is offered to the client.
1853 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1854 serverip will be stored in the additional environment
1855 variable "dnsip2". The first DNS serverip is always
1856 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001857 is defined.
stroesefe389a82003-08-28 14:17:32 +00001858
1859 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1860 to do a dynamic update of a DNS server. To do this, they
1861 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001862 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001863 of the "hostname" environment variable is passed as
1864 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001865
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001866 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1867
1868 A 32bit value in microseconds for a delay between
1869 receiving a "DHCP Offer" and sending the "DHCP Request".
1870 This fixes a problem with certain DHCP servers that don't
1871 respond 100% of the time to a "DHCP request". E.g. On an
1872 AT91RM9200 processor running at 180MHz, this delay needed
1873 to be *at least* 15,000 usec before a Windows Server 2003
1874 DHCP server would reply 100% of the time. I recommend at
1875 least 50,000 usec to be safe. The alternative is to hope
1876 that one of the retries will be successful but note that
1877 the DHCP timeout and retry process takes a longer than
1878 this delay.
1879
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001880 - Link-local IP address negotiation:
1881 Negotiate with other link-local clients on the local network
1882 for an address that doesn't require explicit configuration.
1883 This is especially useful if a DHCP server cannot be guaranteed
1884 to exist in all environments that the device must operate.
1885
1886 See doc/README.link-local for more information.
1887
wdenka3d991b2004-04-15 21:48:45 +00001888 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001889 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001890
1891 The device id used in CDP trigger frames.
1892
1893 CONFIG_CDP_DEVICE_ID_PREFIX
1894
1895 A two character string which is prefixed to the MAC address
1896 of the device.
1897
1898 CONFIG_CDP_PORT_ID
1899
1900 A printf format string which contains the ascii name of
1901 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001902 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001903
1904 CONFIG_CDP_CAPABILITIES
1905
1906 A 32bit integer which indicates the device capabilities;
1907 0x00000010 for a normal host which does not forwards.
1908
1909 CONFIG_CDP_VERSION
1910
1911 An ascii string containing the version of the software.
1912
1913 CONFIG_CDP_PLATFORM
1914
1915 An ascii string containing the name of the platform.
1916
1917 CONFIG_CDP_TRIGGER
1918
1919 A 32bit integer sent on the trigger.
1920
1921 CONFIG_CDP_POWER_CONSUMPTION
1922
1923 A 16bit integer containing the power consumption of the
1924 device in .1 of milliwatts.
1925
1926 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1927
1928 A byte containing the id of the VLAN.
1929
wdenkc6097192002-11-03 00:24:07 +00001930- Status LED: CONFIG_STATUS_LED
1931
1932 Several configurations allow to display the current
1933 status using a LED. For instance, the LED will blink
1934 fast while running U-Boot code, stop blinking as
1935 soon as a reply to a BOOTP request was received, and
1936 start blinking slow once the Linux kernel is running
1937 (supported by a status LED driver in the Linux
1938 kernel). Defining CONFIG_STATUS_LED enables this
1939 feature in U-Boot.
1940
1941- CAN Support: CONFIG_CAN_DRIVER
1942
1943 Defining CONFIG_CAN_DRIVER enables CAN driver support
1944 on those systems that support this (optional)
1945 feature, like the TQM8xxL modules.
1946
1947- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1948
wdenkb37c7e52003-06-30 16:24:52 +00001949 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001950 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001951 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001952
wdenk945af8d2003-07-16 21:53:01 +00001953 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001954 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001955 CONFIG_COMMANDS) and communicate with i2c based realtime
1956 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001957 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001958
Ben Warrenbb99ad62006-09-07 16:50:54 -04001959 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk945af8d2003-07-16 21:53:01 +00001961 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001962 bit-banging) driver instead of CPM or similar hardware
1963 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001964
wdenk945af8d2003-07-16 21:53:01 +00001965 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001966 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001968 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001969 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001970 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001971 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001972
Peter Tyser8d321b82010-04-12 22:28:21 -05001973 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001974 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001975 and so its address should therefore be cleared to 0 (See,
1976 eg, MPC823e User's Manual p.16-473). So, set
1977 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001978
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001979 CONFIG_SYS_I2C_INIT_MPC5XXX
1980
1981 When a board is reset during an i2c bus transfer
1982 chips might think that the current transfer is still
1983 in progress. Reset the slave devices by sending start
1984 commands until the slave device responds.
1985
wdenk945af8d2003-07-16 21:53:01 +00001986 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001987
1988 If you use the software i2c interface (CONFIG_SOFT_I2C)
1989 then the following macros need to be defined (examples are
1990 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001991
1992 I2C_INIT
1993
wdenkb37c7e52003-06-30 16:24:52 +00001994 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001995 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001996
wdenkba56f622004-02-06 23:19:44 +00001997 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001998
wdenkc6097192002-11-03 00:24:07 +00001999 I2C_PORT
2000
wdenk43d96162003-03-06 00:02:04 +00002001 (Only for MPC8260 CPU). The I/O port to use (the code
2002 assumes both bits are on the same port). Valid values
2003 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002004
2005 I2C_ACTIVE
2006
2007 The code necessary to make the I2C data line active
2008 (driven). If the data line is open collector, this
2009 define can be null.
2010
wdenkb37c7e52003-06-30 16:24:52 +00002011 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2012
wdenkc6097192002-11-03 00:24:07 +00002013 I2C_TRISTATE
2014
2015 The code necessary to make the I2C data line tri-stated
2016 (inactive). If the data line is open collector, this
2017 define can be null.
2018
wdenkb37c7e52003-06-30 16:24:52 +00002019 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2020
wdenkc6097192002-11-03 00:24:07 +00002021 I2C_READ
2022
York Sun472d5462013-04-01 11:29:11 -07002023 Code that returns true if the I2C data line is high,
2024 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002025
wdenkb37c7e52003-06-30 16:24:52 +00002026 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2027
wdenkc6097192002-11-03 00:24:07 +00002028 I2C_SDA(bit)
2029
York Sun472d5462013-04-01 11:29:11 -07002030 If <bit> is true, sets the I2C data line high. If it
2031 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002032
wdenkb37c7e52003-06-30 16:24:52 +00002033 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002034 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002035 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002036
wdenkc6097192002-11-03 00:24:07 +00002037 I2C_SCL(bit)
2038
York Sun472d5462013-04-01 11:29:11 -07002039 If <bit> is true, sets the I2C clock line high. If it
2040 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002041
wdenkb37c7e52003-06-30 16:24:52 +00002042 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002043 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002044 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002045
wdenkc6097192002-11-03 00:24:07 +00002046 I2C_DELAY
2047
2048 This delay is invoked four times per clock cycle so this
2049 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002050 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002051 like:
2052
wdenkb37c7e52003-06-30 16:24:52 +00002053 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002054
Mike Frysinger793b5722010-07-21 13:38:02 -04002055 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2056
2057 If your arch supports the generic GPIO framework (asm/gpio.h),
2058 then you may alternatively define the two GPIOs that are to be
2059 used as SCL / SDA. Any of the previous I2C_xxx macros will
2060 have GPIO-based defaults assigned to them as appropriate.
2061
2062 You should define these to the GPIO value as given directly to
2063 the generic GPIO functions.
2064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002065 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002066
wdenk8bde7f72003-06-27 21:31:46 +00002067 When a board is reset during an i2c bus transfer
2068 chips might think that the current transfer is still
2069 in progress. On some boards it is possible to access
2070 the i2c SCLK line directly, either by using the
2071 processor pin as a GPIO or by having a second pin
2072 connected to the bus. If this option is defined a
2073 custom i2c_init_board() routine in boards/xxx/board.c
2074 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002075
Richard Retanubun26a33502010-04-12 15:08:17 -04002076 CONFIG_SYS_I2C_BOARD_LATE_INIT
2077
2078 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2079 defined a custom i2c_board_late_init() routine in
2080 boards/xxx/board.c is run AFTER the operations in i2c_init()
2081 is completed. This callpoint can be used to unreset i2c bus
2082 using CPU i2c controller register accesses for CPUs whose i2c
2083 controller provide such a method. It is called at the end of
2084 i2c_init() to allow i2c_init operations to setup the i2c bus
2085 controller on the CPU (e.g. setting bus speed & slave address).
2086
wdenk17ea1172004-06-06 21:51:03 +00002087 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2088
2089 This option enables configuration of bi_iic_fast[] flags
2090 in u-boot bd_info structure based on u-boot environment
2091 variable "i2cfast". (see also i2cfast)
2092
Ben Warrenbb99ad62006-09-07 16:50:54 -04002093 CONFIG_I2C_MULTI_BUS
2094
2095 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002096 must have a controller. At any point in time, only one bus is
2097 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002098 Note that bus numbering is zero-based.
2099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002100 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002101
2102 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002103 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002104 is set, specify a list of bus-device pairs. Otherwise, specify
2105 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002106
2107 e.g.
2108 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002109 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002110
2111 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2112
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002113 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002114 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002115
2116 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002118 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002119
2120 If defined, then this indicates the I2C bus number for DDR SPD.
2121 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002123 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002124
2125 If defined, then this indicates the I2C bus number for the RTC.
2126 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002128 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002129
2130 If defined, then this indicates the I2C bus number for the DTT.
2131 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002133 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002134
2135 If defined, specifies the I2C address of the DTT device.
2136 If not defined, then U-Boot uses predefined value for
2137 specified DTT device.
2138
Timur Tabibe5e6182006-11-03 19:15:00 -06002139 CONFIG_FSL_I2C
2140
2141 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002142 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002143
Heiko Schocher67b23a32008-10-15 09:39:47 +02002144 CONFIG_I2C_MUX
2145
2146 Define this option if you have I2C devices reached over 1 .. n
2147 I2C Muxes like the pca9544a. This option addes a new I2C
2148 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2149 new I2C Bus to the existing I2C Busses. If you select the
2150 new Bus with "i2c dev", u-bbot sends first the commandos for
2151 the muxes to activate this new "bus".
2152
2153 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2154 feature!
2155
2156 Example:
2157 Adding a new I2C Bus reached over 2 pca9544a muxes
2158 The First mux with address 70 and channel 6
2159 The Second mux with address 71 and channel 4
2160
2161 => i2c bus pca9544a:70:6:pca9544a:71:4
2162
2163 Use the "i2c bus" command without parameter, to get a list
2164 of I2C Busses with muxes:
2165
2166 => i2c bus
2167 Busses reached over muxes:
2168 Bus ID: 2
2169 reached over Mux(es):
2170 pca9544a@70 ch: 4
2171 Bus ID: 3
2172 reached over Mux(es):
2173 pca9544a@70 ch: 6
2174 pca9544a@71 ch: 4
2175 =>
2176
2177 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002178 u-boot first sends the command to the mux@70 to enable
2179 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002180 the channel 4.
2181
2182 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002183 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002184 the 2 muxes.
2185
2186 This option is actually implemented for the bitbanging
2187 algorithm in common/soft_i2c.c and for the Hardware I2C
2188 Bus on the MPC8260. But it should be not so difficult
2189 to add this option to other architectures.
2190
Andrew Dyer2ac69852008-12-29 17:36:01 -06002191 CONFIG_SOFT_I2C_READ_REPEATED_START
2192
2193 defining this will force the i2c_read() function in
2194 the soft_i2c driver to perform an I2C repeated start
2195 between writing the address pointer and reading the
2196 data. If this define is omitted the default behaviour
2197 of doing a stop-start sequence will be used. Most I2C
2198 devices can use either method, but some require one or
2199 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002200
wdenkc6097192002-11-03 00:24:07 +00002201- SPI Support: CONFIG_SPI
2202
2203 Enables SPI driver (so far only tested with
2204 SPI EEPROM, also an instance works with Crystal A/D and
2205 D/As on the SACSng board)
2206
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002207 CONFIG_SH_SPI
2208
2209 Enables the driver for SPI controller on SuperH. Currently
2210 only SH7757 is supported.
2211
wdenkc6097192002-11-03 00:24:07 +00002212 CONFIG_SPI_X
2213
2214 Enables extended (16-bit) SPI EEPROM addressing.
2215 (symmetrical to CONFIG_I2C_X)
2216
2217 CONFIG_SOFT_SPI
2218
wdenk43d96162003-03-06 00:02:04 +00002219 Enables a software (bit-bang) SPI driver rather than
2220 using hardware support. This is a general purpose
2221 driver that only requires three general I/O port pins
2222 (two outputs, one input) to function. If this is
2223 defined, the board configuration must define several
2224 SPI configuration items (port pins to use, etc). For
2225 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002226
Ben Warren04a9e112008-01-16 22:37:35 -05002227 CONFIG_HARD_SPI
2228
2229 Enables a hardware SPI driver for general-purpose reads
2230 and writes. As with CONFIG_SOFT_SPI, the board configuration
2231 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002232 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002233 example, see include/configs/mpc8349emds.h.
2234
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002235 CONFIG_MXC_SPI
2236
2237 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002238 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002239
Matthias Fuchs01335022007-12-27 17:12:34 +01002240- FPGA Support: CONFIG_FPGA
2241
2242 Enables FPGA subsystem.
2243
2244 CONFIG_FPGA_<vendor>
2245
2246 Enables support for specific chip vendors.
2247 (ALTERA, XILINX)
2248
2249 CONFIG_FPGA_<family>
2250
2251 Enables support for FPGA family.
2252 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2253
2254 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002255
wdenk43d96162003-03-06 00:02:04 +00002256 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002258 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002259
wdenk8bde7f72003-06-27 21:31:46 +00002260 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002262 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002263
wdenk43d96162003-03-06 00:02:04 +00002264 Enable checks on FPGA configuration interface busy
2265 status by the configuration function. This option
2266 will require a board or device specific function to
2267 be written.
wdenkc6097192002-11-03 00:24:07 +00002268
2269 CONFIG_FPGA_DELAY
2270
2271 If defined, a function that provides delays in the FPGA
2272 configuration driver.
2273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002275 Allow Control-C to interrupt FPGA configuration
2276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002277 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002278
wdenk43d96162003-03-06 00:02:04 +00002279 Check for configuration errors during FPGA bitfile
2280 loading. For example, abort during Virtex II
2281 configuration if the INIT_B line goes low (which
2282 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002284 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002285
wdenk43d96162003-03-06 00:02:04 +00002286 Maximum time to wait for the INIT_B line to deassert
2287 after PROB_B has been deasserted during a Virtex II
2288 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002289 ms.
wdenkc6097192002-11-03 00:24:07 +00002290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002292
wdenk43d96162003-03-06 00:02:04 +00002293 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002294 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002296 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002297
wdenk43d96162003-03-06 00:02:04 +00002298 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002299 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002300
2301- Configuration Management:
2302 CONFIG_IDENT_STRING
2303
wdenk43d96162003-03-06 00:02:04 +00002304 If defined, this string will be added to the U-Boot
2305 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002306
2307- Vendor Parameter Protection:
2308
wdenk43d96162003-03-06 00:02:04 +00002309 U-Boot considers the values of the environment
2310 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002311 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002312 are set once by the board vendor / manufacturer, and
2313 protects these variables from casual modification by
2314 the user. Once set, these variables are read-only,
2315 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002316 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002317
2318 If CONFIG_ENV_OVERWRITE is #defined in your config
2319 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002320 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002321 these parameters.
2322
2323 Alternatively, if you #define _both_ CONFIG_ETHADDR
2324 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002325 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002326 which can be changed exactly ONCE by the user. [The
2327 serial# is unaffected by this, i. e. it remains
2328 read-only.]
2329
Joe Hershberger25980902012-12-11 22:16:31 -06002330 The same can be accomplished in a more flexible way
2331 for any variable by configuring the type of access
2332 to allow for those variables in the ".flags" variable
2333 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2334
wdenkc6097192002-11-03 00:24:07 +00002335- Protected RAM:
2336 CONFIG_PRAM
2337
2338 Define this variable to enable the reservation of
2339 "protected RAM", i. e. RAM which is not overwritten
2340 by U-Boot. Define CONFIG_PRAM to hold the number of
2341 kB you want to reserve for pRAM. You can overwrite
2342 this default value by defining an environment
2343 variable "pram" to the number of kB you want to
2344 reserve. Note that the board info structure will
2345 still show the full amount of RAM. If pRAM is
2346 reserved, a new environment variable "mem" will
2347 automatically be defined to hold the amount of
2348 remaining RAM in a form that can be passed as boot
2349 argument to Linux, for instance like that:
2350
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002351 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002352 saveenv
2353
2354 This way you can tell Linux not to use this memory,
2355 either, which results in a memory region that will
2356 not be affected by reboots.
2357
2358 *WARNING* If your board configuration uses automatic
2359 detection of the RAM size, you must make sure that
2360 this memory test is non-destructive. So far, the
2361 following board configurations are known to be
2362 "pRAM-clean":
2363
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002364 IVMS8, IVML24, SPD8xx, TQM8xxL,
2365 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002366 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002367
Gabe Black40fef042012-12-02 04:55:18 +00002368- Access to physical memory region (> 4GB)
2369 Some basic support is provided for operations on memory not
2370 normally accessible to U-Boot - e.g. some architectures
2371 support access to more than 4GB of memory on 32-bit
2372 machines using physical address extension or similar.
2373 Define CONFIG_PHYSMEM to access this basic support, which
2374 currently only supports clearing the memory.
2375
wdenkc6097192002-11-03 00:24:07 +00002376- Error Recovery:
2377 CONFIG_PANIC_HANG
2378
2379 Define this variable to stop the system in case of a
2380 fatal error, so that you have to reset it manually.
2381 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002382 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002383 automatically as fast as possible, but it may be
2384 useful during development since you can try to debug
2385 the conditions that lead to the situation.
2386
2387 CONFIG_NET_RETRY_COUNT
2388
wdenk43d96162003-03-06 00:02:04 +00002389 This variable defines the number of retries for
2390 network operations like ARP, RARP, TFTP, or BOOTP
2391 before giving up the operation. If not defined, a
2392 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002393
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002394 CONFIG_ARP_TIMEOUT
2395
2396 Timeout waiting for an ARP reply in milliseconds.
2397
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002398 CONFIG_NFS_TIMEOUT
2399
2400 Timeout in milliseconds used in NFS protocol.
2401 If you encounter "ERROR: Cannot umount" in nfs command,
2402 try longer timeout such as
2403 #define CONFIG_NFS_TIMEOUT 10000UL
2404
wdenkc6097192002-11-03 00:24:07 +00002405- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002406 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002407
2408 Enable auto completion of commands using TAB.
2409
Wolfgang Denka9398e02006-11-27 15:32:42 +01002410 Note that this feature has NOT been implemented yet
2411 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002412
2413
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002414 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002415
2416 Define this variable to enable the "hush" shell (from
2417 Busybox) as command line interpreter, thus enabling
2418 powerful command line syntax like
2419 if...then...else...fi conditionals or `&&' and '||'
2420 constructs ("shell scripts").
2421
2422 If undefined, you get the old, much simpler behaviour
2423 with a somewhat smaller memory footprint.
2424
2425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002426 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002427
2428 This defines the secondary prompt string, which is
2429 printed when the command interpreter needs more input
2430 to complete a command. Usually "> ".
2431
2432 Note:
2433
wdenk8bde7f72003-06-27 21:31:46 +00002434 In the current implementation, the local variables
2435 space and global environment variables space are
2436 separated. Local variables are those you define by
2437 simply typing `name=value'. To access a local
2438 variable later on, you have write `$name' or
2439 `${name}'; to execute the contents of a variable
2440 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002441
wdenk43d96162003-03-06 00:02:04 +00002442 Global environment variables are those you use
2443 setenv/printenv to work with. To run a command stored
2444 in such a variable, you need to use the run command,
2445 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002446
2447 To store commands and special characters in a
2448 variable, please use double quotation marks
2449 surrounding the whole text of the variable, instead
2450 of the backslashes before semicolons and special
2451 symbols.
2452
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002453- Commandline Editing and History:
2454 CONFIG_CMDLINE_EDITING
2455
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002456 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002457 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002458
wdenka8c7c702003-12-06 19:49:23 +00002459- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002460 CONFIG_EXTRA_ENV_SETTINGS
2461
wdenk43d96162003-03-06 00:02:04 +00002462 Define this to contain any number of null terminated
2463 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002464 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002465
wdenk43d96162003-03-06 00:02:04 +00002466 For example, place something like this in your
2467 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002468
2469 #define CONFIG_EXTRA_ENV_SETTINGS \
2470 "myvar1=value1\0" \
2471 "myvar2=value2\0"
2472
wdenk43d96162003-03-06 00:02:04 +00002473 Warning: This method is based on knowledge about the
2474 internal format how the environment is stored by the
2475 U-Boot code. This is NOT an official, exported
2476 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002477 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002478 You better know what you are doing here.
2479
wdenk43d96162003-03-06 00:02:04 +00002480 Note: overly (ab)use of the default environment is
2481 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002482 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002483 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002484
Stephen Warren5e724ca2012-05-22 09:21:54 +00002485 CONFIG_ENV_VARS_UBOOT_CONFIG
2486
2487 Define this in order to add variables describing the
2488 U-Boot build configuration to the default environment.
2489 These will be named arch, cpu, board, vendor, and soc.
2490
2491 Enabling this option will cause the following to be defined:
2492
2493 - CONFIG_SYS_ARCH
2494 - CONFIG_SYS_CPU
2495 - CONFIG_SYS_BOARD
2496 - CONFIG_SYS_VENDOR
2497 - CONFIG_SYS_SOC
2498
Tom Rini7e27f892012-10-24 07:28:16 +00002499 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2500
2501 Define this in order to add variables describing certain
2502 run-time determined information about the hardware to the
2503 environment. These will be named board_name, board_rev.
2504
Simon Glass06fd8532012-11-30 13:01:17 +00002505 CONFIG_DELAY_ENVIRONMENT
2506
2507 Normally the environment is loaded when the board is
2508 intialised so that it is available to U-Boot. This inhibits
2509 that so that the environment is not available until
2510 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2511 this is instead controlled by the value of
2512 /config/load-environment.
2513
wdenka8c7c702003-12-06 19:49:23 +00002514- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002515 CONFIG_HAS_DATAFLASH
2516
wdenk8bde7f72003-06-27 21:31:46 +00002517 Defining this option enables DataFlash features and
2518 allows to read/write in Dataflash via the standard
2519 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002520
Eric Nelsonf61ec452012-01-31 10:52:08 -07002521- Serial Flash support
2522 CONFIG_CMD_SF
2523
2524 Defining this option enables SPI flash commands
2525 'sf probe/read/write/erase/update'.
2526
2527 Usage requires an initial 'probe' to define the serial
2528 flash parameters, followed by read/write/erase/update
2529 commands.
2530
2531 The following defaults may be provided by the platform
2532 to handle the common case when only a single serial
2533 flash is present on the system.
2534
2535 CONFIG_SF_DEFAULT_BUS Bus identifier
2536 CONFIG_SF_DEFAULT_CS Chip-select
2537 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2538 CONFIG_SF_DEFAULT_SPEED in Hz
2539
Simon Glass24007272012-10-08 13:16:02 +00002540 CONFIG_CMD_SF_TEST
2541
2542 Define this option to include a destructive SPI flash
2543 test ('sf test').
2544
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302545 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2546
2547 Define this option to use the Bank addr/Extended addr
2548 support on SPI flashes which has size > 16Mbytes.
2549
wdenk3f85ce22004-02-23 16:11:30 +00002550- SystemACE Support:
2551 CONFIG_SYSTEMACE
2552
2553 Adding this option adds support for Xilinx SystemACE
2554 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002555 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002557
2558 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002559 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002560
2561 When SystemACE support is added, the "ace" device type
2562 becomes available to the fat commands, i.e. fatls.
2563
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002564- TFTP Fixed UDP Port:
2565 CONFIG_TFTP_PORT
2566
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002567 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002568 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002569 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002570 number generator is used.
2571
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002572 Also, the environment variable tftpdstp is used to supply
2573 the TFTP UDP destination port value. If tftpdstp isn't
2574 defined, the normal port 69 is used.
2575
2576 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002577 blindly start the TFTP transfer using the pre-configured
2578 target IP address and UDP port. This has the effect of
2579 "punching through" the (Windows XP) firewall, allowing
2580 the remainder of the TFTP transfer to proceed normally.
2581 A better solution is to properly configure the firewall,
2582 but sometimes that is not allowed.
2583
Simon Glassbf36c5d2012-12-05 14:46:38 +00002584- Hashing support:
2585 CONFIG_CMD_HASH
2586
2587 This enables a generic 'hash' command which can produce
2588 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2589
2590 CONFIG_HASH_VERIFY
2591
2592 Enable the hash verify command (hash -v). This adds to code
2593 size a little.
2594
2595 CONFIG_SHA1 - support SHA1 hashing
2596 CONFIG_SHA256 - support SHA256 hashing
2597
2598 Note: There is also a sha1sum command, which should perhaps
2599 be deprecated in favour of 'hash sha1'.
2600
Robert Winklera11f1872013-07-24 17:57:06 -07002601- Freescale i.MX specific commands:
2602 CONFIG_CMD_HDMIDETECT
2603 This enables 'hdmidet' command which returns true if an
2604 HDMI monitor is detected. This command is i.MX 6 specific.
2605
2606 CONFIG_CMD_BMODE
2607 This enables the 'bmode' (bootmode) command for forcing
2608 a boot from specific media.
2609
2610 This is useful for forcing the ROM's usb downloader to
2611 activate upon a watchdog reset which is nice when iterating
2612 on U-Boot. Using the reset button or running bmode normal
2613 will set it back to normal. This command currently
2614 supports i.MX53 and i.MX6.
2615
Simon Glass19c402a2013-06-13 15:10:02 -07002616- Signing support:
2617 CONFIG_RSA
2618
2619 This enables the RSA algorithm used for FIT image verification
2620 in U-Boot. See doc/uImage/signature for more information.
2621
2622 The signing part is build into mkimage regardless of this
2623 option.
2624
2625
wdenka8c7c702003-12-06 19:49:23 +00002626- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002627 CONFIG_SHOW_BOOT_PROGRESS
2628
wdenk43d96162003-03-06 00:02:04 +00002629 Defining this option allows to add some board-
2630 specific code (calling a user-provided function
2631 "show_boot_progress(int)") that enables you to show
2632 the system's boot progress on some display (for
2633 example, some LED's) on your board. At the moment,
2634 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002635
Simon Glass3a608ca2012-02-13 13:51:19 +00002636- Detailed boot stage timing
2637 CONFIG_BOOTSTAGE
2638 Define this option to get detailed timing of each stage
2639 of the boot process.
2640
2641 CONFIG_BOOTSTAGE_USER_COUNT
2642 This is the number of available user bootstage records.
2643 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2644 a new ID will be allocated from this stash. If you exceed
2645 the limit, recording will stop.
2646
2647 CONFIG_BOOTSTAGE_REPORT
2648 Define this to print a report before boot, similar to this:
2649
2650 Timer summary in microseconds:
2651 Mark Elapsed Stage
2652 0 0 reset
2653 3,575,678 3,575,678 board_init_f start
2654 3,575,695 17 arch_cpu_init A9
2655 3,575,777 82 arch_cpu_init done
2656 3,659,598 83,821 board_init_r start
2657 3,910,375 250,777 main_loop
2658 29,916,167 26,005,792 bootm_start
2659 30,361,327 445,160 start_kernel
2660
Simon Glass2eba38c2012-09-28 08:56:39 +00002661 CONFIG_CMD_BOOTSTAGE
2662 Add a 'bootstage' command which supports printing a report
2663 and un/stashing of bootstage data.
2664
Simon Glass94fd1312012-09-28 08:56:37 +00002665 CONFIG_BOOTSTAGE_FDT
2666 Stash the bootstage information in the FDT. A root 'bootstage'
2667 node is created with each bootstage id as a child. Each child
2668 has a 'name' property and either 'mark' containing the
2669 mark time in microsecond, or 'accum' containing the
2670 accumulated time for that bootstage id in microseconds.
2671 For example:
2672
2673 bootstage {
2674 154 {
2675 name = "board_init_f";
2676 mark = <3575678>;
2677 };
2678 170 {
2679 name = "lcd";
2680 accum = <33482>;
2681 };
2682 };
2683
2684 Code in the Linux kernel can find this in /proc/devicetree.
2685
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002686Legacy uImage format:
2687
wdenkc6097192002-11-03 00:24:07 +00002688 Arg Where When
2689 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002690 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002691 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002692 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002693 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002694 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002695 4 common/cmd_bootm.c Image data has correct checksum
2696 -4 common/cmd_bootm.c Image is for unsupported architecture
2697 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002698 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002699 6 common/cmd_bootm.c Image Type check OK
2700 -6 common/cmd_bootm.c gunzip uncompression error
2701 -7 common/cmd_bootm.c Unimplemented compression type
2702 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002703 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002704 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002705
2706 9 common/image.c Start initial ramdisk verification
2707 -10 common/image.c Ramdisk header has bad magic number
2708 -11 common/image.c Ramdisk header has bad checksum
2709 10 common/image.c Ramdisk header is OK
2710 -12 common/image.c Ramdisk data has bad checksum
2711 11 common/image.c Ramdisk data has correct checksum
2712 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002713 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002714 13 common/image.c Start multifile image verification
2715 14 common/image.c No initial ramdisk, no multifile, continue.
2716
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002717 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002718
Stefan Roesea47a12b2010-04-15 16:07:28 +02002719 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002720 -31 post/post.c POST test failed, detected by post_output_backlog()
2721 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002722
Heiko Schocher566a4942007-06-22 19:11:54 +02002723 34 common/cmd_doc.c before loading a Image from a DOC device
2724 -35 common/cmd_doc.c Bad usage of "doc" command
2725 35 common/cmd_doc.c correct usage of "doc" command
2726 -36 common/cmd_doc.c No boot device
2727 36 common/cmd_doc.c correct boot device
2728 -37 common/cmd_doc.c Unknown Chip ID on boot device
2729 37 common/cmd_doc.c correct chip ID found, device available
2730 -38 common/cmd_doc.c Read Error on boot device
2731 38 common/cmd_doc.c reading Image header from DOC device OK
2732 -39 common/cmd_doc.c Image header has bad magic number
2733 39 common/cmd_doc.c Image header has correct magic number
2734 -40 common/cmd_doc.c Error reading Image from DOC device
2735 40 common/cmd_doc.c Image header has correct magic number
2736 41 common/cmd_ide.c before loading a Image from a IDE device
2737 -42 common/cmd_ide.c Bad usage of "ide" command
2738 42 common/cmd_ide.c correct usage of "ide" command
2739 -43 common/cmd_ide.c No boot device
2740 43 common/cmd_ide.c boot device found
2741 -44 common/cmd_ide.c Device not available
2742 44 common/cmd_ide.c Device available
2743 -45 common/cmd_ide.c wrong partition selected
2744 45 common/cmd_ide.c partition selected
2745 -46 common/cmd_ide.c Unknown partition table
2746 46 common/cmd_ide.c valid partition table found
2747 -47 common/cmd_ide.c Invalid partition type
2748 47 common/cmd_ide.c correct partition type
2749 -48 common/cmd_ide.c Error reading Image Header on boot device
2750 48 common/cmd_ide.c reading Image Header from IDE device OK
2751 -49 common/cmd_ide.c Image header has bad magic number
2752 49 common/cmd_ide.c Image header has correct magic number
2753 -50 common/cmd_ide.c Image header has bad checksum
2754 50 common/cmd_ide.c Image header has correct checksum
2755 -51 common/cmd_ide.c Error reading Image from IDE device
2756 51 common/cmd_ide.c reading Image from IDE device OK
2757 52 common/cmd_nand.c before loading a Image from a NAND device
2758 -53 common/cmd_nand.c Bad usage of "nand" command
2759 53 common/cmd_nand.c correct usage of "nand" command
2760 -54 common/cmd_nand.c No boot device
2761 54 common/cmd_nand.c boot device found
2762 -55 common/cmd_nand.c Unknown Chip ID on boot device
2763 55 common/cmd_nand.c correct chip ID found, device available
2764 -56 common/cmd_nand.c Error reading Image Header on boot device
2765 56 common/cmd_nand.c reading Image Header from NAND device OK
2766 -57 common/cmd_nand.c Image header has bad magic number
2767 57 common/cmd_nand.c Image header has correct magic number
2768 -58 common/cmd_nand.c Error reading Image from NAND device
2769 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002770
Heiko Schocher566a4942007-06-22 19:11:54 +02002771 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002772
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002773 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002774 -64 net/eth.c no Ethernet found.
2775 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002776
Heiko Schocher566a4942007-06-22 19:11:54 +02002777 -80 common/cmd_net.c usage wrong
2778 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002779 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002780 81 common/cmd_net.c NetLoop() back without error
2781 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2782 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002783 83 common/cmd_net.c running "source" command
2784 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002785 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002786
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002787FIT uImage format:
2788
2789 Arg Where When
2790 100 common/cmd_bootm.c Kernel FIT Image has correct format
2791 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2792 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2793 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2794 102 common/cmd_bootm.c Kernel unit name specified
2795 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002796 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002797 104 common/cmd_bootm.c Got kernel subimage node offset
2798 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2799 105 common/cmd_bootm.c Kernel subimage hash verification OK
2800 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2801 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002802 -106 common/cmd_bootm.c Kernel subimage has wrong type
2803 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002804 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2805 108 common/cmd_bootm.c Got kernel subimage data/size
2806 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2807 -109 common/cmd_bootm.c Can't get kernel subimage type
2808 -110 common/cmd_bootm.c Can't get kernel subimage comp
2809 -111 common/cmd_bootm.c Can't get kernel subimage os
2810 -112 common/cmd_bootm.c Can't get kernel subimage load address
2811 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2812
2813 120 common/image.c Start initial ramdisk verification
2814 -120 common/image.c Ramdisk FIT image has incorrect format
2815 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002816 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002817 -122 common/image.c Can't get configuration for ramdisk subimage
2818 123 common/image.c Ramdisk unit name specified
2819 -124 common/image.c Can't get ramdisk subimage node offset
2820 125 common/image.c Got ramdisk subimage node offset
2821 -125 common/image.c Ramdisk subimage hash verification failed
2822 126 common/image.c Ramdisk subimage hash verification OK
2823 -126 common/image.c Ramdisk subimage for unsupported architecture
2824 127 common/image.c Architecture check OK
2825 -127 common/image.c Can't get ramdisk subimage data/size
2826 128 common/image.c Got ramdisk subimage data/size
2827 129 common/image.c Can't get ramdisk load address
2828 -129 common/image.c Got ramdisk load address
2829
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002830 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002831 131 common/cmd_doc.c FIT image format OK
2832
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002833 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002834 141 common/cmd_ide.c FIT image format OK
2835
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002836 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002837 151 common/cmd_nand.c FIT image format OK
2838
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002839- FIT image support:
2840 CONFIG_FIT
2841 Enable support for the FIT uImage format.
2842
2843 CONFIG_FIT_BEST_MATCH
2844 When no configuration is explicitly selected, default to the
2845 one whose fdt's compatibility field best matches that of
2846 U-Boot itself. A match is considered "best" if it matches the
2847 most specific compatibility entry of U-Boot's fdt's root node.
2848 The order of entries in the configuration's fdt is ignored.
2849
Simon Glass3e569a62013-06-13 15:10:00 -07002850 CONFIG_FIT_SIGNATURE
2851 This option enables signature verification of FIT uImages,
2852 using a hash signed and verified using RSA. See
2853 doc/uImage.FIT/signature.txt for more details.
2854
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002855- Standalone program support:
2856 CONFIG_STANDALONE_LOAD_ADDR
2857
Wolfgang Denk6feff892011-10-09 21:06:34 +02002858 This option defines a board specific value for the
2859 address where standalone program gets loaded, thus
2860 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002861 settings.
2862
2863- Frame Buffer Address:
2864 CONFIG_FB_ADDR
2865
2866 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002867 address for frame buffer. This is typically the case
2868 when using a graphics controller has separate video
2869 memory. U-Boot will then place the frame buffer at
2870 the given address instead of dynamically reserving it
2871 in system RAM by calling lcd_setmem(), which grabs
2872 the memory for the frame buffer depending on the
2873 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002874
2875 Please see board_init_f function.
2876
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002877- Automatic software updates via TFTP server
2878 CONFIG_UPDATE_TFTP
2879 CONFIG_UPDATE_TFTP_CNT_MAX
2880 CONFIG_UPDATE_TFTP_MSEC_MAX
2881
2882 These options enable and control the auto-update feature;
2883 for a more detailed description refer to doc/README.update.
2884
2885- MTD Support (mtdparts command, UBI support)
2886 CONFIG_MTD_DEVICE
2887
2888 Adds the MTD device infrastructure from the Linux kernel.
2889 Needed for mtdparts command support.
2890
2891 CONFIG_MTD_PARTITIONS
2892
2893 Adds the MTD partitioning infrastructure from the Linux
2894 kernel. Needed for UBI support.
2895
Joe Hershberger70c219c2013-04-08 10:32:48 +00002896- UBI support
2897 CONFIG_CMD_UBI
2898
2899 Adds commands for interacting with MTD partitions formatted
2900 with the UBI flash translation layer
2901
2902 Requires also defining CONFIG_RBTREE
2903
Joe Hershberger147162d2013-04-08 10:32:49 +00002904 CONFIG_UBI_SILENCE_MSG
2905
2906 Make the verbose messages from UBI stop printing. This leaves
2907 warnings and errors enabled.
2908
Joe Hershberger70c219c2013-04-08 10:32:48 +00002909- UBIFS support
2910 CONFIG_CMD_UBIFS
2911
2912 Adds commands for interacting with UBI volumes formatted as
2913 UBIFS. UBIFS is read-only in u-boot.
2914
2915 Requires UBI support as well as CONFIG_LZO
2916
Joe Hershberger147162d2013-04-08 10:32:49 +00002917 CONFIG_UBIFS_SILENCE_MSG
2918
2919 Make the verbose messages from UBIFS stop printing. This leaves
2920 warnings and errors enabled.
2921
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002922- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002923 CONFIG_SPL
2924 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002925
Tom Rini95579792012-02-14 07:29:40 +00002926 CONFIG_SPL_LDSCRIPT
2927 LDSCRIPT for linking the SPL binary.
2928
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002929 CONFIG_SPL_MAX_FOOTPRINT
2930 Maximum size in memory allocated to the SPL, BSS included.
2931 When defined, the linker checks that the actual memory
2932 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002933 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002934 must not be both defined at the same time.
2935
Tom Rini95579792012-02-14 07:29:40 +00002936 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002937 Maximum size of the SPL image (text, data, rodata, and
2938 linker lists sections), BSS excluded.
2939 When defined, the linker checks that the actual size does
2940 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002941
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002942 CONFIG_SPL_TEXT_BASE
2943 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002944
Scott Wood94a45bb2012-09-20 19:05:12 -05002945 CONFIG_SPL_RELOC_TEXT_BASE
2946 Address to relocate to. If unspecified, this is equal to
2947 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2948
Tom Rini95579792012-02-14 07:29:40 +00002949 CONFIG_SPL_BSS_START_ADDR
2950 Link address for the BSS within the SPL binary.
2951
2952 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002953 Maximum size in memory allocated to the SPL BSS.
2954 When defined, the linker checks that the actual memory used
2955 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002956 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002957 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002958
2959 CONFIG_SPL_STACK
2960 Adress of the start of the stack SPL will use
2961
Scott Wood94a45bb2012-09-20 19:05:12 -05002962 CONFIG_SPL_RELOC_STACK
2963 Adress of the start of the stack SPL will use after
2964 relocation. If unspecified, this is equal to
2965 CONFIG_SPL_STACK.
2966
Tom Rini95579792012-02-14 07:29:40 +00002967 CONFIG_SYS_SPL_MALLOC_START
2968 Starting address of the malloc pool used in SPL.
2969
2970 CONFIG_SYS_SPL_MALLOC_SIZE
2971 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002972
Tom Rini47f7bca2012-08-13 12:03:19 -07002973 CONFIG_SPL_FRAMEWORK
2974 Enable the SPL framework under common/. This framework
2975 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2976 NAND loading of the Linux Kernel.
2977
Tom Rini861a86f2012-08-13 11:37:56 -07002978 CONFIG_SPL_DISPLAY_PRINT
2979 For ARM, enable an optional function to print more information
2980 about the running system.
2981
Scott Wood4b919722012-09-20 16:35:21 -05002982 CONFIG_SPL_INIT_MINIMAL
2983 Arch init code should be built for a very small image
2984
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002985 CONFIG_SPL_LIBCOMMON_SUPPORT
2986 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002987
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002988 CONFIG_SPL_LIBDISK_SUPPORT
2989 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002990
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002991 CONFIG_SPL_I2C_SUPPORT
2992 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002993
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002994 CONFIG_SPL_GPIO_SUPPORT
2995 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002996
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002997 CONFIG_SPL_MMC_SUPPORT
2998 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002999
Tom Rini95579792012-02-14 07:29:40 +00003000 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3001 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3002 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3003 Address, size and partition on the MMC to load U-Boot from
3004 when the MMC is being used in raw mode.
3005
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003006 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3007 Sector to load kernel uImage from when MMC is being
3008 used in raw mode (for Falcon mode)
3009
3010 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3011 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3012 Sector and number of sectors to load kernel argument
3013 parameters from when MMC is being used in raw mode
3014 (for falcon mode)
3015
Tom Rini95579792012-02-14 07:29:40 +00003016 CONFIG_SPL_FAT_SUPPORT
3017 Support for fs/fat/libfat.o in SPL binary
3018
3019 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3020 Filename to read to load U-Boot when reading from FAT
3021
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003022 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3023 Filename to read to load kernel uImage when reading
3024 from FAT (for Falcon mode)
3025
3026 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3027 Filename to read to load kernel argument parameters
3028 when reading from FAT (for Falcon mode)
3029
Scott Wood06f60ae2012-12-06 13:33:17 +00003030 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3031 Set this for NAND SPL on PPC mpc83xx targets, so that
3032 start.S waits for the rest of the SPL to load before
3033 continuing (the hardware starts execution after just
3034 loading the first page rather than the full 4K).
3035
Scott Wood6f2f01b2012-09-20 19:09:07 -05003036 CONFIG_SPL_NAND_BASE
3037 Include nand_base.c in the SPL. Requires
3038 CONFIG_SPL_NAND_DRIVERS.
3039
3040 CONFIG_SPL_NAND_DRIVERS
3041 SPL uses normal NAND drivers, not minimal drivers.
3042
3043 CONFIG_SPL_NAND_ECC
3044 Include standard software ECC in the SPL
3045
Tom Rini95579792012-02-14 07:29:40 +00003046 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003047 Support for NAND boot using simple NAND drivers that
3048 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003049
3050 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3051 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3052 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3053 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3054 CONFIG_SYS_NAND_ECCBYTES
3055 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003056 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003057
3058 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003059 Location in NAND to read U-Boot from
3060
3061 CONFIG_SYS_NAND_U_BOOT_DST
3062 Location in memory to load U-Boot to
3063
3064 CONFIG_SYS_NAND_U_BOOT_SIZE
3065 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003066
3067 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003068 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003069
3070 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3071 Define this if you need to first read the OOB and then the
3072 data. This is used for example on davinci plattforms.
3073
3074 CONFIG_SPL_OMAP3_ID_NAND
3075 Support for an OMAP3-specific set of functions to return the
3076 ID and MFR of the first attached NAND chip, if present.
3077
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003078 CONFIG_SPL_SERIAL_SUPPORT
3079 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003080
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003081 CONFIG_SPL_SPI_FLASH_SUPPORT
3082 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003083
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003084 CONFIG_SPL_SPI_SUPPORT
3085 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003086
Pavel Machekc57b9532012-08-30 22:42:11 +02003087 CONFIG_SPL_RAM_DEVICE
3088 Support for running image already present in ram, in SPL binary
3089
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003090 CONFIG_SPL_LIBGENERIC_SUPPORT
3091 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003092
Ying Zhangba1bee42013-05-20 14:07:25 +08003093 CONFIG_SPL_ENV_SUPPORT
3094 Support for the environment operating in SPL binary
3095
3096 CONFIG_SPL_NET_SUPPORT
3097 Support for the net/libnet.o in SPL binary.
3098 It conflicts with SPL env from storage medium specified by
3099 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3100
Scott Wood74752ba2012-12-06 13:33:16 +00003101 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003102 Image offset to which the SPL should be padded before appending
3103 the SPL payload. By default, this is defined as
3104 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3105 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3106 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003107
Scott Woodca2fca22012-09-21 16:27:32 -05003108 CONFIG_SPL_TARGET
3109 Final target image containing SPL and payload. Some SPLs
3110 use an arch-specific makefile fragment instead, for
3111 example if more than one image needs to be produced.
3112
Simon Glass87ebee32013-05-08 08:05:59 +00003113 CONFIG_FIT_SPL_PRINT
3114 Printing information about a FIT image adds quite a bit of
3115 code to SPL. So this is normally disabled in SPL. Use this
3116 option to re-enable it. This will affect the output of the
3117 bootm command when booting a FIT image.
3118
wdenkc6097192002-11-03 00:24:07 +00003119Modem Support:
3120--------------
3121
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003122[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003123
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003124- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003125 CONFIG_MODEM_SUPPORT
3126
3127- RTS/CTS Flow control enable:
3128 CONFIG_HWFLOW
3129
3130- Modem debug support:
3131 CONFIG_MODEM_SUPPORT_DEBUG
3132
wdenk43d96162003-03-06 00:02:04 +00003133 Enables debugging stuff (char screen[1024], dbg())
3134 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003135
wdenka8c7c702003-12-06 19:49:23 +00003136- Interrupt support (PPC):
3137
wdenkd4ca31c2004-01-02 14:00:00 +00003138 There are common interrupt_init() and timer_interrupt()
3139 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003140 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003141 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003142 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003143 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003144 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003145 specific handling. If board has watchdog / status_led
3146 / other_activity_monitor it works automatically from
3147 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003148
wdenkc6097192002-11-03 00:24:07 +00003149- General:
3150
wdenk43d96162003-03-06 00:02:04 +00003151 In the target system modem support is enabled when a
3152 specific key (key combination) is pressed during
3153 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003154 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003155 board_init(). Currently key_pressed() is a dummy
3156 function, returning 1 and thus enabling modem
3157 initialization.
wdenkc6097192002-11-03 00:24:07 +00003158
wdenk43d96162003-03-06 00:02:04 +00003159 If there are no modem init strings in the
3160 environment, U-Boot proceed to autoboot; the
3161 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003162 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003163
3164 See also: doc/README.Modem
3165
Helmut Raiger9660e442011-10-20 04:19:47 +00003166Board initialization settings:
3167------------------------------
3168
3169During Initialization u-boot calls a number of board specific functions
3170to allow the preparation of board specific prerequisites, e.g. pin setup
3171before drivers are initialized. To enable these callbacks the
3172following configuration macros have to be defined. Currently this is
3173architecture specific, so please check arch/your_architecture/lib/board.c
3174typically in board_init_f() and board_init_r().
3175
3176- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3177- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3178- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3179- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003180
wdenkc6097192002-11-03 00:24:07 +00003181Configuration Settings:
3182-----------------------
3183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003184- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003185 undefine this when you're short of memory.
3186
Peter Tyser2fb26042009-01-27 18:03:12 -06003187- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3188 width of the commands listed in the 'help' command output.
3189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003190- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003191 prompt for user input.
3192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003193- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003195- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003197- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003199- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003200 the application (usually a Linux kernel) when it is
3201 booted
3202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003203- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003204 List of legal baudrate settings for this board.
3205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003206- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003207 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003208
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003209- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003210 If the board specific function
3211 extern int overwrite_console (void);
3212 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003213 serial port, else the settings in the environment are used.
3214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003215- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003216 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003218- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003219 Enable overwrite of previous console environment settings.
3220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003221- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003222 Begin and End addresses of the area used by the
3223 simple memory test.
3224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003225- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003226 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003228- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003229 Scratch address used by the alternate memory test
3230 You only need to set this if address zero isn't writeable
3231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003232- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3233 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003234 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003235 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003236 fixing up gd->ram_size the Linux kernel should gets passed
3237 the now "corrected" memory size and won't touch it either.
3238 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003239 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003240 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003241 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003242
3243 This option can be used as a workaround for the 440EPx/GRx
3244 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3245 be touched.
3246
3247 WARNING: Please make sure that this value is a multiple of
3248 the Linux page size (normally 4k). If this is not the case,
3249 then the end address of the Linux memory will be located at a
3250 non page size aligned address and this could cause major
3251 problems.
3252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003253- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003254 Enable temporary baudrate change while serial download
3255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003256- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003257 Physical start address of SDRAM. _Must_ be 0 here.
3258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003260 Physical start address of Motherboard I/O (if using a
3261 Cogent motherboard)
3262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003264 Physical start address of Flash memory.
3265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003266- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003267 Physical start address of boot monitor code (set by
3268 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003269 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003270 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003272- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003273 Size of memory reserved for monitor code, used to
3274 determine _at_compile_time_ (!) if the environment is
3275 embedded within the U-Boot image, or in a separate
3276 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003279 Size of DRAM reserved for malloc() use.
3280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003281- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003282 Normally compressed uImages are limited to an
3283 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003284 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003285 to adjust this setting to your needs.
3286
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003287- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003288 Maximum size of memory mapped by the startup code of
3289 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003290 the Linux kernel (bd_info, boot arguments, FDT blob if
3291 used) must be put below this limit, unless "bootm_low"
3292 enviroment variable is defined and non-zero. In such case
3293 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003294 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003295 variable "bootm_mapsize" will override the value of
3296 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3297 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003298
John Rigbyfca43cc2010-10-13 13:57:35 -06003299- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3300 Enable initrd_high functionality. If defined then the
3301 initrd_high feature is enabled and the bootm ramdisk subcommand
3302 is enabled.
3303
3304- CONFIG_SYS_BOOT_GET_CMDLINE:
3305 Enables allocating and saving kernel cmdline in space between
3306 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3307
3308- CONFIG_SYS_BOOT_GET_KBD:
3309 Enables allocating and saving a kernel copy of the bd_info in
3310 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003312- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003313 Max number of Flash memory banks
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003316 Max number of sectors on a Flash chip
3317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003318- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003319 Timeout for Flash erase operations (in ms)
3320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003321- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003322 Timeout for Flash write operations (in ms)
3323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003324- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003325 Timeout for Flash set sector lock bit operation (in ms)
3326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003327- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003328 Timeout for Flash clear lock bits operation (in ms)
3329
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003330- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003331 If defined, hardware flash sectors protection is used
3332 instead of U-Boot software protection.
3333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003334- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003335
3336 Enable TFTP transfers directly to flash memory;
3337 without this option such a download has to be
3338 performed in two steps: (1) download to RAM, and (2)
3339 copy from RAM to flash.
3340
3341 The two-step approach is usually more reliable, since
3342 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003343 the flash, but in some situations (when system RAM is
3344 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003345 downloaded image) this option may be very useful.
3346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003347- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003348 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003349 common flash structure for storing flash geometry.
3350
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003351- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003352 This option also enables the building of the cfi_flash driver
3353 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003354
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003355- CONFIG_FLASH_CFI_MTD
3356 This option enables the building of the cfi_mtd driver
3357 in the drivers directory. The driver exports CFI flash
3358 to the MTD layer.
3359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003360- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003361 Use buffered writes to flash.
3362
3363- CONFIG_FLASH_SPANSION_S29WS_N
3364 s29ws-n MirrorBit flash has non-standard addresses for buffered
3365 write commands.
3366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003367- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003368 If this option is defined, the common CFI flash doesn't
3369 print it's warning upon not recognized FLASH banks. This
3370 is useful, if some of the configured banks are only
3371 optionally available.
3372
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003373- CONFIG_FLASH_SHOW_PROGRESS
3374 If defined (must be an integer), print out countdown
3375 digits and dots. Recommended value: 45 (9..1) for 80
3376 column displays, 15 (3..1) for 40 column displays.
3377
Stefan Roese352ef3f2013-04-04 15:53:14 +02003378- CONFIG_FLASH_VERIFY
3379 If defined, the content of the flash (destination) is compared
3380 against the source after the write operation. An error message
3381 will be printed when the contents are not identical.
3382 Please note that this option is useless in nearly all cases,
3383 since such flash programming errors usually are detected earlier
3384 while unprotecting/erasing/programming. Please only enable
3385 this option if you really know what you are doing.
3386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003387- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003388 Defines the number of Ethernet receive buffers. On some
3389 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003390 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3391 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003392 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003393 Defaults to 4 if not defined.
3394
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003395- CONFIG_ENV_MAX_ENTRIES
3396
Wolfgang Denk071bc922010-10-27 22:48:30 +02003397 Maximum number of entries in the hash table that is used
3398 internally to store the environment settings. The default
3399 setting is supposed to be generous and should work in most
3400 cases. This setting can be used to tune behaviour; see
3401 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003402
Joe Hershberger25980902012-12-11 22:16:31 -06003403- CONFIG_ENV_FLAGS_LIST_DEFAULT
3404- CONFIG_ENV_FLAGS_LIST_STATIC
3405 Enable validation of the values given to enviroment variables when
3406 calling env set. Variables can be restricted to only decimal,
3407 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3408 the variables can also be restricted to IP address or MAC address.
3409
3410 The format of the list is:
3411 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003412 access_atribute = [a|r|o|c]
3413 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003414 entry = variable_name[:attributes]
3415 list = entry[,list]
3416
3417 The type attributes are:
3418 s - String (default)
3419 d - Decimal
3420 x - Hexadecimal
3421 b - Boolean ([1yYtT|0nNfF])
3422 i - IP address
3423 m - MAC address
3424
Joe Hershberger267541f2012-12-11 22:16:34 -06003425 The access attributes are:
3426 a - Any (default)
3427 r - Read-only
3428 o - Write-once
3429 c - Change-default
3430
Joe Hershberger25980902012-12-11 22:16:31 -06003431 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3432 Define this to a list (string) to define the ".flags"
3433 envirnoment variable in the default or embedded environment.
3434
3435 - CONFIG_ENV_FLAGS_LIST_STATIC
3436 Define this to a list (string) to define validation that
3437 should be done if an entry is not found in the ".flags"
3438 environment variable. To override a setting in the static
3439 list, simply add an entry for the same variable name to the
3440 ".flags" variable.
3441
Joe Hershberger267541f2012-12-11 22:16:34 -06003442- CONFIG_ENV_ACCESS_IGNORE_FORCE
3443 If defined, don't allow the -f switch to env set override variable
3444 access flags.
3445
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003446- CONFIG_SYS_GENERIC_BOARD
3447 This selects the architecture-generic board system instead of the
3448 architecture-specific board files. It is intended to move boards
3449 to this new framework over time. Defining this will disable the
3450 arch/foo/lib/board.c file and use common/board_f.c and
3451 common/board_r.c instead. To use this option your architecture
3452 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3453 its config.mk file). If you find problems enabling this option on
3454 your board please report the problem and send patches!
3455
Simon Glass632efa72013-03-11 07:06:48 +00003456- CONFIG_SYS_SYM_OFFSETS
3457 This is set by architectures that use offsets for link symbols
3458 instead of absolute values. So bss_start is obtained using an
3459 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3460 directly. You should not need to touch this setting.
3461
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003462- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3463 This is set by OMAP boards for the max time that reset should
3464 be asserted. See doc/README.omap-reset-time for details on how
3465 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003466
wdenkc6097192002-11-03 00:24:07 +00003467The following definitions that deal with the placement and management
3468of environment data (variable area); in general, we support the
3469following configurations:
3470
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003471- CONFIG_BUILD_ENVCRC:
3472
3473 Builds up envcrc with the target environment so that external utils
3474 may easily extract it and embed it in final U-Boot images.
3475
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003476- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003477
3478 Define this if the environment is in flash memory.
3479
3480 a) The environment occupies one whole flash sector, which is
3481 "embedded" in the text segment with the U-Boot code. This
3482 happens usually with "bottom boot sector" or "top boot
3483 sector" type flash chips, which have several smaller
3484 sectors at the start or the end. For instance, such a
3485 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3486 such a case you would place the environment in one of the
3487 4 kB sectors - with U-Boot code before and after it. With
3488 "top boot sector" type flash chips, you would put the
3489 environment in one of the last sectors, leaving a gap
3490 between U-Boot and the environment.
3491
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003492 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003493
3494 Offset of environment data (variable area) to the
3495 beginning of flash memory; for instance, with bottom boot
3496 type flash chips the second sector can be used: the offset
3497 for this sector is given here.
3498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003500
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003501 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003502
3503 This is just another way to specify the start address of
3504 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003505 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003506
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003507 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003508
3509 Size of the sector containing the environment.
3510
3511
3512 b) Sometimes flash chips have few, equal sized, BIG sectors.
3513 In such a case you don't want to spend a whole sector for
3514 the environment.
3515
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003516 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003517
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003518 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003519 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003520 of this flash sector for the environment. This saves
3521 memory for the RAM copy of the environment.
3522
3523 It may also save flash memory if you decide to use this
3524 when your environment is "embedded" within U-Boot code,
3525 since then the remainder of the flash sector could be used
3526 for U-Boot code. It should be pointed out that this is
3527 STRONGLY DISCOURAGED from a robustness point of view:
3528 updating the environment in flash makes it always
3529 necessary to erase the WHOLE sector. If something goes
3530 wrong before the contents has been restored from a copy in
3531 RAM, your target system will be dead.
3532
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003533 - CONFIG_ENV_ADDR_REDUND
3534 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003535
wdenk43d96162003-03-06 00:02:04 +00003536 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003537 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003538 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003539 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003540
3541BE CAREFUL! Any changes to the flash layout, and some changes to the
3542source code will make it necessary to adapt <board>/u-boot.lds*
3543accordingly!
3544
3545
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003546- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003547
3548 Define this if you have some non-volatile memory device
3549 (NVRAM, battery buffered SRAM) which you want to use for the
3550 environment.
3551
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003552 - CONFIG_ENV_ADDR:
3553 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003554
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003555 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003556 want to use for environment. It is assumed that this memory
3557 can just be read and written to, without any special
3558 provision.
3559
3560BE CAREFUL! The first access to the environment happens quite early
3561in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003562console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003563U-Boot will hang.
3564
3565Please note that even with NVRAM we still use a copy of the
3566environment in RAM: we could work on NVRAM directly, but we want to
3567keep settings there always unmodified except somebody uses "saveenv"
3568to save the current settings.
3569
3570
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003571- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003572
3573 Use this if you have an EEPROM or similar serial access
3574 device and a driver for it.
3575
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003576 - CONFIG_ENV_OFFSET:
3577 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003578
3579 These two #defines specify the offset and size of the
3580 environment area within the total memory of your EEPROM.
3581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003582 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003583 If defined, specified the chip address of the EEPROM device.
3584 The default address is zero.
3585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003586 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003587 If defined, the number of bits used to address bytes in a
3588 single page in the EEPROM device. A 64 byte page, for example
3589 would require six bits.
3590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003591 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003592 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003593 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003594
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003595 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003596 The length in bytes of the EEPROM memory array address. Note
3597 that this is NOT the chip address length!
3598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003599 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003600 EEPROM chips that implement "address overflow" are ones
3601 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3602 address and the extra bits end up in the "chip address" bit
3603 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3604 byte chips.
3605
3606 Note that we consider the length of the address field to
3607 still be one byte because the extra address bits are hidden
3608 in the chip address.
3609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003610 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003611 The size in bytes of the EEPROM device.
3612
Heiko Schocher548738b2010-01-07 08:55:40 +01003613 - CONFIG_ENV_EEPROM_IS_ON_I2C
3614 define this, if you have I2C and SPI activated, and your
3615 EEPROM, which holds the environment, is on the I2C bus.
3616
3617 - CONFIG_I2C_ENV_EEPROM_BUS
3618 if you have an Environment on an EEPROM reached over
3619 I2C muxes, you can define here, how to reach this
3620 EEPROM. For example:
3621
Wolfgang Denka9046b92010-06-13 17:48:15 +02003622 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003623
3624 EEPROM which holds the environment, is reached over
3625 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003626
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003627- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003628
wdenkd4ca31c2004-01-02 14:00:00 +00003629 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003630 want to use for the environment.
3631
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003632 - CONFIG_ENV_OFFSET:
3633 - CONFIG_ENV_ADDR:
3634 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003635
3636 These three #defines specify the offset and size of the
3637 environment area within the total memory of your DataFlash placed
3638 at the specified address.
3639
Liu Gang0a85a9e2012-03-08 00:33:20 +00003640- CONFIG_ENV_IS_IN_REMOTE:
3641
3642 Define this if you have a remote memory space which you
3643 want to use for the local device's environment.
3644
3645 - CONFIG_ENV_ADDR:
3646 - CONFIG_ENV_SIZE:
3647
3648 These two #defines specify the address and size of the
3649 environment area within the remote memory space. The
3650 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003651 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003652
3653BE CAREFUL! For some special cases, the local device can not use
3654"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003655environment stored in a remote NOR flash by SRIO or PCIE link,
3656but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003657
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003658- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003659
3660 Define this if you have a NAND device which you want to use
3661 for the environment.
3662
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003663 - CONFIG_ENV_OFFSET:
3664 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003665
3666 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003667 area within the first NAND device. CONFIG_ENV_OFFSET must be
3668 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003669
Scott Woodfdd813d2010-09-17 14:38:37 -05003670 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003671
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003672 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003673 size used to hold a redundant copy of the environment data, so
3674 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003675 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003676 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003677
Scott Woodfdd813d2010-09-17 14:38:37 -05003678 - CONFIG_ENV_RANGE (optional):
3679
3680 Specifies the length of the region in which the environment
3681 can be written. This should be a multiple of the NAND device's
3682 block size. Specifying a range with more erase blocks than
3683 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3684 the range to be avoided.
3685
3686 - CONFIG_ENV_OFFSET_OOB (optional):
3687
3688 Enables support for dynamically retrieving the offset of the
3689 environment from block zero's out-of-band data. The
3690 "nand env.oob" command can be used to record this offset.
3691 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3692 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003693
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003694- CONFIG_NAND_ENV_DST
3695
3696 Defines address in RAM to which the nand_spl code should copy the
3697 environment. If redundant environment is used, it will be copied to
3698 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3699
Joe Hershberger2b744332013-04-08 10:32:51 +00003700- CONFIG_ENV_IS_IN_UBI:
3701
3702 Define this if you have an UBI volume that you want to use for the
3703 environment. This has the benefit of wear-leveling the environment
3704 accesses, which is important on NAND.
3705
3706 - CONFIG_ENV_UBI_PART:
3707
3708 Define this to a string that is the mtd partition containing the UBI.
3709
3710 - CONFIG_ENV_UBI_VOLUME:
3711
3712 Define this to the name of the volume that you want to store the
3713 environment in.
3714
Joe Hershberger785881f2013-04-08 10:32:52 +00003715 - CONFIG_ENV_UBI_VOLUME_REDUND:
3716
3717 Define this to the name of another volume to store a second copy of
3718 the environment in. This will enable redundant environments in UBI.
3719 It is assumed that both volumes are in the same MTD partition.
3720
Joe Hershberger2b744332013-04-08 10:32:51 +00003721 - CONFIG_UBI_SILENCE_MSG
3722 - CONFIG_UBIFS_SILENCE_MSG
3723
3724 You will probably want to define these to avoid a really noisy system
3725 when storing the env in UBI.
3726
Stephen Warren06e4ae52013-06-11 15:14:00 -06003727- CONFIG_ENV_IS_IN_MMC:
3728
3729 Define this if you have an MMC device which you want to use for the
3730 environment.
3731
3732 - CONFIG_SYS_MMC_ENV_DEV:
3733
3734 Specifies which MMC device the environment is stored in.
3735
3736 - CONFIG_SYS_MMC_ENV_PART (optional):
3737
3738 Specifies which MMC partition the environment is stored in. If not
3739 set, defaults to partition 0, the user area. Common values might be
3740 1 (first MMC boot partition), 2 (second MMC boot partition).
3741
3742 - CONFIG_ENV_OFFSET:
3743 - CONFIG_ENV_SIZE:
3744
3745 These two #defines specify the offset and size of the environment
3746 area within the specified MMC device.
3747
Stephen Warren5c088ee2013-06-11 15:14:02 -06003748 If offset is positive (the usual case), it is treated as relative to
3749 the start of the MMC partition. If offset is negative, it is treated
3750 as relative to the end of the MMC partition. This can be useful if
3751 your board may be fitted with different MMC devices, which have
3752 different sizes for the MMC partitions, and you always want the
3753 environment placed at the very end of the partition, to leave the
3754 maximum possible space before it, to store other data.
3755
Stephen Warren06e4ae52013-06-11 15:14:00 -06003756 These two values are in units of bytes, but must be aligned to an
3757 MMC sector boundary.
3758
3759 - CONFIG_ENV_OFFSET_REDUND (optional):
3760
3761 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3762 hold a redundant copy of the environment data. This provides a
3763 valid backup copy in case the other copy is corrupted, e.g. due
3764 to a power failure during a "saveenv" operation.
3765
Stephen Warren5c088ee2013-06-11 15:14:02 -06003766 This value may also be positive or negative; this is handled in the
3767 same way as CONFIG_ENV_OFFSET.
3768
Stephen Warren06e4ae52013-06-11 15:14:00 -06003769 This value is also in units of bytes, but must also be aligned to
3770 an MMC sector boundary.
3771
3772 - CONFIG_ENV_SIZE_REDUND (optional):
3773
3774 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3775 set. If this value is set, it must be set to the same value as
3776 CONFIG_ENV_SIZE.
3777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003778- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003779
3780 Defines offset to the initial SPI buffer area in DPRAM. The
3781 area is used at an early stage (ROM part) if the environment
3782 is configured to reside in the SPI EEPROM: We need a 520 byte
3783 scratch DPRAM area. It is used between the two initialization
3784 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3785 to be a good choice since it makes it far enough from the
3786 start of the data area as well as from the stack pointer.
3787
Bruce Adlere881cb52007-11-02 13:15:42 -07003788Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003789has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003790created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003791until then to read environment variables.
3792
wdenk85ec0bc2003-03-31 16:34:49 +00003793The environment is protected by a CRC32 checksum. Before the monitor
3794is relocated into RAM, as a result of a bad CRC you will be working
3795with the compiled-in default environment - *silently*!!! [This is
3796necessary, because the first environment variable we need is the
3797"baudrate" setting for the console - if we have a bad CRC, we don't
3798have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003799
3800Note: once the monitor has been relocated, then it will complain if
3801the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003802use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003804- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003805 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003807 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003808 also needs to be defined.
3809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003811 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003812
Ron Madridf5675aa2009-02-18 14:30:44 -08003813- CONFIG_NS16550_MIN_FUNCTIONS:
3814 Define this if you desire to only have use of the NS16550_init
3815 and NS16550_putc functions for the serial driver located at
3816 drivers/serial/ns16550.c. This option is useful for saving
3817 space for already greatly restricted images, including but not
3818 limited to NAND_SPL configurations.
3819
Simon Glassb2b92f52012-11-30 13:01:18 +00003820- CONFIG_DISPLAY_BOARDINFO
3821 Display information about the board that U-Boot is running on
3822 when U-Boot starts up. The board function checkboard() is called
3823 to do this.
3824
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003825- CONFIG_DISPLAY_BOARDINFO_LATE
3826 Similar to the previous option, but display this information
3827 later, once stdio is running and output goes to the LCD, if
3828 present.
3829
wdenkc6097192002-11-03 00:24:07 +00003830Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003831---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003833- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003834 Cache Line Size of the CPU.
3835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003836- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003837 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003838
wdenk42d1f032003-10-15 23:53:47 +00003839 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3840 and RPXsuper) to be able to adjust the position of
3841 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003842
Timur Tabie46fedf2011-08-04 18:03:41 -05003843- CONFIG_SYS_CCSRBAR_DEFAULT:
3844 Default (power-on reset) physical address of CCSR on Freescale
3845 PowerPC SOCs.
3846
3847- CONFIG_SYS_CCSRBAR:
3848 Virtual address of CCSR. On a 32-bit build, this is typically
3849 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3850
3851 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3852 for cross-platform code that uses that macro instead.
3853
3854- CONFIG_SYS_CCSRBAR_PHYS:
3855 Physical address of CCSR. CCSR can be relocated to a new
3856 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003857 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003858 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3859 is typically relocated on 36-bit builds. It is recommended
3860 that this macro be defined via the _HIGH and _LOW macros:
3861
3862 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3863 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3864
3865- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003866 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3867 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003868 used in assembly code, so it must not contain typecasts or
3869 integer size suffixes (e.g. "ULL").
3870
3871- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3872 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3873 used in assembly code, so it must not contain typecasts or
3874 integer size suffixes (e.g. "ULL").
3875
3876- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3877 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3878 forced to a value that ensures that CCSR is not relocated.
3879
wdenk7f6c2cb2002-11-10 22:06:23 +00003880- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003881 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003882
3883 the default drive number (default value 0)
3884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003885 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003886
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003887 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003888 (default value 1)
3889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003890 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003891
wdenk43d96162003-03-06 00:02:04 +00003892 defines the offset of register from address. It
3893 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003894 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003896 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3897 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003898 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003900 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003901 fdc_hw_init() is called at the beginning of the FDC
3902 setup. fdc_hw_init() must be provided by the board
3903 source code. It is used to make hardware dependant
3904 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003905
Macpaul Lin0abddf82011-04-11 20:45:32 +00003906- CONFIG_IDE_AHB:
3907 Most IDE controllers were designed to be connected with PCI
3908 interface. Only few of them were designed for AHB interface.
3909 When software is doing ATA command and data transfer to
3910 IDE devices through IDE-AHB controller, some additional
3911 registers accessing to these kind of IDE-AHB controller
3912 is requierd.
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003915 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003916 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003918- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk7152b1d2003-09-05 23:19:14 +00003920 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003921 initial data and stack; please note that this must be
3922 writable memory that is working WITHOUT special
3923 initialization, i. e. you CANNOT use normal RAM which
3924 will become available only after programming the
3925 memory controller and running certain initialization
3926 sequences.
3927
3928 U-Boot uses the following memory types:
3929 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3930 - MPC824X: data cache
3931 - PPC4xx: data cache
3932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003933- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003934
3935 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3937 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003938 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003939 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003940 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3941 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3942 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003943
3944 Note:
3945 On the MPC824X (or other systems that use the data
3946 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003947 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003948 point to an otherwise UNUSED address space between
3949 the top of RAM and the start of the PCI space.
3950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003951- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003953- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003954
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003955- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003956
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003957- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003959- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003960
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003961- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003963- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003964 SDRAM timing
3965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003966- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003967 periodic timer for refresh
3968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003969- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003971- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3972 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3973 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3974 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003975 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3976
3977- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003978 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3979 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003980 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003982- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3983 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003984 Machine Mode Register and Memory Periodic Timer
3985 Prescaler definitions (SDRAM timing)
3986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003987- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003988 enable I2C microcode relocation patch (MPC8xx);
3989 define relocation offset in DPRAM [DSP2]
3990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003991- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003992 enable SMC microcode relocation patch (MPC8xx);
3993 define relocation offset in DPRAM [SMC1]
3994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003995- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003996 enable SPI microcode relocation patch (MPC8xx);
3997 define relocation offset in DPRAM [SCC4]
3998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003999- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004000 Use OSCM clock mode on MBX8xx board. Be careful,
4001 wrong setting might damage your board. Read
4002 doc/README.MBX before setting this variable!
4003
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004004- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004005 Offset of the bootmode word in DPRAM used by post
4006 (Power On Self Tests). This definition overrides
4007 #define'd default value in commproc.h resp.
4008 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004010- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4011 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4012 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4013 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4014 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4015 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4016 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4017 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004018 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004019
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004020- CONFIG_PCI_DISABLE_PCIE:
4021 Disable PCI-Express on systems where it is supported but not
4022 required.
4023
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004024- CONFIG_PCI_ENUM_ONLY
4025 Only scan through and get the devices on the busses.
4026 Don't do any setup work, presumably because someone or
4027 something has already done it, and we don't need to do it
4028 a second time. Useful for platforms that are pre-booted
4029 by coreboot or similar.
4030
Gabor Juhos842033e2013-05-30 07:06:12 +00004031- CONFIG_PCI_INDIRECT_BRIDGE:
4032 Enable support for indirect PCI bridges.
4033
Kumar Galaa09b9b62010-12-30 12:09:53 -06004034- CONFIG_SYS_SRIO:
4035 Chip has SRIO or not
4036
4037- CONFIG_SRIO1:
4038 Board has SRIO 1 port available
4039
4040- CONFIG_SRIO2:
4041 Board has SRIO 2 port available
4042
Liu Gangc8b28152013-05-07 16:30:46 +08004043- CONFIG_SRIO_PCIE_BOOT_MASTER
4044 Board can support master function for Boot from SRIO and PCIE
4045
Kumar Galaa09b9b62010-12-30 12:09:53 -06004046- CONFIG_SYS_SRIOn_MEM_VIRT:
4047 Virtual Address of SRIO port 'n' memory region
4048
4049- CONFIG_SYS_SRIOn_MEM_PHYS:
4050 Physical Address of SRIO port 'n' memory region
4051
4052- CONFIG_SYS_SRIOn_MEM_SIZE:
4053 Size of SRIO port 'n' memory region
4054
Fabio Estevam66bd1842013-04-11 09:35:34 +00004055- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4056 Defined to tell the NAND controller that the NAND chip is using
4057 a 16 bit bus.
4058 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004059 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004060 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004061 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004062
4063- CONFIG_SYS_NDFC_EBC0_CFG
4064 Sets the EBC0_CFG register for the NDFC. If not defined
4065 a default value will be used.
4066
Ben Warrenbb99ad62006-09-07 16:50:54 -04004067- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004068 Get DDR timing information from an I2C EEPROM. Common
4069 with pluggable memory modules such as SODIMMs
4070
Ben Warrenbb99ad62006-09-07 16:50:54 -04004071 SPD_EEPROM_ADDRESS
4072 I2C address of the SPD EEPROM
4073
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004074- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004075 If SPD EEPROM is on an I2C bus other than the first
4076 one, specify here. Note that the value must resolve
4077 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004078
York Sun1b3e3c42011-06-07 09:42:16 +08004079- CONFIG_SYS_DDR_RAW_TIMING
4080 Get DDR timing information from other than SPD. Common with
4081 soldered DDR chips onboard without SPD. DDR raw timing
4082 parameters are extracted from datasheet and hard-coded into
4083 header files or board specific files.
4084
York Sun6f5e1dc2011-09-16 13:21:35 -07004085- CONFIG_FSL_DDR_INTERACTIVE
4086 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004088- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004089 Only for 83xx systems. If specified, then DDR should
4090 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004091
wdenkc26e4542004-04-18 10:13:26 +00004092- CONFIG_ETHER_ON_FEC[12]
4093 Define to enable FEC[12] on a 8xx series processor.
4094
4095- CONFIG_FEC[12]_PHY
4096 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004097 to the given FEC; i. e.
4098 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004099 means that the PHY with address 4 is connected to FEC1
4100
4101 When set to -1, means to probe for first available.
4102
4103- CONFIG_FEC[12]_PHY_NORXERR
4104 The PHY does not have a RXERR line (RMII only).
4105 (so program the FEC to ignore it).
4106
4107- CONFIG_RMII
4108 Enable RMII mode for all FECs.
4109 Note that this is a global option, we can't
4110 have one FEC in standard MII mode and another in RMII mode.
4111
wdenk5cf91d62004-04-23 20:32:05 +00004112- CONFIG_CRC32_VERIFY
4113 Add a verify option to the crc32 command.
4114 The syntax is:
4115
4116 => crc32 -v <address> <count> <crc32>
4117
4118 Where address/count indicate a memory area
4119 and crc32 is the correct crc32 which the
4120 area should have.
4121
wdenk56523f12004-07-11 17:40:54 +00004122- CONFIG_LOOPW
4123 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004124 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004125
stroese7b466642004-12-16 18:46:55 +00004126- CONFIG_MX_CYCLIC
4127 Add the "mdc" and "mwc" memory commands. These are cyclic
4128 "md/mw" commands.
4129 Examples:
4130
wdenkefe2a4d2004-12-16 21:44:03 +00004131 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004132 This command will print 4 bytes (10,11,12,13) each 500 ms.
4133
wdenkefe2a4d2004-12-16 21:44:03 +00004134 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004135 This command will write 12345678 to address 100 all 10 ms.
4136
wdenkefe2a4d2004-12-16 21:44:03 +00004137 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004138 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004139
wdenk8aa1a2d2005-04-04 12:44:11 +00004140- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004141 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004142 low level initializations (like setting up the memory
4143 controller) are omitted and/or U-Boot does not
4144 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004145
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004146 Normally this variable MUST NOT be defined. The only
4147 exception is when U-Boot is loaded (to RAM) by some
4148 other boot loader or by a debugger which performs
4149 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004150
Aneesh V401bb302011-07-13 05:11:07 +00004151- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004152 Modifies the behaviour of start.S when compiling a loader
4153 that is executed before the actual U-Boot. E.g. when
4154 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004155
Ying Zhang5df572f2013-05-20 14:07:23 +08004156- CONFIG_SYS_MPC85XX_NO_RESETVEC
4157 Only for 85xx systems. If this variable is specified, the section
4158 .resetvec is not kept and the section .bootpg is placed in the
4159 previous 4k of the .text section.
4160
Simon Glass4213fc22013-02-24 17:33:14 +00004161- CONFIG_ARCH_MAP_SYSMEM
4162 Generally U-Boot (and in particular the md command) uses
4163 effective address. It is therefore not necessary to regard
4164 U-Boot address as virtual addresses that need to be translated
4165 to physical addresses. However, sandbox requires this, since
4166 it maintains its own little RAM buffer which contains all
4167 addressable memory. This option causes some memory accesses
4168 to be mapped through map_sysmem() / unmap_sysmem().
4169
Matthias Weisserd8834a12011-03-10 21:36:32 +00004170- CONFIG_USE_ARCH_MEMCPY
4171 CONFIG_USE_ARCH_MEMSET
4172 If these options are used a optimized version of memcpy/memset will
4173 be used if available. These functions may be faster under some
4174 conditions but may increase the binary size.
4175
Simon Glass588a13f2013-02-14 04:18:54 +00004176- CONFIG_X86_RESET_VECTOR
4177 If defined, the x86 reset vector code is included. This is not
4178 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004179
Mark Jacksonfc337052013-03-04 01:27:20 +00004180- CONFIG_SYS_MPUCLK
4181 Defines the MPU clock speed (in MHz).
4182
4183 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004184
Timur Tabif2717b42011-11-22 09:21:25 -06004185Freescale QE/FMAN Firmware Support:
4186-----------------------------------
4187
4188The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4189loading of "firmware", which is encoded in the QE firmware binary format.
4190This firmware often needs to be loaded during U-Boot booting, so macros
4191are used to identify the storage device (NOR flash, SPI, etc) and the address
4192within that device.
4193
4194- CONFIG_SYS_QE_FMAN_FW_ADDR
4195 The address in the storage device where the firmware is located. The
4196 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4197 is also specified.
4198
4199- CONFIG_SYS_QE_FMAN_FW_LENGTH
4200 The maximum possible size of the firmware. The firmware binary format
4201 has a field that specifies the actual size of the firmware, but it
4202 might not be possible to read any part of the firmware unless some
4203 local storage is allocated to hold the entire firmware first.
4204
4205- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4206 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4207 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4208 virtual address in NOR flash.
4209
4210- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4211 Specifies that QE/FMAN firmware is located in NAND flash.
4212 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4213
4214- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4215 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4216 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4217
4218- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4219 Specifies that QE/FMAN firmware is located on the primary SPI
4220 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4221
Liu Gang292dc6c2012-03-08 00:33:18 +00004222- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4223 Specifies that QE/FMAN firmware is located in the remote (master)
4224 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004225 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4226 window->master inbound window->master LAW->the ucode address in
4227 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004228
wdenkc6097192002-11-03 00:24:07 +00004229Building the Software:
4230======================
4231
Wolfgang Denk218ca722008-03-26 10:40:12 +01004232Building U-Boot has been tested in several native build environments
4233and in many different cross environments. Of course we cannot support
4234all possibly existing versions of cross development tools in all
4235(potentially obsolete) versions. In case of tool chain problems we
4236recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4237which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004238
Wolfgang Denk218ca722008-03-26 10:40:12 +01004239If you are not using a native environment, it is assumed that you
4240have GNU cross compiling tools available in your path. In this case,
4241you must set the environment variable CROSS_COMPILE in your shell.
4242Note that no changes to the Makefile or any other source files are
4243necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004244
Wolfgang Denk218ca722008-03-26 10:40:12 +01004245 $ CROSS_COMPILE=ppc_4xx-
4246 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004247
Peter Tyser2f8d3962009-03-13 18:54:51 -05004248Note: If you wish to generate Windows versions of the utilities in
4249 the tools directory you can use the MinGW toolchain
4250 (http://www.mingw.org). Set your HOST tools to the MinGW
4251 toolchain and execute 'make tools'. For example:
4252
4253 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4254
4255 Binaries such as tools/mkimage.exe will be created which can
4256 be executed on computers running Windows.
4257
Wolfgang Denk218ca722008-03-26 10:40:12 +01004258U-Boot is intended to be simple to build. After installing the
4259sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004260is done by typing:
4261
4262 make NAME_config
4263
Wolfgang Denk218ca722008-03-26 10:40:12 +01004264where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004265rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267Note: for some board special configuration names may exist; check if
4268 additional information is available from the board vendor; for
4269 instance, the TQM823L systems are available without (standard)
4270 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004271 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273 make TQM823L_config
4274 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276 make TQM823L_LCD_config
4277 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 etc.
wdenkc6097192002-11-03 00:24:07 +00004280
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk2729af92004-05-03 20:45:30 +00004282Finally, type "make all", and you should get some working U-Boot
4283images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004284
wdenk2729af92004-05-03 20:45:30 +00004285- "u-boot.bin" is a raw binary image
4286- "u-boot" is an image in ELF binary format
4287- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004288
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004289By default the build is performed locally and the objects are saved
4290in the source directory. One of the two methods can be used to change
4291this behavior and build U-Boot to some external directory:
4292
42931. Add O= to the make command line invocations:
4294
4295 make O=/tmp/build distclean
4296 make O=/tmp/build NAME_config
4297 make O=/tmp/build all
4298
42992. Set environment variable BUILD_DIR to point to the desired location:
4300
4301 export BUILD_DIR=/tmp/build
4302 make distclean
4303 make NAME_config
4304 make all
4305
4306Note that the command line "O=" setting overrides the BUILD_DIR environment
4307variable.
4308
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk2729af92004-05-03 20:45:30 +00004310Please be aware that the Makefiles assume you are using GNU make, so
4311for instance on NetBSD you might need to use "gmake" instead of
4312native "make".
wdenkc6097192002-11-03 00:24:07 +00004313
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315If the system board that you have is not listed, then you will need
4316to port U-Boot to your hardware platform. To do this, follow these
4317steps:
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +000043191. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004320 "boards.cfg" file, using the existing entries as examples.
4321 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000043222. Create a new directory to hold your board specific code. Add any
4323 files you need. In your board directory, you will need at least
4324 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
43253. Create a new configuration file "include/configs/<board>.h" for
4326 your board
43273. If you're porting U-Boot to a new CPU, then also create a new
4328 directory to hold your CPU specific code. Add any files you need.
43294. Run "make <board>_config" with your new name.
43305. Type "make", and you should get a working "u-boot.srec" file
4331 to be installed on your target system.
43326. Debug and solve any problems that might arise.
4333 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004334
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk2729af92004-05-03 20:45:30 +00004336Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4337==============================================================
wdenkc6097192002-11-03 00:24:07 +00004338
Wolfgang Denk218ca722008-03-26 10:40:12 +01004339If you have modified U-Boot sources (for instance added a new board
4340or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004341provide feedback to the other developers. The feedback normally takes
4342the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004343official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004344
Wolfgang Denk218ca722008-03-26 10:40:12 +01004345But before you submit such a patch, please verify that your modifi-
4346cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004347the supported boards compile WITHOUT ANY compiler warnings. To do so,
4348just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004349for ALL supported system. Be warned, this will take a while. You can
4350select which (cross) compiler to use by passing a `CROSS_COMPILE'
4351environment variable to the script, i. e. to use the ELDK cross tools
4352you can type
wdenkc6097192002-11-03 00:24:07 +00004353
wdenk2729af92004-05-03 20:45:30 +00004354 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004359
Wolfgang Denk218ca722008-03-26 10:40:12 +01004360When using the MAKEALL script, the default behaviour is to build
4361U-Boot in the source directory. This location can be changed by
4362setting the BUILD_DIR environment variable. Also, for each target
4363built, the MAKEALL script saves two log files (<target>.ERR and
4364<target>.MAKEALL) in the <source dir>/LOG directory. This default
4365location can be changed by setting the MAKEALL_LOGDIR environment
4366variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004367
4368 export BUILD_DIR=/tmp/build
4369 export MAKEALL_LOGDIR=/tmp/log
4370 CROSS_COMPILE=ppc_8xx- MAKEALL
4371
Wolfgang Denk218ca722008-03-26 10:40:12 +01004372With the above settings build objects are saved in the /tmp/build,
4373log files are saved in the /tmp/log and the source tree remains clean
4374during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004375
4376
wdenk2729af92004-05-03 20:45:30 +00004377See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004378
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk2729af92004-05-03 20:45:30 +00004380Monitor Commands - Overview:
4381============================
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383go - start application at address 'addr'
4384run - run commands in an environment variable
4385bootm - boot application image from memory
4386bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004387bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004388tftpboot- boot image via network using TFTP protocol
4389 and env variables "ipaddr" and "serverip"
4390 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004391tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004392rarpboot- boot image via network using RARP/TFTP protocol
4393diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4394loads - load S-Record file over serial line
4395loadb - load binary file over serial line (kermit mode)
4396md - memory display
4397mm - memory modify (auto-incrementing)
4398nm - memory modify (constant address)
4399mw - memory write (fill)
4400cp - memory copy
4401cmp - memory compare
4402crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004403i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004404sspi - SPI utility commands
4405base - print or set address offset
4406printenv- print environment variables
4407setenv - set environment variables
4408saveenv - save environment variables to persistent storage
4409protect - enable or disable FLASH write protection
4410erase - erase FLASH memory
4411flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004412nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004413bdinfo - print Board Info structure
4414iminfo - print header information for application image
4415coninfo - print console devices and informations
4416ide - IDE sub-system
4417loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004418loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004419mtest - simple RAM test
4420icache - enable or disable instruction cache
4421dcache - enable or disable data cache
4422reset - Perform RESET of the CPU
4423echo - echo args to console
4424version - print monitor version
4425help - print online help
4426? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004427
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk2729af92004-05-03 20:45:30 +00004429Monitor Commands - Detailed Description:
4430========================================
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk2729af92004-05-03 20:45:30 +00004432TODO.
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk2729af92004-05-03 20:45:30 +00004434For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004435
4436
wdenk2729af92004-05-03 20:45:30 +00004437Environment Variables:
4438======================
wdenkc6097192002-11-03 00:24:07 +00004439
wdenk2729af92004-05-03 20:45:30 +00004440U-Boot supports user configuration using Environment Variables which
4441can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004442
wdenk2729af92004-05-03 20:45:30 +00004443Environment Variables are set using "setenv", printed using
4444"printenv", and saved to Flash using "saveenv". Using "setenv"
4445without a value can be used to delete a variable from the
4446environment. As long as you don't save the environment you are
4447working with an in-memory copy. In case the Flash area containing the
4448environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004449
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004450Some configuration options can be set using Environment Variables.
4451
4452List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004453
wdenk2729af92004-05-03 20:45:30 +00004454 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004455
wdenk2729af92004-05-03 20:45:30 +00004456 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk2729af92004-05-03 20:45:30 +00004458 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004463
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004464 bootm_low - Memory range available for image processing in the bootm
4465 command can be restricted. This variable is given as
4466 a hexadecimal number and defines lowest address allowed
4467 for use by the bootm command. See also "bootm_size"
4468 environment variable. Address defined by "bootm_low" is
4469 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004470 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4471 bootm_mapsize.
4472
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004473 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004474 This variable is given as a hexadecimal number and it
4475 defines the size of the memory region starting at base
4476 address bootm_low that is accessible by the Linux kernel
4477 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4478 as the default value if it is defined, and bootm_size is
4479 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004480
4481 bootm_size - Memory range available for image processing in the bootm
4482 command can be restricted. This variable is given as
4483 a hexadecimal number and defines the size of the region
4484 allowed for use by the bootm command. See also "bootm_low"
4485 environment variable.
4486
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004487 updatefile - Location of the software update file on a TFTP server, used
4488 by the automatic software update feature. Please refer to
4489 documentation in doc/README.update for more details.
4490
wdenk2729af92004-05-03 20:45:30 +00004491 autoload - if set to "no" (any string beginning with 'n'),
4492 "bootp" will just load perform a lookup of the
4493 configuration from the BOOTP server, but not try to
4494 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496 autostart - if set to "yes", an image loaded using the "bootp",
4497 "rarpboot", "tftpboot" or "diskboot" commands will
4498 be automatically started (by internally calling
4499 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk2729af92004-05-03 20:45:30 +00004501 If set to "no", a standalone image passed to the
4502 "bootm" command will be copied to the load address
4503 (and eventually uncompressed), but NOT be started.
4504 This can be used to load and uncompress arbitrary
4505 data.
wdenkc6097192002-11-03 00:24:07 +00004506
David A. Longa28afca2011-07-09 16:40:19 -04004507 fdt_high - if set this restricts the maximum address that the
4508 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004509 For example, if you have a system with 1 GB memory
4510 at physical address 0x10000000, while Linux kernel
4511 only recognizes the first 704 MB as low memory, you
4512 may need to set fdt_high as 0x3C000000 to have the
4513 device tree blob be copied to the maximum address
4514 of the 704 MB low memory, so that Linux kernel can
4515 access it during the boot procedure.
4516
David A. Longa28afca2011-07-09 16:40:19 -04004517 If this is set to the special value 0xFFFFFFFF then
4518 the fdt will not be copied at all on boot. For this
4519 to work it must reside in writable memory, have
4520 sufficient padding on the end of it for u-boot to
4521 add the information it needs into it, and the memory
4522 must be accessible by the kernel.
4523
Simon Glasseea63e02011-10-24 19:15:34 +00004524 fdtcontroladdr- if set this is the address of the control flattened
4525 device tree used by U-Boot when CONFIG_OF_CONTROL is
4526 defined.
4527
wdenk17ea1172004-06-06 21:51:03 +00004528 i2cfast - (PPC405GP|PPC405EP only)
4529 if set to 'y' configures Linux I2C driver for fast
4530 mode (400kHZ). This environment variable is used in
4531 initialization code. So, for changes to be effective
4532 it must be saved and board must be reset.
4533
wdenk2729af92004-05-03 20:45:30 +00004534 initrd_high - restrict positioning of initrd images:
4535 If this variable is not set, initrd images will be
4536 copied to the highest possible address in RAM; this
4537 is usually what you want since it allows for
4538 maximum initrd size. If for some reason you want to
4539 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004540 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004541 variable to a value of "no" or "off" or "0".
4542 Alternatively, you can set it to a maximum upper
4543 address to use (U-Boot will still check that it
4544 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk2729af92004-05-03 20:45:30 +00004546 For instance, when you have a system with 16 MB
4547 RAM, and want to reserve 4 MB from use by Linux,
4548 you can do this by adding "mem=12M" to the value of
4549 the "bootargs" variable. However, now you must make
4550 sure that the initrd image is placed in the first
4551 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk2729af92004-05-03 20:45:30 +00004553 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555 If you set initrd_high to 0xFFFFFFFF, this is an
4556 indication to U-Boot that all addresses are legal
4557 for the Linux kernel, including addresses in flash
4558 memory. In this case U-Boot will NOT COPY the
4559 ramdisk at all. This may be useful to reduce the
4560 boot time on your system, but requires that this
4561 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk2729af92004-05-03 20:45:30 +00004565 loadaddr - Default load address for commands like "bootp",
4566 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk2729af92004-05-03 20:45:30 +00004568 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk2729af92004-05-03 20:45:30 +00004570 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004571
wdenk2729af92004-05-03 20:45:30 +00004572 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk2729af92004-05-03 20:45:30 +00004576 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004577
Mike Frysingere2a53452011-10-02 10:01:27 +00004578 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004579
Mike Frysingere2a53452011-10-02 10:01:27 +00004580 ethact - controls which interface is currently active.
4581 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004582
Heiko Schocher48690d82010-07-20 17:45:02 +02004583 => setenv ethact FEC
4584 => ping 192.168.0.1 # traffic sent on FEC
4585 => setenv ethact SCC
4586 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004587
Matthias Fuchse1692572008-01-17 07:45:05 +01004588 ethrotate - When set to "no" U-Boot does not go through all
4589 available network interfaces.
4590 It just stays at the currently selected interface.
4591
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004592 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004593 either succeed or fail without retrying.
4594 When set to "once" the network operation will
4595 fail when all the available network interfaces
4596 are tried once without success.
4597 Useful on scripts which control the retry operation
4598 themselves.
wdenkc6097192002-11-03 00:24:07 +00004599
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004600 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004601
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004602 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004603 UDP source port.
4604
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004605 tftpdstport - If this is set, the value is used for TFTP's UDP
4606 destination port instead of the Well Know Port 69.
4607
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004608 tftpblocksize - Block size to use for TFTP transfers; if not set,
4609 we use the TFTP server's default block size
4610
4611 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4612 seconds, minimum value is 1000 = 1 second). Defines
4613 when a packet is considered to be lost so it has to
4614 be retransmitted. The default is 5000 = 5 seconds.
4615 Lowering this value may make downloads succeed
4616 faster in networks with high packet loss rates or
4617 with unreliable TFTP servers.
4618
4619 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004620 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004621 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004622
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004623The following image location variables contain the location of images
4624used in booting. The "Image" column gives the role of the image and is
4625not an environment variable name. The other columns are environment
4626variable names. "File Name" gives the name of the file on a TFTP
4627server, "RAM Address" gives the location in RAM the image will be
4628loaded to, and "Flash Location" gives the image's address in NOR
4629flash or offset in NAND flash.
4630
4631*Note* - these variables don't have to be defined for all boards, some
4632boards currenlty use other variables for these purposes, and some
4633boards use these variables for other purposes.
4634
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004635Image File Name RAM Address Flash Location
4636----- --------- ----------- --------------
4637u-boot u-boot u-boot_addr_r u-boot_addr
4638Linux kernel bootfile kernel_addr_r kernel_addr
4639device tree blob fdtfile fdt_addr_r fdt_addr
4640ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004641
wdenk2729af92004-05-03 20:45:30 +00004642The following environment variables may be used and automatically
4643updated by the network boot commands ("bootp" and "rarpboot"),
4644depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004645
wdenk2729af92004-05-03 20:45:30 +00004646 bootfile - see above
4647 dnsip - IP address of your Domain Name Server
4648 dnsip2 - IP address of your secondary Domain Name Server
4649 gatewayip - IP address of the Gateway (Router) to use
4650 hostname - Target hostname
4651 ipaddr - see above
4652 netmask - Subnet Mask
4653 rootpath - Pathname of the root filesystem on the NFS server
4654 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004655
wdenka3d991b2004-04-15 21:48:45 +00004656
wdenk2729af92004-05-03 20:45:30 +00004657There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk2729af92004-05-03 20:45:30 +00004659 serial# - contains hardware identification information such
4660 as type string and/or serial number
4661 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663These variables can be set only once (usually during manufacturing of
4664the board). U-Boot refuses to delete or overwrite these variables
4665once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004666
4667
wdenk2729af92004-05-03 20:45:30 +00004668Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk2729af92004-05-03 20:45:30 +00004670 ver - Contains the U-Boot version string as printed
4671 with the "version" command. This variable is
4672 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004673
wdenkc6097192002-11-03 00:24:07 +00004674
wdenk2729af92004-05-03 20:45:30 +00004675Please note that changes to some configuration parameters may take
4676only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004677
stroesec1551ea2003-04-04 15:53:41 +00004678
Joe Hershberger170ab112012-12-11 22:16:24 -06004679Callback functions for environment variables:
4680---------------------------------------------
4681
4682For some environment variables, the behavior of u-boot needs to change
4683when their values are changed. This functionailty allows functions to
4684be associated with arbitrary variables. On creation, overwrite, or
4685deletion, the callback will provide the opportunity for some side
4686effect to happen or for the change to be rejected.
4687
4688The callbacks are named and associated with a function using the
4689U_BOOT_ENV_CALLBACK macro in your board or driver code.
4690
4691These callbacks are associated with variables in one of two ways. The
4692static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4693in the board configuration to a string that defines a list of
4694associations. The list must be in the following format:
4695
4696 entry = variable_name[:callback_name]
4697 list = entry[,list]
4698
4699If the callback name is not specified, then the callback is deleted.
4700Spaces are also allowed anywhere in the list.
4701
4702Callbacks can also be associated by defining the ".callbacks" variable
4703with the same list format above. Any association in ".callbacks" will
4704override any association in the static list. You can define
4705CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4706".callbacks" envirnoment variable in the default or embedded environment.
4707
4708
wdenk2729af92004-05-03 20:45:30 +00004709Command Line Parsing:
4710=====================
stroesec1551ea2003-04-04 15:53:41 +00004711
wdenk2729af92004-05-03 20:45:30 +00004712There are two different command line parsers available with U-Boot:
4713the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004714
wdenk2729af92004-05-03 20:45:30 +00004715Old, simple command line parser:
4716--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718- supports environment variables (through setenv / saveenv commands)
4719- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004720- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004721- special characters ('$', ';') can be escaped by prefixing with '\',
4722 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004723 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004724- You can also escape text by enclosing in single apostrophes, for example:
4725 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk2729af92004-05-03 20:45:30 +00004727Hush shell:
4728-----------
wdenkf07771c2003-05-28 08:06:31 +00004729
wdenk2729af92004-05-03 20:45:30 +00004730- similar to Bourne shell, with control structures like
4731 if...then...else...fi, for...do...done; while...do...done,
4732 until...do...done, ...
4733- supports environment ("global") variables (through setenv / saveenv
4734 commands) and local shell variables (through standard shell syntax
4735 "name=value"); only environment variables can be used with "run"
4736 command
wdenkf07771c2003-05-28 08:06:31 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738General rules:
4739--------------
wdenkf07771c2003-05-28 08:06:31 +00004740
wdenk2729af92004-05-03 20:45:30 +00004741(1) If a command line (or an environment variable executed by a "run"
4742 command) contains several commands separated by semicolon, and
4743 one of these commands fails, then the remaining commands will be
4744 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004745
wdenk2729af92004-05-03 20:45:30 +00004746(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004747 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004748 command will cause "run" to terminate, i. e. the remaining
4749 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751Note for Redundant Ethernet Interfaces:
4752=======================================
wdenkf07771c2003-05-28 08:06:31 +00004753
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004754Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004755such configurations and is capable of automatic selection of a
4756"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004757
wdenk2729af92004-05-03 20:45:30 +00004758Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4759MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4760"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004761
wdenk2729af92004-05-03 20:45:30 +00004762If the network interface stores some valid MAC address (for instance
4763in SROM), this is used as default address if there is NO correspon-
4764ding setting in the environment; if the corresponding environment
4765variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767o If the SROM has a valid MAC address, and there is no address in the
4768 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk2729af92004-05-03 20:45:30 +00004770o If there is no valid address in the SROM, and a definition in the
4771 environment exists, then the value from the environment variable is
4772 used.
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774o If both the SROM and the environment contain a MAC address, and
4775 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk2729af92004-05-03 20:45:30 +00004777o If both the SROM and the environment contain a MAC address, and the
4778 addresses differ, the value from the environment is used and a
4779 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk2729af92004-05-03 20:45:30 +00004781o If neither SROM nor the environment contain a MAC address, an error
4782 is raised.
wdenkc6097192002-11-03 00:24:07 +00004783
Ben Warrenecee9322010-04-26 11:11:46 -07004784If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004785will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004786may be skipped by setting the appropriate 'ethmacskip' environment variable.
4787The naming convention is as follows:
4788"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790Image Formats:
4791==============
wdenkc6097192002-11-03 00:24:07 +00004792
Marian Balakowicz3310c542008-03-12 12:13:13 +01004793U-Boot is capable of booting (and performing other auxiliary operations on)
4794images in two formats:
4795
4796New uImage format (FIT)
4797-----------------------
4798
4799Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4800to Flattened Device Tree). It allows the use of images with multiple
4801components (several kernels, ramdisks, etc.), with contents protected by
4802SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4803
4804
4805Old uImage format
4806-----------------
4807
4808Old image format is based on binary files which can be basically anything,
4809preceded by a special header; see the definitions in include/image.h for
4810details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk2729af92004-05-03 20:45:30 +00004812* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4813 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004814 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4815 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4816 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004817* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004818 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4819 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004820* Compression Type (uncompressed, gzip, bzip2)
4821* Load Address
4822* Entry Point
4823* Image Name
4824* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826The header is marked by a special Magic Number, and both the header
4827and the data portions of the image are secured against corruption by
4828CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004829
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831Linux Support:
4832==============
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834Although U-Boot should support any OS or standalone application
4835easily, the main focus has always been on Linux during the design of
4836U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004837
wdenk2729af92004-05-03 20:45:30 +00004838U-Boot includes many features that so far have been part of some
4839special "boot loader" code within the Linux kernel. Also, any
4840"initrd" images to be used are no longer part of one big Linux image;
4841instead, kernel and "initrd" are separate images. This implementation
4842serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844- the same features can be used for other OS or standalone
4845 applications (for instance: using compressed images to reduce the
4846 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848- it becomes much easier to port new Linux kernel versions because
4849 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk2729af92004-05-03 20:45:30 +00004851- the same Linux kernel image can now be used with different "initrd"
4852 images; of course this also means that different kernel images can
4853 be run with the same "initrd". This makes testing easier (you don't
4854 have to build a new "zImage.initrd" Linux image when you just
4855 change a file in your "initrd"). Also, a field-upgrade of the
4856 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004857
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk2729af92004-05-03 20:45:30 +00004859Linux HOWTO:
4860============
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862Porting Linux to U-Boot based systems:
4863---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk2729af92004-05-03 20:45:30 +00004865U-Boot cannot save you from doing all the necessary modifications to
4866configure the Linux device drivers for use with your target hardware
4867(no, we don't intend to provide a full virtual machine interface to
4868Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004869
Stefan Roesea47a12b2010-04-15 16:07:28 +02004870But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872Just make sure your machine specific header file (for instance
4873include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004874Information structure as we define in include/asm-<arch>/u-boot.h,
4875and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004876as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004877
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk2729af92004-05-03 20:45:30 +00004879Configuring the Linux kernel:
4880-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882No specific requirements for U-Boot. Make sure you have some root
4883device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004884
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk2729af92004-05-03 20:45:30 +00004886Building a Linux Image:
4887-----------------------
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk2729af92004-05-03 20:45:30 +00004889With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4890not used. If you use recent kernel source, a new build target
4891"uImage" will exist which automatically builds an image usable by
4892U-Boot. Most older kernels also have support for a "pImage" target,
4893which was introduced for our predecessor project PPCBoot and uses a
4894100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk2729af92004-05-03 20:45:30 +00004896Example:
wdenkc6097192002-11-03 00:24:07 +00004897
wdenk2729af92004-05-03 20:45:30 +00004898 make TQM850L_config
4899 make oldconfig
4900 make dep
4901 make uImage
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk2729af92004-05-03 20:45:30 +00004903The "uImage" build target uses a special tool (in 'tools/mkimage') to
4904encapsulate a compressed Linux kernel image with header information,
4905CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk2729af92004-05-03 20:45:30 +00004907* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk2729af92004-05-03 20:45:30 +00004909* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk2729af92004-05-03 20:45:30 +00004911 ${CROSS_COMPILE}-objcopy -O binary \
4912 -R .note -R .comment \
4913 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk2729af92004-05-03 20:45:30 +00004915* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk2729af92004-05-03 20:45:30 +00004917 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk2729af92004-05-03 20:45:30 +00004919* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004920
wdenk2729af92004-05-03 20:45:30 +00004921 mkimage -A ppc -O linux -T kernel -C gzip \
4922 -a 0 -e 0 -n "Linux Kernel Image" \
4923 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004924
wdenk24ee89b2002-11-03 17:56:27 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926The "mkimage" tool can also be used to create ramdisk images for use
4927with U-Boot, either separated from the Linux kernel image, or
4928combined into one file. "mkimage" encapsulates the images with a 64
4929byte header containing information about target architecture,
4930operating system, image type, compression method, entry points, time
4931stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004932
wdenk2729af92004-05-03 20:45:30 +00004933"mkimage" can be called in two ways: to verify existing images and
4934print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936In the first form (with "-l" option) mkimage lists the information
4937contained in the header of an existing U-Boot image; this includes
4938checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004939
wdenk2729af92004-05-03 20:45:30 +00004940 tools/mkimage -l image
4941 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004942
wdenk2729af92004-05-03 20:45:30 +00004943The second form (with "-d" option) is used to build a U-Boot image
4944from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004945
wdenk2729af92004-05-03 20:45:30 +00004946 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4947 -n name -d data_file image
4948 -A ==> set architecture to 'arch'
4949 -O ==> set operating system to 'os'
4950 -T ==> set image type to 'type'
4951 -C ==> set compression type 'comp'
4952 -a ==> set load address to 'addr' (hex)
4953 -e ==> set entry point to 'ep' (hex)
4954 -n ==> set image name to 'name'
4955 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004956
wdenk69459792004-05-29 16:53:29 +00004957Right now, all Linux kernels for PowerPC systems use the same load
4958address (0x00000000), but the entry point address depends on the
4959kernel version:
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk2729af92004-05-03 20:45:30 +00004961- 2.2.x kernels have the entry point at 0x0000000C,
4962- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004963
wdenk2729af92004-05-03 20:45:30 +00004964So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk2729af92004-05-03 20:45:30 +00004966 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4967 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004968 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004969 > examples/uImage.TQM850L
4970 Image Name: 2.4.4 kernel for TQM850L
4971 Created: Wed Jul 19 02:34:59 2000
4972 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4973 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4974 Load Address: 0x00000000
4975 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk2729af92004-05-03 20:45:30 +00004977To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979 -> tools/mkimage -l examples/uImage.TQM850L
4980 Image Name: 2.4.4 kernel for TQM850L
4981 Created: Wed Jul 19 02:34:59 2000
4982 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4983 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4984 Load Address: 0x00000000
4985 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk2729af92004-05-03 20:45:30 +00004987NOTE: for embedded systems where boot time is critical you can trade
4988speed for memory and install an UNCOMPRESSED image instead: this
4989needs more space in Flash, but boots much faster since it does not
4990need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004991
Stefan Roesea47a12b2010-04-15 16:07:28 +02004992 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004993 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4994 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004995 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004996 > examples/uImage.TQM850L-uncompressed
4997 Image Name: 2.4.4 kernel for TQM850L
4998 Created: Wed Jul 19 02:34:59 2000
4999 Image Type: PowerPC Linux Kernel Image (uncompressed)
5000 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5001 Load Address: 0x00000000
5002 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005003
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5006when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008 -> tools/mkimage -n 'Simple Ramdisk Image' \
5009 > -A ppc -O linux -T ramdisk -C gzip \
5010 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5011 Image Name: Simple Ramdisk Image
5012 Created: Wed Jan 12 14:01:50 2000
5013 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5014 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5015 Load Address: 0x00000000
5016 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005017
wdenkdb01a2e2004-04-15 23:14:49 +00005018
wdenk2729af92004-05-03 20:45:30 +00005019Installing a Linux Image:
5020-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005021
wdenk2729af92004-05-03 20:45:30 +00005022To downloading a U-Boot image over the serial (console) interface,
5023you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005026
wdenk2729af92004-05-03 20:45:30 +00005027The 'objcopy' does not understand the information in the U-Boot
5028image header, so the resulting S-Record file will be relative to
5029address 0x00000000. To load it to a given address, you need to
5030specify the target address as 'offset' parameter with the 'loads'
5031command.
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033Example: install the image to address 0x40100000 (which on the
5034TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005037
wdenk2729af92004-05-03 20:45:30 +00005038 .......... done
5039 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005040
wdenk2729af92004-05-03 20:45:30 +00005041 => loads 40100000
5042 ## Ready for S-Record download ...
5043 ~>examples/image.srec
5044 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5045 ...
5046 15989 15990 15991 15992
5047 [file transfer complete]
5048 [connected]
5049 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005050
5051
wdenk2729af92004-05-03 20:45:30 +00005052You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005053this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005054corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk2729af92004-05-03 20:45:30 +00005056 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005057
wdenk2729af92004-05-03 20:45:30 +00005058 ## Checking Image at 40100000 ...
5059 Image Name: 2.2.13 for initrd on TQM850L
5060 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5061 Data Size: 335725 Bytes = 327 kB = 0 MB
5062 Load Address: 00000000
5063 Entry Point: 0000000c
5064 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005065
5066
wdenk2729af92004-05-03 20:45:30 +00005067Boot Linux:
5068-----------
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk2729af92004-05-03 20:45:30 +00005070The "bootm" command is used to boot an application that is stored in
5071memory (RAM or Flash). In case of a Linux kernel image, the contents
5072of the "bootargs" environment variable is passed to the kernel as
5073parameters. You can check and modify this variable using the
5074"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005075
5076
wdenk2729af92004-05-03 20:45:30 +00005077 => printenv bootargs
5078 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080 => 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 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082 => printenv bootargs
5083 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 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085 => bootm 40020000
5086 ## Booting Linux kernel at 40020000 ...
5087 Image Name: 2.2.13 for NFS on TQM850L
5088 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5089 Data Size: 381681 Bytes = 372 kB = 0 MB
5090 Load Address: 00000000
5091 Entry Point: 0000000c
5092 Verifying Checksum ... OK
5093 Uncompressing Kernel Image ... OK
5094 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
5095 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5096 time_init: decrementer frequency = 187500000/60
5097 Calibrating delay loop... 49.77 BogoMIPS
5098 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5099 ...
wdenkc6097192002-11-03 00:24:07 +00005100
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005101If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005102the memory addresses of both the kernel and the initrd image (PPBCOOT
5103format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005104
wdenk2729af92004-05-03 20:45:30 +00005105 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk2729af92004-05-03 20:45:30 +00005107 ## Checking Image at 40100000 ...
5108 Image Name: 2.2.13 for initrd on TQM850L
5109 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5110 Data Size: 335725 Bytes = 327 kB = 0 MB
5111 Load Address: 00000000
5112 Entry Point: 0000000c
5113 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk2729af92004-05-03 20:45:30 +00005115 ## Checking Image at 40200000 ...
5116 Image Name: Simple Ramdisk Image
5117 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5118 Data Size: 566530 Bytes = 553 kB = 0 MB
5119 Load Address: 00000000
5120 Entry Point: 00000000
5121 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123 => bootm 40100000 40200000
5124 ## Booting Linux kernel at 40100000 ...
5125 Image Name: 2.2.13 for initrd on TQM850L
5126 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5127 Data Size: 335725 Bytes = 327 kB = 0 MB
5128 Load Address: 00000000
5129 Entry Point: 0000000c
5130 Verifying Checksum ... OK
5131 Uncompressing Kernel Image ... OK
5132 ## Loading RAMDisk Image at 40200000 ...
5133 Image Name: Simple Ramdisk Image
5134 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5135 Data Size: 566530 Bytes = 553 kB = 0 MB
5136 Load Address: 00000000
5137 Entry Point: 00000000
5138 Verifying Checksum ... OK
5139 Loading Ramdisk ... OK
5140 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
5141 Boot arguments: root=/dev/ram
5142 time_init: decrementer frequency = 187500000/60
5143 Calibrating delay loop... 49.77 BogoMIPS
5144 ...
5145 RAMDISK: Compressed image found at block 0
5146 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148 bash#
wdenkc6097192002-11-03 00:24:07 +00005149
Matthew McClintock02677682006-06-28 10:41:37 -05005150Boot Linux and pass a flat device tree:
5151-----------
5152
5153First, U-Boot must be compiled with the appropriate defines. See the section
5154titled "Linux Kernel Interface" above for a more in depth explanation. The
5155following is an example of how to start a kernel and pass an updated
5156flat device tree:
5157
5158=> print oftaddr
5159oftaddr=0x300000
5160=> print oft
5161oft=oftrees/mpc8540ads.dtb
5162=> tftp $oftaddr $oft
5163Speed: 1000, full duplex
5164Using TSEC0 device
5165TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5166Filename 'oftrees/mpc8540ads.dtb'.
5167Load address: 0x300000
5168Loading: #
5169done
5170Bytes transferred = 4106 (100a hex)
5171=> tftp $loadaddr $bootfile
5172Speed: 1000, full duplex
5173Using TSEC0 device
5174TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5175Filename 'uImage'.
5176Load address: 0x200000
5177Loading:############
5178done
5179Bytes transferred = 1029407 (fb51f hex)
5180=> print loadaddr
5181loadaddr=200000
5182=> print oftaddr
5183oftaddr=0x300000
5184=> bootm $loadaddr - $oftaddr
5185## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005186 Image Name: Linux-2.6.17-dirty
5187 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5188 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005189 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005190 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005191 Verifying Checksum ... OK
5192 Uncompressing Kernel Image ... OK
5193Booting using flat device tree at 0x300000
5194Using MPC85xx ADS machine description
5195Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5196[snip]
5197
5198
wdenk2729af92004-05-03 20:45:30 +00005199More About U-Boot Image Types:
5200------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005201
wdenk2729af92004-05-03 20:45:30 +00005202U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204 "Standalone Programs" are directly runnable in the environment
5205 provided by U-Boot; it is expected that (if they behave
5206 well) you can continue to work in U-Boot after return from
5207 the Standalone Program.
5208 "OS Kernel Images" are usually images of some Embedded OS which
5209 will take over control completely. Usually these programs
5210 will install their own set of exception handlers, device
5211 drivers, set up the MMU, etc. - this means, that you cannot
5212 expect to re-enter U-Boot except by resetting the CPU.
5213 "RAMDisk Images" are more or less just data blocks, and their
5214 parameters (address, size) are passed to an OS kernel that is
5215 being started.
5216 "Multi-File Images" contain several images, typically an OS
5217 (Linux) kernel image and one or more data images like
5218 RAMDisks. This construct is useful for instance when you want
5219 to boot over the network using BOOTP etc., where the boot
5220 server provides just a single image file, but you want to get
5221 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005222
wdenk2729af92004-05-03 20:45:30 +00005223 "Multi-File Images" start with a list of image sizes, each
5224 image size (in bytes) specified by an "uint32_t" in network
5225 byte order. This list is terminated by an "(uint32_t)0".
5226 Immediately after the terminating 0 follow the images, one by
5227 one, all aligned on "uint32_t" boundaries (size rounded up to
5228 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230 "Firmware Images" are binary images containing firmware (like
5231 U-Boot or FPGA images) which usually will be programmed to
5232 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234 "Script files" are command sequences that will be executed by
5235 U-Boot's command interpreter; this feature is especially
5236 useful when you configure U-Boot to use a real shell (hush)
5237 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005238
Marek Vasut44f074c2012-03-14 21:52:45 +00005239Booting the Linux zImage:
5240-------------------------
5241
5242On some platforms, it's possible to boot Linux zImage. This is done
5243using the "bootz" command. The syntax of "bootz" command is the same
5244as the syntax of "bootm" command.
5245
Tom Rini8ac28562013-05-16 11:40:11 -04005246Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005247kernel with raw initrd images. The syntax is slightly different, the
5248address of the initrd must be augmented by it's size, in the following
5249format: "<initrd addres>:<initrd size>".
5250
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk2729af92004-05-03 20:45:30 +00005252Standalone HOWTO:
5253=================
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk2729af92004-05-03 20:45:30 +00005255One of the features of U-Boot is that you can dynamically load and
5256run "standalone" applications, which can use some resources of
5257U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk2729af92004-05-03 20:45:30 +00005259Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261"Hello World" Demo:
5262-------------------
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264'examples/hello_world.c' contains a small "Hello World" Demo
5265application; it is automatically compiled when you build U-Boot.
5266It's configured to run at address 0x00040004, so you can play with it
5267like that:
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269 => loads
5270 ## Ready for S-Record download ...
5271 ~>examples/hello_world.srec
5272 1 2 3 4 5 6 7 8 9 10 11 ...
5273 [file transfer complete]
5274 [connected]
5275 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk2729af92004-05-03 20:45:30 +00005277 => go 40004 Hello World! This is a test.
5278 ## Starting application at 0x00040004 ...
5279 Hello World
5280 argc = 7
5281 argv[0] = "40004"
5282 argv[1] = "Hello"
5283 argv[2] = "World!"
5284 argv[3] = "This"
5285 argv[4] = "is"
5286 argv[5] = "a"
5287 argv[6] = "test."
5288 argv[7] = "<NULL>"
5289 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk2729af92004-05-03 20:45:30 +00005293Another example, which demonstrates how to register a CPM interrupt
5294handler with the U-Boot code, can be found in 'examples/timer.c'.
5295Here, a CPM timer is set up to generate an interrupt every second.
5296The interrupt service routine is trivial, just printing a '.'
5297character, but this is just a demo program. The application can be
5298controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300 ? - print current values og the CPM Timer registers
5301 b - enable interrupts and start timer
5302 e - stop timer and disable interrupts
5303 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk2729af92004-05-03 20:45:30 +00005305 => loads
5306 ## Ready for S-Record download ...
5307 ~>examples/timer.srec
5308 1 2 3 4 5 6 7 8 9 10 11 ...
5309 [file transfer complete]
5310 [connected]
5311 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313 => go 40004
5314 ## Starting application at 0x00040004 ...
5315 TIMERS=0xfff00980
5316 Using timer 1
5317 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk2729af92004-05-03 20:45:30 +00005319Hit 'b':
5320 [q, b, e, ?] Set interval 1000000 us
5321 Enabling timer
5322Hit '?':
5323 [q, b, e, ?] ........
5324 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5325Hit '?':
5326 [q, b, e, ?] .
5327 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5328Hit '?':
5329 [q, b, e, ?] .
5330 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5331Hit '?':
5332 [q, b, e, ?] .
5333 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5334Hit 'e':
5335 [q, b, e, ?] ...Stopping timer
5336Hit 'q':
5337 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005338
5339
wdenk2729af92004-05-03 20:45:30 +00005340Minicom warning:
5341================
wdenk85ec0bc2003-03-31 16:34:49 +00005342
wdenk2729af92004-05-03 20:45:30 +00005343Over time, many people have reported problems when trying to use the
5344"minicom" terminal emulation program for serial download. I (wd)
5345consider minicom to be broken, and recommend not to use it. Under
5346Unix, I recommend to use C-Kermit for general purpose use (and
5347especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005348use "cu" for S-Record download ("loads" command). See
5349http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5350for help with kermit.
5351
wdenk85ec0bc2003-03-31 16:34:49 +00005352
wdenk2729af92004-05-03 20:45:30 +00005353Nevertheless, if you absolutely want to use it try adding this
5354configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005355
wdenk2729af92004-05-03 20:45:30 +00005356 Name Program Name U/D FullScr IO-Red. Multi
5357 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5358 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005359
5360
wdenk2729af92004-05-03 20:45:30 +00005361NetBSD Notes:
5362=============
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364Starting at version 0.9.2, U-Boot supports NetBSD both as host
5365(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367Building requires a cross environment; it is known to work on
5368NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5369need gmake since the Makefiles are not compatible with BSD make).
5370Note that the cross-powerpc package does not install include files;
5371attempting to build U-Boot will fail because <machine/ansi.h> is
5372missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005373
wdenk2729af92004-05-03 20:45:30 +00005374 # cd /usr/pkg/cross/powerpc-netbsd/include
5375 # mkdir powerpc
5376 # ln -s powerpc machine
5377 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5378 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380Native builds *don't* work due to incompatibilities between native
5381and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk2729af92004-05-03 20:45:30 +00005383Booting assumes that (the first part of) the image booted is a
5384stage-2 loader which in turn loads and then invokes the kernel
5385proper. Loader sources will eventually appear in the NetBSD source
5386tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005387meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005388
5389
wdenk2729af92004-05-03 20:45:30 +00005390Implementation Internals:
5391=========================
wdenkc6097192002-11-03 00:24:07 +00005392
wdenk2729af92004-05-03 20:45:30 +00005393The following is not intended to be a complete description of every
5394implementation detail. However, it should help to understand the
5395inner workings of U-Boot and make it easier to port it to custom
5396hardware.
wdenkc6097192002-11-03 00:24:07 +00005397
5398
wdenk2729af92004-05-03 20:45:30 +00005399Initial Stack, Global Data:
5400---------------------------
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk2729af92004-05-03 20:45:30 +00005402The implementation of U-Boot is complicated by the fact that U-Boot
5403starts running out of ROM (flash memory), usually without access to
5404system RAM (because the memory controller is not initialized yet).
5405This means that we don't have writable Data or BSS segments, and BSS
5406is not initialized as zero. To be able to get a C environment working
5407at all, we have to allocate at least a minimal stack. Implementation
5408options for this are defined and restricted by the CPU used: Some CPU
5409models provide on-chip memory (like the IMMR area on MPC8xx and
5410MPC826x processors), on others (parts of) the data cache can be
5411locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005412
Wolfgang Denk218ca722008-03-26 10:40:12 +01005413 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005414 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5417 From: "Chris Hallinan" <clh@net1plus.com>
5418 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5419 ...
wdenk43d96162003-03-06 00:02:04 +00005420
wdenk2729af92004-05-03 20:45:30 +00005421 Correct me if I'm wrong, folks, but the way I understand it
5422 is this: Using DCACHE as initial RAM for Stack, etc, does not
5423 require any physical RAM backing up the cache. The cleverness
5424 is that the cache is being used as a temporary supply of
5425 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005426 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005427 can see how this works by studying the cache architecture and
5428 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005429
wdenk2729af92004-05-03 20:45:30 +00005430 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5431 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005432 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005433 option should work for you. Using CS 4 should be fine if your
5434 board designers haven't used it for something that would
5435 cause you grief during the initial boot! It is frequently not
5436 used.
wdenk43d96162003-03-06 00:02:04 +00005437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005438 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005439 with your processor/board/system design. The default value
5440 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005441 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005442 than your SDRAM module. If you have a 64MB SDRAM module, set
5443 it above 400_0000. Just make sure your board has no resources
5444 that are supposed to respond to that address! That code in
5445 start.S has been around a while and should work as is when
5446 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005447
wdenk2729af92004-05-03 20:45:30 +00005448 -Chris Hallinan
5449 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005450
wdenk2729af92004-05-03 20:45:30 +00005451It is essential to remember this, since it has some impact on the C
5452code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005453
wdenk2729af92004-05-03 20:45:30 +00005454* Initialized global data (data segment) is read-only. Do not attempt
5455 to write it.
wdenkc6097192002-11-03 00:24:07 +00005456
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005457* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005458 as zero data - BSS segment) at all - this is undefined, initiali-
5459 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk2729af92004-05-03 20:45:30 +00005461* Stack space is very limited. Avoid big data buffers or things like
5462 that.
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk2729af92004-05-03 20:45:30 +00005464Having only the stack as writable memory limits means we cannot use
5465normal global data to share information beween the code. But it
5466turned out that the implementation of U-Boot can be greatly
5467simplified by making a global data structure (gd_t) available to all
5468functions. We could pass a pointer to this data as argument to _all_
5469functions, but this would bloat the code. Instead we use a feature of
5470the GCC compiler (Global Register Variables) to share the data: we
5471place a pointer (gd) to the global data into a register which we
5472reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474When choosing a register for such a purpose we are restricted by the
5475relevant (E)ABI specifications for the current architecture, and by
5476GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005477
wdenk2729af92004-05-03 20:45:30 +00005478For PowerPC, the following registers have specific use:
5479 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005480 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005481 R3-R4: parameter passing and return values
5482 R5-R10: parameter passing
5483 R13: small data area pointer
5484 R30: GOT pointer
5485 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005486
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005487 (U-Boot also uses R12 as internal GOT pointer. r12
5488 is a volatile register so r12 needs to be reset when
5489 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005490
Wolfgang Denke7670f62008-02-14 22:43:22 +01005491 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005492
wdenk2729af92004-05-03 20:45:30 +00005493 Note: on PPC, we could use a static initializer (since the
5494 address of the global data structure is known at compile time),
5495 but it turned out that reserving a register results in somewhat
5496 smaller code - although the code savings are not that big (on
5497 average for all boards 752 bytes for the whole U-Boot image,
5498 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005499
Robin Getzc4db3352009-08-17 15:23:02 +00005500On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005501 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5502
Robin Getzc4db3352009-08-17 15:23:02 +00005503 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005504
wdenk2729af92004-05-03 20:45:30 +00005505On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk2729af92004-05-03 20:45:30 +00005507 R0: function argument word/integer result
5508 R1-R3: function argument word
5509 R9: GOT pointer
5510 R10: stack limit (used only if stack checking if enabled)
5511 R11: argument (frame) pointer
5512 R12: temporary workspace
5513 R13: stack pointer
5514 R14: link register
5515 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk2729af92004-05-03 20:45:30 +00005517 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005518
Thomas Chou0df01fd2010-05-21 11:08:03 +08005519On Nios II, the ABI is documented here:
5520 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5521
5522 ==> U-Boot will use gp to hold a pointer to the global data
5523
5524 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5525 to access small data sections, so gp is free.
5526
Macpaul Linafc1ce82011-10-19 20:41:11 +00005527On NDS32, the following registers are used:
5528
5529 R0-R1: argument/return
5530 R2-R5: argument
5531 R15: temporary register for assembler
5532 R16: trampoline register
5533 R28: frame pointer (FP)
5534 R29: global pointer (GP)
5535 R30: link register (LP)
5536 R31: stack pointer (SP)
5537 PC: program counter (PC)
5538
5539 ==> U-Boot will use R10 to hold a pointer to the global data
5540
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005541NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5542or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544Memory Management:
5545------------------
wdenkc6097192002-11-03 00:24:07 +00005546
wdenk2729af92004-05-03 20:45:30 +00005547U-Boot runs in system state and uses physical addresses, i.e. the
5548MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550The available memory is mapped to fixed addresses using the memory
5551controller. In this process, a contiguous block is formed for each
5552memory type (Flash, SDRAM, SRAM), even when it consists of several
5553physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk2729af92004-05-03 20:45:30 +00005555U-Boot is installed in the first 128 kB of the first Flash bank (on
5556TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5557booting and sizing and initializing DRAM, the code relocates itself
5558to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005559memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005560configuration setting]. Below that, a structure with global Board
5561Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005562
wdenk2729af92004-05-03 20:45:30 +00005563Additionally, some exception handler code is copied to the low 8 kB
5564of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005565
wdenk2729af92004-05-03 20:45:30 +00005566So a typical memory configuration with 16 MB of DRAM could look like
5567this:
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569 0x0000 0000 Exception Vector code
5570 :
5571 0x0000 1FFF
5572 0x0000 2000 Free for Application Use
5573 :
5574 :
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk2729af92004-05-03 20:45:30 +00005576 :
5577 :
5578 0x00FB FF20 Monitor Stack (Growing downward)
5579 0x00FB FFAC Board Info Data and permanent copy of global data
5580 0x00FC 0000 Malloc Arena
5581 :
5582 0x00FD FFFF
5583 0x00FE 0000 RAM Copy of Monitor Code
5584 ... eventually: LCD or video framebuffer
5585 ... eventually: pRAM (Protected RAM - unchanged by reset)
5586 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005587
5588
wdenk2729af92004-05-03 20:45:30 +00005589System Initialization:
5590----------------------
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005593(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005594configuration for CS0# this is a mirror of the onboard Flash memory.
5595To be able to re-map memory U-Boot then jumps to its link address.
5596To be able to implement the initialization code in C, a (small!)
5597initial stack is set up in the internal Dual Ported RAM (in case CPUs
5598which provide such a feature like MPC8xx or MPC8260), or in a locked
5599part of the data cache. After that, U-Boot initializes the CPU core,
5600the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005601
wdenk2729af92004-05-03 20:45:30 +00005602Next, all (potentially) available memory banks are mapped using a
5603preliminary mapping. For example, we put them on 512 MB boundaries
5604(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5605on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5606programmed for SDRAM access. Using the temporary configuration, a
5607simple memory test is run that determines the size of the SDRAM
5608banks.
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk2729af92004-05-03 20:45:30 +00005610When there is more than one SDRAM bank, and the banks are of
5611different size, the largest is mapped first. For equal size, the first
5612bank (CS2#) is mapped first. The first mapping is always for address
56130x00000000, with any additional banks following immediately to create
5614contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk2729af92004-05-03 20:45:30 +00005616Then, the monitor installs itself at the upper end of the SDRAM area
5617and allocates memory for use by malloc() and for the global Board
5618Info data; also, the exception vector code is copied to the low RAM
5619pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005620
wdenk2729af92004-05-03 20:45:30 +00005621Only after this relocation will you have a "normal" C environment;
5622until that you are restricted in several ways, mostly because you are
5623running from ROM, and because the code will have to be relocated to a
5624new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005625
5626
wdenk2729af92004-05-03 20:45:30 +00005627U-Boot Porting Guide:
5628----------------------
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk2729af92004-05-03 20:45:30 +00005630[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5631list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005632
5633
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005634int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005635{
5636 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005637
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005638 signal(SIGALRM, no_more_time);
5639 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005642 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005643 return 0;
5644 }
5645
wdenk2729af92004-05-03 20:45:30 +00005646 Download latest U-Boot source;
5647
Wolfgang Denk06682362008-12-30 22:56:11 +01005648 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005649
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005650 if (clueless)
5651 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk2729af92004-05-03 20:45:30 +00005653 while (learning) {
5654 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005655 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5656 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005657 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005658 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005659 }
wdenkc6097192002-11-03 00:24:07 +00005660
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005661 if (available_money > toLocalCurrency ($2500))
5662 Buy a BDI3000;
5663 else
wdenk2729af92004-05-03 20:45:30 +00005664 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005665
5666 if (a similar board exists) { /* hopefully... */
5667 cp -a board/<similar> board/<myboard>
5668 cp include/configs/<similar>.h include/configs/<myboard>.h
5669 } else {
5670 Create your own board support subdirectory;
5671 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005672 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005673 Edit new board/<myboard> files
5674 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005675
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005676 while (!accepted) {
5677 while (!running) {
5678 do {
5679 Add / modify source code;
5680 } until (compiles);
5681 Debug;
5682 if (clueless)
5683 email("Hi, I am having problems...");
5684 }
5685 Send patch file to the U-Boot email list;
5686 if (reasonable critiques)
5687 Incorporate improvements from email list code review;
5688 else
5689 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005690 }
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692 return 0;
5693}
5694
5695void no_more_time (int sig)
5696{
5697 hire_a_guru();
5698}
wdenkc6097192002-11-03 00:24:07 +00005699
5700
wdenk2729af92004-05-03 20:45:30 +00005701Coding Standards:
5702-----------------
wdenkc6097192002-11-03 00:24:07 +00005703
wdenk2729af92004-05-03 20:45:30 +00005704All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005705coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005706"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005707
Detlev Zundel2c051652006-09-01 15:39:02 +02005708Source files originating from a different project (for example the
5709MTD subsystem) are generally exempt from these guidelines and are not
5710reformated to ease subsequent migration to newer versions of those
5711sources.
5712
5713Please note that U-Boot is implemented in C (and to some small parts in
5714Assembler); no C++ is used, so please do not use C++ style comments (//)
5715in your code.
wdenk2729af92004-05-03 20:45:30 +00005716
5717Please also stick to the following formatting rules:
5718- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005719- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005720- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005721- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005722- do not add trailing empty lines to source files
5723
5724Submissions which do not conform to the standards may be returned
5725with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005726
5727
wdenk2729af92004-05-03 20:45:30 +00005728Submitting Patches:
5729-------------------
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731Since the number of patches for U-Boot is growing, we need to
5732establish some rules. Submissions which do not conform to these rules
5733may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005734
Magnus Lilja0d28f342008-08-06 19:32:33 +02005735Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005736
Wolfgang Denk06682362008-12-30 22:56:11 +01005737Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5738see http://lists.denx.de/mailman/listinfo/u-boot
5739
wdenk2729af92004-05-03 20:45:30 +00005740When you send a patch, please include the following information with
5741it:
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk2729af92004-05-03 20:45:30 +00005743* For bug fixes: a description of the bug and how your patch fixes
5744 this bug. Please try to include a way of demonstrating that the
5745 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747* For new features: a description of the feature and your
5748 implementation.
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk2729af92004-05-03 20:45:30 +00005750* A CHANGELOG entry as plaintext (separate from the patch)
5751
5752* For major contributions, your entry to the CREDITS file
5753
5754* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005755 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005756
5757* If your patch adds new configuration options, don't forget to
5758 document these in the README file.
5759
Wolfgang Denk218ca722008-03-26 10:40:12 +01005760* The patch itself. If you are using git (which is *strongly*
5761 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005762 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005763 the U-Boot mailing list, you will avoid most of the common problems
5764 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005765
Wolfgang Denk218ca722008-03-26 10:40:12 +01005766 If you cannot use git, use "diff -purN OLD NEW". If your version of
5767 diff does not support these options, then get the latest version of
5768 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005769
Wolfgang Denk218ca722008-03-26 10:40:12 +01005770 The current directory when running this command shall be the parent
5771 directory of the U-Boot source tree (i. e. please make sure that
5772 your patch includes sufficient directory information for the
5773 affected files).
5774
5775 We prefer patches as plain text. MIME attachments are discouraged,
5776 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005777
5778* If one logical set of modifications affects or creates several
5779 files, all these changes shall be submitted in a SINGLE patch file.
5780
5781* Changesets that contain different, unrelated modifications shall be
5782 submitted as SEPARATE patches, one patch per changeset.
5783
5784
5785Notes:
5786
5787* Before sending the patch, run the MAKEALL script on your patched
5788 source tree and make sure that no errors or warnings are reported
5789 for any of the boards.
5790
5791* Keep your modifications to the necessary minimum: A patch
5792 containing several unrelated changes or arbitrary reformats will be
5793 returned with a request to re-formatting / split it.
5794
5795* If you modify existing code, make sure that your new code does not
5796 add to the memory footprint of the code ;-) Small is beautiful!
5797 When adding new features, these should compile conditionally only
5798 (using #ifdef), and the resulting code with the new feature
5799 disabled must not need more memory than the old code without your
5800 modification.
wdenk90dc6702005-05-03 14:12:25 +00005801
Wolfgang Denk06682362008-12-30 22:56:11 +01005802* Remember that there is a size limit of 100 kB per message on the
5803 u-boot mailing list. Bigger patches will be moderated. If they are
5804 reasonable and not too big, they will be acknowledged. But patches
5805 bigger than the size limit should be avoided.