blob: e2ca76e7aedd6cb721bd4540e91e5cf9da0f6971 [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
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001947- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001948
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001949 This enable the NEW i2c subsystem, and will allow you to use
1950 i2c commands at the u-boot command line (as long as you set
1951 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1952 based realtime clock chips or other i2c devices. See
1953 common/cmd_i2c.c for a description of the command line
1954 interface.
1955
1956 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001957 - drivers/i2c/soft_i2c.c:
1958 - activate first bus with CONFIG_SYS_I2C_SOFT define
1959 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1960 for defining speed and slave address
1961 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1962 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1963 for defining speed and slave address
1964 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1965 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1966 for defining speed and slave address
1967 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1968 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1969 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001970
1971 additional defines:
1972
1973 CONFIG_SYS_NUM_I2C_BUSES
1974 Hold the number of i2c busses you want to use. If you
1975 don't use/have i2c muxes on your i2c bus, this
1976 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
1977 omit this define.
1978
1979 CONFIG_SYS_I2C_DIRECT_BUS
1980 define this, if you don't use i2c muxes on your hardware.
1981 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1982 omit this define.
1983
1984 CONFIG_SYS_I2C_MAX_HOPS
1985 define how many muxes are maximal consecutively connected
1986 on one i2c bus. If you not use i2c muxes, omit this
1987 define.
1988
1989 CONFIG_SYS_I2C_BUSES
1990 hold a list of busses you want to use, only used if
1991 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1992 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1993 CONFIG_SYS_NUM_I2C_BUSES = 9:
1994
1995 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1996 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1997 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1998 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1999 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2000 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2001 {1, {I2C_NULL_HOP}}, \
2002 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2003 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2004 }
2005
2006 which defines
2007 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002008 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2009 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2010 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2011 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2012 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002013 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002014 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2015 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002016
2017 If you do not have i2c muxes on your board, omit this define.
2018
Heiko Schocherea818db2013-01-29 08:53:15 +01002019- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002020
2021 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2022 provides the following compelling advantages:
2023
2024 - more than one i2c adapter is usable
2025 - approved multibus support
2026 - better i2c mux support
2027
2028 ** Please consider updating your I2C driver now. **
2029
Heiko Schocherea818db2013-01-29 08:53:15 +01002030 These enable legacy I2C serial bus commands. Defining
2031 CONFIG_HARD_I2C will include the appropriate I2C driver
2032 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002033
wdenk945af8d2003-07-16 21:53:01 +00002034 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002035 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002036 CONFIG_COMMANDS) and communicate with i2c based realtime
2037 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002038 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002039
Ben Warrenbb99ad62006-09-07 16:50:54 -04002040 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002041
wdenk945af8d2003-07-16 21:53:01 +00002042 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002043 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002045 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002046 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002047 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002048 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002049
Peter Tyser8d321b82010-04-12 22:28:21 -05002050 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002051 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002052 and so its address should therefore be cleared to 0 (See,
2053 eg, MPC823e User's Manual p.16-473). So, set
2054 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002055
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002056 CONFIG_SYS_I2C_INIT_MPC5XXX
2057
2058 When a board is reset during an i2c bus transfer
2059 chips might think that the current transfer is still
2060 in progress. Reset the slave devices by sending start
2061 commands until the slave device responds.
2062
wdenk945af8d2003-07-16 21:53:01 +00002063 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002064
Heiko Schocherea818db2013-01-29 08:53:15 +01002065 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002066 then the following macros need to be defined (examples are
2067 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002068
2069 I2C_INIT
2070
wdenkb37c7e52003-06-30 16:24:52 +00002071 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002072 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002073
wdenkba56f622004-02-06 23:19:44 +00002074 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002075
wdenkc6097192002-11-03 00:24:07 +00002076 I2C_PORT
2077
wdenk43d96162003-03-06 00:02:04 +00002078 (Only for MPC8260 CPU). The I/O port to use (the code
2079 assumes both bits are on the same port). Valid values
2080 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002081
2082 I2C_ACTIVE
2083
2084 The code necessary to make the I2C data line active
2085 (driven). If the data line is open collector, this
2086 define can be null.
2087
wdenkb37c7e52003-06-30 16:24:52 +00002088 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2089
wdenkc6097192002-11-03 00:24:07 +00002090 I2C_TRISTATE
2091
2092 The code necessary to make the I2C data line tri-stated
2093 (inactive). If the data line is open collector, this
2094 define can be null.
2095
wdenkb37c7e52003-06-30 16:24:52 +00002096 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2097
wdenkc6097192002-11-03 00:24:07 +00002098 I2C_READ
2099
York Sun472d5462013-04-01 11:29:11 -07002100 Code that returns true if the I2C data line is high,
2101 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002102
wdenkb37c7e52003-06-30 16:24:52 +00002103 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2104
wdenkc6097192002-11-03 00:24:07 +00002105 I2C_SDA(bit)
2106
York Sun472d5462013-04-01 11:29:11 -07002107 If <bit> is true, sets the I2C data line high. If it
2108 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002109
wdenkb37c7e52003-06-30 16:24:52 +00002110 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002111 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002112 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002113
wdenkc6097192002-11-03 00:24:07 +00002114 I2C_SCL(bit)
2115
York Sun472d5462013-04-01 11:29:11 -07002116 If <bit> is true, sets the I2C clock line high. If it
2117 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002118
wdenkb37c7e52003-06-30 16:24:52 +00002119 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002120 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002121 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002122
wdenkc6097192002-11-03 00:24:07 +00002123 I2C_DELAY
2124
2125 This delay is invoked four times per clock cycle so this
2126 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002127 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002128 like:
2129
wdenkb37c7e52003-06-30 16:24:52 +00002130 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002131
Mike Frysinger793b5722010-07-21 13:38:02 -04002132 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2133
2134 If your arch supports the generic GPIO framework (asm/gpio.h),
2135 then you may alternatively define the two GPIOs that are to be
2136 used as SCL / SDA. Any of the previous I2C_xxx macros will
2137 have GPIO-based defaults assigned to them as appropriate.
2138
2139 You should define these to the GPIO value as given directly to
2140 the generic GPIO functions.
2141
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002142 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002143
wdenk8bde7f72003-06-27 21:31:46 +00002144 When a board is reset during an i2c bus transfer
2145 chips might think that the current transfer is still
2146 in progress. On some boards it is possible to access
2147 the i2c SCLK line directly, either by using the
2148 processor pin as a GPIO or by having a second pin
2149 connected to the bus. If this option is defined a
2150 custom i2c_init_board() routine in boards/xxx/board.c
2151 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002152
Richard Retanubun26a33502010-04-12 15:08:17 -04002153 CONFIG_SYS_I2C_BOARD_LATE_INIT
2154
2155 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2156 defined a custom i2c_board_late_init() routine in
2157 boards/xxx/board.c is run AFTER the operations in i2c_init()
2158 is completed. This callpoint can be used to unreset i2c bus
2159 using CPU i2c controller register accesses for CPUs whose i2c
2160 controller provide such a method. It is called at the end of
2161 i2c_init() to allow i2c_init operations to setup the i2c bus
2162 controller on the CPU (e.g. setting bus speed & slave address).
2163
wdenk17ea1172004-06-06 21:51:03 +00002164 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2165
2166 This option enables configuration of bi_iic_fast[] flags
2167 in u-boot bd_info structure based on u-boot environment
2168 variable "i2cfast". (see also i2cfast)
2169
Ben Warrenbb99ad62006-09-07 16:50:54 -04002170 CONFIG_I2C_MULTI_BUS
2171
2172 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002173 must have a controller. At any point in time, only one bus is
2174 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002175 Note that bus numbering is zero-based.
2176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002177 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002178
2179 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002180 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002181 is set, specify a list of bus-device pairs. Otherwise, specify
2182 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002183
2184 e.g.
2185 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002186 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002187
2188 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2189
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002190 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002191 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002192
2193 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002195 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002196
2197 If defined, then this indicates the I2C bus number for DDR SPD.
2198 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002200 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002201
2202 If defined, then this indicates the I2C bus number for the RTC.
2203 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002205 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002206
2207 If defined, then this indicates the I2C bus number for the DTT.
2208 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002210 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002211
2212 If defined, specifies the I2C address of the DTT device.
2213 If not defined, then U-Boot uses predefined value for
2214 specified DTT device.
2215
Timur Tabibe5e6182006-11-03 19:15:00 -06002216 CONFIG_FSL_I2C
2217
2218 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002219 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002220
Heiko Schocher67b23a32008-10-15 09:39:47 +02002221 CONFIG_I2C_MUX
2222
2223 Define this option if you have I2C devices reached over 1 .. n
2224 I2C Muxes like the pca9544a. This option addes a new I2C
2225 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2226 new I2C Bus to the existing I2C Busses. If you select the
2227 new Bus with "i2c dev", u-bbot sends first the commandos for
2228 the muxes to activate this new "bus".
2229
2230 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2231 feature!
2232
2233 Example:
2234 Adding a new I2C Bus reached over 2 pca9544a muxes
2235 The First mux with address 70 and channel 6
2236 The Second mux with address 71 and channel 4
2237
2238 => i2c bus pca9544a:70:6:pca9544a:71:4
2239
2240 Use the "i2c bus" command without parameter, to get a list
2241 of I2C Busses with muxes:
2242
2243 => i2c bus
2244 Busses reached over muxes:
2245 Bus ID: 2
2246 reached over Mux(es):
2247 pca9544a@70 ch: 4
2248 Bus ID: 3
2249 reached over Mux(es):
2250 pca9544a@70 ch: 6
2251 pca9544a@71 ch: 4
2252 =>
2253
2254 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002255 u-boot first sends the command to the mux@70 to enable
2256 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002257 the channel 4.
2258
2259 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002260 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002261 the 2 muxes.
2262
2263 This option is actually implemented for the bitbanging
2264 algorithm in common/soft_i2c.c and for the Hardware I2C
2265 Bus on the MPC8260. But it should be not so difficult
2266 to add this option to other architectures.
2267
Andrew Dyer2ac69852008-12-29 17:36:01 -06002268 CONFIG_SOFT_I2C_READ_REPEATED_START
2269
2270 defining this will force the i2c_read() function in
2271 the soft_i2c driver to perform an I2C repeated start
2272 between writing the address pointer and reading the
2273 data. If this define is omitted the default behaviour
2274 of doing a stop-start sequence will be used. Most I2C
2275 devices can use either method, but some require one or
2276 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002277
wdenkc6097192002-11-03 00:24:07 +00002278- SPI Support: CONFIG_SPI
2279
2280 Enables SPI driver (so far only tested with
2281 SPI EEPROM, also an instance works with Crystal A/D and
2282 D/As on the SACSng board)
2283
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002284 CONFIG_SH_SPI
2285
2286 Enables the driver for SPI controller on SuperH. Currently
2287 only SH7757 is supported.
2288
wdenkc6097192002-11-03 00:24:07 +00002289 CONFIG_SPI_X
2290
2291 Enables extended (16-bit) SPI EEPROM addressing.
2292 (symmetrical to CONFIG_I2C_X)
2293
2294 CONFIG_SOFT_SPI
2295
wdenk43d96162003-03-06 00:02:04 +00002296 Enables a software (bit-bang) SPI driver rather than
2297 using hardware support. This is a general purpose
2298 driver that only requires three general I/O port pins
2299 (two outputs, one input) to function. If this is
2300 defined, the board configuration must define several
2301 SPI configuration items (port pins to use, etc). For
2302 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002303
Ben Warren04a9e112008-01-16 22:37:35 -05002304 CONFIG_HARD_SPI
2305
2306 Enables a hardware SPI driver for general-purpose reads
2307 and writes. As with CONFIG_SOFT_SPI, the board configuration
2308 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002309 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002310 example, see include/configs/mpc8349emds.h.
2311
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002312 CONFIG_MXC_SPI
2313
2314 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002315 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002316
Matthias Fuchs01335022007-12-27 17:12:34 +01002317- FPGA Support: CONFIG_FPGA
2318
2319 Enables FPGA subsystem.
2320
2321 CONFIG_FPGA_<vendor>
2322
2323 Enables support for specific chip vendors.
2324 (ALTERA, XILINX)
2325
2326 CONFIG_FPGA_<family>
2327
2328 Enables support for FPGA family.
2329 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2330
2331 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002332
wdenk43d96162003-03-06 00:02:04 +00002333 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002336
wdenk8bde7f72003-06-27 21:31:46 +00002337 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002339 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002340
wdenk43d96162003-03-06 00:02:04 +00002341 Enable checks on FPGA configuration interface busy
2342 status by the configuration function. This option
2343 will require a board or device specific function to
2344 be written.
wdenkc6097192002-11-03 00:24:07 +00002345
2346 CONFIG_FPGA_DELAY
2347
2348 If defined, a function that provides delays in the FPGA
2349 configuration driver.
2350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002351 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002352 Allow Control-C to interrupt FPGA configuration
2353
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002354 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002355
wdenk43d96162003-03-06 00:02:04 +00002356 Check for configuration errors during FPGA bitfile
2357 loading. For example, abort during Virtex II
2358 configuration if the INIT_B line goes low (which
2359 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002361 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002362
wdenk43d96162003-03-06 00:02:04 +00002363 Maximum time to wait for the INIT_B line to deassert
2364 after PROB_B has been deasserted during a Virtex II
2365 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 ms.
wdenkc6097192002-11-03 00:24:07 +00002367
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002368 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002369
wdenk43d96162003-03-06 00:02:04 +00002370 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002371 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002373 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002374
wdenk43d96162003-03-06 00:02:04 +00002375 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002376 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002377
2378- Configuration Management:
2379 CONFIG_IDENT_STRING
2380
wdenk43d96162003-03-06 00:02:04 +00002381 If defined, this string will be added to the U-Boot
2382 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002383
2384- Vendor Parameter Protection:
2385
wdenk43d96162003-03-06 00:02:04 +00002386 U-Boot considers the values of the environment
2387 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002388 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002389 are set once by the board vendor / manufacturer, and
2390 protects these variables from casual modification by
2391 the user. Once set, these variables are read-only,
2392 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002393 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002394
2395 If CONFIG_ENV_OVERWRITE is #defined in your config
2396 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002397 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002398 these parameters.
2399
2400 Alternatively, if you #define _both_ CONFIG_ETHADDR
2401 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002402 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002403 which can be changed exactly ONCE by the user. [The
2404 serial# is unaffected by this, i. e. it remains
2405 read-only.]
2406
Joe Hershberger25980902012-12-11 22:16:31 -06002407 The same can be accomplished in a more flexible way
2408 for any variable by configuring the type of access
2409 to allow for those variables in the ".flags" variable
2410 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2411
wdenkc6097192002-11-03 00:24:07 +00002412- Protected RAM:
2413 CONFIG_PRAM
2414
2415 Define this variable to enable the reservation of
2416 "protected RAM", i. e. RAM which is not overwritten
2417 by U-Boot. Define CONFIG_PRAM to hold the number of
2418 kB you want to reserve for pRAM. You can overwrite
2419 this default value by defining an environment
2420 variable "pram" to the number of kB you want to
2421 reserve. Note that the board info structure will
2422 still show the full amount of RAM. If pRAM is
2423 reserved, a new environment variable "mem" will
2424 automatically be defined to hold the amount of
2425 remaining RAM in a form that can be passed as boot
2426 argument to Linux, for instance like that:
2427
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002428 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002429 saveenv
2430
2431 This way you can tell Linux not to use this memory,
2432 either, which results in a memory region that will
2433 not be affected by reboots.
2434
2435 *WARNING* If your board configuration uses automatic
2436 detection of the RAM size, you must make sure that
2437 this memory test is non-destructive. So far, the
2438 following board configurations are known to be
2439 "pRAM-clean":
2440
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002441 IVMS8, IVML24, SPD8xx, TQM8xxL,
2442 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002443 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002444
Gabe Black40fef042012-12-02 04:55:18 +00002445- Access to physical memory region (> 4GB)
2446 Some basic support is provided for operations on memory not
2447 normally accessible to U-Boot - e.g. some architectures
2448 support access to more than 4GB of memory on 32-bit
2449 machines using physical address extension or similar.
2450 Define CONFIG_PHYSMEM to access this basic support, which
2451 currently only supports clearing the memory.
2452
wdenkc6097192002-11-03 00:24:07 +00002453- Error Recovery:
2454 CONFIG_PANIC_HANG
2455
2456 Define this variable to stop the system in case of a
2457 fatal error, so that you have to reset it manually.
2458 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002459 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002460 automatically as fast as possible, but it may be
2461 useful during development since you can try to debug
2462 the conditions that lead to the situation.
2463
2464 CONFIG_NET_RETRY_COUNT
2465
wdenk43d96162003-03-06 00:02:04 +00002466 This variable defines the number of retries for
2467 network operations like ARP, RARP, TFTP, or BOOTP
2468 before giving up the operation. If not defined, a
2469 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002470
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002471 CONFIG_ARP_TIMEOUT
2472
2473 Timeout waiting for an ARP reply in milliseconds.
2474
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002475 CONFIG_NFS_TIMEOUT
2476
2477 Timeout in milliseconds used in NFS protocol.
2478 If you encounter "ERROR: Cannot umount" in nfs command,
2479 try longer timeout such as
2480 #define CONFIG_NFS_TIMEOUT 10000UL
2481
wdenkc6097192002-11-03 00:24:07 +00002482- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002483 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002484
2485 Enable auto completion of commands using TAB.
2486
Wolfgang Denka9398e02006-11-27 15:32:42 +01002487 Note that this feature has NOT been implemented yet
2488 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002489
2490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002491 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002492
2493 Define this variable to enable the "hush" shell (from
2494 Busybox) as command line interpreter, thus enabling
2495 powerful command line syntax like
2496 if...then...else...fi conditionals or `&&' and '||'
2497 constructs ("shell scripts").
2498
2499 If undefined, you get the old, much simpler behaviour
2500 with a somewhat smaller memory footprint.
2501
2502
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002503 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002504
2505 This defines the secondary prompt string, which is
2506 printed when the command interpreter needs more input
2507 to complete a command. Usually "> ".
2508
2509 Note:
2510
wdenk8bde7f72003-06-27 21:31:46 +00002511 In the current implementation, the local variables
2512 space and global environment variables space are
2513 separated. Local variables are those you define by
2514 simply typing `name=value'. To access a local
2515 variable later on, you have write `$name' or
2516 `${name}'; to execute the contents of a variable
2517 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002518
wdenk43d96162003-03-06 00:02:04 +00002519 Global environment variables are those you use
2520 setenv/printenv to work with. To run a command stored
2521 in such a variable, you need to use the run command,
2522 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002523
2524 To store commands and special characters in a
2525 variable, please use double quotation marks
2526 surrounding the whole text of the variable, instead
2527 of the backslashes before semicolons and special
2528 symbols.
2529
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002530- Commandline Editing and History:
2531 CONFIG_CMDLINE_EDITING
2532
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002533 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002534 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002535
wdenka8c7c702003-12-06 19:49:23 +00002536- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002537 CONFIG_EXTRA_ENV_SETTINGS
2538
wdenk43d96162003-03-06 00:02:04 +00002539 Define this to contain any number of null terminated
2540 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002541 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002542
wdenk43d96162003-03-06 00:02:04 +00002543 For example, place something like this in your
2544 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002545
2546 #define CONFIG_EXTRA_ENV_SETTINGS \
2547 "myvar1=value1\0" \
2548 "myvar2=value2\0"
2549
wdenk43d96162003-03-06 00:02:04 +00002550 Warning: This method is based on knowledge about the
2551 internal format how the environment is stored by the
2552 U-Boot code. This is NOT an official, exported
2553 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002554 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002555 You better know what you are doing here.
2556
wdenk43d96162003-03-06 00:02:04 +00002557 Note: overly (ab)use of the default environment is
2558 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002559 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002560 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002561
Stephen Warren5e724ca2012-05-22 09:21:54 +00002562 CONFIG_ENV_VARS_UBOOT_CONFIG
2563
2564 Define this in order to add variables describing the
2565 U-Boot build configuration to the default environment.
2566 These will be named arch, cpu, board, vendor, and soc.
2567
2568 Enabling this option will cause the following to be defined:
2569
2570 - CONFIG_SYS_ARCH
2571 - CONFIG_SYS_CPU
2572 - CONFIG_SYS_BOARD
2573 - CONFIG_SYS_VENDOR
2574 - CONFIG_SYS_SOC
2575
Tom Rini7e27f892012-10-24 07:28:16 +00002576 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2577
2578 Define this in order to add variables describing certain
2579 run-time determined information about the hardware to the
2580 environment. These will be named board_name, board_rev.
2581
Simon Glass06fd8532012-11-30 13:01:17 +00002582 CONFIG_DELAY_ENVIRONMENT
2583
2584 Normally the environment is loaded when the board is
2585 intialised so that it is available to U-Boot. This inhibits
2586 that so that the environment is not available until
2587 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2588 this is instead controlled by the value of
2589 /config/load-environment.
2590
wdenka8c7c702003-12-06 19:49:23 +00002591- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002592 CONFIG_HAS_DATAFLASH
2593
wdenk8bde7f72003-06-27 21:31:46 +00002594 Defining this option enables DataFlash features and
2595 allows to read/write in Dataflash via the standard
2596 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002597
Eric Nelsonf61ec452012-01-31 10:52:08 -07002598- Serial Flash support
2599 CONFIG_CMD_SF
2600
2601 Defining this option enables SPI flash commands
2602 'sf probe/read/write/erase/update'.
2603
2604 Usage requires an initial 'probe' to define the serial
2605 flash parameters, followed by read/write/erase/update
2606 commands.
2607
2608 The following defaults may be provided by the platform
2609 to handle the common case when only a single serial
2610 flash is present on the system.
2611
2612 CONFIG_SF_DEFAULT_BUS Bus identifier
2613 CONFIG_SF_DEFAULT_CS Chip-select
2614 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2615 CONFIG_SF_DEFAULT_SPEED in Hz
2616
Simon Glass24007272012-10-08 13:16:02 +00002617 CONFIG_CMD_SF_TEST
2618
2619 Define this option to include a destructive SPI flash
2620 test ('sf test').
2621
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302622 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2623
2624 Define this option to use the Bank addr/Extended addr
2625 support on SPI flashes which has size > 16Mbytes.
2626
wdenk3f85ce22004-02-23 16:11:30 +00002627- SystemACE Support:
2628 CONFIG_SYSTEMACE
2629
2630 Adding this option adds support for Xilinx SystemACE
2631 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002632 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002633 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002634
2635 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002636 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002637
2638 When SystemACE support is added, the "ace" device type
2639 becomes available to the fat commands, i.e. fatls.
2640
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002641- TFTP Fixed UDP Port:
2642 CONFIG_TFTP_PORT
2643
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002644 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002645 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002646 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002647 number generator is used.
2648
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002649 Also, the environment variable tftpdstp is used to supply
2650 the TFTP UDP destination port value. If tftpdstp isn't
2651 defined, the normal port 69 is used.
2652
2653 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002654 blindly start the TFTP transfer using the pre-configured
2655 target IP address and UDP port. This has the effect of
2656 "punching through" the (Windows XP) firewall, allowing
2657 the remainder of the TFTP transfer to proceed normally.
2658 A better solution is to properly configure the firewall,
2659 but sometimes that is not allowed.
2660
Simon Glassbf36c5d2012-12-05 14:46:38 +00002661- Hashing support:
2662 CONFIG_CMD_HASH
2663
2664 This enables a generic 'hash' command which can produce
2665 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2666
2667 CONFIG_HASH_VERIFY
2668
2669 Enable the hash verify command (hash -v). This adds to code
2670 size a little.
2671
2672 CONFIG_SHA1 - support SHA1 hashing
2673 CONFIG_SHA256 - support SHA256 hashing
2674
2675 Note: There is also a sha1sum command, which should perhaps
2676 be deprecated in favour of 'hash sha1'.
2677
Simon Glass19c402a2013-06-13 15:10:02 -07002678- Signing support:
2679 CONFIG_RSA
2680
2681 This enables the RSA algorithm used for FIT image verification
2682 in U-Boot. See doc/uImage/signature for more information.
2683
2684 The signing part is build into mkimage regardless of this
2685 option.
2686
2687
wdenka8c7c702003-12-06 19:49:23 +00002688- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002689 CONFIG_SHOW_BOOT_PROGRESS
2690
wdenk43d96162003-03-06 00:02:04 +00002691 Defining this option allows to add some board-
2692 specific code (calling a user-provided function
2693 "show_boot_progress(int)") that enables you to show
2694 the system's boot progress on some display (for
2695 example, some LED's) on your board. At the moment,
2696 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002697
Simon Glass3a608ca2012-02-13 13:51:19 +00002698- Detailed boot stage timing
2699 CONFIG_BOOTSTAGE
2700 Define this option to get detailed timing of each stage
2701 of the boot process.
2702
2703 CONFIG_BOOTSTAGE_USER_COUNT
2704 This is the number of available user bootstage records.
2705 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2706 a new ID will be allocated from this stash. If you exceed
2707 the limit, recording will stop.
2708
2709 CONFIG_BOOTSTAGE_REPORT
2710 Define this to print a report before boot, similar to this:
2711
2712 Timer summary in microseconds:
2713 Mark Elapsed Stage
2714 0 0 reset
2715 3,575,678 3,575,678 board_init_f start
2716 3,575,695 17 arch_cpu_init A9
2717 3,575,777 82 arch_cpu_init done
2718 3,659,598 83,821 board_init_r start
2719 3,910,375 250,777 main_loop
2720 29,916,167 26,005,792 bootm_start
2721 30,361,327 445,160 start_kernel
2722
Simon Glass2eba38c2012-09-28 08:56:39 +00002723 CONFIG_CMD_BOOTSTAGE
2724 Add a 'bootstage' command which supports printing a report
2725 and un/stashing of bootstage data.
2726
Simon Glass94fd1312012-09-28 08:56:37 +00002727 CONFIG_BOOTSTAGE_FDT
2728 Stash the bootstage information in the FDT. A root 'bootstage'
2729 node is created with each bootstage id as a child. Each child
2730 has a 'name' property and either 'mark' containing the
2731 mark time in microsecond, or 'accum' containing the
2732 accumulated time for that bootstage id in microseconds.
2733 For example:
2734
2735 bootstage {
2736 154 {
2737 name = "board_init_f";
2738 mark = <3575678>;
2739 };
2740 170 {
2741 name = "lcd";
2742 accum = <33482>;
2743 };
2744 };
2745
2746 Code in the Linux kernel can find this in /proc/devicetree.
2747
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002748Legacy uImage format:
2749
wdenkc6097192002-11-03 00:24:07 +00002750 Arg Where When
2751 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002752 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002753 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002754 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002755 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002756 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002757 4 common/cmd_bootm.c Image data has correct checksum
2758 -4 common/cmd_bootm.c Image is for unsupported architecture
2759 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002760 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002761 6 common/cmd_bootm.c Image Type check OK
2762 -6 common/cmd_bootm.c gunzip uncompression error
2763 -7 common/cmd_bootm.c Unimplemented compression type
2764 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002765 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002766 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002767
2768 9 common/image.c Start initial ramdisk verification
2769 -10 common/image.c Ramdisk header has bad magic number
2770 -11 common/image.c Ramdisk header has bad checksum
2771 10 common/image.c Ramdisk header is OK
2772 -12 common/image.c Ramdisk data has bad checksum
2773 11 common/image.c Ramdisk data has correct checksum
2774 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002775 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002776 13 common/image.c Start multifile image verification
2777 14 common/image.c No initial ramdisk, no multifile, continue.
2778
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002779 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002780
Stefan Roesea47a12b2010-04-15 16:07:28 +02002781 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002782 -31 post/post.c POST test failed, detected by post_output_backlog()
2783 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002784
Heiko Schocher566a4942007-06-22 19:11:54 +02002785 34 common/cmd_doc.c before loading a Image from a DOC device
2786 -35 common/cmd_doc.c Bad usage of "doc" command
2787 35 common/cmd_doc.c correct usage of "doc" command
2788 -36 common/cmd_doc.c No boot device
2789 36 common/cmd_doc.c correct boot device
2790 -37 common/cmd_doc.c Unknown Chip ID on boot device
2791 37 common/cmd_doc.c correct chip ID found, device available
2792 -38 common/cmd_doc.c Read Error on boot device
2793 38 common/cmd_doc.c reading Image header from DOC device OK
2794 -39 common/cmd_doc.c Image header has bad magic number
2795 39 common/cmd_doc.c Image header has correct magic number
2796 -40 common/cmd_doc.c Error reading Image from DOC device
2797 40 common/cmd_doc.c Image header has correct magic number
2798 41 common/cmd_ide.c before loading a Image from a IDE device
2799 -42 common/cmd_ide.c Bad usage of "ide" command
2800 42 common/cmd_ide.c correct usage of "ide" command
2801 -43 common/cmd_ide.c No boot device
2802 43 common/cmd_ide.c boot device found
2803 -44 common/cmd_ide.c Device not available
2804 44 common/cmd_ide.c Device available
2805 -45 common/cmd_ide.c wrong partition selected
2806 45 common/cmd_ide.c partition selected
2807 -46 common/cmd_ide.c Unknown partition table
2808 46 common/cmd_ide.c valid partition table found
2809 -47 common/cmd_ide.c Invalid partition type
2810 47 common/cmd_ide.c correct partition type
2811 -48 common/cmd_ide.c Error reading Image Header on boot device
2812 48 common/cmd_ide.c reading Image Header from IDE device OK
2813 -49 common/cmd_ide.c Image header has bad magic number
2814 49 common/cmd_ide.c Image header has correct magic number
2815 -50 common/cmd_ide.c Image header has bad checksum
2816 50 common/cmd_ide.c Image header has correct checksum
2817 -51 common/cmd_ide.c Error reading Image from IDE device
2818 51 common/cmd_ide.c reading Image from IDE device OK
2819 52 common/cmd_nand.c before loading a Image from a NAND device
2820 -53 common/cmd_nand.c Bad usage of "nand" command
2821 53 common/cmd_nand.c correct usage of "nand" command
2822 -54 common/cmd_nand.c No boot device
2823 54 common/cmd_nand.c boot device found
2824 -55 common/cmd_nand.c Unknown Chip ID on boot device
2825 55 common/cmd_nand.c correct chip ID found, device available
2826 -56 common/cmd_nand.c Error reading Image Header on boot device
2827 56 common/cmd_nand.c reading Image Header from NAND device OK
2828 -57 common/cmd_nand.c Image header has bad magic number
2829 57 common/cmd_nand.c Image header has correct magic number
2830 -58 common/cmd_nand.c Error reading Image from NAND device
2831 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002832
Heiko Schocher566a4942007-06-22 19:11:54 +02002833 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002834
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002835 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002836 -64 net/eth.c no Ethernet found.
2837 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002838
Heiko Schocher566a4942007-06-22 19:11:54 +02002839 -80 common/cmd_net.c usage wrong
2840 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002841 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002842 81 common/cmd_net.c NetLoop() back without error
2843 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2844 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002845 83 common/cmd_net.c running "source" command
2846 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002847 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002848
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002849FIT uImage format:
2850
2851 Arg Where When
2852 100 common/cmd_bootm.c Kernel FIT Image has correct format
2853 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2854 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2855 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2856 102 common/cmd_bootm.c Kernel unit name specified
2857 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002858 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002859 104 common/cmd_bootm.c Got kernel subimage node offset
2860 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2861 105 common/cmd_bootm.c Kernel subimage hash verification OK
2862 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2863 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002864 -106 common/cmd_bootm.c Kernel subimage has wrong type
2865 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002866 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2867 108 common/cmd_bootm.c Got kernel subimage data/size
2868 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2869 -109 common/cmd_bootm.c Can't get kernel subimage type
2870 -110 common/cmd_bootm.c Can't get kernel subimage comp
2871 -111 common/cmd_bootm.c Can't get kernel subimage os
2872 -112 common/cmd_bootm.c Can't get kernel subimage load address
2873 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2874
2875 120 common/image.c Start initial ramdisk verification
2876 -120 common/image.c Ramdisk FIT image has incorrect format
2877 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002878 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002879 -122 common/image.c Can't get configuration for ramdisk subimage
2880 123 common/image.c Ramdisk unit name specified
2881 -124 common/image.c Can't get ramdisk subimage node offset
2882 125 common/image.c Got ramdisk subimage node offset
2883 -125 common/image.c Ramdisk subimage hash verification failed
2884 126 common/image.c Ramdisk subimage hash verification OK
2885 -126 common/image.c Ramdisk subimage for unsupported architecture
2886 127 common/image.c Architecture check OK
2887 -127 common/image.c Can't get ramdisk subimage data/size
2888 128 common/image.c Got ramdisk subimage data/size
2889 129 common/image.c Can't get ramdisk load address
2890 -129 common/image.c Got ramdisk load address
2891
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002892 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002893 131 common/cmd_doc.c FIT image format OK
2894
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002895 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002896 141 common/cmd_ide.c FIT image format OK
2897
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002898 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002899 151 common/cmd_nand.c FIT image format OK
2900
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002901- FIT image support:
2902 CONFIG_FIT
2903 Enable support for the FIT uImage format.
2904
2905 CONFIG_FIT_BEST_MATCH
2906 When no configuration is explicitly selected, default to the
2907 one whose fdt's compatibility field best matches that of
2908 U-Boot itself. A match is considered "best" if it matches the
2909 most specific compatibility entry of U-Boot's fdt's root node.
2910 The order of entries in the configuration's fdt is ignored.
2911
Simon Glass3e569a62013-06-13 15:10:00 -07002912 CONFIG_FIT_SIGNATURE
2913 This option enables signature verification of FIT uImages,
2914 using a hash signed and verified using RSA. See
2915 doc/uImage.FIT/signature.txt for more details.
2916
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002917- Standalone program support:
2918 CONFIG_STANDALONE_LOAD_ADDR
2919
Wolfgang Denk6feff892011-10-09 21:06:34 +02002920 This option defines a board specific value for the
2921 address where standalone program gets loaded, thus
2922 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002923 settings.
2924
2925- Frame Buffer Address:
2926 CONFIG_FB_ADDR
2927
2928 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002929 address for frame buffer. This is typically the case
2930 when using a graphics controller has separate video
2931 memory. U-Boot will then place the frame buffer at
2932 the given address instead of dynamically reserving it
2933 in system RAM by calling lcd_setmem(), which grabs
2934 the memory for the frame buffer depending on the
2935 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002936
2937 Please see board_init_f function.
2938
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002939- Automatic software updates via TFTP server
2940 CONFIG_UPDATE_TFTP
2941 CONFIG_UPDATE_TFTP_CNT_MAX
2942 CONFIG_UPDATE_TFTP_MSEC_MAX
2943
2944 These options enable and control the auto-update feature;
2945 for a more detailed description refer to doc/README.update.
2946
2947- MTD Support (mtdparts command, UBI support)
2948 CONFIG_MTD_DEVICE
2949
2950 Adds the MTD device infrastructure from the Linux kernel.
2951 Needed for mtdparts command support.
2952
2953 CONFIG_MTD_PARTITIONS
2954
2955 Adds the MTD partitioning infrastructure from the Linux
2956 kernel. Needed for UBI support.
2957
Joe Hershberger70c219c2013-04-08 10:32:48 +00002958- UBI support
2959 CONFIG_CMD_UBI
2960
2961 Adds commands for interacting with MTD partitions formatted
2962 with the UBI flash translation layer
2963
2964 Requires also defining CONFIG_RBTREE
2965
Joe Hershberger147162d2013-04-08 10:32:49 +00002966 CONFIG_UBI_SILENCE_MSG
2967
2968 Make the verbose messages from UBI stop printing. This leaves
2969 warnings and errors enabled.
2970
Joe Hershberger70c219c2013-04-08 10:32:48 +00002971- UBIFS support
2972 CONFIG_CMD_UBIFS
2973
2974 Adds commands for interacting with UBI volumes formatted as
2975 UBIFS. UBIFS is read-only in u-boot.
2976
2977 Requires UBI support as well as CONFIG_LZO
2978
Joe Hershberger147162d2013-04-08 10:32:49 +00002979 CONFIG_UBIFS_SILENCE_MSG
2980
2981 Make the verbose messages from UBIFS stop printing. This leaves
2982 warnings and errors enabled.
2983
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002984- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002985 CONFIG_SPL
2986 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002987
Tom Rini95579792012-02-14 07:29:40 +00002988 CONFIG_SPL_LDSCRIPT
2989 LDSCRIPT for linking the SPL binary.
2990
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002991 CONFIG_SPL_MAX_FOOTPRINT
2992 Maximum size in memory allocated to the SPL, BSS included.
2993 When defined, the linker checks that the actual memory
2994 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002995 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002996 must not be both defined at the same time.
2997
Tom Rini95579792012-02-14 07:29:40 +00002998 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002999 Maximum size of the SPL image (text, data, rodata, and
3000 linker lists sections), BSS excluded.
3001 When defined, the linker checks that the actual size does
3002 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003003
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003004 CONFIG_SPL_TEXT_BASE
3005 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003006
Scott Wood94a45bb2012-09-20 19:05:12 -05003007 CONFIG_SPL_RELOC_TEXT_BASE
3008 Address to relocate to. If unspecified, this is equal to
3009 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3010
Tom Rini95579792012-02-14 07:29:40 +00003011 CONFIG_SPL_BSS_START_ADDR
3012 Link address for the BSS within the SPL binary.
3013
3014 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003015 Maximum size in memory allocated to the SPL BSS.
3016 When defined, the linker checks that the actual memory used
3017 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003018 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003019 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003020
3021 CONFIG_SPL_STACK
3022 Adress of the start of the stack SPL will use
3023
Scott Wood94a45bb2012-09-20 19:05:12 -05003024 CONFIG_SPL_RELOC_STACK
3025 Adress of the start of the stack SPL will use after
3026 relocation. If unspecified, this is equal to
3027 CONFIG_SPL_STACK.
3028
Tom Rini95579792012-02-14 07:29:40 +00003029 CONFIG_SYS_SPL_MALLOC_START
3030 Starting address of the malloc pool used in SPL.
3031
3032 CONFIG_SYS_SPL_MALLOC_SIZE
3033 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003034
Tom Rini47f7bca2012-08-13 12:03:19 -07003035 CONFIG_SPL_FRAMEWORK
3036 Enable the SPL framework under common/. This framework
3037 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3038 NAND loading of the Linux Kernel.
3039
Tom Rini861a86f2012-08-13 11:37:56 -07003040 CONFIG_SPL_DISPLAY_PRINT
3041 For ARM, enable an optional function to print more information
3042 about the running system.
3043
Scott Wood4b919722012-09-20 16:35:21 -05003044 CONFIG_SPL_INIT_MINIMAL
3045 Arch init code should be built for a very small image
3046
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003047 CONFIG_SPL_LIBCOMMON_SUPPORT
3048 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003049
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003050 CONFIG_SPL_LIBDISK_SUPPORT
3051 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003052
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003053 CONFIG_SPL_I2C_SUPPORT
3054 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003055
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003056 CONFIG_SPL_GPIO_SUPPORT
3057 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003058
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003059 CONFIG_SPL_MMC_SUPPORT
3060 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003061
Tom Rini95579792012-02-14 07:29:40 +00003062 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3063 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3064 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3065 Address, size and partition on the MMC to load U-Boot from
3066 when the MMC is being used in raw mode.
3067
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003068 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3069 Sector to load kernel uImage from when MMC is being
3070 used in raw mode (for Falcon mode)
3071
3072 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3073 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3074 Sector and number of sectors to load kernel argument
3075 parameters from when MMC is being used in raw mode
3076 (for falcon mode)
3077
Tom Rini95579792012-02-14 07:29:40 +00003078 CONFIG_SPL_FAT_SUPPORT
3079 Support for fs/fat/libfat.o in SPL binary
3080
3081 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3082 Filename to read to load U-Boot when reading from FAT
3083
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003084 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3085 Filename to read to load kernel uImage when reading
3086 from FAT (for Falcon mode)
3087
3088 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3089 Filename to read to load kernel argument parameters
3090 when reading from FAT (for Falcon mode)
3091
Scott Wood06f60ae2012-12-06 13:33:17 +00003092 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3093 Set this for NAND SPL on PPC mpc83xx targets, so that
3094 start.S waits for the rest of the SPL to load before
3095 continuing (the hardware starts execution after just
3096 loading the first page rather than the full 4K).
3097
Scott Wood6f2f01b2012-09-20 19:09:07 -05003098 CONFIG_SPL_NAND_BASE
3099 Include nand_base.c in the SPL. Requires
3100 CONFIG_SPL_NAND_DRIVERS.
3101
3102 CONFIG_SPL_NAND_DRIVERS
3103 SPL uses normal NAND drivers, not minimal drivers.
3104
3105 CONFIG_SPL_NAND_ECC
3106 Include standard software ECC in the SPL
3107
Tom Rini95579792012-02-14 07:29:40 +00003108 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003109 Support for NAND boot using simple NAND drivers that
3110 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003111
3112 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3113 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3114 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3115 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3116 CONFIG_SYS_NAND_ECCBYTES
3117 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003118 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003119
3120 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003121 Location in NAND to read U-Boot from
3122
3123 CONFIG_SYS_NAND_U_BOOT_DST
3124 Location in memory to load U-Boot to
3125
3126 CONFIG_SYS_NAND_U_BOOT_SIZE
3127 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003128
3129 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003130 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003131
3132 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3133 Define this if you need to first read the OOB and then the
3134 data. This is used for example on davinci plattforms.
3135
3136 CONFIG_SPL_OMAP3_ID_NAND
3137 Support for an OMAP3-specific set of functions to return the
3138 ID and MFR of the first attached NAND chip, if present.
3139
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003140 CONFIG_SPL_SERIAL_SUPPORT
3141 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003142
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003143 CONFIG_SPL_SPI_FLASH_SUPPORT
3144 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003145
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003146 CONFIG_SPL_SPI_SUPPORT
3147 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003148
Pavel Machekc57b9532012-08-30 22:42:11 +02003149 CONFIG_SPL_RAM_DEVICE
3150 Support for running image already present in ram, in SPL binary
3151
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003152 CONFIG_SPL_LIBGENERIC_SUPPORT
3153 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003154
Ying Zhangba1bee42013-05-20 14:07:25 +08003155 CONFIG_SPL_ENV_SUPPORT
3156 Support for the environment operating in SPL binary
3157
3158 CONFIG_SPL_NET_SUPPORT
3159 Support for the net/libnet.o in SPL binary.
3160 It conflicts with SPL env from storage medium specified by
3161 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3162
Scott Wood74752ba2012-12-06 13:33:16 +00003163 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003164 Image offset to which the SPL should be padded before appending
3165 the SPL payload. By default, this is defined as
3166 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3167 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3168 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003169
Scott Woodca2fca22012-09-21 16:27:32 -05003170 CONFIG_SPL_TARGET
3171 Final target image containing SPL and payload. Some SPLs
3172 use an arch-specific makefile fragment instead, for
3173 example if more than one image needs to be produced.
3174
Simon Glass87ebee32013-05-08 08:05:59 +00003175 CONFIG_FIT_SPL_PRINT
3176 Printing information about a FIT image adds quite a bit of
3177 code to SPL. So this is normally disabled in SPL. Use this
3178 option to re-enable it. This will affect the output of the
3179 bootm command when booting a FIT image.
3180
wdenkc6097192002-11-03 00:24:07 +00003181Modem Support:
3182--------------
3183
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003184[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003185
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003186- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003187 CONFIG_MODEM_SUPPORT
3188
3189- RTS/CTS Flow control enable:
3190 CONFIG_HWFLOW
3191
3192- Modem debug support:
3193 CONFIG_MODEM_SUPPORT_DEBUG
3194
wdenk43d96162003-03-06 00:02:04 +00003195 Enables debugging stuff (char screen[1024], dbg())
3196 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003197
wdenka8c7c702003-12-06 19:49:23 +00003198- Interrupt support (PPC):
3199
wdenkd4ca31c2004-01-02 14:00:00 +00003200 There are common interrupt_init() and timer_interrupt()
3201 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003202 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003203 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003204 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003205 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003206 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003207 specific handling. If board has watchdog / status_led
3208 / other_activity_monitor it works automatically from
3209 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003210
wdenkc6097192002-11-03 00:24:07 +00003211- General:
3212
wdenk43d96162003-03-06 00:02:04 +00003213 In the target system modem support is enabled when a
3214 specific key (key combination) is pressed during
3215 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003216 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003217 board_init(). Currently key_pressed() is a dummy
3218 function, returning 1 and thus enabling modem
3219 initialization.
wdenkc6097192002-11-03 00:24:07 +00003220
wdenk43d96162003-03-06 00:02:04 +00003221 If there are no modem init strings in the
3222 environment, U-Boot proceed to autoboot; the
3223 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003224 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003225
3226 See also: doc/README.Modem
3227
Helmut Raiger9660e442011-10-20 04:19:47 +00003228Board initialization settings:
3229------------------------------
3230
3231During Initialization u-boot calls a number of board specific functions
3232to allow the preparation of board specific prerequisites, e.g. pin setup
3233before drivers are initialized. To enable these callbacks the
3234following configuration macros have to be defined. Currently this is
3235architecture specific, so please check arch/your_architecture/lib/board.c
3236typically in board_init_f() and board_init_r().
3237
3238- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3239- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3240- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3241- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003242
wdenkc6097192002-11-03 00:24:07 +00003243Configuration Settings:
3244-----------------------
3245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003246- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003247 undefine this when you're short of memory.
3248
Peter Tyser2fb26042009-01-27 18:03:12 -06003249- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3250 width of the commands listed in the 'help' command output.
3251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003252- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003253 prompt for user input.
3254
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003255- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003257- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003261- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003262 the application (usually a Linux kernel) when it is
3263 booted
3264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003265- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003266 List of legal baudrate settings for this board.
3267
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003268- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003269 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003271- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003272 If the board specific function
3273 extern int overwrite_console (void);
3274 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003275 serial port, else the settings in the environment are used.
3276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003277- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003278 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003280- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003281 Enable overwrite of previous console environment settings.
3282
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003283- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003284 Begin and End addresses of the area used by the
3285 simple memory test.
3286
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003287- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003288 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003290- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003291 Scratch address used by the alternate memory test
3292 You only need to set this if address zero isn't writeable
3293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003294- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3295 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003296 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003297 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003298 fixing up gd->ram_size the Linux kernel should gets passed
3299 the now "corrected" memory size and won't touch it either.
3300 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003301 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003302 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003303 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003304
3305 This option can be used as a workaround for the 440EPx/GRx
3306 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3307 be touched.
3308
3309 WARNING: Please make sure that this value is a multiple of
3310 the Linux page size (normally 4k). If this is not the case,
3311 then the end address of the Linux memory will be located at a
3312 non page size aligned address and this could cause major
3313 problems.
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003316 Enable temporary baudrate change while serial download
3317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003318- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003319 Physical start address of SDRAM. _Must_ be 0 here.
3320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003321- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003322 Physical start address of Motherboard I/O (if using a
3323 Cogent motherboard)
3324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003325- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003326 Physical start address of Flash memory.
3327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003328- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003329 Physical start address of boot monitor code (set by
3330 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003331 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003332 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003334- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003335 Size of memory reserved for monitor code, used to
3336 determine _at_compile_time_ (!) if the environment is
3337 embedded within the U-Boot image, or in a separate
3338 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003340- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003341 Size of DRAM reserved for malloc() use.
3342
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003343- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003344 Normally compressed uImages are limited to an
3345 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003346 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003347 to adjust this setting to your needs.
3348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003349- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003350 Maximum size of memory mapped by the startup code of
3351 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003352 the Linux kernel (bd_info, boot arguments, FDT blob if
3353 used) must be put below this limit, unless "bootm_low"
3354 enviroment variable is defined and non-zero. In such case
3355 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003356 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003357 variable "bootm_mapsize" will override the value of
3358 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3359 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003360
John Rigbyfca43cc2010-10-13 13:57:35 -06003361- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3362 Enable initrd_high functionality. If defined then the
3363 initrd_high feature is enabled and the bootm ramdisk subcommand
3364 is enabled.
3365
3366- CONFIG_SYS_BOOT_GET_CMDLINE:
3367 Enables allocating and saving kernel cmdline in space between
3368 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3369
3370- CONFIG_SYS_BOOT_GET_KBD:
3371 Enables allocating and saving a kernel copy of the bd_info in
3372 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003374- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003375 Max number of Flash memory banks
3376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003377- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003378 Max number of sectors on a Flash chip
3379
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003380- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003381 Timeout for Flash erase operations (in ms)
3382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003383- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003384 Timeout for Flash write operations (in ms)
3385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003386- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003387 Timeout for Flash set sector lock bit operation (in ms)
3388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003389- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003390 Timeout for Flash clear lock bits operation (in ms)
3391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003393 If defined, hardware flash sectors protection is used
3394 instead of U-Boot software protection.
3395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003396- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003397
3398 Enable TFTP transfers directly to flash memory;
3399 without this option such a download has to be
3400 performed in two steps: (1) download to RAM, and (2)
3401 copy from RAM to flash.
3402
3403 The two-step approach is usually more reliable, since
3404 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003405 the flash, but in some situations (when system RAM is
3406 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003407 downloaded image) this option may be very useful.
3408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003409- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003410 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003411 common flash structure for storing flash geometry.
3412
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003413- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003414 This option also enables the building of the cfi_flash driver
3415 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003416
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003417- CONFIG_FLASH_CFI_MTD
3418 This option enables the building of the cfi_mtd driver
3419 in the drivers directory. The driver exports CFI flash
3420 to the MTD layer.
3421
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003422- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003423 Use buffered writes to flash.
3424
3425- CONFIG_FLASH_SPANSION_S29WS_N
3426 s29ws-n MirrorBit flash has non-standard addresses for buffered
3427 write commands.
3428
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003429- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003430 If this option is defined, the common CFI flash doesn't
3431 print it's warning upon not recognized FLASH banks. This
3432 is useful, if some of the configured banks are only
3433 optionally available.
3434
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003435- CONFIG_FLASH_SHOW_PROGRESS
3436 If defined (must be an integer), print out countdown
3437 digits and dots. Recommended value: 45 (9..1) for 80
3438 column displays, 15 (3..1) for 40 column displays.
3439
Stefan Roese352ef3f2013-04-04 15:53:14 +02003440- CONFIG_FLASH_VERIFY
3441 If defined, the content of the flash (destination) is compared
3442 against the source after the write operation. An error message
3443 will be printed when the contents are not identical.
3444 Please note that this option is useless in nearly all cases,
3445 since such flash programming errors usually are detected earlier
3446 while unprotecting/erasing/programming. Please only enable
3447 this option if you really know what you are doing.
3448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003449- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003450 Defines the number of Ethernet receive buffers. On some
3451 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003452 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3453 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003454 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003455 Defaults to 4 if not defined.
3456
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003457- CONFIG_ENV_MAX_ENTRIES
3458
Wolfgang Denk071bc922010-10-27 22:48:30 +02003459 Maximum number of entries in the hash table that is used
3460 internally to store the environment settings. The default
3461 setting is supposed to be generous and should work in most
3462 cases. This setting can be used to tune behaviour; see
3463 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003464
Joe Hershberger25980902012-12-11 22:16:31 -06003465- CONFIG_ENV_FLAGS_LIST_DEFAULT
3466- CONFIG_ENV_FLAGS_LIST_STATIC
3467 Enable validation of the values given to enviroment variables when
3468 calling env set. Variables can be restricted to only decimal,
3469 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3470 the variables can also be restricted to IP address or MAC address.
3471
3472 The format of the list is:
3473 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003474 access_atribute = [a|r|o|c]
3475 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003476 entry = variable_name[:attributes]
3477 list = entry[,list]
3478
3479 The type attributes are:
3480 s - String (default)
3481 d - Decimal
3482 x - Hexadecimal
3483 b - Boolean ([1yYtT|0nNfF])
3484 i - IP address
3485 m - MAC address
3486
Joe Hershberger267541f2012-12-11 22:16:34 -06003487 The access attributes are:
3488 a - Any (default)
3489 r - Read-only
3490 o - Write-once
3491 c - Change-default
3492
Joe Hershberger25980902012-12-11 22:16:31 -06003493 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3494 Define this to a list (string) to define the ".flags"
3495 envirnoment variable in the default or embedded environment.
3496
3497 - CONFIG_ENV_FLAGS_LIST_STATIC
3498 Define this to a list (string) to define validation that
3499 should be done if an entry is not found in the ".flags"
3500 environment variable. To override a setting in the static
3501 list, simply add an entry for the same variable name to the
3502 ".flags" variable.
3503
Joe Hershberger267541f2012-12-11 22:16:34 -06003504- CONFIG_ENV_ACCESS_IGNORE_FORCE
3505 If defined, don't allow the -f switch to env set override variable
3506 access flags.
3507
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003508- CONFIG_SYS_GENERIC_BOARD
3509 This selects the architecture-generic board system instead of the
3510 architecture-specific board files. It is intended to move boards
3511 to this new framework over time. Defining this will disable the
3512 arch/foo/lib/board.c file and use common/board_f.c and
3513 common/board_r.c instead. To use this option your architecture
3514 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3515 its config.mk file). If you find problems enabling this option on
3516 your board please report the problem and send patches!
3517
Simon Glass632efa72013-03-11 07:06:48 +00003518- CONFIG_SYS_SYM_OFFSETS
3519 This is set by architectures that use offsets for link symbols
3520 instead of absolute values. So bss_start is obtained using an
3521 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3522 directly. You should not need to touch this setting.
3523
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003524- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3525 This is set by OMAP boards for the max time that reset should
3526 be asserted. See doc/README.omap-reset-time for details on how
3527 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003528
wdenkc6097192002-11-03 00:24:07 +00003529The following definitions that deal with the placement and management
3530of environment data (variable area); in general, we support the
3531following configurations:
3532
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003533- CONFIG_BUILD_ENVCRC:
3534
3535 Builds up envcrc with the target environment so that external utils
3536 may easily extract it and embed it in final U-Boot images.
3537
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003538- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003539
3540 Define this if the environment is in flash memory.
3541
3542 a) The environment occupies one whole flash sector, which is
3543 "embedded" in the text segment with the U-Boot code. This
3544 happens usually with "bottom boot sector" or "top boot
3545 sector" type flash chips, which have several smaller
3546 sectors at the start or the end. For instance, such a
3547 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3548 such a case you would place the environment in one of the
3549 4 kB sectors - with U-Boot code before and after it. With
3550 "top boot sector" type flash chips, you would put the
3551 environment in one of the last sectors, leaving a gap
3552 between U-Boot and the environment.
3553
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003554 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003555
3556 Offset of environment data (variable area) to the
3557 beginning of flash memory; for instance, with bottom boot
3558 type flash chips the second sector can be used: the offset
3559 for this sector is given here.
3560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003561 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003562
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003563 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003564
3565 This is just another way to specify the start address of
3566 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003567 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003568
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003569 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003570
3571 Size of the sector containing the environment.
3572
3573
3574 b) Sometimes flash chips have few, equal sized, BIG sectors.
3575 In such a case you don't want to spend a whole sector for
3576 the environment.
3577
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003578 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003579
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003580 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003581 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003582 of this flash sector for the environment. This saves
3583 memory for the RAM copy of the environment.
3584
3585 It may also save flash memory if you decide to use this
3586 when your environment is "embedded" within U-Boot code,
3587 since then the remainder of the flash sector could be used
3588 for U-Boot code. It should be pointed out that this is
3589 STRONGLY DISCOURAGED from a robustness point of view:
3590 updating the environment in flash makes it always
3591 necessary to erase the WHOLE sector. If something goes
3592 wrong before the contents has been restored from a copy in
3593 RAM, your target system will be dead.
3594
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003595 - CONFIG_ENV_ADDR_REDUND
3596 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003597
wdenk43d96162003-03-06 00:02:04 +00003598 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003599 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003600 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003601 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003602
3603BE CAREFUL! Any changes to the flash layout, and some changes to the
3604source code will make it necessary to adapt <board>/u-boot.lds*
3605accordingly!
3606
3607
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003608- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003609
3610 Define this if you have some non-volatile memory device
3611 (NVRAM, battery buffered SRAM) which you want to use for the
3612 environment.
3613
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003614 - CONFIG_ENV_ADDR:
3615 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003616
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003617 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003618 want to use for environment. It is assumed that this memory
3619 can just be read and written to, without any special
3620 provision.
3621
3622BE CAREFUL! The first access to the environment happens quite early
3623in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003624console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003625U-Boot will hang.
3626
3627Please note that even with NVRAM we still use a copy of the
3628environment in RAM: we could work on NVRAM directly, but we want to
3629keep settings there always unmodified except somebody uses "saveenv"
3630to save the current settings.
3631
3632
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003633- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003634
3635 Use this if you have an EEPROM or similar serial access
3636 device and a driver for it.
3637
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003638 - CONFIG_ENV_OFFSET:
3639 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003640
3641 These two #defines specify the offset and size of the
3642 environment area within the total memory of your EEPROM.
3643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003644 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003645 If defined, specified the chip address of the EEPROM device.
3646 The default address is zero.
3647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003648 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003649 If defined, the number of bits used to address bytes in a
3650 single page in the EEPROM device. A 64 byte page, for example
3651 would require six bits.
3652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003653 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003654 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003655 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003657 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003658 The length in bytes of the EEPROM memory array address. Note
3659 that this is NOT the chip address length!
3660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003661 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003662 EEPROM chips that implement "address overflow" are ones
3663 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3664 address and the extra bits end up in the "chip address" bit
3665 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3666 byte chips.
3667
3668 Note that we consider the length of the address field to
3669 still be one byte because the extra address bits are hidden
3670 in the chip address.
3671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003672 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003673 The size in bytes of the EEPROM device.
3674
Heiko Schocher548738b2010-01-07 08:55:40 +01003675 - CONFIG_ENV_EEPROM_IS_ON_I2C
3676 define this, if you have I2C and SPI activated, and your
3677 EEPROM, which holds the environment, is on the I2C bus.
3678
3679 - CONFIG_I2C_ENV_EEPROM_BUS
3680 if you have an Environment on an EEPROM reached over
3681 I2C muxes, you can define here, how to reach this
3682 EEPROM. For example:
3683
Heiko Schocherea818db2013-01-29 08:53:15 +01003684 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003685
3686 EEPROM which holds the environment, is reached over
3687 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003688
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003689- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003690
wdenkd4ca31c2004-01-02 14:00:00 +00003691 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003692 want to use for the environment.
3693
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003694 - CONFIG_ENV_OFFSET:
3695 - CONFIG_ENV_ADDR:
3696 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003697
3698 These three #defines specify the offset and size of the
3699 environment area within the total memory of your DataFlash placed
3700 at the specified address.
3701
Liu Gang0a85a9e2012-03-08 00:33:20 +00003702- CONFIG_ENV_IS_IN_REMOTE:
3703
3704 Define this if you have a remote memory space which you
3705 want to use for the local device's environment.
3706
3707 - CONFIG_ENV_ADDR:
3708 - CONFIG_ENV_SIZE:
3709
3710 These two #defines specify the address and size of the
3711 environment area within the remote memory space. The
3712 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003713 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003714
3715BE CAREFUL! For some special cases, the local device can not use
3716"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003717environment stored in a remote NOR flash by SRIO or PCIE link,
3718but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003719
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003720- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003721
3722 Define this if you have a NAND device which you want to use
3723 for the environment.
3724
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003725 - CONFIG_ENV_OFFSET:
3726 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003727
3728 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003729 area within the first NAND device. CONFIG_ENV_OFFSET must be
3730 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003731
Scott Woodfdd813d2010-09-17 14:38:37 -05003732 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003733
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003734 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003735 size used to hold a redundant copy of the environment data, so
3736 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003737 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003738 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003739
Scott Woodfdd813d2010-09-17 14:38:37 -05003740 - CONFIG_ENV_RANGE (optional):
3741
3742 Specifies the length of the region in which the environment
3743 can be written. This should be a multiple of the NAND device's
3744 block size. Specifying a range with more erase blocks than
3745 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3746 the range to be avoided.
3747
3748 - CONFIG_ENV_OFFSET_OOB (optional):
3749
3750 Enables support for dynamically retrieving the offset of the
3751 environment from block zero's out-of-band data. The
3752 "nand env.oob" command can be used to record this offset.
3753 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3754 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003755
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003756- CONFIG_NAND_ENV_DST
3757
3758 Defines address in RAM to which the nand_spl code should copy the
3759 environment. If redundant environment is used, it will be copied to
3760 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3761
Joe Hershberger2b744332013-04-08 10:32:51 +00003762- CONFIG_ENV_IS_IN_UBI:
3763
3764 Define this if you have an UBI volume that you want to use for the
3765 environment. This has the benefit of wear-leveling the environment
3766 accesses, which is important on NAND.
3767
3768 - CONFIG_ENV_UBI_PART:
3769
3770 Define this to a string that is the mtd partition containing the UBI.
3771
3772 - CONFIG_ENV_UBI_VOLUME:
3773
3774 Define this to the name of the volume that you want to store the
3775 environment in.
3776
Joe Hershberger785881f2013-04-08 10:32:52 +00003777 - CONFIG_ENV_UBI_VOLUME_REDUND:
3778
3779 Define this to the name of another volume to store a second copy of
3780 the environment in. This will enable redundant environments in UBI.
3781 It is assumed that both volumes are in the same MTD partition.
3782
Joe Hershberger2b744332013-04-08 10:32:51 +00003783 - CONFIG_UBI_SILENCE_MSG
3784 - CONFIG_UBIFS_SILENCE_MSG
3785
3786 You will probably want to define these to avoid a really noisy system
3787 when storing the env in UBI.
3788
Stephen Warren06e4ae52013-06-11 15:14:00 -06003789- CONFIG_ENV_IS_IN_MMC:
3790
3791 Define this if you have an MMC device which you want to use for the
3792 environment.
3793
3794 - CONFIG_SYS_MMC_ENV_DEV:
3795
3796 Specifies which MMC device the environment is stored in.
3797
3798 - CONFIG_SYS_MMC_ENV_PART (optional):
3799
3800 Specifies which MMC partition the environment is stored in. If not
3801 set, defaults to partition 0, the user area. Common values might be
3802 1 (first MMC boot partition), 2 (second MMC boot partition).
3803
3804 - CONFIG_ENV_OFFSET:
3805 - CONFIG_ENV_SIZE:
3806
3807 These two #defines specify the offset and size of the environment
3808 area within the specified MMC device.
3809
Stephen Warren5c088ee2013-06-11 15:14:02 -06003810 If offset is positive (the usual case), it is treated as relative to
3811 the start of the MMC partition. If offset is negative, it is treated
3812 as relative to the end of the MMC partition. This can be useful if
3813 your board may be fitted with different MMC devices, which have
3814 different sizes for the MMC partitions, and you always want the
3815 environment placed at the very end of the partition, to leave the
3816 maximum possible space before it, to store other data.
3817
Stephen Warren06e4ae52013-06-11 15:14:00 -06003818 These two values are in units of bytes, but must be aligned to an
3819 MMC sector boundary.
3820
3821 - CONFIG_ENV_OFFSET_REDUND (optional):
3822
3823 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3824 hold a redundant copy of the environment data. This provides a
3825 valid backup copy in case the other copy is corrupted, e.g. due
3826 to a power failure during a "saveenv" operation.
3827
Stephen Warren5c088ee2013-06-11 15:14:02 -06003828 This value may also be positive or negative; this is handled in the
3829 same way as CONFIG_ENV_OFFSET.
3830
Stephen Warren06e4ae52013-06-11 15:14:00 -06003831 This value is also in units of bytes, but must also be aligned to
3832 an MMC sector boundary.
3833
3834 - CONFIG_ENV_SIZE_REDUND (optional):
3835
3836 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3837 set. If this value is set, it must be set to the same value as
3838 CONFIG_ENV_SIZE.
3839
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003840- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003841
3842 Defines offset to the initial SPI buffer area in DPRAM. The
3843 area is used at an early stage (ROM part) if the environment
3844 is configured to reside in the SPI EEPROM: We need a 520 byte
3845 scratch DPRAM area. It is used between the two initialization
3846 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3847 to be a good choice since it makes it far enough from the
3848 start of the data area as well as from the stack pointer.
3849
Bruce Adlere881cb52007-11-02 13:15:42 -07003850Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003851has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003852created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003853until then to read environment variables.
3854
wdenk85ec0bc2003-03-31 16:34:49 +00003855The environment is protected by a CRC32 checksum. Before the monitor
3856is relocated into RAM, as a result of a bad CRC you will be working
3857with the compiled-in default environment - *silently*!!! [This is
3858necessary, because the first environment variable we need is the
3859"baudrate" setting for the console - if we have a bad CRC, we don't
3860have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003861
3862Note: once the monitor has been relocated, then it will complain if
3863the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003864use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003865
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003866- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003867 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003869 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003870 also needs to be defined.
3871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003872- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003873 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003874
Ron Madridf5675aa2009-02-18 14:30:44 -08003875- CONFIG_NS16550_MIN_FUNCTIONS:
3876 Define this if you desire to only have use of the NS16550_init
3877 and NS16550_putc functions for the serial driver located at
3878 drivers/serial/ns16550.c. This option is useful for saving
3879 space for already greatly restricted images, including but not
3880 limited to NAND_SPL configurations.
3881
Simon Glassb2b92f52012-11-30 13:01:18 +00003882- CONFIG_DISPLAY_BOARDINFO
3883 Display information about the board that U-Boot is running on
3884 when U-Boot starts up. The board function checkboard() is called
3885 to do this.
3886
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003887- CONFIG_DISPLAY_BOARDINFO_LATE
3888 Similar to the previous option, but display this information
3889 later, once stdio is running and output goes to the LCD, if
3890 present.
3891
wdenkc6097192002-11-03 00:24:07 +00003892Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003893---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003895- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003896 Cache Line Size of the CPU.
3897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003898- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003899 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003900
wdenk42d1f032003-10-15 23:53:47 +00003901 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3902 and RPXsuper) to be able to adjust the position of
3903 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003904
Timur Tabie46fedf2011-08-04 18:03:41 -05003905- CONFIG_SYS_CCSRBAR_DEFAULT:
3906 Default (power-on reset) physical address of CCSR on Freescale
3907 PowerPC SOCs.
3908
3909- CONFIG_SYS_CCSRBAR:
3910 Virtual address of CCSR. On a 32-bit build, this is typically
3911 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3912
3913 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3914 for cross-platform code that uses that macro instead.
3915
3916- CONFIG_SYS_CCSRBAR_PHYS:
3917 Physical address of CCSR. CCSR can be relocated to a new
3918 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003919 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003920 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3921 is typically relocated on 36-bit builds. It is recommended
3922 that this macro be defined via the _HIGH and _LOW macros:
3923
3924 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3925 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3926
3927- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003928 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3929 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003930 used in assembly code, so it must not contain typecasts or
3931 integer size suffixes (e.g. "ULL").
3932
3933- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3934 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3935 used in assembly code, so it must not contain typecasts or
3936 integer size suffixes (e.g. "ULL").
3937
3938- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3939 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3940 forced to a value that ensures that CCSR is not relocated.
3941
wdenk7f6c2cb2002-11-10 22:06:23 +00003942- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003943 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003944
3945 the default drive number (default value 0)
3946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003947 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003948
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003949 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003950 (default value 1)
3951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003952 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003953
wdenk43d96162003-03-06 00:02:04 +00003954 defines the offset of register from address. It
3955 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003956 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003957
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003958 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3959 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003960 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003961
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003962 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003963 fdc_hw_init() is called at the beginning of the FDC
3964 setup. fdc_hw_init() must be provided by the board
3965 source code. It is used to make hardware dependant
3966 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003967
Macpaul Lin0abddf82011-04-11 20:45:32 +00003968- CONFIG_IDE_AHB:
3969 Most IDE controllers were designed to be connected with PCI
3970 interface. Only few of them were designed for AHB interface.
3971 When software is doing ATA command and data transfer to
3972 IDE devices through IDE-AHB controller, some additional
3973 registers accessing to these kind of IDE-AHB controller
3974 is requierd.
3975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003976- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003977 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003978 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003979
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003980- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk7152b1d2003-09-05 23:19:14 +00003982 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003983 initial data and stack; please note that this must be
3984 writable memory that is working WITHOUT special
3985 initialization, i. e. you CANNOT use normal RAM which
3986 will become available only after programming the
3987 memory controller and running certain initialization
3988 sequences.
3989
3990 U-Boot uses the following memory types:
3991 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3992 - MPC824X: data cache
3993 - PPC4xx: data cache
3994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003995- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003996
3997 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003998 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3999 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004000 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004001 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004002 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4003 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4004 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004005
4006 Note:
4007 On the MPC824X (or other systems that use the data
4008 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004009 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004010 point to an otherwise UNUSED address space between
4011 the top of RAM and the start of the PCI space.
4012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004013- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004015- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004016
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004017- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004019- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004021- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004023- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004025- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004026 SDRAM timing
4027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004028- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004029 periodic timer for refresh
4030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004031- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004033- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4034 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4035 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4036 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004037 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4038
4039- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004040 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4041 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004042 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004044- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4045 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004046 Machine Mode Register and Memory Periodic Timer
4047 Prescaler definitions (SDRAM timing)
4048
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004049- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004050 enable I2C microcode relocation patch (MPC8xx);
4051 define relocation offset in DPRAM [DSP2]
4052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004053- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004054 enable SMC microcode relocation patch (MPC8xx);
4055 define relocation offset in DPRAM [SMC1]
4056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004057- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004058 enable SPI microcode relocation patch (MPC8xx);
4059 define relocation offset in DPRAM [SCC4]
4060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004061- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004062 Use OSCM clock mode on MBX8xx board. Be careful,
4063 wrong setting might damage your board. Read
4064 doc/README.MBX before setting this variable!
4065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004066- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004067 Offset of the bootmode word in DPRAM used by post
4068 (Power On Self Tests). This definition overrides
4069 #define'd default value in commproc.h resp.
4070 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4073 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4074 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4075 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4076 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4077 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4078 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4079 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004080 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004081
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004082- CONFIG_PCI_DISABLE_PCIE:
4083 Disable PCI-Express on systems where it is supported but not
4084 required.
4085
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004086- CONFIG_PCI_ENUM_ONLY
4087 Only scan through and get the devices on the busses.
4088 Don't do any setup work, presumably because someone or
4089 something has already done it, and we don't need to do it
4090 a second time. Useful for platforms that are pre-booted
4091 by coreboot or similar.
4092
Gabor Juhos842033e2013-05-30 07:06:12 +00004093- CONFIG_PCI_INDIRECT_BRIDGE:
4094 Enable support for indirect PCI bridges.
4095
Kumar Galaa09b9b62010-12-30 12:09:53 -06004096- CONFIG_SYS_SRIO:
4097 Chip has SRIO or not
4098
4099- CONFIG_SRIO1:
4100 Board has SRIO 1 port available
4101
4102- CONFIG_SRIO2:
4103 Board has SRIO 2 port available
4104
Liu Gangc8b28152013-05-07 16:30:46 +08004105- CONFIG_SRIO_PCIE_BOOT_MASTER
4106 Board can support master function for Boot from SRIO and PCIE
4107
Kumar Galaa09b9b62010-12-30 12:09:53 -06004108- CONFIG_SYS_SRIOn_MEM_VIRT:
4109 Virtual Address of SRIO port 'n' memory region
4110
4111- CONFIG_SYS_SRIOn_MEM_PHYS:
4112 Physical Address of SRIO port 'n' memory region
4113
4114- CONFIG_SYS_SRIOn_MEM_SIZE:
4115 Size of SRIO port 'n' memory region
4116
Fabio Estevam66bd1842013-04-11 09:35:34 +00004117- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4118 Defined to tell the NAND controller that the NAND chip is using
4119 a 16 bit bus.
4120 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004121 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004122 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004123 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004124
4125- CONFIG_SYS_NDFC_EBC0_CFG
4126 Sets the EBC0_CFG register for the NDFC. If not defined
4127 a default value will be used.
4128
Ben Warrenbb99ad62006-09-07 16:50:54 -04004129- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004130 Get DDR timing information from an I2C EEPROM. Common
4131 with pluggable memory modules such as SODIMMs
4132
Ben Warrenbb99ad62006-09-07 16:50:54 -04004133 SPD_EEPROM_ADDRESS
4134 I2C address of the SPD EEPROM
4135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004136- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004137 If SPD EEPROM is on an I2C bus other than the first
4138 one, specify here. Note that the value must resolve
4139 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004140
York Sun1b3e3c42011-06-07 09:42:16 +08004141- CONFIG_SYS_DDR_RAW_TIMING
4142 Get DDR timing information from other than SPD. Common with
4143 soldered DDR chips onboard without SPD. DDR raw timing
4144 parameters are extracted from datasheet and hard-coded into
4145 header files or board specific files.
4146
York Sun6f5e1dc2011-09-16 13:21:35 -07004147- CONFIG_FSL_DDR_INTERACTIVE
4148 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004150- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004151 Only for 83xx systems. If specified, then DDR should
4152 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004153
wdenkc26e4542004-04-18 10:13:26 +00004154- CONFIG_ETHER_ON_FEC[12]
4155 Define to enable FEC[12] on a 8xx series processor.
4156
4157- CONFIG_FEC[12]_PHY
4158 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004159 to the given FEC; i. e.
4160 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004161 means that the PHY with address 4 is connected to FEC1
4162
4163 When set to -1, means to probe for first available.
4164
4165- CONFIG_FEC[12]_PHY_NORXERR
4166 The PHY does not have a RXERR line (RMII only).
4167 (so program the FEC to ignore it).
4168
4169- CONFIG_RMII
4170 Enable RMII mode for all FECs.
4171 Note that this is a global option, we can't
4172 have one FEC in standard MII mode and another in RMII mode.
4173
wdenk5cf91d62004-04-23 20:32:05 +00004174- CONFIG_CRC32_VERIFY
4175 Add a verify option to the crc32 command.
4176 The syntax is:
4177
4178 => crc32 -v <address> <count> <crc32>
4179
4180 Where address/count indicate a memory area
4181 and crc32 is the correct crc32 which the
4182 area should have.
4183
wdenk56523f12004-07-11 17:40:54 +00004184- CONFIG_LOOPW
4185 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004186 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004187
stroese7b466642004-12-16 18:46:55 +00004188- CONFIG_MX_CYCLIC
4189 Add the "mdc" and "mwc" memory commands. These are cyclic
4190 "md/mw" commands.
4191 Examples:
4192
wdenkefe2a4d2004-12-16 21:44:03 +00004193 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004194 This command will print 4 bytes (10,11,12,13) each 500 ms.
4195
wdenkefe2a4d2004-12-16 21:44:03 +00004196 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004197 This command will write 12345678 to address 100 all 10 ms.
4198
wdenkefe2a4d2004-12-16 21:44:03 +00004199 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004200 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004201
wdenk8aa1a2d2005-04-04 12:44:11 +00004202- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004203 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004204 low level initializations (like setting up the memory
4205 controller) are omitted and/or U-Boot does not
4206 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004207
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004208 Normally this variable MUST NOT be defined. The only
4209 exception is when U-Boot is loaded (to RAM) by some
4210 other boot loader or by a debugger which performs
4211 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004212
Aneesh V401bb302011-07-13 05:11:07 +00004213- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004214 Modifies the behaviour of start.S when compiling a loader
4215 that is executed before the actual U-Boot. E.g. when
4216 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004217
Ying Zhang5df572f2013-05-20 14:07:23 +08004218- CONFIG_SYS_MPC85XX_NO_RESETVEC
4219 Only for 85xx systems. If this variable is specified, the section
4220 .resetvec is not kept and the section .bootpg is placed in the
4221 previous 4k of the .text section.
4222
Simon Glass4213fc22013-02-24 17:33:14 +00004223- CONFIG_ARCH_MAP_SYSMEM
4224 Generally U-Boot (and in particular the md command) uses
4225 effective address. It is therefore not necessary to regard
4226 U-Boot address as virtual addresses that need to be translated
4227 to physical addresses. However, sandbox requires this, since
4228 it maintains its own little RAM buffer which contains all
4229 addressable memory. This option causes some memory accesses
4230 to be mapped through map_sysmem() / unmap_sysmem().
4231
Matthias Weisserd8834a12011-03-10 21:36:32 +00004232- CONFIG_USE_ARCH_MEMCPY
4233 CONFIG_USE_ARCH_MEMSET
4234 If these options are used a optimized version of memcpy/memset will
4235 be used if available. These functions may be faster under some
4236 conditions but may increase the binary size.
4237
Simon Glass588a13f2013-02-14 04:18:54 +00004238- CONFIG_X86_RESET_VECTOR
4239 If defined, the x86 reset vector code is included. This is not
4240 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004241
Mark Jacksonfc337052013-03-04 01:27:20 +00004242- CONFIG_SYS_MPUCLK
4243 Defines the MPU clock speed (in MHz).
4244
4245 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004246
Timur Tabif2717b42011-11-22 09:21:25 -06004247Freescale QE/FMAN Firmware Support:
4248-----------------------------------
4249
4250The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4251loading of "firmware", which is encoded in the QE firmware binary format.
4252This firmware often needs to be loaded during U-Boot booting, so macros
4253are used to identify the storage device (NOR flash, SPI, etc) and the address
4254within that device.
4255
4256- CONFIG_SYS_QE_FMAN_FW_ADDR
4257 The address in the storage device where the firmware is located. The
4258 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4259 is also specified.
4260
4261- CONFIG_SYS_QE_FMAN_FW_LENGTH
4262 The maximum possible size of the firmware. The firmware binary format
4263 has a field that specifies the actual size of the firmware, but it
4264 might not be possible to read any part of the firmware unless some
4265 local storage is allocated to hold the entire firmware first.
4266
4267- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4268 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4269 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4270 virtual address in NOR flash.
4271
4272- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4273 Specifies that QE/FMAN firmware is located in NAND flash.
4274 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4275
4276- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4277 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4278 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4279
4280- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4281 Specifies that QE/FMAN firmware is located on the primary SPI
4282 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4283
Liu Gang292dc6c2012-03-08 00:33:18 +00004284- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4285 Specifies that QE/FMAN firmware is located in the remote (master)
4286 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004287 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4288 window->master inbound window->master LAW->the ucode address in
4289 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004290
wdenkc6097192002-11-03 00:24:07 +00004291Building the Software:
4292======================
4293
Wolfgang Denk218ca722008-03-26 10:40:12 +01004294Building U-Boot has been tested in several native build environments
4295and in many different cross environments. Of course we cannot support
4296all possibly existing versions of cross development tools in all
4297(potentially obsolete) versions. In case of tool chain problems we
4298recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4299which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004300
Wolfgang Denk218ca722008-03-26 10:40:12 +01004301If you are not using a native environment, it is assumed that you
4302have GNU cross compiling tools available in your path. In this case,
4303you must set the environment variable CROSS_COMPILE in your shell.
4304Note that no changes to the Makefile or any other source files are
4305necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004306
Wolfgang Denk218ca722008-03-26 10:40:12 +01004307 $ CROSS_COMPILE=ppc_4xx-
4308 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004309
Peter Tyser2f8d3962009-03-13 18:54:51 -05004310Note: If you wish to generate Windows versions of the utilities in
4311 the tools directory you can use the MinGW toolchain
4312 (http://www.mingw.org). Set your HOST tools to the MinGW
4313 toolchain and execute 'make tools'. For example:
4314
4315 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4316
4317 Binaries such as tools/mkimage.exe will be created which can
4318 be executed on computers running Windows.
4319
Wolfgang Denk218ca722008-03-26 10:40:12 +01004320U-Boot is intended to be simple to build. After installing the
4321sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004322is done by typing:
4323
4324 make NAME_config
4325
Wolfgang Denk218ca722008-03-26 10:40:12 +01004326where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004327rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004328
wdenk2729af92004-05-03 20:45:30 +00004329Note: for some board special configuration names may exist; check if
4330 additional information is available from the board vendor; for
4331 instance, the TQM823L systems are available without (standard)
4332 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004333 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335 make TQM823L_config
4336 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338 make TQM823L_LCD_config
4339 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004340
wdenk2729af92004-05-03 20:45:30 +00004341 etc.
wdenkc6097192002-11-03 00:24:07 +00004342
wdenkc6097192002-11-03 00:24:07 +00004343
wdenk2729af92004-05-03 20:45:30 +00004344Finally, type "make all", and you should get some working U-Boot
4345images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004346
wdenk2729af92004-05-03 20:45:30 +00004347- "u-boot.bin" is a raw binary image
4348- "u-boot" is an image in ELF binary format
4349- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004350
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004351By default the build is performed locally and the objects are saved
4352in the source directory. One of the two methods can be used to change
4353this behavior and build U-Boot to some external directory:
4354
43551. Add O= to the make command line invocations:
4356
4357 make O=/tmp/build distclean
4358 make O=/tmp/build NAME_config
4359 make O=/tmp/build all
4360
43612. Set environment variable BUILD_DIR to point to the desired location:
4362
4363 export BUILD_DIR=/tmp/build
4364 make distclean
4365 make NAME_config
4366 make all
4367
4368Note that the command line "O=" setting overrides the BUILD_DIR environment
4369variable.
4370
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372Please be aware that the Makefiles assume you are using GNU make, so
4373for instance on NetBSD you might need to use "gmake" instead of
4374native "make".
wdenkc6097192002-11-03 00:24:07 +00004375
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377If the system board that you have is not listed, then you will need
4378to port U-Boot to your hardware platform. To do this, follow these
4379steps:
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +000043811. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004382 "boards.cfg" file, using the existing entries as examples.
4383 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000043842. Create a new directory to hold your board specific code. Add any
4385 files you need. In your board directory, you will need at least
4386 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
43873. Create a new configuration file "include/configs/<board>.h" for
4388 your board
43893. If you're porting U-Boot to a new CPU, then also create a new
4390 directory to hold your CPU specific code. Add any files you need.
43914. Run "make <board>_config" with your new name.
43925. Type "make", and you should get a working "u-boot.srec" file
4393 to be installed on your target system.
43946. Debug and solve any problems that might arise.
4395 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004396
wdenkc6097192002-11-03 00:24:07 +00004397
wdenk2729af92004-05-03 20:45:30 +00004398Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4399==============================================================
wdenkc6097192002-11-03 00:24:07 +00004400
Wolfgang Denk218ca722008-03-26 10:40:12 +01004401If you have modified U-Boot sources (for instance added a new board
4402or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004403provide feedback to the other developers. The feedback normally takes
4404the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004405official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004406
Wolfgang Denk218ca722008-03-26 10:40:12 +01004407But before you submit such a patch, please verify that your modifi-
4408cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004409the supported boards compile WITHOUT ANY compiler warnings. To do so,
4410just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004411for ALL supported system. Be warned, this will take a while. You can
4412select which (cross) compiler to use by passing a `CROSS_COMPILE'
4413environment variable to the script, i. e. to use the ELDK cross tools
4414you can type
wdenkc6097192002-11-03 00:24:07 +00004415
wdenk2729af92004-05-03 20:45:30 +00004416 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004417
wdenk2729af92004-05-03 20:45:30 +00004418or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk2729af92004-05-03 20:45:30 +00004420 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004421
Wolfgang Denk218ca722008-03-26 10:40:12 +01004422When using the MAKEALL script, the default behaviour is to build
4423U-Boot in the source directory. This location can be changed by
4424setting the BUILD_DIR environment variable. Also, for each target
4425built, the MAKEALL script saves two log files (<target>.ERR and
4426<target>.MAKEALL) in the <source dir>/LOG directory. This default
4427location can be changed by setting the MAKEALL_LOGDIR environment
4428variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004429
4430 export BUILD_DIR=/tmp/build
4431 export MAKEALL_LOGDIR=/tmp/log
4432 CROSS_COMPILE=ppc_8xx- MAKEALL
4433
Wolfgang Denk218ca722008-03-26 10:40:12 +01004434With the above settings build objects are saved in the /tmp/build,
4435log files are saved in the /tmp/log and the source tree remains clean
4436during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004437
4438
wdenk2729af92004-05-03 20:45:30 +00004439See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004440
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442Monitor Commands - Overview:
4443============================
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk2729af92004-05-03 20:45:30 +00004445go - start application at address 'addr'
4446run - run commands in an environment variable
4447bootm - boot application image from memory
4448bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004449bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004450tftpboot- boot image via network using TFTP protocol
4451 and env variables "ipaddr" and "serverip"
4452 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004453tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004454rarpboot- boot image via network using RARP/TFTP protocol
4455diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4456loads - load S-Record file over serial line
4457loadb - load binary file over serial line (kermit mode)
4458md - memory display
4459mm - memory modify (auto-incrementing)
4460nm - memory modify (constant address)
4461mw - memory write (fill)
4462cp - memory copy
4463cmp - memory compare
4464crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004465i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004466sspi - SPI utility commands
4467base - print or set address offset
4468printenv- print environment variables
4469setenv - set environment variables
4470saveenv - save environment variables to persistent storage
4471protect - enable or disable FLASH write protection
4472erase - erase FLASH memory
4473flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004474nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004475bdinfo - print Board Info structure
4476iminfo - print header information for application image
4477coninfo - print console devices and informations
4478ide - IDE sub-system
4479loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004480loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004481mtest - simple RAM test
4482icache - enable or disable instruction cache
4483dcache - enable or disable data cache
4484reset - Perform RESET of the CPU
4485echo - echo args to console
4486version - print monitor version
4487help - print online help
4488? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004489
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491Monitor Commands - Detailed Description:
4492========================================
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494TODO.
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004497
4498
wdenk2729af92004-05-03 20:45:30 +00004499Environment Variables:
4500======================
wdenkc6097192002-11-03 00:24:07 +00004501
wdenk2729af92004-05-03 20:45:30 +00004502U-Boot supports user configuration using Environment Variables which
4503can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004504
wdenk2729af92004-05-03 20:45:30 +00004505Environment Variables are set using "setenv", printed using
4506"printenv", and saved to Flash using "saveenv". Using "setenv"
4507without a value can be used to delete a variable from the
4508environment. As long as you don't save the environment you are
4509working with an in-memory copy. In case the Flash area containing the
4510environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004511
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004512Some configuration options can be set using Environment Variables.
4513
4514List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk2729af92004-05-03 20:45:30 +00004516 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk2729af92004-05-03 20:45:30 +00004520 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk2729af92004-05-03 20:45:30 +00004522 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004525
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004526 bootm_low - Memory range available for image processing in the bootm
4527 command can be restricted. This variable is given as
4528 a hexadecimal number and defines lowest address allowed
4529 for use by the bootm command. See also "bootm_size"
4530 environment variable. Address defined by "bootm_low" is
4531 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004532 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4533 bootm_mapsize.
4534
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004535 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004536 This variable is given as a hexadecimal number and it
4537 defines the size of the memory region starting at base
4538 address bootm_low that is accessible by the Linux kernel
4539 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4540 as the default value if it is defined, and bootm_size is
4541 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004542
4543 bootm_size - Memory range available for image processing in the bootm
4544 command can be restricted. This variable is given as
4545 a hexadecimal number and defines the size of the region
4546 allowed for use by the bootm command. See also "bootm_low"
4547 environment variable.
4548
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004549 updatefile - Location of the software update file on a TFTP server, used
4550 by the automatic software update feature. Please refer to
4551 documentation in doc/README.update for more details.
4552
wdenk2729af92004-05-03 20:45:30 +00004553 autoload - if set to "no" (any string beginning with 'n'),
4554 "bootp" will just load perform a lookup of the
4555 configuration from the BOOTP server, but not try to
4556 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk2729af92004-05-03 20:45:30 +00004558 autostart - if set to "yes", an image loaded using the "bootp",
4559 "rarpboot", "tftpboot" or "diskboot" commands will
4560 be automatically started (by internally calling
4561 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563 If set to "no", a standalone image passed to the
4564 "bootm" command will be copied to the load address
4565 (and eventually uncompressed), but NOT be started.
4566 This can be used to load and uncompress arbitrary
4567 data.
wdenkc6097192002-11-03 00:24:07 +00004568
David A. Longa28afca2011-07-09 16:40:19 -04004569 fdt_high - if set this restricts the maximum address that the
4570 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004571 For example, if you have a system with 1 GB memory
4572 at physical address 0x10000000, while Linux kernel
4573 only recognizes the first 704 MB as low memory, you
4574 may need to set fdt_high as 0x3C000000 to have the
4575 device tree blob be copied to the maximum address
4576 of the 704 MB low memory, so that Linux kernel can
4577 access it during the boot procedure.
4578
David A. Longa28afca2011-07-09 16:40:19 -04004579 If this is set to the special value 0xFFFFFFFF then
4580 the fdt will not be copied at all on boot. For this
4581 to work it must reside in writable memory, have
4582 sufficient padding on the end of it for u-boot to
4583 add the information it needs into it, and the memory
4584 must be accessible by the kernel.
4585
Simon Glasseea63e02011-10-24 19:15:34 +00004586 fdtcontroladdr- if set this is the address of the control flattened
4587 device tree used by U-Boot when CONFIG_OF_CONTROL is
4588 defined.
4589
wdenk17ea1172004-06-06 21:51:03 +00004590 i2cfast - (PPC405GP|PPC405EP only)
4591 if set to 'y' configures Linux I2C driver for fast
4592 mode (400kHZ). This environment variable is used in
4593 initialization code. So, for changes to be effective
4594 it must be saved and board must be reset.
4595
wdenk2729af92004-05-03 20:45:30 +00004596 initrd_high - restrict positioning of initrd images:
4597 If this variable is not set, initrd images will be
4598 copied to the highest possible address in RAM; this
4599 is usually what you want since it allows for
4600 maximum initrd size. If for some reason you want to
4601 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004602 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004603 variable to a value of "no" or "off" or "0".
4604 Alternatively, you can set it to a maximum upper
4605 address to use (U-Boot will still check that it
4606 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608 For instance, when you have a system with 16 MB
4609 RAM, and want to reserve 4 MB from use by Linux,
4610 you can do this by adding "mem=12M" to the value of
4611 the "bootargs" variable. However, now you must make
4612 sure that the initrd image is placed in the first
4613 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004614
wdenk2729af92004-05-03 20:45:30 +00004615 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004616
wdenk2729af92004-05-03 20:45:30 +00004617 If you set initrd_high to 0xFFFFFFFF, this is an
4618 indication to U-Boot that all addresses are legal
4619 for the Linux kernel, including addresses in flash
4620 memory. In this case U-Boot will NOT COPY the
4621 ramdisk at all. This may be useful to reduce the
4622 boot time on your system, but requires that this
4623 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004624
wdenk2729af92004-05-03 20:45:30 +00004625 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk2729af92004-05-03 20:45:30 +00004627 loadaddr - Default load address for commands like "bootp",
4628 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004631
wdenk2729af92004-05-03 20:45:30 +00004632 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004633
wdenk2729af92004-05-03 20:45:30 +00004634 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk2729af92004-05-03 20:45:30 +00004638 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004639
Mike Frysingere2a53452011-10-02 10:01:27 +00004640 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004641
Mike Frysingere2a53452011-10-02 10:01:27 +00004642 ethact - controls which interface is currently active.
4643 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004644
Heiko Schocher48690d82010-07-20 17:45:02 +02004645 => setenv ethact FEC
4646 => ping 192.168.0.1 # traffic sent on FEC
4647 => setenv ethact SCC
4648 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004649
Matthias Fuchse1692572008-01-17 07:45:05 +01004650 ethrotate - When set to "no" U-Boot does not go through all
4651 available network interfaces.
4652 It just stays at the currently selected interface.
4653
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004654 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004655 either succeed or fail without retrying.
4656 When set to "once" the network operation will
4657 fail when all the available network interfaces
4658 are tried once without success.
4659 Useful on scripts which control the retry operation
4660 themselves.
wdenkc6097192002-11-03 00:24:07 +00004661
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004662 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004663
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004664 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004665 UDP source port.
4666
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004667 tftpdstport - If this is set, the value is used for TFTP's UDP
4668 destination port instead of the Well Know Port 69.
4669
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004670 tftpblocksize - Block size to use for TFTP transfers; if not set,
4671 we use the TFTP server's default block size
4672
4673 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4674 seconds, minimum value is 1000 = 1 second). Defines
4675 when a packet is considered to be lost so it has to
4676 be retransmitted. The default is 5000 = 5 seconds.
4677 Lowering this value may make downloads succeed
4678 faster in networks with high packet loss rates or
4679 with unreliable TFTP servers.
4680
4681 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004682 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004683 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004684
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004685The following image location variables contain the location of images
4686used in booting. The "Image" column gives the role of the image and is
4687not an environment variable name. The other columns are environment
4688variable names. "File Name" gives the name of the file on a TFTP
4689server, "RAM Address" gives the location in RAM the image will be
4690loaded to, and "Flash Location" gives the image's address in NOR
4691flash or offset in NAND flash.
4692
4693*Note* - these variables don't have to be defined for all boards, some
4694boards currenlty use other variables for these purposes, and some
4695boards use these variables for other purposes.
4696
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004697Image File Name RAM Address Flash Location
4698----- --------- ----------- --------------
4699u-boot u-boot u-boot_addr_r u-boot_addr
4700Linux kernel bootfile kernel_addr_r kernel_addr
4701device tree blob fdtfile fdt_addr_r fdt_addr
4702ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004703
wdenk2729af92004-05-03 20:45:30 +00004704The following environment variables may be used and automatically
4705updated by the network boot commands ("bootp" and "rarpboot"),
4706depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004707
wdenk2729af92004-05-03 20:45:30 +00004708 bootfile - see above
4709 dnsip - IP address of your Domain Name Server
4710 dnsip2 - IP address of your secondary Domain Name Server
4711 gatewayip - IP address of the Gateway (Router) to use
4712 hostname - Target hostname
4713 ipaddr - see above
4714 netmask - Subnet Mask
4715 rootpath - Pathname of the root filesystem on the NFS server
4716 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004717
wdenka3d991b2004-04-15 21:48:45 +00004718
wdenk2729af92004-05-03 20:45:30 +00004719There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk2729af92004-05-03 20:45:30 +00004721 serial# - contains hardware identification information such
4722 as type string and/or serial number
4723 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk2729af92004-05-03 20:45:30 +00004725These variables can be set only once (usually during manufacturing of
4726the board). U-Boot refuses to delete or overwrite these variables
4727once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004728
4729
wdenk2729af92004-05-03 20:45:30 +00004730Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732 ver - Contains the U-Boot version string as printed
4733 with the "version" command. This variable is
4734 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004735
wdenkc6097192002-11-03 00:24:07 +00004736
wdenk2729af92004-05-03 20:45:30 +00004737Please note that changes to some configuration parameters may take
4738only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004739
stroesec1551ea2003-04-04 15:53:41 +00004740
Joe Hershberger170ab112012-12-11 22:16:24 -06004741Callback functions for environment variables:
4742---------------------------------------------
4743
4744For some environment variables, the behavior of u-boot needs to change
4745when their values are changed. This functionailty allows functions to
4746be associated with arbitrary variables. On creation, overwrite, or
4747deletion, the callback will provide the opportunity for some side
4748effect to happen or for the change to be rejected.
4749
4750The callbacks are named and associated with a function using the
4751U_BOOT_ENV_CALLBACK macro in your board or driver code.
4752
4753These callbacks are associated with variables in one of two ways. The
4754static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4755in the board configuration to a string that defines a list of
4756associations. The list must be in the following format:
4757
4758 entry = variable_name[:callback_name]
4759 list = entry[,list]
4760
4761If the callback name is not specified, then the callback is deleted.
4762Spaces are also allowed anywhere in the list.
4763
4764Callbacks can also be associated by defining the ".callbacks" variable
4765with the same list format above. Any association in ".callbacks" will
4766override any association in the static list. You can define
4767CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4768".callbacks" envirnoment variable in the default or embedded environment.
4769
4770
wdenk2729af92004-05-03 20:45:30 +00004771Command Line Parsing:
4772=====================
stroesec1551ea2003-04-04 15:53:41 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774There are two different command line parsers available with U-Boot:
4775the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004776
wdenk2729af92004-05-03 20:45:30 +00004777Old, simple command line parser:
4778--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780- supports environment variables (through setenv / saveenv commands)
4781- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004782- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004783- special characters ('$', ';') can be escaped by prefixing with '\',
4784 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004785 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004786- You can also escape text by enclosing in single apostrophes, for example:
4787 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004788
wdenk2729af92004-05-03 20:45:30 +00004789Hush shell:
4790-----------
wdenkf07771c2003-05-28 08:06:31 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792- similar to Bourne shell, with control structures like
4793 if...then...else...fi, for...do...done; while...do...done,
4794 until...do...done, ...
4795- supports environment ("global") variables (through setenv / saveenv
4796 commands) and local shell variables (through standard shell syntax
4797 "name=value"); only environment variables can be used with "run"
4798 command
wdenkf07771c2003-05-28 08:06:31 +00004799
wdenk2729af92004-05-03 20:45:30 +00004800General rules:
4801--------------
wdenkf07771c2003-05-28 08:06:31 +00004802
wdenk2729af92004-05-03 20:45:30 +00004803(1) If a command line (or an environment variable executed by a "run"
4804 command) contains several commands separated by semicolon, and
4805 one of these commands fails, then the remaining commands will be
4806 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004807
wdenk2729af92004-05-03 20:45:30 +00004808(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004809 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004810 command will cause "run" to terminate, i. e. the remaining
4811 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004812
wdenk2729af92004-05-03 20:45:30 +00004813Note for Redundant Ethernet Interfaces:
4814=======================================
wdenkf07771c2003-05-28 08:06:31 +00004815
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004816Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004817such configurations and is capable of automatic selection of a
4818"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4821MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4822"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004823
wdenk2729af92004-05-03 20:45:30 +00004824If the network interface stores some valid MAC address (for instance
4825in SROM), this is used as default address if there is NO correspon-
4826ding setting in the environment; if the corresponding environment
4827variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829o If the SROM has a valid MAC address, and there is no address in the
4830 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk2729af92004-05-03 20:45:30 +00004832o If there is no valid address in the SROM, and a definition in the
4833 environment exists, then the value from the environment variable is
4834 used.
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836o If both the SROM and the environment contain a MAC address, and
4837 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk2729af92004-05-03 20:45:30 +00004839o If both the SROM and the environment contain a MAC address, and the
4840 addresses differ, the value from the environment is used and a
4841 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843o If neither SROM nor the environment contain a MAC address, an error
4844 is raised.
wdenkc6097192002-11-03 00:24:07 +00004845
Ben Warrenecee9322010-04-26 11:11:46 -07004846If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004847will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004848may be skipped by setting the appropriate 'ethmacskip' environment variable.
4849The naming convention is as follows:
4850"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852Image Formats:
4853==============
wdenkc6097192002-11-03 00:24:07 +00004854
Marian Balakowicz3310c542008-03-12 12:13:13 +01004855U-Boot is capable of booting (and performing other auxiliary operations on)
4856images in two formats:
4857
4858New uImage format (FIT)
4859-----------------------
4860
4861Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4862to Flattened Device Tree). It allows the use of images with multiple
4863components (several kernels, ramdisks, etc.), with contents protected by
4864SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4865
4866
4867Old uImage format
4868-----------------
4869
4870Old image format is based on binary files which can be basically anything,
4871preceded by a special header; see the definitions in include/image.h for
4872details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4875 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004876 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4877 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4878 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004879* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004880 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4881 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004882* Compression Type (uncompressed, gzip, bzip2)
4883* Load Address
4884* Entry Point
4885* Image Name
4886* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004887
wdenk2729af92004-05-03 20:45:30 +00004888The header is marked by a special Magic Number, and both the header
4889and the data portions of the image are secured against corruption by
4890CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004891
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893Linux Support:
4894==============
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk2729af92004-05-03 20:45:30 +00004896Although U-Boot should support any OS or standalone application
4897easily, the main focus has always been on Linux during the design of
4898U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900U-Boot includes many features that so far have been part of some
4901special "boot loader" code within the Linux kernel. Also, any
4902"initrd" images to be used are no longer part of one big Linux image;
4903instead, kernel and "initrd" are separate images. This implementation
4904serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906- the same features can be used for other OS or standalone
4907 applications (for instance: using compressed images to reduce the
4908 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk2729af92004-05-03 20:45:30 +00004910- it becomes much easier to port new Linux kernel versions because
4911 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913- the same Linux kernel image can now be used with different "initrd"
4914 images; of course this also means that different kernel images can
4915 be run with the same "initrd". This makes testing easier (you don't
4916 have to build a new "zImage.initrd" Linux image when you just
4917 change a file in your "initrd"). Also, a field-upgrade of the
4918 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004919
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk2729af92004-05-03 20:45:30 +00004921Linux HOWTO:
4922============
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk2729af92004-05-03 20:45:30 +00004924Porting Linux to U-Boot based systems:
4925---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk2729af92004-05-03 20:45:30 +00004927U-Boot cannot save you from doing all the necessary modifications to
4928configure the Linux device drivers for use with your target hardware
4929(no, we don't intend to provide a full virtual machine interface to
4930Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004931
Stefan Roesea47a12b2010-04-15 16:07:28 +02004932But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934Just make sure your machine specific header file (for instance
4935include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004936Information structure as we define in include/asm-<arch>/u-boot.h,
4937and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004938as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004939
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk2729af92004-05-03 20:45:30 +00004941Configuring the Linux kernel:
4942-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk2729af92004-05-03 20:45:30 +00004944No specific requirements for U-Boot. Make sure you have some root
4945device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004946
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk2729af92004-05-03 20:45:30 +00004948Building a Linux Image:
4949-----------------------
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk2729af92004-05-03 20:45:30 +00004951With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4952not used. If you use recent kernel source, a new build target
4953"uImage" will exist which automatically builds an image usable by
4954U-Boot. Most older kernels also have support for a "pImage" target,
4955which was introduced for our predecessor project PPCBoot and uses a
4956100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk2729af92004-05-03 20:45:30 +00004958Example:
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk2729af92004-05-03 20:45:30 +00004960 make TQM850L_config
4961 make oldconfig
4962 make dep
4963 make uImage
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk2729af92004-05-03 20:45:30 +00004965The "uImage" build target uses a special tool (in 'tools/mkimage') to
4966encapsulate a compressed Linux kernel image with header information,
4967CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk2729af92004-05-03 20:45:30 +00004969* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk2729af92004-05-03 20:45:30 +00004971* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973 ${CROSS_COMPILE}-objcopy -O binary \
4974 -R .note -R .comment \
4975 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk2729af92004-05-03 20:45:30 +00004977* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004982
wdenk2729af92004-05-03 20:45:30 +00004983 mkimage -A ppc -O linux -T kernel -C gzip \
4984 -a 0 -e 0 -n "Linux Kernel Image" \
4985 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004986
wdenk24ee89b2002-11-03 17:56:27 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988The "mkimage" tool can also be used to create ramdisk images for use
4989with U-Boot, either separated from the Linux kernel image, or
4990combined into one file. "mkimage" encapsulates the images with a 64
4991byte header containing information about target architecture,
4992operating system, image type, compression method, entry points, time
4993stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004994
wdenk2729af92004-05-03 20:45:30 +00004995"mkimage" can be called in two ways: to verify existing images and
4996print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004997
wdenk2729af92004-05-03 20:45:30 +00004998In the first form (with "-l" option) mkimage lists the information
4999contained in the header of an existing U-Boot image; this includes
5000checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005001
wdenk2729af92004-05-03 20:45:30 +00005002 tools/mkimage -l image
5003 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005The second form (with "-d" option) is used to build a U-Boot image
5006from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5009 -n name -d data_file image
5010 -A ==> set architecture to 'arch'
5011 -O ==> set operating system to 'os'
5012 -T ==> set image type to 'type'
5013 -C ==> set compression type 'comp'
5014 -a ==> set load address to 'addr' (hex)
5015 -e ==> set entry point to 'ep' (hex)
5016 -n ==> set image name to 'name'
5017 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005018
wdenk69459792004-05-29 16:53:29 +00005019Right now, all Linux kernels for PowerPC systems use the same load
5020address (0x00000000), but the entry point address depends on the
5021kernel version:
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk2729af92004-05-03 20:45:30 +00005023- 2.2.x kernels have the entry point at 0x0000000C,
5024- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk2729af92004-05-03 20:45:30 +00005026So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5029 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005030 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005031 > examples/uImage.TQM850L
5032 Image Name: 2.4.4 kernel for TQM850L
5033 Created: Wed Jul 19 02:34:59 2000
5034 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5035 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5036 Load Address: 0x00000000
5037 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005038
wdenk2729af92004-05-03 20:45:30 +00005039To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005040
wdenk2729af92004-05-03 20:45:30 +00005041 -> tools/mkimage -l examples/uImage.TQM850L
5042 Image Name: 2.4.4 kernel for TQM850L
5043 Created: Wed Jul 19 02:34:59 2000
5044 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5045 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5046 Load Address: 0x00000000
5047 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk2729af92004-05-03 20:45:30 +00005049NOTE: for embedded systems where boot time is critical you can trade
5050speed for memory and install an UNCOMPRESSED image instead: this
5051needs more space in Flash, but boots much faster since it does not
5052need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005053
Stefan Roesea47a12b2010-04-15 16:07:28 +02005054 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005055 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5056 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005057 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005058 > examples/uImage.TQM850L-uncompressed
5059 Image Name: 2.4.4 kernel for TQM850L
5060 Created: Wed Jul 19 02:34:59 2000
5061 Image Type: PowerPC Linux Kernel Image (uncompressed)
5062 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5063 Load Address: 0x00000000
5064 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005065
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk2729af92004-05-03 20:45:30 +00005067Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5068when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005069
wdenk2729af92004-05-03 20:45:30 +00005070 -> tools/mkimage -n 'Simple Ramdisk Image' \
5071 > -A ppc -O linux -T ramdisk -C gzip \
5072 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5073 Image Name: Simple Ramdisk Image
5074 Created: Wed Jan 12 14:01:50 2000
5075 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5076 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5077 Load Address: 0x00000000
5078 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005079
wdenkdb01a2e2004-04-15 23:14:49 +00005080
wdenk2729af92004-05-03 20:45:30 +00005081Installing a Linux Image:
5082-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084To downloading a U-Boot image over the serial (console) interface,
5085you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089The 'objcopy' does not understand the information in the U-Boot
5090image header, so the resulting S-Record file will be relative to
5091address 0x00000000. To load it to a given address, you need to
5092specify the target address as 'offset' parameter with the 'loads'
5093command.
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095Example: install the image to address 0x40100000 (which on the
5096TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk2729af92004-05-03 20:45:30 +00005100 .......... done
5101 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005102
wdenk2729af92004-05-03 20:45:30 +00005103 => loads 40100000
5104 ## Ready for S-Record download ...
5105 ~>examples/image.srec
5106 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5107 ...
5108 15989 15990 15991 15992
5109 [file transfer complete]
5110 [connected]
5111 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005112
5113
wdenk2729af92004-05-03 20:45:30 +00005114You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005115this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005116corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk2729af92004-05-03 20:45:30 +00005118 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk2729af92004-05-03 20:45:30 +00005120 ## Checking Image at 40100000 ...
5121 Image Name: 2.2.13 for initrd on TQM850L
5122 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5123 Data Size: 335725 Bytes = 327 kB = 0 MB
5124 Load Address: 00000000
5125 Entry Point: 0000000c
5126 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005127
5128
wdenk2729af92004-05-03 20:45:30 +00005129Boot Linux:
5130-----------
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk2729af92004-05-03 20:45:30 +00005132The "bootm" command is used to boot an application that is stored in
5133memory (RAM or Flash). In case of a Linux kernel image, the contents
5134of the "bootargs" environment variable is passed to the kernel as
5135parameters. You can check and modify this variable using the
5136"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005137
5138
wdenk2729af92004-05-03 20:45:30 +00005139 => printenv bootargs
5140 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk2729af92004-05-03 20:45:30 +00005142 => 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 +00005143
wdenk2729af92004-05-03 20:45:30 +00005144 => printenv bootargs
5145 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 +00005146
wdenk2729af92004-05-03 20:45:30 +00005147 => bootm 40020000
5148 ## Booting Linux kernel at 40020000 ...
5149 Image Name: 2.2.13 for NFS on TQM850L
5150 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5151 Data Size: 381681 Bytes = 372 kB = 0 MB
5152 Load Address: 00000000
5153 Entry Point: 0000000c
5154 Verifying Checksum ... OK
5155 Uncompressing Kernel Image ... OK
5156 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
5157 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5158 time_init: decrementer frequency = 187500000/60
5159 Calibrating delay loop... 49.77 BogoMIPS
5160 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5161 ...
wdenkc6097192002-11-03 00:24:07 +00005162
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005163If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005164the memory addresses of both the kernel and the initrd image (PPBCOOT
5165format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk2729af92004-05-03 20:45:30 +00005169 ## Checking Image at 40100000 ...
5170 Image Name: 2.2.13 for initrd on TQM850L
5171 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5172 Data Size: 335725 Bytes = 327 kB = 0 MB
5173 Load Address: 00000000
5174 Entry Point: 0000000c
5175 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177 ## Checking Image at 40200000 ...
5178 Image Name: Simple Ramdisk Image
5179 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5180 Data Size: 566530 Bytes = 553 kB = 0 MB
5181 Load Address: 00000000
5182 Entry Point: 00000000
5183 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185 => bootm 40100000 40200000
5186 ## Booting Linux kernel at 40100000 ...
5187 Image Name: 2.2.13 for initrd on TQM850L
5188 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5189 Data Size: 335725 Bytes = 327 kB = 0 MB
5190 Load Address: 00000000
5191 Entry Point: 0000000c
5192 Verifying Checksum ... OK
5193 Uncompressing Kernel Image ... OK
5194 ## Loading RAMDisk Image at 40200000 ...
5195 Image Name: Simple Ramdisk Image
5196 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5197 Data Size: 566530 Bytes = 553 kB = 0 MB
5198 Load Address: 00000000
5199 Entry Point: 00000000
5200 Verifying Checksum ... OK
5201 Loading Ramdisk ... OK
5202 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
5203 Boot arguments: root=/dev/ram
5204 time_init: decrementer frequency = 187500000/60
5205 Calibrating delay loop... 49.77 BogoMIPS
5206 ...
5207 RAMDISK: Compressed image found at block 0
5208 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk2729af92004-05-03 20:45:30 +00005210 bash#
wdenkc6097192002-11-03 00:24:07 +00005211
Matthew McClintock02677682006-06-28 10:41:37 -05005212Boot Linux and pass a flat device tree:
5213-----------
5214
5215First, U-Boot must be compiled with the appropriate defines. See the section
5216titled "Linux Kernel Interface" above for a more in depth explanation. The
5217following is an example of how to start a kernel and pass an updated
5218flat device tree:
5219
5220=> print oftaddr
5221oftaddr=0x300000
5222=> print oft
5223oft=oftrees/mpc8540ads.dtb
5224=> tftp $oftaddr $oft
5225Speed: 1000, full duplex
5226Using TSEC0 device
5227TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5228Filename 'oftrees/mpc8540ads.dtb'.
5229Load address: 0x300000
5230Loading: #
5231done
5232Bytes transferred = 4106 (100a hex)
5233=> tftp $loadaddr $bootfile
5234Speed: 1000, full duplex
5235Using TSEC0 device
5236TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5237Filename 'uImage'.
5238Load address: 0x200000
5239Loading:############
5240done
5241Bytes transferred = 1029407 (fb51f hex)
5242=> print loadaddr
5243loadaddr=200000
5244=> print oftaddr
5245oftaddr=0x300000
5246=> bootm $loadaddr - $oftaddr
5247## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005248 Image Name: Linux-2.6.17-dirty
5249 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5250 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005251 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005252 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005253 Verifying Checksum ... OK
5254 Uncompressing Kernel Image ... OK
5255Booting using flat device tree at 0x300000
5256Using MPC85xx ADS machine description
5257Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5258[snip]
5259
5260
wdenk2729af92004-05-03 20:45:30 +00005261More About U-Boot Image Types:
5262------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266 "Standalone Programs" are directly runnable in the environment
5267 provided by U-Boot; it is expected that (if they behave
5268 well) you can continue to work in U-Boot after return from
5269 the Standalone Program.
5270 "OS Kernel Images" are usually images of some Embedded OS which
5271 will take over control completely. Usually these programs
5272 will install their own set of exception handlers, device
5273 drivers, set up the MMU, etc. - this means, that you cannot
5274 expect to re-enter U-Boot except by resetting the CPU.
5275 "RAMDisk Images" are more or less just data blocks, and their
5276 parameters (address, size) are passed to an OS kernel that is
5277 being started.
5278 "Multi-File Images" contain several images, typically an OS
5279 (Linux) kernel image and one or more data images like
5280 RAMDisks. This construct is useful for instance when you want
5281 to boot over the network using BOOTP etc., where the boot
5282 server provides just a single image file, but you want to get
5283 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285 "Multi-File Images" start with a list of image sizes, each
5286 image size (in bytes) specified by an "uint32_t" in network
5287 byte order. This list is terminated by an "(uint32_t)0".
5288 Immediately after the terminating 0 follow the images, one by
5289 one, all aligned on "uint32_t" boundaries (size rounded up to
5290 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005291
wdenk2729af92004-05-03 20:45:30 +00005292 "Firmware Images" are binary images containing firmware (like
5293 U-Boot or FPGA images) which usually will be programmed to
5294 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005295
wdenk2729af92004-05-03 20:45:30 +00005296 "Script files" are command sequences that will be executed by
5297 U-Boot's command interpreter; this feature is especially
5298 useful when you configure U-Boot to use a real shell (hush)
5299 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005300
Marek Vasut44f074c2012-03-14 21:52:45 +00005301Booting the Linux zImage:
5302-------------------------
5303
5304On some platforms, it's possible to boot Linux zImage. This is done
5305using the "bootz" command. The syntax of "bootz" command is the same
5306as the syntax of "bootm" command.
5307
Tom Rini8ac28562013-05-16 11:40:11 -04005308Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005309kernel with raw initrd images. The syntax is slightly different, the
5310address of the initrd must be augmented by it's size, in the following
5311format: "<initrd addres>:<initrd size>".
5312
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314Standalone HOWTO:
5315=================
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk2729af92004-05-03 20:45:30 +00005317One of the features of U-Boot is that you can dynamically load and
5318run "standalone" applications, which can use some resources of
5319U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk2729af92004-05-03 20:45:30 +00005321Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk2729af92004-05-03 20:45:30 +00005323"Hello World" Demo:
5324-------------------
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk2729af92004-05-03 20:45:30 +00005326'examples/hello_world.c' contains a small "Hello World" Demo
5327application; it is automatically compiled when you build U-Boot.
5328It's configured to run at address 0x00040004, so you can play with it
5329like that:
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk2729af92004-05-03 20:45:30 +00005331 => loads
5332 ## Ready for S-Record download ...
5333 ~>examples/hello_world.srec
5334 1 2 3 4 5 6 7 8 9 10 11 ...
5335 [file transfer complete]
5336 [connected]
5337 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk2729af92004-05-03 20:45:30 +00005339 => go 40004 Hello World! This is a test.
5340 ## Starting application at 0x00040004 ...
5341 Hello World
5342 argc = 7
5343 argv[0] = "40004"
5344 argv[1] = "Hello"
5345 argv[2] = "World!"
5346 argv[3] = "This"
5347 argv[4] = "is"
5348 argv[5] = "a"
5349 argv[6] = "test."
5350 argv[7] = "<NULL>"
5351 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk2729af92004-05-03 20:45:30 +00005353 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005354
wdenk2729af92004-05-03 20:45:30 +00005355Another example, which demonstrates how to register a CPM interrupt
5356handler with the U-Boot code, can be found in 'examples/timer.c'.
5357Here, a CPM timer is set up to generate an interrupt every second.
5358The interrupt service routine is trivial, just printing a '.'
5359character, but this is just a demo program. The application can be
5360controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk2729af92004-05-03 20:45:30 +00005362 ? - print current values og the CPM Timer registers
5363 b - enable interrupts and start timer
5364 e - stop timer and disable interrupts
5365 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 => loads
5368 ## Ready for S-Record download ...
5369 ~>examples/timer.srec
5370 1 2 3 4 5 6 7 8 9 10 11 ...
5371 [file transfer complete]
5372 [connected]
5373 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375 => go 40004
5376 ## Starting application at 0x00040004 ...
5377 TIMERS=0xfff00980
5378 Using timer 1
5379 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk2729af92004-05-03 20:45:30 +00005381Hit 'b':
5382 [q, b, e, ?] Set interval 1000000 us
5383 Enabling timer
5384Hit '?':
5385 [q, b, e, ?] ........
5386 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5387Hit '?':
5388 [q, b, e, ?] .
5389 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5390Hit '?':
5391 [q, b, e, ?] .
5392 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5393Hit '?':
5394 [q, b, e, ?] .
5395 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5396Hit 'e':
5397 [q, b, e, ?] ...Stopping timer
5398Hit 'q':
5399 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005400
5401
wdenk2729af92004-05-03 20:45:30 +00005402Minicom warning:
5403================
wdenk85ec0bc2003-03-31 16:34:49 +00005404
wdenk2729af92004-05-03 20:45:30 +00005405Over time, many people have reported problems when trying to use the
5406"minicom" terminal emulation program for serial download. I (wd)
5407consider minicom to be broken, and recommend not to use it. Under
5408Unix, I recommend to use C-Kermit for general purpose use (and
5409especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005410use "cu" for S-Record download ("loads" command). See
5411http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5412for help with kermit.
5413
wdenk85ec0bc2003-03-31 16:34:49 +00005414
wdenk2729af92004-05-03 20:45:30 +00005415Nevertheless, if you absolutely want to use it try adding this
5416configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005417
wdenk2729af92004-05-03 20:45:30 +00005418 Name Program Name U/D FullScr IO-Red. Multi
5419 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5420 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005421
5422
wdenk2729af92004-05-03 20:45:30 +00005423NetBSD Notes:
5424=============
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk2729af92004-05-03 20:45:30 +00005426Starting at version 0.9.2, U-Boot supports NetBSD both as host
5427(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk2729af92004-05-03 20:45:30 +00005429Building requires a cross environment; it is known to work on
5430NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5431need gmake since the Makefiles are not compatible with BSD make).
5432Note that the cross-powerpc package does not install include files;
5433attempting to build U-Boot will fail because <machine/ansi.h> is
5434missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk2729af92004-05-03 20:45:30 +00005436 # cd /usr/pkg/cross/powerpc-netbsd/include
5437 # mkdir powerpc
5438 # ln -s powerpc machine
5439 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5440 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442Native builds *don't* work due to incompatibilities between native
5443and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk2729af92004-05-03 20:45:30 +00005445Booting assumes that (the first part of) the image booted is a
5446stage-2 loader which in turn loads and then invokes the kernel
5447proper. Loader sources will eventually appear in the NetBSD source
5448tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005449meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005450
5451
wdenk2729af92004-05-03 20:45:30 +00005452Implementation Internals:
5453=========================
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk2729af92004-05-03 20:45:30 +00005455The following is not intended to be a complete description of every
5456implementation detail. However, it should help to understand the
5457inner workings of U-Boot and make it easier to port it to custom
5458hardware.
wdenkc6097192002-11-03 00:24:07 +00005459
5460
wdenk2729af92004-05-03 20:45:30 +00005461Initial Stack, Global Data:
5462---------------------------
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk2729af92004-05-03 20:45:30 +00005464The implementation of U-Boot is complicated by the fact that U-Boot
5465starts running out of ROM (flash memory), usually without access to
5466system RAM (because the memory controller is not initialized yet).
5467This means that we don't have writable Data or BSS segments, and BSS
5468is not initialized as zero. To be able to get a C environment working
5469at all, we have to allocate at least a minimal stack. Implementation
5470options for this are defined and restricted by the CPU used: Some CPU
5471models provide on-chip memory (like the IMMR area on MPC8xx and
5472MPC826x processors), on others (parts of) the data cache can be
5473locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005474
Wolfgang Denk218ca722008-03-26 10:40:12 +01005475 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005476 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005477
wdenk2729af92004-05-03 20:45:30 +00005478 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5479 From: "Chris Hallinan" <clh@net1plus.com>
5480 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5481 ...
wdenk43d96162003-03-06 00:02:04 +00005482
wdenk2729af92004-05-03 20:45:30 +00005483 Correct me if I'm wrong, folks, but the way I understand it
5484 is this: Using DCACHE as initial RAM for Stack, etc, does not
5485 require any physical RAM backing up the cache. The cleverness
5486 is that the cache is being used as a temporary supply of
5487 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005488 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005489 can see how this works by studying the cache architecture and
5490 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5493 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005494 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005495 option should work for you. Using CS 4 should be fine if your
5496 board designers haven't used it for something that would
5497 cause you grief during the initial boot! It is frequently not
5498 used.
wdenk43d96162003-03-06 00:02:04 +00005499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005500 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005501 with your processor/board/system design. The default value
5502 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005503 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005504 than your SDRAM module. If you have a 64MB SDRAM module, set
5505 it above 400_0000. Just make sure your board has no resources
5506 that are supposed to respond to that address! That code in
5507 start.S has been around a while and should work as is when
5508 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005509
wdenk2729af92004-05-03 20:45:30 +00005510 -Chris Hallinan
5511 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005512
wdenk2729af92004-05-03 20:45:30 +00005513It is essential to remember this, since it has some impact on the C
5514code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005515
wdenk2729af92004-05-03 20:45:30 +00005516* Initialized global data (data segment) is read-only. Do not attempt
5517 to write it.
wdenkc6097192002-11-03 00:24:07 +00005518
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005519* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005520 as zero data - BSS segment) at all - this is undefined, initiali-
5521 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk2729af92004-05-03 20:45:30 +00005523* Stack space is very limited. Avoid big data buffers or things like
5524 that.
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk2729af92004-05-03 20:45:30 +00005526Having only the stack as writable memory limits means we cannot use
5527normal global data to share information beween the code. But it
5528turned out that the implementation of U-Boot can be greatly
5529simplified by making a global data structure (gd_t) available to all
5530functions. We could pass a pointer to this data as argument to _all_
5531functions, but this would bloat the code. Instead we use a feature of
5532the GCC compiler (Global Register Variables) to share the data: we
5533place a pointer (gd) to the global data into a register which we
5534reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk2729af92004-05-03 20:45:30 +00005536When choosing a register for such a purpose we are restricted by the
5537relevant (E)ABI specifications for the current architecture, and by
5538GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk2729af92004-05-03 20:45:30 +00005540For PowerPC, the following registers have specific use:
5541 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005542 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005543 R3-R4: parameter passing and return values
5544 R5-R10: parameter passing
5545 R13: small data area pointer
5546 R30: GOT pointer
5547 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005548
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005549 (U-Boot also uses R12 as internal GOT pointer. r12
5550 is a volatile register so r12 needs to be reset when
5551 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005552
Wolfgang Denke7670f62008-02-14 22:43:22 +01005553 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk2729af92004-05-03 20:45:30 +00005555 Note: on PPC, we could use a static initializer (since the
5556 address of the global data structure is known at compile time),
5557 but it turned out that reserving a register results in somewhat
5558 smaller code - although the code savings are not that big (on
5559 average for all boards 752 bytes for the whole U-Boot image,
5560 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005561
Robin Getzc4db3352009-08-17 15:23:02 +00005562On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005563 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5564
Robin Getzc4db3352009-08-17 15:23:02 +00005565 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005566
wdenk2729af92004-05-03 20:45:30 +00005567On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569 R0: function argument word/integer result
5570 R1-R3: function argument word
5571 R9: GOT pointer
5572 R10: stack limit (used only if stack checking if enabled)
5573 R11: argument (frame) pointer
5574 R12: temporary workspace
5575 R13: stack pointer
5576 R14: link register
5577 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk2729af92004-05-03 20:45:30 +00005579 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005580
Thomas Chou0df01fd2010-05-21 11:08:03 +08005581On Nios II, the ABI is documented here:
5582 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5583
5584 ==> U-Boot will use gp to hold a pointer to the global data
5585
5586 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5587 to access small data sections, so gp is free.
5588
Macpaul Linafc1ce82011-10-19 20:41:11 +00005589On NDS32, the following registers are used:
5590
5591 R0-R1: argument/return
5592 R2-R5: argument
5593 R15: temporary register for assembler
5594 R16: trampoline register
5595 R28: frame pointer (FP)
5596 R29: global pointer (GP)
5597 R30: link register (LP)
5598 R31: stack pointer (SP)
5599 PC: program counter (PC)
5600
5601 ==> U-Boot will use R10 to hold a pointer to the global data
5602
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005603NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5604or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606Memory Management:
5607------------------
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk2729af92004-05-03 20:45:30 +00005609U-Boot runs in system state and uses physical addresses, i.e. the
5610MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005611
wdenk2729af92004-05-03 20:45:30 +00005612The available memory is mapped to fixed addresses using the memory
5613controller. In this process, a contiguous block is formed for each
5614memory type (Flash, SDRAM, SRAM), even when it consists of several
5615physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk2729af92004-05-03 20:45:30 +00005617U-Boot is installed in the first 128 kB of the first Flash bank (on
5618TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5619booting and sizing and initializing DRAM, the code relocates itself
5620to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005621memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005622configuration setting]. Below that, a structure with global Board
5623Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625Additionally, some exception handler code is copied to the low 8 kB
5626of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk2729af92004-05-03 20:45:30 +00005628So a typical memory configuration with 16 MB of DRAM could look like
5629this:
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631 0x0000 0000 Exception Vector code
5632 :
5633 0x0000 1FFF
5634 0x0000 2000 Free for Application Use
5635 :
5636 :
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk2729af92004-05-03 20:45:30 +00005638 :
5639 :
5640 0x00FB FF20 Monitor Stack (Growing downward)
5641 0x00FB FFAC Board Info Data and permanent copy of global data
5642 0x00FC 0000 Malloc Arena
5643 :
5644 0x00FD FFFF
5645 0x00FE 0000 RAM Copy of Monitor Code
5646 ... eventually: LCD or video framebuffer
5647 ... eventually: pRAM (Protected RAM - unchanged by reset)
5648 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005649
5650
wdenk2729af92004-05-03 20:45:30 +00005651System Initialization:
5652----------------------
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk2729af92004-05-03 20:45:30 +00005654In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005655(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005656configuration for CS0# this is a mirror of the onboard Flash memory.
5657To be able to re-map memory U-Boot then jumps to its link address.
5658To be able to implement the initialization code in C, a (small!)
5659initial stack is set up in the internal Dual Ported RAM (in case CPUs
5660which provide such a feature like MPC8xx or MPC8260), or in a locked
5661part of the data cache. After that, U-Boot initializes the CPU core,
5662the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664Next, all (potentially) available memory banks are mapped using a
5665preliminary mapping. For example, we put them on 512 MB boundaries
5666(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5667on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5668programmed for SDRAM access. Using the temporary configuration, a
5669simple memory test is run that determines the size of the SDRAM
5670banks.
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk2729af92004-05-03 20:45:30 +00005672When there is more than one SDRAM bank, and the banks are of
5673different size, the largest is mapped first. For equal size, the first
5674bank (CS2#) is mapped first. The first mapping is always for address
56750x00000000, with any additional banks following immediately to create
5676contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678Then, the monitor installs itself at the upper end of the SDRAM area
5679and allocates memory for use by malloc() and for the global Board
5680Info data; also, the exception vector code is copied to the low RAM
5681pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk2729af92004-05-03 20:45:30 +00005683Only after this relocation will you have a "normal" C environment;
5684until that you are restricted in several ways, mostly because you are
5685running from ROM, and because the code will have to be relocated to a
5686new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005687
5688
wdenk2729af92004-05-03 20:45:30 +00005689U-Boot Porting Guide:
5690----------------------
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5693list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005694
5695
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005696int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005697{
5698 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005699
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005700 signal(SIGALRM, no_more_time);
5701 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005704 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005705 return 0;
5706 }
5707
wdenk2729af92004-05-03 20:45:30 +00005708 Download latest U-Boot source;
5709
Wolfgang Denk06682362008-12-30 22:56:11 +01005710 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005711
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005712 if (clueless)
5713 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk2729af92004-05-03 20:45:30 +00005715 while (learning) {
5716 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005717 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5718 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005719 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005720 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005721 }
wdenkc6097192002-11-03 00:24:07 +00005722
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005723 if (available_money > toLocalCurrency ($2500))
5724 Buy a BDI3000;
5725 else
wdenk2729af92004-05-03 20:45:30 +00005726 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005727
5728 if (a similar board exists) { /* hopefully... */
5729 cp -a board/<similar> board/<myboard>
5730 cp include/configs/<similar>.h include/configs/<myboard>.h
5731 } else {
5732 Create your own board support subdirectory;
5733 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005734 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005735 Edit new board/<myboard> files
5736 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005737
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005738 while (!accepted) {
5739 while (!running) {
5740 do {
5741 Add / modify source code;
5742 } until (compiles);
5743 Debug;
5744 if (clueless)
5745 email("Hi, I am having problems...");
5746 }
5747 Send patch file to the U-Boot email list;
5748 if (reasonable critiques)
5749 Incorporate improvements from email list code review;
5750 else
5751 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005752 }
wdenkc6097192002-11-03 00:24:07 +00005753
wdenk2729af92004-05-03 20:45:30 +00005754 return 0;
5755}
5756
5757void no_more_time (int sig)
5758{
5759 hire_a_guru();
5760}
wdenkc6097192002-11-03 00:24:07 +00005761
5762
wdenk2729af92004-05-03 20:45:30 +00005763Coding Standards:
5764-----------------
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk2729af92004-05-03 20:45:30 +00005766All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005767coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005768"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005769
Detlev Zundel2c051652006-09-01 15:39:02 +02005770Source files originating from a different project (for example the
5771MTD subsystem) are generally exempt from these guidelines and are not
5772reformated to ease subsequent migration to newer versions of those
5773sources.
5774
5775Please note that U-Boot is implemented in C (and to some small parts in
5776Assembler); no C++ is used, so please do not use C++ style comments (//)
5777in your code.
wdenk2729af92004-05-03 20:45:30 +00005778
5779Please also stick to the following formatting rules:
5780- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005781- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005782- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005783- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005784- do not add trailing empty lines to source files
5785
5786Submissions which do not conform to the standards may be returned
5787with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005788
5789
wdenk2729af92004-05-03 20:45:30 +00005790Submitting Patches:
5791-------------------
wdenkc6097192002-11-03 00:24:07 +00005792
wdenk2729af92004-05-03 20:45:30 +00005793Since the number of patches for U-Boot is growing, we need to
5794establish some rules. Submissions which do not conform to these rules
5795may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005796
Magnus Lilja0d28f342008-08-06 19:32:33 +02005797Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005798
Wolfgang Denk06682362008-12-30 22:56:11 +01005799Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5800see http://lists.denx.de/mailman/listinfo/u-boot
5801
wdenk2729af92004-05-03 20:45:30 +00005802When you send a patch, please include the following information with
5803it:
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805* For bug fixes: a description of the bug and how your patch fixes
5806 this bug. Please try to include a way of demonstrating that the
5807 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk2729af92004-05-03 20:45:30 +00005809* For new features: a description of the feature and your
5810 implementation.
wdenkc6097192002-11-03 00:24:07 +00005811
wdenk2729af92004-05-03 20:45:30 +00005812* A CHANGELOG entry as plaintext (separate from the patch)
5813
5814* For major contributions, your entry to the CREDITS file
5815
5816* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005817 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005818
5819* If your patch adds new configuration options, don't forget to
5820 document these in the README file.
5821
Wolfgang Denk218ca722008-03-26 10:40:12 +01005822* The patch itself. If you are using git (which is *strongly*
5823 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005824 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005825 the U-Boot mailing list, you will avoid most of the common problems
5826 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005827
Wolfgang Denk218ca722008-03-26 10:40:12 +01005828 If you cannot use git, use "diff -purN OLD NEW". If your version of
5829 diff does not support these options, then get the latest version of
5830 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005831
Wolfgang Denk218ca722008-03-26 10:40:12 +01005832 The current directory when running this command shall be the parent
5833 directory of the U-Boot source tree (i. e. please make sure that
5834 your patch includes sufficient directory information for the
5835 affected files).
5836
5837 We prefer patches as plain text. MIME attachments are discouraged,
5838 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005839
5840* If one logical set of modifications affects or creates several
5841 files, all these changes shall be submitted in a SINGLE patch file.
5842
5843* Changesets that contain different, unrelated modifications shall be
5844 submitted as SEPARATE patches, one patch per changeset.
5845
5846
5847Notes:
5848
5849* Before sending the patch, run the MAKEALL script on your patched
5850 source tree and make sure that no errors or warnings are reported
5851 for any of the boards.
5852
5853* Keep your modifications to the necessary minimum: A patch
5854 containing several unrelated changes or arbitrary reformats will be
5855 returned with a request to re-formatting / split it.
5856
5857* If you modify existing code, make sure that your new code does not
5858 add to the memory footprint of the code ;-) Small is beautiful!
5859 When adding new features, these should compile conditionally only
5860 (using #ifdef), and the resulting code with the new feature
5861 disabled must not need more memory than the old code without your
5862 modification.
wdenk90dc6702005-05-03 14:12:25 +00005863
Wolfgang Denk06682362008-12-30 22:56:11 +01005864* Remember that there is a size limit of 100 kB per message on the
5865 u-boot mailing list. Bigger patches will be moderated. If they are
5866 reasonable and not too big, they will be acknowledged. But patches
5867 bigger than the size limit should be avoided.