blob: 391880765a0865f05a71efc6dedf40d99e61d7fe [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010038who contributed the specific port. The MAINTAINERS file lists board
39maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
135 /arm Files generic to ARM architecture
136 /cpu CPU specific files
137 /arm720t Files specific to ARM 720 CPUs
138 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000139 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200140 /imx Files specific to Freescale MC9328 i.MX CPUs
141 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /arm925t Files specific to ARM 925 CPUs
143 /arm926ejs Files specific to ARM 926 CPUs
144 /arm1136 Files specific to ARM 1136 CPUs
145 /ixp Files specific to Intel XScale IXP CPUs
146 /pxa Files specific to Intel XScale PXA CPUs
147 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
148 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
149 /lib Architecture specific library files
150 /avr32 Files generic to AVR32 architecture
151 /cpu CPU specific files
152 /lib Architecture specific library files
153 /blackfin Files generic to Analog Devices Blackfin architecture
154 /cpu CPU specific files
155 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000156 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /cpu CPU specific files
158 /lib Architecture specific library files
159 /m68k Files generic to m68k architecture
160 /cpu CPU specific files
161 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
162 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
163 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
164 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
165 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
166 /lib Architecture specific library files
167 /microblaze Files generic to microblaze architecture
168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /mips Files generic to MIPS architecture
171 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200172 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800173 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500174 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000175 /nds32 Files generic to NDS32 architecture
176 /cpu CPU specific files
177 /n1213 Files specific to Andes Technology N1213 CPUs
178 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500179 /nios2 Files generic to Altera NIOS2 architecture
180 /cpu CPU specific files
181 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200182 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500183 /cpu CPU specific files
184 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /mpc824x Files specific to Freescale MPC824x CPUs
189 /mpc8260 Files specific to Freescale MPC8260 CPUs
190 /mpc85xx Files specific to Freescale MPC85xx CPUs
191 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
192 /lib Architecture specific library files
193 /sh Files generic to SH architecture
194 /cpu CPU specific files
195 /sh2 Files specific to sh2 CPUs
196 /sh3 Files specific to sh3 CPUs
197 /sh4 Files specific to sh4 CPUs
198 /lib Architecture specific library files
199 /sparc Files generic to SPARC architecture
200 /cpu CPU specific files
201 /leon2 Files specific to Gaisler LEON2 SPARC CPU
202 /leon3 Files specific to Gaisler LEON3 SPARC CPU
203 /lib Architecture specific library files
204/api Machine/arch independent API for external apps
205/board Board dependent files
206/common Misc architecture independent functions
207/disk Code for disk drive partition handling
208/doc Documentation (don't expect too much)
209/drivers Commonly used device drivers
210/examples Example code for standalone applications, etc.
211/fs Filesystem code (cramfs, ext2, jffs2, etc.)
212/include Header Files
213/lib Files generic to all architectures
214 /libfdt Library files to support flattened device trees
215 /lzma Library files to support LZMA decompression
216 /lzo Library files to support LZO decompression
217/net Networking code
218/post Power On Self Test
219/rtc Real Time Clock drivers
220/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000221
wdenkc6097192002-11-03 00:24:07 +0000222Software Configuration:
223=======================
224
225Configuration is usually done using C preprocessor defines; the
226rationale behind that is to avoid dead code whenever possible.
227
228There are two classes of configuration variables:
229
230* Configuration _OPTIONS_:
231 These are selectable by the user and have names beginning with
232 "CONFIG_".
233
234* Configuration _SETTINGS_:
235 These depend on the hardware etc. and should not be meddled with if
236 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200237 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000238
239Later we will add a configuration tool - probably similar to or even
240identical to what's used for the Linux kernel. Right now, we have to
241do the configuration by hand, which means creating some symbolic
242links and editing some configuration files. We use the TQM8xxL boards
243as an example here.
244
245
246Selection of Processor Architecture and Board Type:
247---------------------------------------------------
248
249For all supported boards there are ready-to-use default
250configurations available; just type "make <board_name>_config".
251
252Example: For a TQM823L module type:
253
254 cd u-boot
255 make TQM823L_config
256
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200257For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000258e.g. "make cogent_mpc8xx_config". And also configure the cogent
259directory according to the instructions in cogent/README.
260
261
262Configuration Options:
263----------------------
264
265Configuration depends on the combination of board and CPU type; all
266such information is kept in a configuration file
267"include/configs/<board_name>.h".
268
269Example: For a TQM823L module, all configuration settings are in
270"include/configs/TQM823L.h".
271
272
wdenk7f6c2cb2002-11-10 22:06:23 +0000273Many of the options are named exactly as the corresponding Linux
274kernel configuration options. The intention is to make it easier to
275build a config tool - later.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278The following options need to be configured:
279
Kim Phillips26281142007-08-10 13:28:25 -0500280- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000281
Kim Phillips26281142007-08-10 13:28:25 -0500282- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200283
284- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100285 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000286
287- CPU Module Type: (if CONFIG_COGENT is defined)
288 Define exactly one of
289 CONFIG_CMA286_60_OLD
290--- FIXME --- not tested yet:
291 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
292 CONFIG_CMA287_23, CONFIG_CMA287_50
293
294- Motherboard Type: (if CONFIG_COGENT is defined)
295 Define exactly one of
296 CONFIG_CMA101, CONFIG_CMA102
297
298- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
299 Define one or more of
300 CONFIG_CMA302
301
302- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
303 Define one or more of
304 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200305 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000306 a "rotator" |\-/|\-/
307
wdenk2535d602003-07-17 23:16:40 +0000308- Board flavour: (if CONFIG_MPC8260ADS is defined)
309 CONFIG_ADSTYPE
310 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200311 CONFIG_SYS_8260ADS - original MPC8260ADS
312 CONFIG_SYS_8266ADS - MPC8266ADS
313 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
314 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000315
Lei Wencf946c62011-02-09 18:06:58 +0530316- Marvell Family Member
317 CONFIG_SYS_MVFS - define it if you want to enable
318 multiple fs option at one time
319 for marvell soc family
320
wdenkc6097192002-11-03 00:24:07 +0000321- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000322 Define exactly one of
323 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000324
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200325- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000326 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
327 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000328 e.g. if there is no 32KHz
329 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000330 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
331 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000332
wdenk66ca92a2004-09-28 17:59:53 +0000333- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200334 CONFIG_SYS_8xx_CPUCLK_MIN
335 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000337 See doc/README.MPC866
338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200339 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000340
wdenkba56f622004-02-06 23:19:44 +0000341 Define this to measure the actual CPU clock instead
342 of relying on the correctness of the configured
343 values. Mostly useful for board bringup to make sure
344 the PLL is locked at the intended frequency. Note
345 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000347
Heiko Schocher506f3912009-03-12 07:37:15 +0100348 CONFIG_SYS_DELAYED_ICACHE
349
350 Define this option if you want to enable the
351 ICache only when Code runs from RAM.
352
Kumar Gala66412c62011-02-18 05:40:54 -0600353- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000354 CONFIG_SYS_PPC64
355
356 Specifies that the core is a 64-bit PowerPC implementation (implements
357 the "64" category of the Power ISA). This is necessary for ePAPR
358 compliance, among other possible reasons.
359
Kumar Gala66412c62011-02-18 05:40:54 -0600360 CONFIG_SYS_FSL_TBCLK_DIV
361
362 Defines the core time base clock divider ratio compared to the
363 system clock. On most PQ3 devices this is 8, on newer QorIQ
364 devices it can be 16 or 32. The ratio varies from SoC to Soc.
365
Kumar Gala8f290842011-05-20 00:39:21 -0500366 CONFIG_SYS_FSL_PCIE_COMPAT
367
368 Defines the string to utilize when trying to match PCIe device
369 tree nodes for the given platform.
370
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000371 CONFIG_SYS_PPC_E500_DEBUG_TLB
372
373 Enables a temporary TLB entry to be used during boot to work
374 around limitations in e500v1 and e500v2 external debugger
375 support. This reduces the portions of the boot code where
376 breakpoints and single stepping do not work. The value of this
377 symbol should be set to the TLB1 entry to be used for this
378 purpose.
379
Scott Wood33eee332012-08-14 10:14:53 +0000380 CONFIG_SYS_FSL_ERRATUM_A004510
381
382 Enables a workaround for erratum A004510. If set,
383 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
384 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
385
386 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
387 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
388
389 Defines one or two SoC revisions (low 8 bits of SVR)
390 for which the A004510 workaround should be applied.
391
392 The rest of SVR is either not relevant to the decision
393 of whether the erratum is present (e.g. p2040 versus
394 p2041) or is implied by the build target, which controls
395 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
396
397 See Freescale App Note 4493 for more information about
398 this erratum.
399
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530400 CONFIG_A003399_NOR_WORKAROUND
401 Enables a workaround for IFC erratum A003399. It is only
402 requred during NOR boot.
403
Scott Wood33eee332012-08-14 10:14:53 +0000404 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
405
406 This is the value to write into CCSR offset 0x18600
407 according to the A004510 workaround.
408
Priyanka Jain64501c62013-07-02 09:21:04 +0530409 CONFIG_SYS_FSL_DSP_DDR_ADDR
410 This value denotes start offset of DDR memory which is
411 connected exclusively to the DSP cores.
412
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530413 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
414 This value denotes start offset of M2 memory
415 which is directly connected to the DSP core.
416
Priyanka Jain64501c62013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
418 This value denotes start offset of M3 memory which is directly
419 connected to the DSP core.
420
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
422 This value denotes start offset of DSP CCSR space.
423
York Suncb930712013-06-25 11:37:41 -0700424 CONFIG_SYS_FSL_DDR_EMU
425 Specify emulator support for DDR. Some DDR features such as
426 deskew training are not available.
427
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000428- Generic CPU options:
429 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
430
431 Defines the endianess of the CPU. Implementation of those
432 values is arch specific.
433
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100434- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100436
437 Defines the Monahans run mode to oscillator
438 ratio. Valid values are 8, 16, 24, 31. The core
439 frequency is this value multiplied by 13 MHz.
440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200441 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200442
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100443 Defines the Monahans turbo mode to oscillator
444 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200445 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100446 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200447
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200448- MIPS CPU options:
449 CONFIG_SYS_INIT_SP_OFFSET
450
451 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
452 pointer. This is needed for the temporary stack before
453 relocation.
454
455 CONFIG_SYS_MIPS_CACHE_MODE
456
457 Cache operation mode for the MIPS CPU.
458 See also arch/mips/include/asm/mipsregs.h.
459 Possible values are:
460 CONF_CM_CACHABLE_NO_WA
461 CONF_CM_CACHABLE_WA
462 CONF_CM_UNCACHED
463 CONF_CM_CACHABLE_NONCOHERENT
464 CONF_CM_CACHABLE_CE
465 CONF_CM_CACHABLE_COW
466 CONF_CM_CACHABLE_CUW
467 CONF_CM_CACHABLE_ACCELERATED
468
469 CONFIG_SYS_XWAY_EBU_BOOTCFG
470
471 Special option for Lantiq XWAY SoCs for booting from NOR flash.
472 See also arch/mips/cpu/mips32/start.S.
473
474 CONFIG_XWAY_SWAP_BYTES
475
476 Enable compilation of tools/xway-swap-bytes needed for Lantiq
477 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
478 be swapped if a flash programmer is used.
479
Christian Rieschb67d8812012-02-02 00:44:39 +0000480- ARM options:
481 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
482
483 Select high exception vectors of the ARM core, e.g., do not
484 clear the V bit of the c1 register of CP15.
485
Aneesh V5356f542012-03-08 07:20:19 +0000486 CONFIG_SYS_THUMB_BUILD
487
488 Use this flag to build U-Boot using the Thumb instruction
489 set for ARM architectures. Thumb instruction set provides
490 better code density. For ARM architectures that support
491 Thumb2 this flag will result in Thumb2 code generated by
492 GCC.
493
Stephen Warrenc5d47522013-03-04 13:29:40 +0000494 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000495 CONFIG_ARM_ERRATA_742230
496 CONFIG_ARM_ERRATA_743622
497 CONFIG_ARM_ERRATA_751472
498
499 If set, the workarounds for these ARM errata are applied early
500 during U-Boot startup. Note that these options force the
501 workarounds to be applied; no CPU-type/version detection
502 exists, unlike the similar options in the Linux kernel. Do not
503 set these options unless they apply!
504
Stephen Warren795659d2013-03-27 17:06:41 +0000505- CPU timer options:
506 CONFIG_SYS_HZ
507
508 The frequency of the timer returned by get_timer().
509 get_timer() must operate in milliseconds and this CONFIG
510 option must be set to 1000.
511
wdenk5da627a2003-10-09 20:09:04 +0000512- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000513 CONFIG_CLOCKS_IN_MHZ
514
515 U-Boot stores all clock information in Hz
516 internally. For binary compatibility with older Linux
517 kernels (which expect the clocks passed in the
518 bd_info data to be in MHz) the environment variable
519 "clocks_in_mhz" can be defined so that U-Boot
520 converts clock data to MHZ before passing it to the
521 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000522 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100523 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000524 default environment.
525
wdenk5da627a2003-10-09 20:09:04 +0000526 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
527
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200528 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000529 expect it to be in bytes, others in MB.
530 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
531
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400532 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200533
534 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400535 passed using flattened device trees (based on open firmware
536 concepts).
537
538 CONFIG_OF_LIBFDT
539 * New libfdt-based support
540 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500541 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400542
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200543 OF_CPU - The proper name of the cpus node (only required for
544 MPC512X and MPC5xxx based boards).
545 OF_SOC - The proper name of the soc node (only required for
546 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200547 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600548 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200549
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200550 boards with QUICC Engines require OF_QE to set UCC MAC
551 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500552
Kumar Gala4e253132006-01-11 13:54:17 -0600553 CONFIG_OF_BOARD_SETUP
554
555 Board code has addition modification that it wants to make
556 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000557
Matthew McClintock02677682006-06-28 10:41:37 -0500558 CONFIG_OF_BOOT_CPU
559
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200560 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500561 param header, the default value is zero if undefined.
562
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200563 CONFIG_OF_IDE_FIXUP
564
565 U-Boot can detect if an IDE device is present or not.
566 If not, and this new config option is activated, U-Boot
567 removes the ATA node from the DTS before booting Linux,
568 so the Linux IDE driver does not probe the device and
569 crash. This is needed for buggy hardware (uc101) where
570 no pull down resistor is connected to the signal IDE5V_DD7.
571
Igor Grinberg7eb29392011-07-14 05:45:07 +0000572 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
573
574 This setting is mandatory for all boards that have only one
575 machine type and must be used to specify the machine type
576 number as it appears in the ARM machine registry
577 (see http://www.arm.linux.org.uk/developer/machines/).
578 Only boards that have multiple machine types supported
579 in a single configuration file and the machine type is
580 runtime discoverable, do not have to use this setting.
581
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100582- vxWorks boot parameters:
583
584 bootvx constructs a valid bootline using the following
585 environments variables: bootfile, ipaddr, serverip, hostname.
586 It loads the vxWorks image pointed bootfile.
587
588 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
589 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
590 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
591 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
592
593 CONFIG_SYS_VXWORKS_ADD_PARAMS
594
595 Add it at the end of the bootline. E.g "u=username pw=secret"
596
597 Note: If a "bootargs" environment is defined, it will overwride
598 the defaults discussed just above.
599
Aneesh V2c451f72011-06-16 23:30:47 +0000600- Cache Configuration:
601 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
602 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
603 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
604
Aneesh V93bc2192011-06-16 23:30:51 +0000605- Cache Configuration for ARM:
606 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
607 controller
608 CONFIG_SYS_PL310_BASE - Physical base address of PL310
609 controller register space
610
wdenk6705d812004-08-02 23:22:59 +0000611- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200612 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000613
614 Define this if you want support for Amba PrimeCell PL010 UARTs.
615
Andreas Engel48d01922008-09-08 14:30:53 +0200616 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000617
618 Define this if you want support for Amba PrimeCell PL011 UARTs.
619
620 CONFIG_PL011_CLOCK
621
622 If you have Amba PrimeCell PL011 UARTs, set this variable to
623 the clock speed of the UARTs.
624
625 CONFIG_PL01x_PORTS
626
627 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
628 define this to a list of base addresses for each (supported)
629 port. See e.g. include/configs/versatile.h
630
John Rigby910f1ae2011-04-19 10:42:39 +0000631 CONFIG_PL011_SERIAL_RLCR
632
633 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
634 have separate receive and transmit line control registers. Set
635 this variable to initialize the extra register.
636
637 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
638
639 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
640 boot loader that has already initialized the UART. Define this
641 variable to flush the UART at init time.
642
wdenk6705d812004-08-02 23:22:59 +0000643
wdenkc6097192002-11-03 00:24:07 +0000644- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000645 Depending on board, define exactly one serial port
646 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
647 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
648 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000649
650 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
651 port routines must be defined elsewhere
652 (i.e. serial_init(), serial_getc(), ...)
653
654 CONFIG_CFB_CONSOLE
655 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000656 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000657 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
658 (default big endian)
659 VIDEO_HW_RECTFILL graphic chip supports
660 rectangle fill
661 (cf. smiLynxEM)
662 VIDEO_HW_BITBLT graphic chip supports
663 bit-blit (cf. smiLynxEM)
664 VIDEO_VISIBLE_COLS visible pixel columns
665 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000666 VIDEO_VISIBLE_ROWS visible pixel rows
667 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000668 VIDEO_DATA_FORMAT graphic data format
669 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000670 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000671 VIDEO_KBD_INIT_FCT keyboard int fct
672 (i.e. i8042_kbd_init())
673 VIDEO_TSTC_FCT test char fct
674 (i.e. i8042_tstc)
675 VIDEO_GETC_FCT get char fct
676 (i.e. i8042_getc)
677 CONFIG_CONSOLE_CURSOR cursor drawing on/off
678 (requires blink timer
679 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200680 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000681 CONFIG_CONSOLE_TIME display time/date info in
682 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500683 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000684 CONFIG_VIDEO_LOGO display Linux logo in
685 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000686 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
687 linux_logo.h for logo.
688 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000689 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200690 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000691 the logo
692
Pali Rohár33a35bb2012-10-19 13:30:09 +0000693 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
694 a limited number of ANSI escape sequences (cursor control,
695 erase functions and limited graphics rendition control).
696
wdenk43d96162003-03-06 00:02:04 +0000697 When CONFIG_CFB_CONSOLE is defined, video console is
698 default i/o. Serial console can be forced with
699 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000700
wdenkd4ca31c2004-01-02 14:00:00 +0000701 When CONFIG_SILENT_CONSOLE is defined, all console
702 messages (by U-Boot and Linux!) can be silenced with
703 the "silent" environment variable. See
704 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000705
wdenkc6097192002-11-03 00:24:07 +0000706- Console Baudrate:
707 CONFIG_BAUDRATE - in bps
708 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200709 CONFIG_SYS_BAUDRATE_TABLE, see below.
710 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000711
Heiko Schocherc92fac92009-01-30 12:55:38 +0100712- Console Rx buffer length
713 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
714 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100715 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100716 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
717 must be defined, to setup the maximum idle timeout for
718 the SMC.
719
Graeme Russ9558b482011-09-01 00:48:27 +0000720- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200721 Prior to the console being initialised (i.e. serial UART
722 initialised etc) all console output is silently discarded.
723 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
724 buffer any console messages prior to the console being
725 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
726 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
727 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200728 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200729 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000730
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200731 'Sane' compilers will generate smaller code if
732 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000733
Sonny Rao046a37b2011-11-02 09:52:08 +0000734- Safe printf() functions
735 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
736 the printf() functions. These are defined in
737 include/vsprintf.h and include snprintf(), vsnprintf() and
738 so on. Code size increase is approximately 300-500 bytes.
739 If this option is not given then these functions will
740 silently discard their buffer size argument - this means
741 you are not getting any overflow checking in this case.
742
wdenkc6097192002-11-03 00:24:07 +0000743- Boot Delay: CONFIG_BOOTDELAY - in seconds
744 Delay before automatically booting the default image;
745 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000746 set to -2 to autoboot with no delay and not check for abort
747 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000748
749 See doc/README.autoboot for these options that
750 work with CONFIG_BOOTDELAY. None are required.
751 CONFIG_BOOT_RETRY_TIME
752 CONFIG_BOOT_RETRY_MIN
753 CONFIG_AUTOBOOT_KEYED
754 CONFIG_AUTOBOOT_PROMPT
755 CONFIG_AUTOBOOT_DELAY_STR
756 CONFIG_AUTOBOOT_STOP_STR
757 CONFIG_AUTOBOOT_DELAY_STR2
758 CONFIG_AUTOBOOT_STOP_STR2
759 CONFIG_ZERO_BOOTDELAY_CHECK
760 CONFIG_RESET_TO_RETRY
761
762- Autoboot Command:
763 CONFIG_BOOTCOMMAND
764 Only needed when CONFIG_BOOTDELAY is enabled;
765 define a command string that is automatically executed
766 when no character is read on the console interface
767 within "Boot Delay" after reset.
768
769 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000770 This can be used to pass arguments to the bootm
771 command. The value of CONFIG_BOOTARGS goes into the
772 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000773
774 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000775 The value of these goes into the environment as
776 "ramboot" and "nfsboot" respectively, and can be used
777 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200778 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000779
780- Pre-Boot Commands:
781 CONFIG_PREBOOT
782
783 When this option is #defined, the existence of the
784 environment variable "preboot" will be checked
785 immediately before starting the CONFIG_BOOTDELAY
786 countdown and/or running the auto-boot command resp.
787 entering interactive mode.
788
789 This feature is especially useful when "preboot" is
790 automatically generated or modified. For an example
791 see the LWMON board specific code: here "preboot" is
792 modified when the user holds down a certain
793 combination of keys on the (special) keyboard when
794 booting the systems
795
796- Serial Download Echo Mode:
797 CONFIG_LOADS_ECHO
798 If defined to 1, all characters received during a
799 serial download (using the "loads" command) are
800 echoed back. This might be needed by some terminal
801 emulations (like "cu"), but may as well just take
802 time on others. This setting #define's the initial
803 value of the "loads_echo" environment variable.
804
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000806 CONFIG_KGDB_BAUDRATE
807 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200808 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000809
810- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500811 Monitor commands can be included or excluded
812 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000813 <config_cmd_all.h> and #undef'ing unwanted
814 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 and augmenting with additional #define's
816 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000817
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500818 The default command configuration includes all commands
819 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000820
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500821 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500822 CONFIG_CMD_BDI bdinfo
823 CONFIG_CMD_BEDBUG * Include BedBug Debugger
824 CONFIG_CMD_BMP * BMP support
825 CONFIG_CMD_BSP * Board specific commands
826 CONFIG_CMD_BOOTD bootd
827 CONFIG_CMD_CACHE * icache, dcache
828 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500829 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_DATE * support for RTC, date/time...
831 CONFIG_CMD_DHCP * DHCP support
832 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600833 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
834 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
835 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
836 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_DTT * Digital Therm and Thermostat
838 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500839 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500840 CONFIG_CMD_EEPROM * EEPROM read/write support
841 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600842 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600843 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500844 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000845 CONFIG_CMD_EXT2 * ext2 command support
846 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500847 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500848 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000849 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500850 CONFIG_CMD_FDOS * Dos diskette Support
851 CONFIG_CMD_FLASH flinfo, erase, protect
852 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200853 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000854 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500855 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000856 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000857 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500858 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
859 CONFIG_CMD_I2C * I2C serial bus support
860 CONFIG_CMD_IDE * IDE harddisk support
861 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000862 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200863 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500864 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500865 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000866 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_IRQ * irqinfo
868 CONFIG_CMD_ITEST Integer/string test of 2 values
869 CONFIG_CMD_JFFS2 * JFFS2 Support
870 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200871 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000872 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
873 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500874 CONFIG_CMD_LOADB loadb
875 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200876 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400877 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000878 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500879 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000880 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200881 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882 CONFIG_CMD_MISC Misc functions like sleep etc
883 CONFIG_CMD_MMC * MMC memory mapped support
884 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100885 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500886 CONFIG_CMD_NAND * NAND support
887 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200888 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600889 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000890 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500891 CONFIG_CMD_PCI * pciinfo
892 CONFIG_CMD_PCMCIA * PCMCIA support
893 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
894 host
895 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000896 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500897 CONFIG_CMD_REGINFO * Register dump
898 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000899 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500900 CONFIG_CMD_SAVES * save S record dump
901 CONFIG_CMD_SCSI * SCSI Support
902 CONFIG_CMD_SDRAM * print SDRAM configuration information
903 (requires CONFIG_CMD_I2C)
904 CONFIG_CMD_SETGETDCR Support for DCR Register access
905 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700906 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200907 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400908 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800909 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200910 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500911 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000912 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000913 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000914 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
915 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500916 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500917 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000918 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200919 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000920
wdenkc6097192002-11-03 00:24:07 +0000921
922 EXAMPLE: If you want all functions except of network
923 support you can write:
924
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500925 #include "config_cmd_all.h"
926 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000927
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400928 Other Commands:
929 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000930
931 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500932 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000933 what you (and your U-Boot users) are doing. Data
934 cache cannot be enabled on systems like the 8xx or
935 8260 (where accesses to the IMMR region must be
936 uncached), and it cannot be disabled on all other
937 systems where we (mis-) use the data cache to hold an
938 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000939
940
941 XXX - this list needs to get updated!
942
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000943- Regular expression support:
944 CONFIG_REGEX
945 If this variable is defined, U-Boot is linked against
946 the SLRE (Super Light Regular Expression) library,
947 which adds regex support to some commands, as for
948 example "env grep" and "setexpr".
949
Simon Glass45ba8072011-10-15 05:48:20 +0000950- Device tree:
951 CONFIG_OF_CONTROL
952 If this variable is defined, U-Boot will use a device tree
953 to configure its devices, instead of relying on statically
954 compiled #defines in the board file. This option is
955 experimental and only available on a few boards. The device
956 tree is available in the global data as gd->fdt_blob.
957
Simon Glass2c0f79e2011-10-24 19:15:31 +0000958 U-Boot needs to get its device tree from somewhere. This can
959 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000960
961 CONFIG_OF_EMBED
962 If this variable is defined, U-Boot will embed a device tree
963 binary in its image. This device tree file should be in the
964 board directory and called <soc>-<board>.dts. The binary file
965 is then picked up in board_init_f() and made available through
966 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000967
Simon Glass2c0f79e2011-10-24 19:15:31 +0000968 CONFIG_OF_SEPARATE
969 If this variable is defined, U-Boot will build a device tree
970 binary. It will be called u-boot.dtb. Architecture-specific
971 code will locate it at run-time. Generally this works by:
972
973 cat u-boot.bin u-boot.dtb >image.bin
974
975 and in fact, U-Boot does this for you, creating a file called
976 u-boot-dtb.bin which is useful in the common case. You can
977 still use the individual files if you need something more
978 exotic.
979
wdenkc6097192002-11-03 00:24:07 +0000980- Watchdog:
981 CONFIG_WATCHDOG
982 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000983 support for the SoC. There must be support in the SoC
984 specific code for a watchdog. For the 8xx and 8260
985 CPUs, the SIU Watchdog feature is enabled in the SYPCR
986 register. When supported for a specific SoC is
987 available, then no further board specific code should
988 be needed to use it.
989
990 CONFIG_HW_WATCHDOG
991 When using a watchdog circuitry external to the used
992 SoC, then define this variable and provide board
993 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000994
stroesec1551ea2003-04-04 15:53:41 +0000995- U-Boot Version:
996 CONFIG_VERSION_VARIABLE
997 If this variable is defined, an environment variable
998 named "ver" is created by U-Boot showing the U-Boot
999 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001000 Any change to this variable will be reverted at the
1001 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001002
wdenkc6097192002-11-03 00:24:07 +00001003- Real-Time Clock:
1004
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001005 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001006 has to be selected, too. Define exactly one of the
1007 following options:
1008
1009 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1010 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001011 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001012 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001013 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001014 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001015 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001016 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001017 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001018 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001019 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001020 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1021 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001022
wdenkb37c7e52003-06-30 16:24:52 +00001023 Note that if the RTC uses I2C, then the I2C interface
1024 must also be configured. See I2C Support, below.
1025
Peter Tysere92739d2008-12-17 16:36:21 -06001026- GPIO Support:
1027 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1028 CONFIG_PCA953X_INFO - enable pca953x info command
1029
Chris Packham5dec49c2010-12-19 10:12:13 +00001030 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1031 chip-ngpio pairs that tell the PCA953X driver the number of
1032 pins supported by a particular chip.
1033
Peter Tysere92739d2008-12-17 16:36:21 -06001034 Note that if the GPIO device uses I2C, then the I2C interface
1035 must also be configured. See I2C Support, below.
1036
wdenkc6097192002-11-03 00:24:07 +00001037- Timestamp Support:
1038
wdenk43d96162003-03-06 00:02:04 +00001039 When CONFIG_TIMESTAMP is selected, the timestamp
1040 (date and time) of an image is printed by image
1041 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001042 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001043
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001044- Partition Labels (disklabels) Supported:
1045 Zero or more of the following:
1046 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1047 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1048 Intel architecture, USB sticks, etc.
1049 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1050 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1051 bootloader. Note 2TB partition limit; see
1052 disk/part_efi.c
1053 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001054
Wolfgang Denk218ca722008-03-26 10:40:12 +01001055 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1056 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001057 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001058
1059- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001060 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1061 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001062
wdenk4d13cba2004-03-14 14:09:05 +00001063 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1064 be performed by calling the function
1065 ide_set_reset(int reset)
1066 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001067
1068- ATAPI Support:
1069 CONFIG_ATAPI
1070
1071 Set this to enable ATAPI support.
1072
wdenkc40b2952004-03-13 23:29:43 +00001073- LBA48 Support
1074 CONFIG_LBA48
1075
1076 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001077 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001078 Whithout these , LBA48 support uses 32bit variables and will 'only'
1079 support disks up to 2.1TB.
1080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001081 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001082 When enabled, makes the IDE subsystem use 64bit sector addresses.
1083 Default is 32bit.
1084
wdenkc6097192002-11-03 00:24:07 +00001085- SCSI Support:
1086 At the moment only there is only support for the
1087 SYM53C8XX SCSI controller; define
1088 CONFIG_SCSI_SYM53C8XX to enable it.
1089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001090 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1091 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1092 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001093 maximum numbers of LUNs, SCSI ID's and target
1094 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001095 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001096
Stefan Reinauer447c0312012-10-29 05:23:48 +00001097 The environment variable 'scsidevs' is set to the number of
1098 SCSI devices found during the last scan.
1099
wdenkc6097192002-11-03 00:24:07 +00001100- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001101 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001102 Support for Intel 8254x/8257x gigabit chips.
1103
1104 CONFIG_E1000_SPI
1105 Utility code for direct access to the SPI bus on Intel 8257x.
1106 This does not do anything useful unless you set at least one
1107 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1108
1109 CONFIG_E1000_SPI_GENERIC
1110 Allow generic access to the SPI bus on the Intel 8257x, for
1111 example with the "sspi" command.
1112
1113 CONFIG_CMD_E1000
1114 Management command for E1000 devices. When used on devices
1115 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001116
Andre Schwarzac3315c2008-03-06 16:45:44 +01001117 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001118 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001119
wdenkc6097192002-11-03 00:24:07 +00001120 CONFIG_EEPRO100
1121 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001122 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001123 write routine for first time initialisation.
1124
1125 CONFIG_TULIP
1126 Support for Digital 2114x chips.
1127 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1128 modem chip initialisation (KS8761/QS6611).
1129
1130 CONFIG_NATSEMI
1131 Support for National dp83815 chips.
1132
1133 CONFIG_NS8382X
1134 Support for National dp8382[01] gigabit chips.
1135
wdenk45219c42003-05-12 21:50:16 +00001136- NETWORK Support (other):
1137
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001138 CONFIG_DRIVER_AT91EMAC
1139 Support for AT91RM9200 EMAC.
1140
1141 CONFIG_RMII
1142 Define this to use reduced MII inteface
1143
1144 CONFIG_DRIVER_AT91EMAC_QUIET
1145 If this defined, the driver is quiet.
1146 The driver doen't show link status messages.
1147
Rob Herringefdd7312011-12-15 11:15:49 +00001148 CONFIG_CALXEDA_XGMAC
1149 Support for the Calxeda XGMAC device
1150
Ashok3bb46d22012-10-15 06:20:47 +00001151 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001152 Support for SMSC's LAN91C96 chips.
1153
1154 CONFIG_LAN91C96_BASE
1155 Define this to hold the physical address
1156 of the LAN91C96's I/O space
1157
1158 CONFIG_LAN91C96_USE_32_BIT
1159 Define this to enable 32 bit addressing
1160
Ashok3bb46d22012-10-15 06:20:47 +00001161 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001162 Support for SMSC's LAN91C111 chip
1163
1164 CONFIG_SMC91111_BASE
1165 Define this to hold the physical address
1166 of the device (I/O space)
1167
1168 CONFIG_SMC_USE_32_BIT
1169 Define this if data bus is 32 bits
1170
1171 CONFIG_SMC_USE_IOFUNCS
1172 Define this to use i/o functions instead of macros
1173 (some hardware wont work with macros)
1174
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001175 CONFIG_DRIVER_TI_EMAC
1176 Support for davinci emac
1177
1178 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1179 Define this if you have more then 3 PHYs.
1180
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001181 CONFIG_FTGMAC100
1182 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1183
1184 CONFIG_FTGMAC100_EGIGA
1185 Define this to use GE link update with gigabit PHY.
1186 Define this if FTGMAC100 is connected to gigabit PHY.
1187 If your system has 10/100 PHY only, it might not occur
1188 wrong behavior. Because PHY usually return timeout or
1189 useless data when polling gigabit status and gigabit
1190 control registers. This behavior won't affect the
1191 correctnessof 10/100 link speed update.
1192
Mike Rapoportc2fff332009-11-11 10:03:03 +02001193 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001194 Support for SMSC's LAN911x and LAN921x chips
1195
Mike Rapoportc2fff332009-11-11 10:03:03 +02001196 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001197 Define this to hold the physical address
1198 of the device (I/O space)
1199
Mike Rapoportc2fff332009-11-11 10:03:03 +02001200 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001201 Define this if data bus is 32 bits
1202
Mike Rapoportc2fff332009-11-11 10:03:03 +02001203 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001204 Define this if data bus is 16 bits. If your processor
1205 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001206 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001207
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001208 CONFIG_SH_ETHER
1209 Support for Renesas on-chip Ethernet controller
1210
1211 CONFIG_SH_ETHER_USE_PORT
1212 Define the number of ports to be used
1213
1214 CONFIG_SH_ETHER_PHY_ADDR
1215 Define the ETH PHY's address
1216
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001217 CONFIG_SH_ETHER_CACHE_WRITEBACK
1218 If this option is set, the driver enables cache flush.
1219
Vadim Bendebury5e124722011-10-17 08:36:14 +00001220- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001221 CONFIG_TPM
1222 Support TPM devices.
1223
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001224 CONFIG_TPM_TIS_I2C
1225 Support for i2c bus TPM devices. Only one device
1226 per system is supported at this time.
1227
1228 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1229 Define the the i2c bus number for the TPM device
1230
1231 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1232 Define the TPM's address on the i2c bus
1233
1234 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1235 Define the burst count bytes upper limit
1236
Dirk Eibachc01939c2013-06-26 15:55:15 +02001237 CONFIG_TPM_ATMEL_TWI
1238 Support for Atmel TWI TPM device. Requires I2C support.
1239
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001240 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001241 Support for generic parallel port TPM devices. Only one device
1242 per system is supported at this time.
1243
1244 CONFIG_TPM_TIS_BASE_ADDRESS
1245 Base address where the generic TPM device is mapped
1246 to. Contemporary x86 systems usually map it at
1247 0xfed40000.
1248
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001249 CONFIG_CMD_TPM
1250 Add tpm monitor functions.
1251 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1252 provides monitor access to authorized functions.
1253
1254 CONFIG_TPM
1255 Define this to enable the TPM support library which provides
1256 functional interfaces to some TPM commands.
1257 Requires support for a TPM device.
1258
1259 CONFIG_TPM_AUTH_SESSIONS
1260 Define this to enable authorized functions in the TPM library.
1261 Requires CONFIG_TPM and CONFIG_SHA1.
1262
wdenkc6097192002-11-03 00:24:07 +00001263- USB Support:
1264 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001265 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001266 CONFIG_USB_UHCI to enable it.
1267 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001268 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001269 storage devices.
1270 Note:
1271 Supported are USB Keyboards and USB Floppy drives
1272 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001273 MPC5200 USB requires additional defines:
1274 CONFIG_USB_CLOCK
1275 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001276 CONFIG_PSC3_USB
1277 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001278 CONFIG_USB_CONFIG
1279 for differential drivers: 0x00001000
1280 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001281 for differential drivers on PSC3: 0x00000100
1282 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001283 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001284 May be defined to allow interrupt polling
1285 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001286
Simon Glass9ab4ce22012-02-27 10:52:47 +00001287 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1288 txfilltuning field in the EHCI controller on reset.
1289
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001290 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1291 interval for usb hub power-on delay.(minimum 100msec)
1292
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001293- USB Device:
1294 Define the below if you wish to use the USB console.
1295 Once firmware is rebuilt from a serial console issue the
1296 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001297 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001298 it has found a new device. The environment variable usbtty
1299 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001300 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001301 Common Device Class Abstract Control Model serial device.
1302 If you select usbtty = gserial you should be able to enumerate
1303 a Linux host by
1304 # modprobe usbserial vendor=0xVendorID product=0xProductID
1305 else if using cdc_acm, simply setting the environment
1306 variable usbtty to be cdc_acm should suffice. The following
1307 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001308
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001309 CONFIG_USB_DEVICE
1310 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001311
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001312 CONFIG_USB_TTY
1313 Define this to have a tty type of device available to
1314 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001315
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301316 CONFIG_USBD_HS
1317 Define this to enable the high speed support for usb
1318 device and usbtty. If this feature is enabled, a routine
1319 int is_usbd_high_speed(void)
1320 also needs to be defined by the driver to dynamically poll
1321 whether the enumeration has succeded at high speed or full
1322 speed.
1323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001324 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001325 Define this if you want stdin, stdout &/or stderr to
1326 be set to usbtty.
1327
1328 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001329 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001330 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001331 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001333 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001334 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001335 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001336
Wolfgang Denk386eda02006-06-14 18:14:56 +02001337 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001338 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001339 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001340 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1341 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1342 should pretend to be a Linux device to it's target host.
1343
1344 CONFIG_USBD_MANUFACTURER
1345 Define this string as the name of your company for
1346 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001347
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001348 CONFIG_USBD_PRODUCT_NAME
1349 Define this string as the name of your product
1350 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1351
1352 CONFIG_USBD_VENDORID
1353 Define this as your assigned Vendor ID from the USB
1354 Implementors Forum. This *must* be a genuine Vendor ID
1355 to avoid polluting the USB namespace.
1356 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001357
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001358 CONFIG_USBD_PRODUCTID
1359 Define this as the unique Product ID
1360 for your device
1361 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001362
Igor Grinbergd70a5602011-12-12 12:08:35 +02001363- ULPI Layer Support:
1364 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1365 the generic ULPI layer. The generic layer accesses the ULPI PHY
1366 via the platform viewport, so you need both the genric layer and
1367 the viewport enabled. Currently only Chipidea/ARC based
1368 viewport is supported.
1369 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1370 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001371 If your ULPI phy needs a different reference clock than the
1372 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1373 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001374
1375- MMC Support:
1376 The MMC controller on the Intel PXA is supported. To
1377 enable this define CONFIG_MMC. The MMC can be
1378 accessed from the boot prompt by mapping the device
1379 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001380 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1381 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001382
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001383 CONFIG_SH_MMCIF
1384 Support for Renesas on-chip MMCIF controller
1385
1386 CONFIG_SH_MMCIF_ADDR
1387 Define the base address of MMCIF registers
1388
1389 CONFIG_SH_MMCIF_CLK
1390 Define the clock frequency for MMCIF
1391
Tom Rinib3ba6e92013-03-14 05:32:47 +00001392- USB Device Firmware Update (DFU) class support:
1393 CONFIG_DFU_FUNCTION
1394 This enables the USB portion of the DFU USB class
1395
1396 CONFIG_CMD_DFU
1397 This enables the command "dfu" which is used to have
1398 U-Boot create a DFU class device via USB. This command
1399 requires that the "dfu_alt_info" environment variable be
1400 set and define the alt settings to expose to the host.
1401
1402 CONFIG_DFU_MMC
1403 This enables support for exposing (e)MMC devices via DFU.
1404
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001405 CONFIG_DFU_NAND
1406 This enables support for exposing NAND devices via DFU.
1407
Heiko Schochere7e75c72013-06-12 06:05:51 +02001408 CONFIG_SYS_DFU_DATA_BUF_SIZE
1409 Dfu transfer uses a buffer before writing data to the
1410 raw storage device. Make the size (in bytes) of this buffer
1411 configurable. The size of this buffer is also configurable
1412 through the "dfu_bufsiz" environment variable.
1413
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001414 CONFIG_SYS_DFU_MAX_FILE_SIZE
1415 When updating files rather than the raw storage device,
1416 we use a static buffer to copy the file into and then write
1417 the buffer once we've been given the whole file. Define
1418 this to the maximum filesize (in bytes) for the buffer.
1419 Default is 4 MiB if undefined.
1420
wdenk6705d812004-08-02 23:22:59 +00001421- Journaling Flash filesystem support:
1422 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1423 CONFIG_JFFS2_NAND_DEV
1424 Define these for a default partition on a NAND device
1425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001426 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1427 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001428 Define these for a default partition on a NOR device
1429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001430 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001431 Define this to create an own partition. You have to provide a
1432 function struct part_info* jffs2_part_info(int part_num)
1433
1434 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001435 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001436 to disable the command chpart. This is the default when you
1437 have not defined a custom partition
1438
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001439- FAT(File Allocation Table) filesystem write function support:
1440 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001441
1442 Define this to enable support for saving memory data as a
1443 file in FAT formatted partition.
1444
1445 This will also enable the command "fatwrite" enabling the
1446 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001447
Gabe Black84cd9322012-10-12 14:26:11 +00001448CBFS (Coreboot Filesystem) support
1449 CONFIG_CMD_CBFS
1450
1451 Define this to enable support for reading from a Coreboot
1452 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1453 and cbfsload.
1454
wdenkc6097192002-11-03 00:24:07 +00001455- Keyboard Support:
1456 CONFIG_ISA_KEYBOARD
1457
1458 Define this to enable standard (PC-Style) keyboard
1459 support
1460
1461 CONFIG_I8042_KBD
1462 Standard PC keyboard driver with US (is default) and
1463 GERMAN key layout (switch via environment 'keymap=de') support.
1464 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1465 for cfb_console. Supports cursor blinking.
1466
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001467 CONFIG_CROS_EC_KEYB
1468 Enables a Chrome OS keyboard using the CROS_EC interface.
1469 This uses CROS_EC to communicate with a second microcontroller
1470 which provides key scans on request.
1471
wdenkc6097192002-11-03 00:24:07 +00001472- Video support:
1473 CONFIG_VIDEO
1474
1475 Define this to enable video support (for output to
1476 video).
1477
1478 CONFIG_VIDEO_CT69000
1479
1480 Enable Chips & Technologies 69000 Video chip
1481
1482 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001483 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001484 video output is selected via environment 'videoout'
1485 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1486 assumed.
wdenkc6097192002-11-03 00:24:07 +00001487
wdenkb79a11c2004-03-25 15:14:43 +00001488 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001489 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001490 are possible:
1491 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001492 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001493
1494 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1495 -------------+---------------------------------------------
1496 8 bits | 0x301* 0x303 0x305 0x161 0x307
1497 15 bits | 0x310 0x313 0x316 0x162 0x319
1498 16 bits | 0x311 0x314 0x317 0x163 0x31A
1499 24 bits | 0x312 0x315 0x318 ? 0x31B
1500 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001501 (i.e. setenv videomode 317; saveenv; reset;)
1502
wdenkb79a11c2004-03-25 15:14:43 +00001503 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001504 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001505
1506
stroesec1551ea2003-04-04 15:53:41 +00001507 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001508 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001509 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1510 or CONFIG_VIDEO_SED13806_16BPP
1511
Timur Tabi7d3053f2011-02-15 17:09:19 -06001512 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001513 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001514 SOCs that have a DIU should define this macro to enable DIU
1515 support, and should also define these other macros:
1516
1517 CONFIG_SYS_DIU_ADDR
1518 CONFIG_VIDEO
1519 CONFIG_CMD_BMP
1520 CONFIG_CFB_CONSOLE
1521 CONFIG_VIDEO_SW_CURSOR
1522 CONFIG_VGA_AS_SINGLE_DEVICE
1523 CONFIG_VIDEO_LOGO
1524 CONFIG_VIDEO_BMP_LOGO
1525
Timur Tabiba8e76b2011-04-11 14:18:22 -05001526 The DIU driver will look for the 'video-mode' environment
1527 variable, and if defined, enable the DIU as a console during
1528 boot. See the documentation file README.video for a
1529 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001530
Simon Glass058d59b2012-12-03 13:59:47 +00001531 CONFIG_VIDEO_VGA
1532
1533 Enable the VGA video / BIOS for x86. The alternative if you
1534 are using coreboot is to use the coreboot frame buffer
1535 driver.
1536
1537
wdenk682011f2003-06-03 23:54:09 +00001538- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001539 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001540
wdenk8bde7f72003-06-27 21:31:46 +00001541 Define this to enable a custom keyboard support.
1542 This simply calls drv_keyboard_init() which must be
1543 defined in your board-specific files.
1544 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001545
wdenkc6097192002-11-03 00:24:07 +00001546- LCD Support: CONFIG_LCD
1547
1548 Define this to enable LCD support (for output to LCD
1549 display); also select one of the supported displays
1550 by defining one of these:
1551
Stelian Pop39cf4802008-05-09 21:57:18 +02001552 CONFIG_ATMEL_LCD:
1553
1554 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1555
wdenkfd3103b2003-11-25 16:55:19 +00001556 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001557
wdenkfd3103b2003-11-25 16:55:19 +00001558 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001559
wdenkfd3103b2003-11-25 16:55:19 +00001560 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001561
wdenkfd3103b2003-11-25 16:55:19 +00001562 NEC NL6448BC20-08. 6.5", 640x480.
1563 Active, color, single scan.
1564
1565 CONFIG_NEC_NL6448BC33_54
1566
1567 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001568 Active, color, single scan.
1569
1570 CONFIG_SHARP_16x9
1571
1572 Sharp 320x240. Active, color, single scan.
1573 It isn't 16x9, and I am not sure what it is.
1574
1575 CONFIG_SHARP_LQ64D341
1576
1577 Sharp LQ64D341 display, 640x480.
1578 Active, color, single scan.
1579
1580 CONFIG_HLD1045
1581
1582 HLD1045 display, 640x480.
1583 Active, color, single scan.
1584
1585 CONFIG_OPTREX_BW
1586
1587 Optrex CBL50840-2 NF-FW 99 22 M5
1588 or
1589 Hitachi LMG6912RPFC-00T
1590 or
1591 Hitachi SP14Q002
1592
1593 320x240. Black & white.
1594
1595 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001596 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001597
Simon Glass676d3192012-10-17 13:24:54 +00001598 CONFIG_LCD_ALIGNMENT
1599
1600 Normally the LCD is page-aligned (tyically 4KB). If this is
1601 defined then the LCD will be aligned to this value instead.
1602 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1603 here, since it is cheaper to change data cache settings on
1604 a per-section basis.
1605
Simon Glass0d89efe2012-10-17 13:24:59 +00001606 CONFIG_CONSOLE_SCROLL_LINES
1607
1608 When the console need to be scrolled, this is the number of
1609 lines to scroll by. It defaults to 1. Increasing this makes
1610 the console jump but can help speed up operation when scrolling
1611 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001612
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001613 CONFIG_LCD_BMP_RLE8
1614
1615 Support drawing of RLE8-compressed bitmaps on the LCD.
1616
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001617 CONFIG_I2C_EDID
1618
1619 Enables an 'i2c edid' command which can read EDID
1620 information over I2C from an attached LCD display.
1621
wdenk7152b1d2003-09-05 23:19:14 +00001622- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001623
wdenk8bde7f72003-06-27 21:31:46 +00001624 If this option is set, the environment is checked for
1625 a variable "splashimage". If found, the usual display
1626 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001627 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001628 specified in "splashimage" is loaded instead. The
1629 console is redirected to the "nulldev", too. This
1630 allows for a "silent" boot where a splash screen is
1631 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001632
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001633 CONFIG_SPLASHIMAGE_GUARD
1634
1635 If this option is set, then U-Boot will prevent the environment
1636 variable "splashimage" from being set to a problematic address
1637 (see README.displaying-bmps and README.arm-unaligned-accesses).
1638 This option is useful for targets where, due to alignment
1639 restrictions, an improperly aligned BMP image will cause a data
1640 abort. If you think you will not have problems with unaligned
1641 accesses (for example because your toolchain prevents them)
1642 there is no need to set this option.
1643
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001644 CONFIG_SPLASH_SCREEN_ALIGN
1645
1646 If this option is set the splash image can be freely positioned
1647 on the screen. Environment variable "splashpos" specifies the
1648 position as "x,y". If a positive number is given it is used as
1649 number of pixel from left/top. If a negative number is given it
1650 is used as number of pixel from right/bottom. You can also
1651 specify 'm' for centering the image.
1652
1653 Example:
1654 setenv splashpos m,m
1655 => image at center of screen
1656
1657 setenv splashpos 30,20
1658 => image at x = 30 and y = 20
1659
1660 setenv splashpos -10,m
1661 => vertically centered image
1662 at x = dspWidth - bmpWidth - 9
1663
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001664- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1665
1666 If this option is set, additionally to standard BMP
1667 images, gzipped BMP images can be displayed via the
1668 splashscreen support or the bmp command.
1669
Anatolij Gustschind5011762010-03-15 14:50:25 +01001670- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1671
1672 If this option is set, 8-bit RLE compressed BMP images
1673 can be displayed via the splashscreen support or the
1674 bmp command.
1675
Lei Wenf2b96df2012-09-28 04:26:47 +00001676- Do compresssing for memory range:
1677 CONFIG_CMD_ZIP
1678
1679 If this option is set, it would use zlib deflate method
1680 to compress the specified memory at its best effort.
1681
wdenkc29fdfc2003-08-29 20:57:53 +00001682- Compression support:
1683 CONFIG_BZIP2
1684
1685 If this option is set, support for bzip2 compressed
1686 images is included. If not, only uncompressed and gzip
1687 compressed images are supported.
1688
wdenk42d1f032003-10-15 23:53:47 +00001689 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001690 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001691 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001692
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001693 CONFIG_LZMA
1694
1695 If this option is set, support for lzma compressed
1696 images is included.
1697
1698 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1699 requires an amount of dynamic memory that is given by the
1700 formula:
1701
1702 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1703
1704 Where lc and lp stand for, respectively, Literal context bits
1705 and Literal pos bits.
1706
1707 This value is upper-bounded by 14MB in the worst case. Anyway,
1708 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1709 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1710 a very small buffer.
1711
1712 Use the lzmainfo tool to determinate the lc and lp values and
1713 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001714 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001715
wdenk17ea1172004-06-06 21:51:03 +00001716- MII/PHY support:
1717 CONFIG_PHY_ADDR
1718
1719 The address of PHY on MII bus.
1720
1721 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1722
1723 The clock frequency of the MII bus
1724
1725 CONFIG_PHY_GIGE
1726
1727 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001728 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001729
1730 CONFIG_PHY_RESET_DELAY
1731
1732 Some PHY like Intel LXT971A need extra delay after
1733 reset before any MII register access is possible.
1734 For such PHY, set this option to the usec delay
1735 required. (minimum 300usec for LXT971A)
1736
1737 CONFIG_PHY_CMD_DELAY (ppc4xx)
1738
1739 Some PHY like Intel LXT971A need extra delay after
1740 command issued before MII status register can be read
1741
wdenkc6097192002-11-03 00:24:07 +00001742- Ethernet address:
1743 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001744 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001745 CONFIG_ETH2ADDR
1746 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001747 CONFIG_ETH4ADDR
1748 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001749
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001750 Define a default value for Ethernet address to use
1751 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001752 is not determined automatically.
1753
1754- IP address:
1755 CONFIG_IPADDR
1756
1757 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001758 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001759 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001760 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001761
1762- Server IP address:
1763 CONFIG_SERVERIP
1764
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001765 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001766 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001767 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001768
Robin Getz97cfe862009-07-21 12:15:28 -04001769 CONFIG_KEEP_SERVERADDR
1770
1771 Keeps the server's MAC address, in the env 'serveraddr'
1772 for passing to bootargs (like Linux's netconsole option)
1773
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001774- Gateway IP address:
1775 CONFIG_GATEWAYIP
1776
1777 Defines a default value for the IP address of the
1778 default router where packets to other networks are
1779 sent to.
1780 (Environment variable "gatewayip")
1781
1782- Subnet mask:
1783 CONFIG_NETMASK
1784
1785 Defines a default value for the subnet mask (or
1786 routing prefix) which is used to determine if an IP
1787 address belongs to the local subnet or needs to be
1788 forwarded through a router.
1789 (Environment variable "netmask")
1790
David Updegraff53a5c422007-06-11 10:41:07 -05001791- Multicast TFTP Mode:
1792 CONFIG_MCAST_TFTP
1793
1794 Defines whether you want to support multicast TFTP as per
1795 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001796 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001797 driver in use must provide a function: mcast() to join/leave a
1798 multicast group.
1799
wdenkc6097192002-11-03 00:24:07 +00001800- BOOTP Recovery Mode:
1801 CONFIG_BOOTP_RANDOM_DELAY
1802
1803 If you have many targets in a network that try to
1804 boot using BOOTP, you may want to avoid that all
1805 systems send out BOOTP requests at precisely the same
1806 moment (which would happen for instance at recovery
1807 from a power failure, when all systems will try to
1808 boot, thus flooding the BOOTP server. Defining
1809 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1810 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001811 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001812
1813 1st BOOTP request: delay 0 ... 1 sec
1814 2nd BOOTP request: delay 0 ... 2 sec
1815 3rd BOOTP request: delay 0 ... 4 sec
1816 4th and following
1817 BOOTP requests: delay 0 ... 8 sec
1818
stroesefe389a82003-08-28 14:17:32 +00001819- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001820 You can fine tune the DHCP functionality by defining
1821 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001822
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001823 CONFIG_BOOTP_SUBNETMASK
1824 CONFIG_BOOTP_GATEWAY
1825 CONFIG_BOOTP_HOSTNAME
1826 CONFIG_BOOTP_NISDOMAIN
1827 CONFIG_BOOTP_BOOTPATH
1828 CONFIG_BOOTP_BOOTFILESIZE
1829 CONFIG_BOOTP_DNS
1830 CONFIG_BOOTP_DNS2
1831 CONFIG_BOOTP_SEND_HOSTNAME
1832 CONFIG_BOOTP_NTPSERVER
1833 CONFIG_BOOTP_TIMEOFFSET
1834 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001835 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001836
Wilson Callan5d110f02007-07-28 10:56:13 -04001837 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1838 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001839
Joe Hershberger2c00e092012-05-23 07:59:19 +00001840 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1841 after the configured retry count, the call will fail
1842 instead of starting over. This can be used to fail over
1843 to Link-local IP address configuration if the DHCP server
1844 is not available.
1845
stroesefe389a82003-08-28 14:17:32 +00001846 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1847 serverip from a DHCP server, it is possible that more
1848 than one DNS serverip is offered to the client.
1849 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1850 serverip will be stored in the additional environment
1851 variable "dnsip2". The first DNS serverip is always
1852 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001853 is defined.
stroesefe389a82003-08-28 14:17:32 +00001854
1855 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1856 to do a dynamic update of a DNS server. To do this, they
1857 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001858 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001859 of the "hostname" environment variable is passed as
1860 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001861
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001862 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1863
1864 A 32bit value in microseconds for a delay between
1865 receiving a "DHCP Offer" and sending the "DHCP Request".
1866 This fixes a problem with certain DHCP servers that don't
1867 respond 100% of the time to a "DHCP request". E.g. On an
1868 AT91RM9200 processor running at 180MHz, this delay needed
1869 to be *at least* 15,000 usec before a Windows Server 2003
1870 DHCP server would reply 100% of the time. I recommend at
1871 least 50,000 usec to be safe. The alternative is to hope
1872 that one of the retries will be successful but note that
1873 the DHCP timeout and retry process takes a longer than
1874 this delay.
1875
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001876 - Link-local IP address negotiation:
1877 Negotiate with other link-local clients on the local network
1878 for an address that doesn't require explicit configuration.
1879 This is especially useful if a DHCP server cannot be guaranteed
1880 to exist in all environments that the device must operate.
1881
1882 See doc/README.link-local for more information.
1883
wdenka3d991b2004-04-15 21:48:45 +00001884 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001885 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001886
1887 The device id used in CDP trigger frames.
1888
1889 CONFIG_CDP_DEVICE_ID_PREFIX
1890
1891 A two character string which is prefixed to the MAC address
1892 of the device.
1893
1894 CONFIG_CDP_PORT_ID
1895
1896 A printf format string which contains the ascii name of
1897 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001898 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001899
1900 CONFIG_CDP_CAPABILITIES
1901
1902 A 32bit integer which indicates the device capabilities;
1903 0x00000010 for a normal host which does not forwards.
1904
1905 CONFIG_CDP_VERSION
1906
1907 An ascii string containing the version of the software.
1908
1909 CONFIG_CDP_PLATFORM
1910
1911 An ascii string containing the name of the platform.
1912
1913 CONFIG_CDP_TRIGGER
1914
1915 A 32bit integer sent on the trigger.
1916
1917 CONFIG_CDP_POWER_CONSUMPTION
1918
1919 A 16bit integer containing the power consumption of the
1920 device in .1 of milliwatts.
1921
1922 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1923
1924 A byte containing the id of the VLAN.
1925
wdenkc6097192002-11-03 00:24:07 +00001926- Status LED: CONFIG_STATUS_LED
1927
1928 Several configurations allow to display the current
1929 status using a LED. For instance, the LED will blink
1930 fast while running U-Boot code, stop blinking as
1931 soon as a reply to a BOOTP request was received, and
1932 start blinking slow once the Linux kernel is running
1933 (supported by a status LED driver in the Linux
1934 kernel). Defining CONFIG_STATUS_LED enables this
1935 feature in U-Boot.
1936
1937- CAN Support: CONFIG_CAN_DRIVER
1938
1939 Defining CONFIG_CAN_DRIVER enables CAN driver support
1940 on those systems that support this (optional)
1941 feature, like the TQM8xxL modules.
1942
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001943- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001944
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001945 This enable the NEW i2c subsystem, and will allow you to use
1946 i2c commands at the u-boot command line (as long as you set
1947 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1948 based realtime clock chips or other i2c devices. See
1949 common/cmd_i2c.c for a description of the command line
1950 interface.
1951
1952 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001953 - drivers/i2c/soft_i2c.c:
1954 - activate first bus with CONFIG_SYS_I2C_SOFT define
1955 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1956 for defining speed and slave address
1957 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1958 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1959 for defining speed and slave address
1960 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1961 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1962 for defining speed and slave address
1963 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1964 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1965 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001966
Heiko Schocher00f792e2012-10-24 13:48:22 +02001967 - drivers/i2c/fsl_i2c.c:
1968 - activate i2c driver with CONFIG_SYS_I2C_FSL
1969 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1970 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1971 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1972 bus.
1973 - If your board supports a second fsl i2c bus, define
1974 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1975 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1976 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1977 second bus.
1978
Simon Glass1f2ba722012-10-30 07:28:53 +00001979 - drivers/i2c/tegra_i2c.c:
1980 - activate this driver with CONFIG_SYS_I2C_TEGRA
1981 - This driver adds 4 i2c buses with a fix speed from
1982 100000 and the slave addr 0!
1983
Dirk Eibach880540d2013-04-25 02:40:01 +00001984 - drivers/i2c/ppc4xx_i2c.c
1985 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1986 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1987 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1988
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001989 additional defines:
1990
1991 CONFIG_SYS_NUM_I2C_BUSES
1992 Hold the number of i2c busses you want to use. If you
1993 don't use/have i2c muxes on your i2c bus, this
1994 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
1995 omit this define.
1996
1997 CONFIG_SYS_I2C_DIRECT_BUS
1998 define this, if you don't use i2c muxes on your hardware.
1999 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2000 omit this define.
2001
2002 CONFIG_SYS_I2C_MAX_HOPS
2003 define how many muxes are maximal consecutively connected
2004 on one i2c bus. If you not use i2c muxes, omit this
2005 define.
2006
2007 CONFIG_SYS_I2C_BUSES
2008 hold a list of busses you want to use, only used if
2009 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2010 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2011 CONFIG_SYS_NUM_I2C_BUSES = 9:
2012
2013 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2014 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2015 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2016 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2017 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2018 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2019 {1, {I2C_NULL_HOP}}, \
2020 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2021 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2022 }
2023
2024 which defines
2025 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002026 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2027 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2028 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2029 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2030 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002031 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002032 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2033 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002034
2035 If you do not have i2c muxes on your board, omit this define.
2036
Heiko Schocherea818db2013-01-29 08:53:15 +01002037- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002038
2039 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2040 provides the following compelling advantages:
2041
2042 - more than one i2c adapter is usable
2043 - approved multibus support
2044 - better i2c mux support
2045
2046 ** Please consider updating your I2C driver now. **
2047
Heiko Schocherea818db2013-01-29 08:53:15 +01002048 These enable legacy I2C serial bus commands. Defining
2049 CONFIG_HARD_I2C will include the appropriate I2C driver
2050 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002051
wdenk945af8d2003-07-16 21:53:01 +00002052 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002053 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002054 CONFIG_COMMANDS) and communicate with i2c based realtime
2055 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002056 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002057
Ben Warrenbb99ad62006-09-07 16:50:54 -04002058 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002059
wdenk945af8d2003-07-16 21:53:01 +00002060 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002061 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002063 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002064 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002065 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002066 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002067
Peter Tyser8d321b82010-04-12 22:28:21 -05002068 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002069 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002070 and so its address should therefore be cleared to 0 (See,
2071 eg, MPC823e User's Manual p.16-473). So, set
2072 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002073
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002074 CONFIG_SYS_I2C_INIT_MPC5XXX
2075
2076 When a board is reset during an i2c bus transfer
2077 chips might think that the current transfer is still
2078 in progress. Reset the slave devices by sending start
2079 commands until the slave device responds.
2080
wdenk945af8d2003-07-16 21:53:01 +00002081 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002082
Heiko Schocherea818db2013-01-29 08:53:15 +01002083 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002084 then the following macros need to be defined (examples are
2085 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002086
2087 I2C_INIT
2088
wdenkb37c7e52003-06-30 16:24:52 +00002089 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002090 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002091
wdenkba56f622004-02-06 23:19:44 +00002092 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002093
wdenkc6097192002-11-03 00:24:07 +00002094 I2C_PORT
2095
wdenk43d96162003-03-06 00:02:04 +00002096 (Only for MPC8260 CPU). The I/O port to use (the code
2097 assumes both bits are on the same port). Valid values
2098 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002099
2100 I2C_ACTIVE
2101
2102 The code necessary to make the I2C data line active
2103 (driven). If the data line is open collector, this
2104 define can be null.
2105
wdenkb37c7e52003-06-30 16:24:52 +00002106 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2107
wdenkc6097192002-11-03 00:24:07 +00002108 I2C_TRISTATE
2109
2110 The code necessary to make the I2C data line tri-stated
2111 (inactive). If the data line is open collector, this
2112 define can be null.
2113
wdenkb37c7e52003-06-30 16:24:52 +00002114 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2115
wdenkc6097192002-11-03 00:24:07 +00002116 I2C_READ
2117
York Sun472d5462013-04-01 11:29:11 -07002118 Code that returns true if the I2C data line is high,
2119 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002120
wdenkb37c7e52003-06-30 16:24:52 +00002121 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2122
wdenkc6097192002-11-03 00:24:07 +00002123 I2C_SDA(bit)
2124
York Sun472d5462013-04-01 11:29:11 -07002125 If <bit> is true, sets the I2C data line high. If it
2126 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002127
wdenkb37c7e52003-06-30 16:24:52 +00002128 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002129 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002130 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002131
wdenkc6097192002-11-03 00:24:07 +00002132 I2C_SCL(bit)
2133
York Sun472d5462013-04-01 11:29:11 -07002134 If <bit> is true, sets the I2C clock line high. If it
2135 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002136
wdenkb37c7e52003-06-30 16:24:52 +00002137 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002138 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002139 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002140
wdenkc6097192002-11-03 00:24:07 +00002141 I2C_DELAY
2142
2143 This delay is invoked four times per clock cycle so this
2144 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002145 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002146 like:
2147
wdenkb37c7e52003-06-30 16:24:52 +00002148 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002149
Mike Frysinger793b5722010-07-21 13:38:02 -04002150 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2151
2152 If your arch supports the generic GPIO framework (asm/gpio.h),
2153 then you may alternatively define the two GPIOs that are to be
2154 used as SCL / SDA. Any of the previous I2C_xxx macros will
2155 have GPIO-based defaults assigned to them as appropriate.
2156
2157 You should define these to the GPIO value as given directly to
2158 the generic GPIO functions.
2159
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002160 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002161
wdenk8bde7f72003-06-27 21:31:46 +00002162 When a board is reset during an i2c bus transfer
2163 chips might think that the current transfer is still
2164 in progress. On some boards it is possible to access
2165 the i2c SCLK line directly, either by using the
2166 processor pin as a GPIO or by having a second pin
2167 connected to the bus. If this option is defined a
2168 custom i2c_init_board() routine in boards/xxx/board.c
2169 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002170
Richard Retanubun26a33502010-04-12 15:08:17 -04002171 CONFIG_SYS_I2C_BOARD_LATE_INIT
2172
2173 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2174 defined a custom i2c_board_late_init() routine in
2175 boards/xxx/board.c is run AFTER the operations in i2c_init()
2176 is completed. This callpoint can be used to unreset i2c bus
2177 using CPU i2c controller register accesses for CPUs whose i2c
2178 controller provide such a method. It is called at the end of
2179 i2c_init() to allow i2c_init operations to setup the i2c bus
2180 controller on the CPU (e.g. setting bus speed & slave address).
2181
wdenk17ea1172004-06-06 21:51:03 +00002182 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2183
2184 This option enables configuration of bi_iic_fast[] flags
2185 in u-boot bd_info structure based on u-boot environment
2186 variable "i2cfast". (see also i2cfast)
2187
Ben Warrenbb99ad62006-09-07 16:50:54 -04002188 CONFIG_I2C_MULTI_BUS
2189
2190 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002191 must have a controller. At any point in time, only one bus is
2192 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002193 Note that bus numbering is zero-based.
2194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002195 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002196
2197 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002198 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002199 is set, specify a list of bus-device pairs. Otherwise, specify
2200 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002201
2202 e.g.
2203 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002204 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002205
2206 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2207
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002208 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002209 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002210
2211 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002214
2215 If defined, then this indicates the I2C bus number for DDR SPD.
2216 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002218 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002219
2220 If defined, then this indicates the I2C bus number for the RTC.
2221 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002223 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002224
2225 If defined, then this indicates the I2C bus number for the DTT.
2226 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002228 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002229
2230 If defined, specifies the I2C address of the DTT device.
2231 If not defined, then U-Boot uses predefined value for
2232 specified DTT device.
2233
Andrew Dyer2ac69852008-12-29 17:36:01 -06002234 CONFIG_SOFT_I2C_READ_REPEATED_START
2235
2236 defining this will force the i2c_read() function in
2237 the soft_i2c driver to perform an I2C repeated start
2238 between writing the address pointer and reading the
2239 data. If this define is omitted the default behaviour
2240 of doing a stop-start sequence will be used. Most I2C
2241 devices can use either method, but some require one or
2242 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002243
wdenkc6097192002-11-03 00:24:07 +00002244- SPI Support: CONFIG_SPI
2245
2246 Enables SPI driver (so far only tested with
2247 SPI EEPROM, also an instance works with Crystal A/D and
2248 D/As on the SACSng board)
2249
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002250 CONFIG_SH_SPI
2251
2252 Enables the driver for SPI controller on SuperH. Currently
2253 only SH7757 is supported.
2254
wdenkc6097192002-11-03 00:24:07 +00002255 CONFIG_SPI_X
2256
2257 Enables extended (16-bit) SPI EEPROM addressing.
2258 (symmetrical to CONFIG_I2C_X)
2259
2260 CONFIG_SOFT_SPI
2261
wdenk43d96162003-03-06 00:02:04 +00002262 Enables a software (bit-bang) SPI driver rather than
2263 using hardware support. This is a general purpose
2264 driver that only requires three general I/O port pins
2265 (two outputs, one input) to function. If this is
2266 defined, the board configuration must define several
2267 SPI configuration items (port pins to use, etc). For
2268 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002269
Ben Warren04a9e112008-01-16 22:37:35 -05002270 CONFIG_HARD_SPI
2271
2272 Enables a hardware SPI driver for general-purpose reads
2273 and writes. As with CONFIG_SOFT_SPI, the board configuration
2274 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002275 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002276 example, see include/configs/mpc8349emds.h.
2277
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002278 CONFIG_MXC_SPI
2279
2280 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002281 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002282
Matthias Fuchs01335022007-12-27 17:12:34 +01002283- FPGA Support: CONFIG_FPGA
2284
2285 Enables FPGA subsystem.
2286
2287 CONFIG_FPGA_<vendor>
2288
2289 Enables support for specific chip vendors.
2290 (ALTERA, XILINX)
2291
2292 CONFIG_FPGA_<family>
2293
2294 Enables support for FPGA family.
2295 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2296
2297 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002298
wdenk43d96162003-03-06 00:02:04 +00002299 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002301 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002302
wdenk8bde7f72003-06-27 21:31:46 +00002303 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002305 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002306
wdenk43d96162003-03-06 00:02:04 +00002307 Enable checks on FPGA configuration interface busy
2308 status by the configuration function. This option
2309 will require a board or device specific function to
2310 be written.
wdenkc6097192002-11-03 00:24:07 +00002311
2312 CONFIG_FPGA_DELAY
2313
2314 If defined, a function that provides delays in the FPGA
2315 configuration driver.
2316
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002317 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002318 Allow Control-C to interrupt FPGA configuration
2319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002320 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002321
wdenk43d96162003-03-06 00:02:04 +00002322 Check for configuration errors during FPGA bitfile
2323 loading. For example, abort during Virtex II
2324 configuration if the INIT_B line goes low (which
2325 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002327 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002328
wdenk43d96162003-03-06 00:02:04 +00002329 Maximum time to wait for the INIT_B line to deassert
2330 after PROB_B has been deasserted during a Virtex II
2331 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002332 ms.
wdenkc6097192002-11-03 00:24:07 +00002333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002335
wdenk43d96162003-03-06 00:02:04 +00002336 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002337 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002339 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002340
wdenk43d96162003-03-06 00:02:04 +00002341 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002342 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002343
2344- Configuration Management:
2345 CONFIG_IDENT_STRING
2346
wdenk43d96162003-03-06 00:02:04 +00002347 If defined, this string will be added to the U-Boot
2348 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002349
2350- Vendor Parameter Protection:
2351
wdenk43d96162003-03-06 00:02:04 +00002352 U-Boot considers the values of the environment
2353 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002354 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002355 are set once by the board vendor / manufacturer, and
2356 protects these variables from casual modification by
2357 the user. Once set, these variables are read-only,
2358 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002359 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002360
2361 If CONFIG_ENV_OVERWRITE is #defined in your config
2362 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002363 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002364 these parameters.
2365
2366 Alternatively, if you #define _both_ CONFIG_ETHADDR
2367 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002369 which can be changed exactly ONCE by the user. [The
2370 serial# is unaffected by this, i. e. it remains
2371 read-only.]
2372
Joe Hershberger25980902012-12-11 22:16:31 -06002373 The same can be accomplished in a more flexible way
2374 for any variable by configuring the type of access
2375 to allow for those variables in the ".flags" variable
2376 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2377
wdenkc6097192002-11-03 00:24:07 +00002378- Protected RAM:
2379 CONFIG_PRAM
2380
2381 Define this variable to enable the reservation of
2382 "protected RAM", i. e. RAM which is not overwritten
2383 by U-Boot. Define CONFIG_PRAM to hold the number of
2384 kB you want to reserve for pRAM. You can overwrite
2385 this default value by defining an environment
2386 variable "pram" to the number of kB you want to
2387 reserve. Note that the board info structure will
2388 still show the full amount of RAM. If pRAM is
2389 reserved, a new environment variable "mem" will
2390 automatically be defined to hold the amount of
2391 remaining RAM in a form that can be passed as boot
2392 argument to Linux, for instance like that:
2393
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002394 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002395 saveenv
2396
2397 This way you can tell Linux not to use this memory,
2398 either, which results in a memory region that will
2399 not be affected by reboots.
2400
2401 *WARNING* If your board configuration uses automatic
2402 detection of the RAM size, you must make sure that
2403 this memory test is non-destructive. So far, the
2404 following board configurations are known to be
2405 "pRAM-clean":
2406
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002407 IVMS8, IVML24, SPD8xx, TQM8xxL,
2408 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002409 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002410
Gabe Black40fef042012-12-02 04:55:18 +00002411- Access to physical memory region (> 4GB)
2412 Some basic support is provided for operations on memory not
2413 normally accessible to U-Boot - e.g. some architectures
2414 support access to more than 4GB of memory on 32-bit
2415 machines using physical address extension or similar.
2416 Define CONFIG_PHYSMEM to access this basic support, which
2417 currently only supports clearing the memory.
2418
wdenkc6097192002-11-03 00:24:07 +00002419- Error Recovery:
2420 CONFIG_PANIC_HANG
2421
2422 Define this variable to stop the system in case of a
2423 fatal error, so that you have to reset it manually.
2424 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002425 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002426 automatically as fast as possible, but it may be
2427 useful during development since you can try to debug
2428 the conditions that lead to the situation.
2429
2430 CONFIG_NET_RETRY_COUNT
2431
wdenk43d96162003-03-06 00:02:04 +00002432 This variable defines the number of retries for
2433 network operations like ARP, RARP, TFTP, or BOOTP
2434 before giving up the operation. If not defined, a
2435 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002436
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002437 CONFIG_ARP_TIMEOUT
2438
2439 Timeout waiting for an ARP reply in milliseconds.
2440
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002441 CONFIG_NFS_TIMEOUT
2442
2443 Timeout in milliseconds used in NFS protocol.
2444 If you encounter "ERROR: Cannot umount" in nfs command,
2445 try longer timeout such as
2446 #define CONFIG_NFS_TIMEOUT 10000UL
2447
wdenkc6097192002-11-03 00:24:07 +00002448- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002449 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002450
2451 Enable auto completion of commands using TAB.
2452
Wolfgang Denka9398e02006-11-27 15:32:42 +01002453 Note that this feature has NOT been implemented yet
2454 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002455
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002458
2459 Define this variable to enable the "hush" shell (from
2460 Busybox) as command line interpreter, thus enabling
2461 powerful command line syntax like
2462 if...then...else...fi conditionals or `&&' and '||'
2463 constructs ("shell scripts").
2464
2465 If undefined, you get the old, much simpler behaviour
2466 with a somewhat smaller memory footprint.
2467
2468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002469 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002470
2471 This defines the secondary prompt string, which is
2472 printed when the command interpreter needs more input
2473 to complete a command. Usually "> ".
2474
2475 Note:
2476
wdenk8bde7f72003-06-27 21:31:46 +00002477 In the current implementation, the local variables
2478 space and global environment variables space are
2479 separated. Local variables are those you define by
2480 simply typing `name=value'. To access a local
2481 variable later on, you have write `$name' or
2482 `${name}'; to execute the contents of a variable
2483 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002484
wdenk43d96162003-03-06 00:02:04 +00002485 Global environment variables are those you use
2486 setenv/printenv to work with. To run a command stored
2487 in such a variable, you need to use the run command,
2488 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002489
2490 To store commands and special characters in a
2491 variable, please use double quotation marks
2492 surrounding the whole text of the variable, instead
2493 of the backslashes before semicolons and special
2494 symbols.
2495
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002496- Commandline Editing and History:
2497 CONFIG_CMDLINE_EDITING
2498
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002499 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002500 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002501
wdenka8c7c702003-12-06 19:49:23 +00002502- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002503 CONFIG_EXTRA_ENV_SETTINGS
2504
wdenk43d96162003-03-06 00:02:04 +00002505 Define this to contain any number of null terminated
2506 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002507 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002508
wdenk43d96162003-03-06 00:02:04 +00002509 For example, place something like this in your
2510 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002511
2512 #define CONFIG_EXTRA_ENV_SETTINGS \
2513 "myvar1=value1\0" \
2514 "myvar2=value2\0"
2515
wdenk43d96162003-03-06 00:02:04 +00002516 Warning: This method is based on knowledge about the
2517 internal format how the environment is stored by the
2518 U-Boot code. This is NOT an official, exported
2519 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002520 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002521 You better know what you are doing here.
2522
wdenk43d96162003-03-06 00:02:04 +00002523 Note: overly (ab)use of the default environment is
2524 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002525 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002526 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002527
Stephen Warren5e724ca2012-05-22 09:21:54 +00002528 CONFIG_ENV_VARS_UBOOT_CONFIG
2529
2530 Define this in order to add variables describing the
2531 U-Boot build configuration to the default environment.
2532 These will be named arch, cpu, board, vendor, and soc.
2533
2534 Enabling this option will cause the following to be defined:
2535
2536 - CONFIG_SYS_ARCH
2537 - CONFIG_SYS_CPU
2538 - CONFIG_SYS_BOARD
2539 - CONFIG_SYS_VENDOR
2540 - CONFIG_SYS_SOC
2541
Tom Rini7e27f892012-10-24 07:28:16 +00002542 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2543
2544 Define this in order to add variables describing certain
2545 run-time determined information about the hardware to the
2546 environment. These will be named board_name, board_rev.
2547
Simon Glass06fd8532012-11-30 13:01:17 +00002548 CONFIG_DELAY_ENVIRONMENT
2549
2550 Normally the environment is loaded when the board is
2551 intialised so that it is available to U-Boot. This inhibits
2552 that so that the environment is not available until
2553 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2554 this is instead controlled by the value of
2555 /config/load-environment.
2556
wdenka8c7c702003-12-06 19:49:23 +00002557- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002558 CONFIG_HAS_DATAFLASH
2559
wdenk8bde7f72003-06-27 21:31:46 +00002560 Defining this option enables DataFlash features and
2561 allows to read/write in Dataflash via the standard
2562 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002563
Eric Nelsonf61ec452012-01-31 10:52:08 -07002564- Serial Flash support
2565 CONFIG_CMD_SF
2566
2567 Defining this option enables SPI flash commands
2568 'sf probe/read/write/erase/update'.
2569
2570 Usage requires an initial 'probe' to define the serial
2571 flash parameters, followed by read/write/erase/update
2572 commands.
2573
2574 The following defaults may be provided by the platform
2575 to handle the common case when only a single serial
2576 flash is present on the system.
2577
2578 CONFIG_SF_DEFAULT_BUS Bus identifier
2579 CONFIG_SF_DEFAULT_CS Chip-select
2580 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2581 CONFIG_SF_DEFAULT_SPEED in Hz
2582
Simon Glass24007272012-10-08 13:16:02 +00002583 CONFIG_CMD_SF_TEST
2584
2585 Define this option to include a destructive SPI flash
2586 test ('sf test').
2587
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302588 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2589
2590 Define this option to use the Bank addr/Extended addr
2591 support on SPI flashes which has size > 16Mbytes.
2592
wdenk3f85ce22004-02-23 16:11:30 +00002593- SystemACE Support:
2594 CONFIG_SYSTEMACE
2595
2596 Adding this option adds support for Xilinx SystemACE
2597 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002598 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002599 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002600
2601 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002602 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002603
2604 When SystemACE support is added, the "ace" device type
2605 becomes available to the fat commands, i.e. fatls.
2606
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002607- TFTP Fixed UDP Port:
2608 CONFIG_TFTP_PORT
2609
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002610 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002611 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002612 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002613 number generator is used.
2614
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002615 Also, the environment variable tftpdstp is used to supply
2616 the TFTP UDP destination port value. If tftpdstp isn't
2617 defined, the normal port 69 is used.
2618
2619 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002620 blindly start the TFTP transfer using the pre-configured
2621 target IP address and UDP port. This has the effect of
2622 "punching through" the (Windows XP) firewall, allowing
2623 the remainder of the TFTP transfer to proceed normally.
2624 A better solution is to properly configure the firewall,
2625 but sometimes that is not allowed.
2626
Simon Glassbf36c5d2012-12-05 14:46:38 +00002627- Hashing support:
2628 CONFIG_CMD_HASH
2629
2630 This enables a generic 'hash' command which can produce
2631 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2632
2633 CONFIG_HASH_VERIFY
2634
2635 Enable the hash verify command (hash -v). This adds to code
2636 size a little.
2637
2638 CONFIG_SHA1 - support SHA1 hashing
2639 CONFIG_SHA256 - support SHA256 hashing
2640
2641 Note: There is also a sha1sum command, which should perhaps
2642 be deprecated in favour of 'hash sha1'.
2643
Simon Glass19c402a2013-06-13 15:10:02 -07002644- Signing support:
2645 CONFIG_RSA
2646
2647 This enables the RSA algorithm used for FIT image verification
2648 in U-Boot. See doc/uImage/signature for more information.
2649
2650 The signing part is build into mkimage regardless of this
2651 option.
2652
2653
wdenka8c7c702003-12-06 19:49:23 +00002654- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002655 CONFIG_SHOW_BOOT_PROGRESS
2656
wdenk43d96162003-03-06 00:02:04 +00002657 Defining this option allows to add some board-
2658 specific code (calling a user-provided function
2659 "show_boot_progress(int)") that enables you to show
2660 the system's boot progress on some display (for
2661 example, some LED's) on your board. At the moment,
2662 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002663
Simon Glass3a608ca2012-02-13 13:51:19 +00002664- Detailed boot stage timing
2665 CONFIG_BOOTSTAGE
2666 Define this option to get detailed timing of each stage
2667 of the boot process.
2668
2669 CONFIG_BOOTSTAGE_USER_COUNT
2670 This is the number of available user bootstage records.
2671 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2672 a new ID will be allocated from this stash. If you exceed
2673 the limit, recording will stop.
2674
2675 CONFIG_BOOTSTAGE_REPORT
2676 Define this to print a report before boot, similar to this:
2677
2678 Timer summary in microseconds:
2679 Mark Elapsed Stage
2680 0 0 reset
2681 3,575,678 3,575,678 board_init_f start
2682 3,575,695 17 arch_cpu_init A9
2683 3,575,777 82 arch_cpu_init done
2684 3,659,598 83,821 board_init_r start
2685 3,910,375 250,777 main_loop
2686 29,916,167 26,005,792 bootm_start
2687 30,361,327 445,160 start_kernel
2688
Simon Glass2eba38c2012-09-28 08:56:39 +00002689 CONFIG_CMD_BOOTSTAGE
2690 Add a 'bootstage' command which supports printing a report
2691 and un/stashing of bootstage data.
2692
Simon Glass94fd1312012-09-28 08:56:37 +00002693 CONFIG_BOOTSTAGE_FDT
2694 Stash the bootstage information in the FDT. A root 'bootstage'
2695 node is created with each bootstage id as a child. Each child
2696 has a 'name' property and either 'mark' containing the
2697 mark time in microsecond, or 'accum' containing the
2698 accumulated time for that bootstage id in microseconds.
2699 For example:
2700
2701 bootstage {
2702 154 {
2703 name = "board_init_f";
2704 mark = <3575678>;
2705 };
2706 170 {
2707 name = "lcd";
2708 accum = <33482>;
2709 };
2710 };
2711
2712 Code in the Linux kernel can find this in /proc/devicetree.
2713
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002714Legacy uImage format:
2715
wdenkc6097192002-11-03 00:24:07 +00002716 Arg Where When
2717 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002718 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002719 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002720 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002721 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002722 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002723 4 common/cmd_bootm.c Image data has correct checksum
2724 -4 common/cmd_bootm.c Image is for unsupported architecture
2725 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002726 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002727 6 common/cmd_bootm.c Image Type check OK
2728 -6 common/cmd_bootm.c gunzip uncompression error
2729 -7 common/cmd_bootm.c Unimplemented compression type
2730 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002731 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002732 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002733
2734 9 common/image.c Start initial ramdisk verification
2735 -10 common/image.c Ramdisk header has bad magic number
2736 -11 common/image.c Ramdisk header has bad checksum
2737 10 common/image.c Ramdisk header is OK
2738 -12 common/image.c Ramdisk data has bad checksum
2739 11 common/image.c Ramdisk data has correct checksum
2740 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002741 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002742 13 common/image.c Start multifile image verification
2743 14 common/image.c No initial ramdisk, no multifile, continue.
2744
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002745 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002746
Stefan Roesea47a12b2010-04-15 16:07:28 +02002747 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002748 -31 post/post.c POST test failed, detected by post_output_backlog()
2749 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002750
Heiko Schocher566a4942007-06-22 19:11:54 +02002751 34 common/cmd_doc.c before loading a Image from a DOC device
2752 -35 common/cmd_doc.c Bad usage of "doc" command
2753 35 common/cmd_doc.c correct usage of "doc" command
2754 -36 common/cmd_doc.c No boot device
2755 36 common/cmd_doc.c correct boot device
2756 -37 common/cmd_doc.c Unknown Chip ID on boot device
2757 37 common/cmd_doc.c correct chip ID found, device available
2758 -38 common/cmd_doc.c Read Error on boot device
2759 38 common/cmd_doc.c reading Image header from DOC device OK
2760 -39 common/cmd_doc.c Image header has bad magic number
2761 39 common/cmd_doc.c Image header has correct magic number
2762 -40 common/cmd_doc.c Error reading Image from DOC device
2763 40 common/cmd_doc.c Image header has correct magic number
2764 41 common/cmd_ide.c before loading a Image from a IDE device
2765 -42 common/cmd_ide.c Bad usage of "ide" command
2766 42 common/cmd_ide.c correct usage of "ide" command
2767 -43 common/cmd_ide.c No boot device
2768 43 common/cmd_ide.c boot device found
2769 -44 common/cmd_ide.c Device not available
2770 44 common/cmd_ide.c Device available
2771 -45 common/cmd_ide.c wrong partition selected
2772 45 common/cmd_ide.c partition selected
2773 -46 common/cmd_ide.c Unknown partition table
2774 46 common/cmd_ide.c valid partition table found
2775 -47 common/cmd_ide.c Invalid partition type
2776 47 common/cmd_ide.c correct partition type
2777 -48 common/cmd_ide.c Error reading Image Header on boot device
2778 48 common/cmd_ide.c reading Image Header from IDE device OK
2779 -49 common/cmd_ide.c Image header has bad magic number
2780 49 common/cmd_ide.c Image header has correct magic number
2781 -50 common/cmd_ide.c Image header has bad checksum
2782 50 common/cmd_ide.c Image header has correct checksum
2783 -51 common/cmd_ide.c Error reading Image from IDE device
2784 51 common/cmd_ide.c reading Image from IDE device OK
2785 52 common/cmd_nand.c before loading a Image from a NAND device
2786 -53 common/cmd_nand.c Bad usage of "nand" command
2787 53 common/cmd_nand.c correct usage of "nand" command
2788 -54 common/cmd_nand.c No boot device
2789 54 common/cmd_nand.c boot device found
2790 -55 common/cmd_nand.c Unknown Chip ID on boot device
2791 55 common/cmd_nand.c correct chip ID found, device available
2792 -56 common/cmd_nand.c Error reading Image Header on boot device
2793 56 common/cmd_nand.c reading Image Header from NAND device OK
2794 -57 common/cmd_nand.c Image header has bad magic number
2795 57 common/cmd_nand.c Image header has correct magic number
2796 -58 common/cmd_nand.c Error reading Image from NAND device
2797 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002798
Heiko Schocher566a4942007-06-22 19:11:54 +02002799 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002800
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002801 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002802 -64 net/eth.c no Ethernet found.
2803 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002804
Heiko Schocher566a4942007-06-22 19:11:54 +02002805 -80 common/cmd_net.c usage wrong
2806 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002807 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002808 81 common/cmd_net.c NetLoop() back without error
2809 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2810 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002811 83 common/cmd_net.c running "source" command
2812 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002813 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002814
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002815FIT uImage format:
2816
2817 Arg Where When
2818 100 common/cmd_bootm.c Kernel FIT Image has correct format
2819 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2820 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2821 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2822 102 common/cmd_bootm.c Kernel unit name specified
2823 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002824 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002825 104 common/cmd_bootm.c Got kernel subimage node offset
2826 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2827 105 common/cmd_bootm.c Kernel subimage hash verification OK
2828 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2829 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002830 -106 common/cmd_bootm.c Kernel subimage has wrong type
2831 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002832 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2833 108 common/cmd_bootm.c Got kernel subimage data/size
2834 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2835 -109 common/cmd_bootm.c Can't get kernel subimage type
2836 -110 common/cmd_bootm.c Can't get kernel subimage comp
2837 -111 common/cmd_bootm.c Can't get kernel subimage os
2838 -112 common/cmd_bootm.c Can't get kernel subimage load address
2839 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2840
2841 120 common/image.c Start initial ramdisk verification
2842 -120 common/image.c Ramdisk FIT image has incorrect format
2843 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002844 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002845 -122 common/image.c Can't get configuration for ramdisk subimage
2846 123 common/image.c Ramdisk unit name specified
2847 -124 common/image.c Can't get ramdisk subimage node offset
2848 125 common/image.c Got ramdisk subimage node offset
2849 -125 common/image.c Ramdisk subimage hash verification failed
2850 126 common/image.c Ramdisk subimage hash verification OK
2851 -126 common/image.c Ramdisk subimage for unsupported architecture
2852 127 common/image.c Architecture check OK
2853 -127 common/image.c Can't get ramdisk subimage data/size
2854 128 common/image.c Got ramdisk subimage data/size
2855 129 common/image.c Can't get ramdisk load address
2856 -129 common/image.c Got ramdisk load address
2857
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002858 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002859 131 common/cmd_doc.c FIT image format OK
2860
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002861 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002862 141 common/cmd_ide.c FIT image format OK
2863
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002864 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002865 151 common/cmd_nand.c FIT image format OK
2866
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002867- FIT image support:
2868 CONFIG_FIT
2869 Enable support for the FIT uImage format.
2870
2871 CONFIG_FIT_BEST_MATCH
2872 When no configuration is explicitly selected, default to the
2873 one whose fdt's compatibility field best matches that of
2874 U-Boot itself. A match is considered "best" if it matches the
2875 most specific compatibility entry of U-Boot's fdt's root node.
2876 The order of entries in the configuration's fdt is ignored.
2877
Simon Glass3e569a62013-06-13 15:10:00 -07002878 CONFIG_FIT_SIGNATURE
2879 This option enables signature verification of FIT uImages,
2880 using a hash signed and verified using RSA. See
2881 doc/uImage.FIT/signature.txt for more details.
2882
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002883- Standalone program support:
2884 CONFIG_STANDALONE_LOAD_ADDR
2885
Wolfgang Denk6feff892011-10-09 21:06:34 +02002886 This option defines a board specific value for the
2887 address where standalone program gets loaded, thus
2888 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002889 settings.
2890
2891- Frame Buffer Address:
2892 CONFIG_FB_ADDR
2893
2894 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002895 address for frame buffer. This is typically the case
2896 when using a graphics controller has separate video
2897 memory. U-Boot will then place the frame buffer at
2898 the given address instead of dynamically reserving it
2899 in system RAM by calling lcd_setmem(), which grabs
2900 the memory for the frame buffer depending on the
2901 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002902
2903 Please see board_init_f function.
2904
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002905- Automatic software updates via TFTP server
2906 CONFIG_UPDATE_TFTP
2907 CONFIG_UPDATE_TFTP_CNT_MAX
2908 CONFIG_UPDATE_TFTP_MSEC_MAX
2909
2910 These options enable and control the auto-update feature;
2911 for a more detailed description refer to doc/README.update.
2912
2913- MTD Support (mtdparts command, UBI support)
2914 CONFIG_MTD_DEVICE
2915
2916 Adds the MTD device infrastructure from the Linux kernel.
2917 Needed for mtdparts command support.
2918
2919 CONFIG_MTD_PARTITIONS
2920
2921 Adds the MTD partitioning infrastructure from the Linux
2922 kernel. Needed for UBI support.
2923
Joe Hershberger70c219c2013-04-08 10:32:48 +00002924- UBI support
2925 CONFIG_CMD_UBI
2926
2927 Adds commands for interacting with MTD partitions formatted
2928 with the UBI flash translation layer
2929
2930 Requires also defining CONFIG_RBTREE
2931
Joe Hershberger147162d2013-04-08 10:32:49 +00002932 CONFIG_UBI_SILENCE_MSG
2933
2934 Make the verbose messages from UBI stop printing. This leaves
2935 warnings and errors enabled.
2936
Joe Hershberger70c219c2013-04-08 10:32:48 +00002937- UBIFS support
2938 CONFIG_CMD_UBIFS
2939
2940 Adds commands for interacting with UBI volumes formatted as
2941 UBIFS. UBIFS is read-only in u-boot.
2942
2943 Requires UBI support as well as CONFIG_LZO
2944
Joe Hershberger147162d2013-04-08 10:32:49 +00002945 CONFIG_UBIFS_SILENCE_MSG
2946
2947 Make the verbose messages from UBIFS stop printing. This leaves
2948 warnings and errors enabled.
2949
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002950- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002951 CONFIG_SPL
2952 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002953
Tom Rini95579792012-02-14 07:29:40 +00002954 CONFIG_SPL_LDSCRIPT
2955 LDSCRIPT for linking the SPL binary.
2956
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002957 CONFIG_SPL_MAX_FOOTPRINT
2958 Maximum size in memory allocated to the SPL, BSS included.
2959 When defined, the linker checks that the actual memory
2960 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002961 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002962 must not be both defined at the same time.
2963
Tom Rini95579792012-02-14 07:29:40 +00002964 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002965 Maximum size of the SPL image (text, data, rodata, and
2966 linker lists sections), BSS excluded.
2967 When defined, the linker checks that the actual size does
2968 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002969
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002970 CONFIG_SPL_TEXT_BASE
2971 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002972
Scott Wood94a45bb2012-09-20 19:05:12 -05002973 CONFIG_SPL_RELOC_TEXT_BASE
2974 Address to relocate to. If unspecified, this is equal to
2975 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2976
Tom Rini95579792012-02-14 07:29:40 +00002977 CONFIG_SPL_BSS_START_ADDR
2978 Link address for the BSS within the SPL binary.
2979
2980 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002981 Maximum size in memory allocated to the SPL BSS.
2982 When defined, the linker checks that the actual memory used
2983 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002984 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002985 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002986
2987 CONFIG_SPL_STACK
2988 Adress of the start of the stack SPL will use
2989
Scott Wood94a45bb2012-09-20 19:05:12 -05002990 CONFIG_SPL_RELOC_STACK
2991 Adress of the start of the stack SPL will use after
2992 relocation. If unspecified, this is equal to
2993 CONFIG_SPL_STACK.
2994
Tom Rini95579792012-02-14 07:29:40 +00002995 CONFIG_SYS_SPL_MALLOC_START
2996 Starting address of the malloc pool used in SPL.
2997
2998 CONFIG_SYS_SPL_MALLOC_SIZE
2999 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003000
Tom Rini47f7bca2012-08-13 12:03:19 -07003001 CONFIG_SPL_FRAMEWORK
3002 Enable the SPL framework under common/. This framework
3003 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3004 NAND loading of the Linux Kernel.
3005
Tom Rini861a86f2012-08-13 11:37:56 -07003006 CONFIG_SPL_DISPLAY_PRINT
3007 For ARM, enable an optional function to print more information
3008 about the running system.
3009
Scott Wood4b919722012-09-20 16:35:21 -05003010 CONFIG_SPL_INIT_MINIMAL
3011 Arch init code should be built for a very small image
3012
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003013 CONFIG_SPL_LIBCOMMON_SUPPORT
3014 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003015
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003016 CONFIG_SPL_LIBDISK_SUPPORT
3017 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003018
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003019 CONFIG_SPL_I2C_SUPPORT
3020 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003021
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003022 CONFIG_SPL_GPIO_SUPPORT
3023 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003024
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003025 CONFIG_SPL_MMC_SUPPORT
3026 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003027
Tom Rini95579792012-02-14 07:29:40 +00003028 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3029 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3030 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3031 Address, size and partition on the MMC to load U-Boot from
3032 when the MMC is being used in raw mode.
3033
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003034 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3035 Sector to load kernel uImage from when MMC is being
3036 used in raw mode (for Falcon mode)
3037
3038 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3039 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3040 Sector and number of sectors to load kernel argument
3041 parameters from when MMC is being used in raw mode
3042 (for falcon mode)
3043
Tom Rini95579792012-02-14 07:29:40 +00003044 CONFIG_SPL_FAT_SUPPORT
3045 Support for fs/fat/libfat.o in SPL binary
3046
3047 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3048 Filename to read to load U-Boot when reading from FAT
3049
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003050 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3051 Filename to read to load kernel uImage when reading
3052 from FAT (for Falcon mode)
3053
3054 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3055 Filename to read to load kernel argument parameters
3056 when reading from FAT (for Falcon mode)
3057
Scott Wood06f60ae2012-12-06 13:33:17 +00003058 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3059 Set this for NAND SPL on PPC mpc83xx targets, so that
3060 start.S waits for the rest of the SPL to load before
3061 continuing (the hardware starts execution after just
3062 loading the first page rather than the full 4K).
3063
Scott Wood6f2f01b2012-09-20 19:09:07 -05003064 CONFIG_SPL_NAND_BASE
3065 Include nand_base.c in the SPL. Requires
3066 CONFIG_SPL_NAND_DRIVERS.
3067
3068 CONFIG_SPL_NAND_DRIVERS
3069 SPL uses normal NAND drivers, not minimal drivers.
3070
3071 CONFIG_SPL_NAND_ECC
3072 Include standard software ECC in the SPL
3073
Tom Rini95579792012-02-14 07:29:40 +00003074 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003075 Support for NAND boot using simple NAND drivers that
3076 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003077
3078 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3079 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3080 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3081 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3082 CONFIG_SYS_NAND_ECCBYTES
3083 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003084 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003085
3086 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003087 Location in NAND to read U-Boot from
3088
3089 CONFIG_SYS_NAND_U_BOOT_DST
3090 Location in memory to load U-Boot to
3091
3092 CONFIG_SYS_NAND_U_BOOT_SIZE
3093 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003094
3095 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003096 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003097
3098 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3099 Define this if you need to first read the OOB and then the
3100 data. This is used for example on davinci plattforms.
3101
3102 CONFIG_SPL_OMAP3_ID_NAND
3103 Support for an OMAP3-specific set of functions to return the
3104 ID and MFR of the first attached NAND chip, if present.
3105
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003106 CONFIG_SPL_SERIAL_SUPPORT
3107 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003108
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003109 CONFIG_SPL_SPI_FLASH_SUPPORT
3110 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003111
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003112 CONFIG_SPL_SPI_SUPPORT
3113 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003114
Pavel Machekc57b9532012-08-30 22:42:11 +02003115 CONFIG_SPL_RAM_DEVICE
3116 Support for running image already present in ram, in SPL binary
3117
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003118 CONFIG_SPL_LIBGENERIC_SUPPORT
3119 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003120
Ying Zhangba1bee42013-05-20 14:07:25 +08003121 CONFIG_SPL_ENV_SUPPORT
3122 Support for the environment operating in SPL binary
3123
3124 CONFIG_SPL_NET_SUPPORT
3125 Support for the net/libnet.o in SPL binary.
3126 It conflicts with SPL env from storage medium specified by
3127 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3128
Scott Wood74752ba2012-12-06 13:33:16 +00003129 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003130 Image offset to which the SPL should be padded before appending
3131 the SPL payload. By default, this is defined as
3132 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3133 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3134 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003135
Scott Woodca2fca22012-09-21 16:27:32 -05003136 CONFIG_SPL_TARGET
3137 Final target image containing SPL and payload. Some SPLs
3138 use an arch-specific makefile fragment instead, for
3139 example if more than one image needs to be produced.
3140
Simon Glass87ebee32013-05-08 08:05:59 +00003141 CONFIG_FIT_SPL_PRINT
3142 Printing information about a FIT image adds quite a bit of
3143 code to SPL. So this is normally disabled in SPL. Use this
3144 option to re-enable it. This will affect the output of the
3145 bootm command when booting a FIT image.
3146
wdenkc6097192002-11-03 00:24:07 +00003147Modem Support:
3148--------------
3149
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003150[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003151
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003152- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003153 CONFIG_MODEM_SUPPORT
3154
3155- RTS/CTS Flow control enable:
3156 CONFIG_HWFLOW
3157
3158- Modem debug support:
3159 CONFIG_MODEM_SUPPORT_DEBUG
3160
wdenk43d96162003-03-06 00:02:04 +00003161 Enables debugging stuff (char screen[1024], dbg())
3162 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003163
wdenka8c7c702003-12-06 19:49:23 +00003164- Interrupt support (PPC):
3165
wdenkd4ca31c2004-01-02 14:00:00 +00003166 There are common interrupt_init() and timer_interrupt()
3167 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003168 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003169 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003170 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003171 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003172 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003173 specific handling. If board has watchdog / status_led
3174 / other_activity_monitor it works automatically from
3175 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003176
wdenkc6097192002-11-03 00:24:07 +00003177- General:
3178
wdenk43d96162003-03-06 00:02:04 +00003179 In the target system modem support is enabled when a
3180 specific key (key combination) is pressed during
3181 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003182 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003183 board_init(). Currently key_pressed() is a dummy
3184 function, returning 1 and thus enabling modem
3185 initialization.
wdenkc6097192002-11-03 00:24:07 +00003186
wdenk43d96162003-03-06 00:02:04 +00003187 If there are no modem init strings in the
3188 environment, U-Boot proceed to autoboot; the
3189 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003190 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003191
3192 See also: doc/README.Modem
3193
Helmut Raiger9660e442011-10-20 04:19:47 +00003194Board initialization settings:
3195------------------------------
3196
3197During Initialization u-boot calls a number of board specific functions
3198to allow the preparation of board specific prerequisites, e.g. pin setup
3199before drivers are initialized. To enable these callbacks the
3200following configuration macros have to be defined. Currently this is
3201architecture specific, so please check arch/your_architecture/lib/board.c
3202typically in board_init_f() and board_init_r().
3203
3204- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3205- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3206- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3207- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003208
wdenkc6097192002-11-03 00:24:07 +00003209Configuration Settings:
3210-----------------------
3211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003212- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003213 undefine this when you're short of memory.
3214
Peter Tyser2fb26042009-01-27 18:03:12 -06003215- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3216 width of the commands listed in the 'help' command output.
3217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003218- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003219 prompt for user input.
3220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003221- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003223- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003225- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003226
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003227- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003228 the application (usually a Linux kernel) when it is
3229 booted
3230
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003231- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003232 List of legal baudrate settings for this board.
3233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003235 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003237- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003238 If the board specific function
3239 extern int overwrite_console (void);
3240 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003241 serial port, else the settings in the environment are used.
3242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003243- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003244 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003246- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003247 Enable overwrite of previous console environment settings.
3248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003250 Begin and End addresses of the area used by the
3251 simple memory test.
3252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003253- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003254 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003256- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003257 Scratch address used by the alternate memory test
3258 You only need to set this if address zero isn't writeable
3259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003260- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3261 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003262 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003263 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003264 fixing up gd->ram_size the Linux kernel should gets passed
3265 the now "corrected" memory size and won't touch it either.
3266 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003267 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003268 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003269 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003270
3271 This option can be used as a workaround for the 440EPx/GRx
3272 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3273 be touched.
3274
3275 WARNING: Please make sure that this value is a multiple of
3276 the Linux page size (normally 4k). If this is not the case,
3277 then the end address of the Linux memory will be located at a
3278 non page size aligned address and this could cause major
3279 problems.
3280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003281- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003282 Enable temporary baudrate change while serial download
3283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003284- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003285 Physical start address of SDRAM. _Must_ be 0 here.
3286
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003287- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003288 Physical start address of Motherboard I/O (if using a
3289 Cogent motherboard)
3290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003291- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003292 Physical start address of Flash memory.
3293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003294- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003295 Physical start address of boot monitor code (set by
3296 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003297 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003298 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003300- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003301 Size of memory reserved for monitor code, used to
3302 determine _at_compile_time_ (!) if the environment is
3303 embedded within the U-Boot image, or in a separate
3304 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003306- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003307 Size of DRAM reserved for malloc() use.
3308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003309- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003310 Normally compressed uImages are limited to an
3311 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003312 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003313 to adjust this setting to your needs.
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003316 Maximum size of memory mapped by the startup code of
3317 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003318 the Linux kernel (bd_info, boot arguments, FDT blob if
3319 used) must be put below this limit, unless "bootm_low"
3320 enviroment variable is defined and non-zero. In such case
3321 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003322 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003323 variable "bootm_mapsize" will override the value of
3324 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3325 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003326
John Rigbyfca43cc2010-10-13 13:57:35 -06003327- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3328 Enable initrd_high functionality. If defined then the
3329 initrd_high feature is enabled and the bootm ramdisk subcommand
3330 is enabled.
3331
3332- CONFIG_SYS_BOOT_GET_CMDLINE:
3333 Enables allocating and saving kernel cmdline in space between
3334 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3335
3336- CONFIG_SYS_BOOT_GET_KBD:
3337 Enables allocating and saving a kernel copy of the bd_info in
3338 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003340- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003341 Max number of Flash memory banks
3342
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003343- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003344 Max number of sectors on a Flash chip
3345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003346- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003347 Timeout for Flash erase operations (in ms)
3348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003349- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003350 Timeout for Flash write operations (in ms)
3351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003352- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003353 Timeout for Flash set sector lock bit operation (in ms)
3354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003355- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003356 Timeout for Flash clear lock bits operation (in ms)
3357
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003358- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003359 If defined, hardware flash sectors protection is used
3360 instead of U-Boot software protection.
3361
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003362- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003363
3364 Enable TFTP transfers directly to flash memory;
3365 without this option such a download has to be
3366 performed in two steps: (1) download to RAM, and (2)
3367 copy from RAM to flash.
3368
3369 The two-step approach is usually more reliable, since
3370 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003371 the flash, but in some situations (when system RAM is
3372 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003373 downloaded image) this option may be very useful.
3374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003375- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003376 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003377 common flash structure for storing flash geometry.
3378
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003379- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003380 This option also enables the building of the cfi_flash driver
3381 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003382
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003383- CONFIG_FLASH_CFI_MTD
3384 This option enables the building of the cfi_mtd driver
3385 in the drivers directory. The driver exports CFI flash
3386 to the MTD layer.
3387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003388- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003389 Use buffered writes to flash.
3390
3391- CONFIG_FLASH_SPANSION_S29WS_N
3392 s29ws-n MirrorBit flash has non-standard addresses for buffered
3393 write commands.
3394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003395- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003396 If this option is defined, the common CFI flash doesn't
3397 print it's warning upon not recognized FLASH banks. This
3398 is useful, if some of the configured banks are only
3399 optionally available.
3400
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003401- CONFIG_FLASH_SHOW_PROGRESS
3402 If defined (must be an integer), print out countdown
3403 digits and dots. Recommended value: 45 (9..1) for 80
3404 column displays, 15 (3..1) for 40 column displays.
3405
Stefan Roese352ef3f2013-04-04 15:53:14 +02003406- CONFIG_FLASH_VERIFY
3407 If defined, the content of the flash (destination) is compared
3408 against the source after the write operation. An error message
3409 will be printed when the contents are not identical.
3410 Please note that this option is useless in nearly all cases,
3411 since such flash programming errors usually are detected earlier
3412 while unprotecting/erasing/programming. Please only enable
3413 this option if you really know what you are doing.
3414
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003415- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003416 Defines the number of Ethernet receive buffers. On some
3417 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003418 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3419 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003420 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003421 Defaults to 4 if not defined.
3422
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003423- CONFIG_ENV_MAX_ENTRIES
3424
Wolfgang Denk071bc922010-10-27 22:48:30 +02003425 Maximum number of entries in the hash table that is used
3426 internally to store the environment settings. The default
3427 setting is supposed to be generous and should work in most
3428 cases. This setting can be used to tune behaviour; see
3429 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003430
Joe Hershberger25980902012-12-11 22:16:31 -06003431- CONFIG_ENV_FLAGS_LIST_DEFAULT
3432- CONFIG_ENV_FLAGS_LIST_STATIC
3433 Enable validation of the values given to enviroment variables when
3434 calling env set. Variables can be restricted to only decimal,
3435 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3436 the variables can also be restricted to IP address or MAC address.
3437
3438 The format of the list is:
3439 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003440 access_atribute = [a|r|o|c]
3441 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003442 entry = variable_name[:attributes]
3443 list = entry[,list]
3444
3445 The type attributes are:
3446 s - String (default)
3447 d - Decimal
3448 x - Hexadecimal
3449 b - Boolean ([1yYtT|0nNfF])
3450 i - IP address
3451 m - MAC address
3452
Joe Hershberger267541f2012-12-11 22:16:34 -06003453 The access attributes are:
3454 a - Any (default)
3455 r - Read-only
3456 o - Write-once
3457 c - Change-default
3458
Joe Hershberger25980902012-12-11 22:16:31 -06003459 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3460 Define this to a list (string) to define the ".flags"
3461 envirnoment variable in the default or embedded environment.
3462
3463 - CONFIG_ENV_FLAGS_LIST_STATIC
3464 Define this to a list (string) to define validation that
3465 should be done if an entry is not found in the ".flags"
3466 environment variable. To override a setting in the static
3467 list, simply add an entry for the same variable name to the
3468 ".flags" variable.
3469
Joe Hershberger267541f2012-12-11 22:16:34 -06003470- CONFIG_ENV_ACCESS_IGNORE_FORCE
3471 If defined, don't allow the -f switch to env set override variable
3472 access flags.
3473
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003474- CONFIG_SYS_GENERIC_BOARD
3475 This selects the architecture-generic board system instead of the
3476 architecture-specific board files. It is intended to move boards
3477 to this new framework over time. Defining this will disable the
3478 arch/foo/lib/board.c file and use common/board_f.c and
3479 common/board_r.c instead. To use this option your architecture
3480 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3481 its config.mk file). If you find problems enabling this option on
3482 your board please report the problem and send patches!
3483
Simon Glass632efa72013-03-11 07:06:48 +00003484- CONFIG_SYS_SYM_OFFSETS
3485 This is set by architectures that use offsets for link symbols
3486 instead of absolute values. So bss_start is obtained using an
3487 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3488 directly. You should not need to touch this setting.
3489
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003490- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3491 This is set by OMAP boards for the max time that reset should
3492 be asserted. See doc/README.omap-reset-time for details on how
3493 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003494
wdenkc6097192002-11-03 00:24:07 +00003495The following definitions that deal with the placement and management
3496of environment data (variable area); in general, we support the
3497following configurations:
3498
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003499- CONFIG_BUILD_ENVCRC:
3500
3501 Builds up envcrc with the target environment so that external utils
3502 may easily extract it and embed it in final U-Boot images.
3503
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003504- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003505
3506 Define this if the environment is in flash memory.
3507
3508 a) The environment occupies one whole flash sector, which is
3509 "embedded" in the text segment with the U-Boot code. This
3510 happens usually with "bottom boot sector" or "top boot
3511 sector" type flash chips, which have several smaller
3512 sectors at the start or the end. For instance, such a
3513 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3514 such a case you would place the environment in one of the
3515 4 kB sectors - with U-Boot code before and after it. With
3516 "top boot sector" type flash chips, you would put the
3517 environment in one of the last sectors, leaving a gap
3518 between U-Boot and the environment.
3519
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003520 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003521
3522 Offset of environment data (variable area) to the
3523 beginning of flash memory; for instance, with bottom boot
3524 type flash chips the second sector can be used: the offset
3525 for this sector is given here.
3526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003528
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003529 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003530
3531 This is just another way to specify the start address of
3532 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003533 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003534
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003535 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003536
3537 Size of the sector containing the environment.
3538
3539
3540 b) Sometimes flash chips have few, equal sized, BIG sectors.
3541 In such a case you don't want to spend a whole sector for
3542 the environment.
3543
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003544 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003545
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003546 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003547 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003548 of this flash sector for the environment. This saves
3549 memory for the RAM copy of the environment.
3550
3551 It may also save flash memory if you decide to use this
3552 when your environment is "embedded" within U-Boot code,
3553 since then the remainder of the flash sector could be used
3554 for U-Boot code. It should be pointed out that this is
3555 STRONGLY DISCOURAGED from a robustness point of view:
3556 updating the environment in flash makes it always
3557 necessary to erase the WHOLE sector. If something goes
3558 wrong before the contents has been restored from a copy in
3559 RAM, your target system will be dead.
3560
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003561 - CONFIG_ENV_ADDR_REDUND
3562 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk43d96162003-03-06 00:02:04 +00003564 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003565 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003566 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003567 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003568
3569BE CAREFUL! Any changes to the flash layout, and some changes to the
3570source code will make it necessary to adapt <board>/u-boot.lds*
3571accordingly!
3572
3573
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003574- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003575
3576 Define this if you have some non-volatile memory device
3577 (NVRAM, battery buffered SRAM) which you want to use for the
3578 environment.
3579
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003580 - CONFIG_ENV_ADDR:
3581 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003582
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003583 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003584 want to use for environment. It is assumed that this memory
3585 can just be read and written to, without any special
3586 provision.
3587
3588BE CAREFUL! The first access to the environment happens quite early
3589in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003590console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003591U-Boot will hang.
3592
3593Please note that even with NVRAM we still use a copy of the
3594environment in RAM: we could work on NVRAM directly, but we want to
3595keep settings there always unmodified except somebody uses "saveenv"
3596to save the current settings.
3597
3598
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003599- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003600
3601 Use this if you have an EEPROM or similar serial access
3602 device and a driver for it.
3603
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003604 - CONFIG_ENV_OFFSET:
3605 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003606
3607 These two #defines specify the offset and size of the
3608 environment area within the total memory of your EEPROM.
3609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003610 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003611 If defined, specified the chip address of the EEPROM device.
3612 The default address is zero.
3613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003614 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003615 If defined, the number of bits used to address bytes in a
3616 single page in the EEPROM device. A 64 byte page, for example
3617 would require six bits.
3618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003619 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003620 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003621 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003623 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003624 The length in bytes of the EEPROM memory array address. Note
3625 that this is NOT the chip address length!
3626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003627 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003628 EEPROM chips that implement "address overflow" are ones
3629 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3630 address and the extra bits end up in the "chip address" bit
3631 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3632 byte chips.
3633
3634 Note that we consider the length of the address field to
3635 still be one byte because the extra address bits are hidden
3636 in the chip address.
3637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003638 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003639 The size in bytes of the EEPROM device.
3640
Heiko Schocher548738b2010-01-07 08:55:40 +01003641 - CONFIG_ENV_EEPROM_IS_ON_I2C
3642 define this, if you have I2C and SPI activated, and your
3643 EEPROM, which holds the environment, is on the I2C bus.
3644
3645 - CONFIG_I2C_ENV_EEPROM_BUS
3646 if you have an Environment on an EEPROM reached over
3647 I2C muxes, you can define here, how to reach this
3648 EEPROM. For example:
3649
Heiko Schocherea818db2013-01-29 08:53:15 +01003650 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003651
3652 EEPROM which holds the environment, is reached over
3653 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003654
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003655- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003656
wdenkd4ca31c2004-01-02 14:00:00 +00003657 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003658 want to use for the environment.
3659
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003660 - CONFIG_ENV_OFFSET:
3661 - CONFIG_ENV_ADDR:
3662 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003663
3664 These three #defines specify the offset and size of the
3665 environment area within the total memory of your DataFlash placed
3666 at the specified address.
3667
Liu Gang0a85a9e2012-03-08 00:33:20 +00003668- CONFIG_ENV_IS_IN_REMOTE:
3669
3670 Define this if you have a remote memory space which you
3671 want to use for the local device's environment.
3672
3673 - CONFIG_ENV_ADDR:
3674 - CONFIG_ENV_SIZE:
3675
3676 These two #defines specify the address and size of the
3677 environment area within the remote memory space. The
3678 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003679 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003680
3681BE CAREFUL! For some special cases, the local device can not use
3682"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003683environment stored in a remote NOR flash by SRIO or PCIE link,
3684but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003685
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003686- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003687
3688 Define this if you have a NAND device which you want to use
3689 for the environment.
3690
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003691 - CONFIG_ENV_OFFSET:
3692 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003693
3694 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003695 area within the first NAND device. CONFIG_ENV_OFFSET must be
3696 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003697
Scott Woodfdd813d2010-09-17 14:38:37 -05003698 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003699
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003700 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003701 size used to hold a redundant copy of the environment data, so
3702 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003703 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003704 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003705
Scott Woodfdd813d2010-09-17 14:38:37 -05003706 - CONFIG_ENV_RANGE (optional):
3707
3708 Specifies the length of the region in which the environment
3709 can be written. This should be a multiple of the NAND device's
3710 block size. Specifying a range with more erase blocks than
3711 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3712 the range to be avoided.
3713
3714 - CONFIG_ENV_OFFSET_OOB (optional):
3715
3716 Enables support for dynamically retrieving the offset of the
3717 environment from block zero's out-of-band data. The
3718 "nand env.oob" command can be used to record this offset.
3719 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3720 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003721
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003722- CONFIG_NAND_ENV_DST
3723
3724 Defines address in RAM to which the nand_spl code should copy the
3725 environment. If redundant environment is used, it will be copied to
3726 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3727
Joe Hershberger2b744332013-04-08 10:32:51 +00003728- CONFIG_ENV_IS_IN_UBI:
3729
3730 Define this if you have an UBI volume that you want to use for the
3731 environment. This has the benefit of wear-leveling the environment
3732 accesses, which is important on NAND.
3733
3734 - CONFIG_ENV_UBI_PART:
3735
3736 Define this to a string that is the mtd partition containing the UBI.
3737
3738 - CONFIG_ENV_UBI_VOLUME:
3739
3740 Define this to the name of the volume that you want to store the
3741 environment in.
3742
Joe Hershberger785881f2013-04-08 10:32:52 +00003743 - CONFIG_ENV_UBI_VOLUME_REDUND:
3744
3745 Define this to the name of another volume to store a second copy of
3746 the environment in. This will enable redundant environments in UBI.
3747 It is assumed that both volumes are in the same MTD partition.
3748
Joe Hershberger2b744332013-04-08 10:32:51 +00003749 - CONFIG_UBI_SILENCE_MSG
3750 - CONFIG_UBIFS_SILENCE_MSG
3751
3752 You will probably want to define these to avoid a really noisy system
3753 when storing the env in UBI.
3754
Stephen Warren06e4ae52013-06-11 15:14:00 -06003755- CONFIG_ENV_IS_IN_MMC:
3756
3757 Define this if you have an MMC device which you want to use for the
3758 environment.
3759
3760 - CONFIG_SYS_MMC_ENV_DEV:
3761
3762 Specifies which MMC device the environment is stored in.
3763
3764 - CONFIG_SYS_MMC_ENV_PART (optional):
3765
3766 Specifies which MMC partition the environment is stored in. If not
3767 set, defaults to partition 0, the user area. Common values might be
3768 1 (first MMC boot partition), 2 (second MMC boot partition).
3769
3770 - CONFIG_ENV_OFFSET:
3771 - CONFIG_ENV_SIZE:
3772
3773 These two #defines specify the offset and size of the environment
3774 area within the specified MMC device.
3775
Stephen Warren5c088ee2013-06-11 15:14:02 -06003776 If offset is positive (the usual case), it is treated as relative to
3777 the start of the MMC partition. If offset is negative, it is treated
3778 as relative to the end of the MMC partition. This can be useful if
3779 your board may be fitted with different MMC devices, which have
3780 different sizes for the MMC partitions, and you always want the
3781 environment placed at the very end of the partition, to leave the
3782 maximum possible space before it, to store other data.
3783
Stephen Warren06e4ae52013-06-11 15:14:00 -06003784 These two values are in units of bytes, but must be aligned to an
3785 MMC sector boundary.
3786
3787 - CONFIG_ENV_OFFSET_REDUND (optional):
3788
3789 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3790 hold a redundant copy of the environment data. This provides a
3791 valid backup copy in case the other copy is corrupted, e.g. due
3792 to a power failure during a "saveenv" operation.
3793
Stephen Warren5c088ee2013-06-11 15:14:02 -06003794 This value may also be positive or negative; this is handled in the
3795 same way as CONFIG_ENV_OFFSET.
3796
Stephen Warren06e4ae52013-06-11 15:14:00 -06003797 This value is also in units of bytes, but must also be aligned to
3798 an MMC sector boundary.
3799
3800 - CONFIG_ENV_SIZE_REDUND (optional):
3801
3802 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3803 set. If this value is set, it must be set to the same value as
3804 CONFIG_ENV_SIZE.
3805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003806- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003807
3808 Defines offset to the initial SPI buffer area in DPRAM. The
3809 area is used at an early stage (ROM part) if the environment
3810 is configured to reside in the SPI EEPROM: We need a 520 byte
3811 scratch DPRAM area. It is used between the two initialization
3812 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3813 to be a good choice since it makes it far enough from the
3814 start of the data area as well as from the stack pointer.
3815
Bruce Adlere881cb52007-11-02 13:15:42 -07003816Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003817has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003818created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003819until then to read environment variables.
3820
wdenk85ec0bc2003-03-31 16:34:49 +00003821The environment is protected by a CRC32 checksum. Before the monitor
3822is relocated into RAM, as a result of a bad CRC you will be working
3823with the compiled-in default environment - *silently*!!! [This is
3824necessary, because the first environment variable we need is the
3825"baudrate" setting for the console - if we have a bad CRC, we don't
3826have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003827
3828Note: once the monitor has been relocated, then it will complain if
3829the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003830use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003832- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003833 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003835 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003836 also needs to be defined.
3837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003838- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003839 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003840
Ron Madridf5675aa2009-02-18 14:30:44 -08003841- CONFIG_NS16550_MIN_FUNCTIONS:
3842 Define this if you desire to only have use of the NS16550_init
3843 and NS16550_putc functions for the serial driver located at
3844 drivers/serial/ns16550.c. This option is useful for saving
3845 space for already greatly restricted images, including but not
3846 limited to NAND_SPL configurations.
3847
Simon Glassb2b92f52012-11-30 13:01:18 +00003848- CONFIG_DISPLAY_BOARDINFO
3849 Display information about the board that U-Boot is running on
3850 when U-Boot starts up. The board function checkboard() is called
3851 to do this.
3852
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003853- CONFIG_DISPLAY_BOARDINFO_LATE
3854 Similar to the previous option, but display this information
3855 later, once stdio is running and output goes to the LCD, if
3856 present.
3857
wdenkc6097192002-11-03 00:24:07 +00003858Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003859---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003860
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003861- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003862 Cache Line Size of the CPU.
3863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003864- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003865 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003866
wdenk42d1f032003-10-15 23:53:47 +00003867 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3868 and RPXsuper) to be able to adjust the position of
3869 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003870
Timur Tabie46fedf2011-08-04 18:03:41 -05003871- CONFIG_SYS_CCSRBAR_DEFAULT:
3872 Default (power-on reset) physical address of CCSR on Freescale
3873 PowerPC SOCs.
3874
3875- CONFIG_SYS_CCSRBAR:
3876 Virtual address of CCSR. On a 32-bit build, this is typically
3877 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3878
3879 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3880 for cross-platform code that uses that macro instead.
3881
3882- CONFIG_SYS_CCSRBAR_PHYS:
3883 Physical address of CCSR. CCSR can be relocated to a new
3884 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003885 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003886 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3887 is typically relocated on 36-bit builds. It is recommended
3888 that this macro be defined via the _HIGH and _LOW macros:
3889
3890 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3891 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3892
3893- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003894 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3895 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003896 used in assembly code, so it must not contain typecasts or
3897 integer size suffixes (e.g. "ULL").
3898
3899- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3900 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3901 used in assembly code, so it must not contain typecasts or
3902 integer size suffixes (e.g. "ULL").
3903
3904- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3905 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3906 forced to a value that ensures that CCSR is not relocated.
3907
wdenk7f6c2cb2002-11-10 22:06:23 +00003908- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003909 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003910
3911 the default drive number (default value 0)
3912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003913 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003914
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003915 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003916 (default value 1)
3917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003918 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003919
wdenk43d96162003-03-06 00:02:04 +00003920 defines the offset of register from address. It
3921 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003922 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003924 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3925 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003926 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003928 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003929 fdc_hw_init() is called at the beginning of the FDC
3930 setup. fdc_hw_init() must be provided by the board
3931 source code. It is used to make hardware dependant
3932 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003933
Macpaul Lin0abddf82011-04-11 20:45:32 +00003934- CONFIG_IDE_AHB:
3935 Most IDE controllers were designed to be connected with PCI
3936 interface. Only few of them were designed for AHB interface.
3937 When software is doing ATA command and data transfer to
3938 IDE devices through IDE-AHB controller, some additional
3939 registers accessing to these kind of IDE-AHB controller
3940 is requierd.
3941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003942- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003943 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003944 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003945
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003946- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003947
wdenk7152b1d2003-09-05 23:19:14 +00003948 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003949 initial data and stack; please note that this must be
3950 writable memory that is working WITHOUT special
3951 initialization, i. e. you CANNOT use normal RAM which
3952 will become available only after programming the
3953 memory controller and running certain initialization
3954 sequences.
3955
3956 U-Boot uses the following memory types:
3957 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3958 - MPC824X: data cache
3959 - PPC4xx: data cache
3960
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003961- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003962
3963 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003964 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3965 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003966 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003967 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003968 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3969 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3970 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003971
3972 Note:
3973 On the MPC824X (or other systems that use the data
3974 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003976 point to an otherwise UNUSED address space between
3977 the top of RAM and the start of the PCI space.
3978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003979- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003981- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003983- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003985- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003987- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003989- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003991- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003992 SDRAM timing
3993
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003994- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003995 periodic timer for refresh
3996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003997- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003999- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4000 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4001 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4002 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004003 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4004
4005- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004006 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4007 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004008 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004010- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4011 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004012 Machine Mode Register and Memory Periodic Timer
4013 Prescaler definitions (SDRAM timing)
4014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004015- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004016 enable I2C microcode relocation patch (MPC8xx);
4017 define relocation offset in DPRAM [DSP2]
4018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004019- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004020 enable SMC microcode relocation patch (MPC8xx);
4021 define relocation offset in DPRAM [SMC1]
4022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004023- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004024 enable SPI microcode relocation patch (MPC8xx);
4025 define relocation offset in DPRAM [SCC4]
4026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004027- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004028 Use OSCM clock mode on MBX8xx board. Be careful,
4029 wrong setting might damage your board. Read
4030 doc/README.MBX before setting this variable!
4031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004032- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004033 Offset of the bootmode word in DPRAM used by post
4034 (Power On Self Tests). This definition overrides
4035 #define'd default value in commproc.h resp.
4036 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4039 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4040 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4041 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4042 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4043 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4044 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4045 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004046 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004047
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004048- CONFIG_PCI_DISABLE_PCIE:
4049 Disable PCI-Express on systems where it is supported but not
4050 required.
4051
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004052- CONFIG_PCI_ENUM_ONLY
4053 Only scan through and get the devices on the busses.
4054 Don't do any setup work, presumably because someone or
4055 something has already done it, and we don't need to do it
4056 a second time. Useful for platforms that are pre-booted
4057 by coreboot or similar.
4058
Gabor Juhos842033e2013-05-30 07:06:12 +00004059- CONFIG_PCI_INDIRECT_BRIDGE:
4060 Enable support for indirect PCI bridges.
4061
Kumar Galaa09b9b62010-12-30 12:09:53 -06004062- CONFIG_SYS_SRIO:
4063 Chip has SRIO or not
4064
4065- CONFIG_SRIO1:
4066 Board has SRIO 1 port available
4067
4068- CONFIG_SRIO2:
4069 Board has SRIO 2 port available
4070
Liu Gangc8b28152013-05-07 16:30:46 +08004071- CONFIG_SRIO_PCIE_BOOT_MASTER
4072 Board can support master function for Boot from SRIO and PCIE
4073
Kumar Galaa09b9b62010-12-30 12:09:53 -06004074- CONFIG_SYS_SRIOn_MEM_VIRT:
4075 Virtual Address of SRIO port 'n' memory region
4076
4077- CONFIG_SYS_SRIOn_MEM_PHYS:
4078 Physical Address of SRIO port 'n' memory region
4079
4080- CONFIG_SYS_SRIOn_MEM_SIZE:
4081 Size of SRIO port 'n' memory region
4082
Fabio Estevam66bd1842013-04-11 09:35:34 +00004083- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4084 Defined to tell the NAND controller that the NAND chip is using
4085 a 16 bit bus.
4086 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004087 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004088 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004089 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004090
4091- CONFIG_SYS_NDFC_EBC0_CFG
4092 Sets the EBC0_CFG register for the NDFC. If not defined
4093 a default value will be used.
4094
Ben Warrenbb99ad62006-09-07 16:50:54 -04004095- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004096 Get DDR timing information from an I2C EEPROM. Common
4097 with pluggable memory modules such as SODIMMs
4098
Ben Warrenbb99ad62006-09-07 16:50:54 -04004099 SPD_EEPROM_ADDRESS
4100 I2C address of the SPD EEPROM
4101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004102- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004103 If SPD EEPROM is on an I2C bus other than the first
4104 one, specify here. Note that the value must resolve
4105 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004106
York Sun1b3e3c42011-06-07 09:42:16 +08004107- CONFIG_SYS_DDR_RAW_TIMING
4108 Get DDR timing information from other than SPD. Common with
4109 soldered DDR chips onboard without SPD. DDR raw timing
4110 parameters are extracted from datasheet and hard-coded into
4111 header files or board specific files.
4112
York Sun6f5e1dc2011-09-16 13:21:35 -07004113- CONFIG_FSL_DDR_INTERACTIVE
4114 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4115
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004116- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004117 Only for 83xx systems. If specified, then DDR should
4118 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004119
wdenkc26e4542004-04-18 10:13:26 +00004120- CONFIG_ETHER_ON_FEC[12]
4121 Define to enable FEC[12] on a 8xx series processor.
4122
4123- CONFIG_FEC[12]_PHY
4124 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004125 to the given FEC; i. e.
4126 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004127 means that the PHY with address 4 is connected to FEC1
4128
4129 When set to -1, means to probe for first available.
4130
4131- CONFIG_FEC[12]_PHY_NORXERR
4132 The PHY does not have a RXERR line (RMII only).
4133 (so program the FEC to ignore it).
4134
4135- CONFIG_RMII
4136 Enable RMII mode for all FECs.
4137 Note that this is a global option, we can't
4138 have one FEC in standard MII mode and another in RMII mode.
4139
wdenk5cf91d62004-04-23 20:32:05 +00004140- CONFIG_CRC32_VERIFY
4141 Add a verify option to the crc32 command.
4142 The syntax is:
4143
4144 => crc32 -v <address> <count> <crc32>
4145
4146 Where address/count indicate a memory area
4147 and crc32 is the correct crc32 which the
4148 area should have.
4149
wdenk56523f12004-07-11 17:40:54 +00004150- CONFIG_LOOPW
4151 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004152 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004153
stroese7b466642004-12-16 18:46:55 +00004154- CONFIG_MX_CYCLIC
4155 Add the "mdc" and "mwc" memory commands. These are cyclic
4156 "md/mw" commands.
4157 Examples:
4158
wdenkefe2a4d2004-12-16 21:44:03 +00004159 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004160 This command will print 4 bytes (10,11,12,13) each 500 ms.
4161
wdenkefe2a4d2004-12-16 21:44:03 +00004162 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004163 This command will write 12345678 to address 100 all 10 ms.
4164
wdenkefe2a4d2004-12-16 21:44:03 +00004165 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004166 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004167
wdenk8aa1a2d2005-04-04 12:44:11 +00004168- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004169 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004170 low level initializations (like setting up the memory
4171 controller) are omitted and/or U-Boot does not
4172 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004173
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004174 Normally this variable MUST NOT be defined. The only
4175 exception is when U-Boot is loaded (to RAM) by some
4176 other boot loader or by a debugger which performs
4177 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004178
Aneesh V401bb302011-07-13 05:11:07 +00004179- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004180 Modifies the behaviour of start.S when compiling a loader
4181 that is executed before the actual U-Boot. E.g. when
4182 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004183
Ying Zhang5df572f2013-05-20 14:07:23 +08004184- CONFIG_SYS_MPC85XX_NO_RESETVEC
4185 Only for 85xx systems. If this variable is specified, the section
4186 .resetvec is not kept and the section .bootpg is placed in the
4187 previous 4k of the .text section.
4188
Simon Glass4213fc22013-02-24 17:33:14 +00004189- CONFIG_ARCH_MAP_SYSMEM
4190 Generally U-Boot (and in particular the md command) uses
4191 effective address. It is therefore not necessary to regard
4192 U-Boot address as virtual addresses that need to be translated
4193 to physical addresses. However, sandbox requires this, since
4194 it maintains its own little RAM buffer which contains all
4195 addressable memory. This option causes some memory accesses
4196 to be mapped through map_sysmem() / unmap_sysmem().
4197
Matthias Weisserd8834a12011-03-10 21:36:32 +00004198- CONFIG_USE_ARCH_MEMCPY
4199 CONFIG_USE_ARCH_MEMSET
4200 If these options are used a optimized version of memcpy/memset will
4201 be used if available. These functions may be faster under some
4202 conditions but may increase the binary size.
4203
Simon Glass588a13f2013-02-14 04:18:54 +00004204- CONFIG_X86_RESET_VECTOR
4205 If defined, the x86 reset vector code is included. This is not
4206 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004207
Mark Jacksonfc337052013-03-04 01:27:20 +00004208- CONFIG_SYS_MPUCLK
4209 Defines the MPU clock speed (in MHz).
4210
4211 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004212
Timur Tabif2717b42011-11-22 09:21:25 -06004213Freescale QE/FMAN Firmware Support:
4214-----------------------------------
4215
4216The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4217loading of "firmware", which is encoded in the QE firmware binary format.
4218This firmware often needs to be loaded during U-Boot booting, so macros
4219are used to identify the storage device (NOR flash, SPI, etc) and the address
4220within that device.
4221
4222- CONFIG_SYS_QE_FMAN_FW_ADDR
4223 The address in the storage device where the firmware is located. The
4224 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4225 is also specified.
4226
4227- CONFIG_SYS_QE_FMAN_FW_LENGTH
4228 The maximum possible size of the firmware. The firmware binary format
4229 has a field that specifies the actual size of the firmware, but it
4230 might not be possible to read any part of the firmware unless some
4231 local storage is allocated to hold the entire firmware first.
4232
4233- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4234 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4235 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4236 virtual address in NOR flash.
4237
4238- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4239 Specifies that QE/FMAN firmware is located in NAND flash.
4240 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4241
4242- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4243 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4244 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4245
4246- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4247 Specifies that QE/FMAN firmware is located on the primary SPI
4248 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4249
Liu Gang292dc6c2012-03-08 00:33:18 +00004250- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4251 Specifies that QE/FMAN firmware is located in the remote (master)
4252 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004253 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4254 window->master inbound window->master LAW->the ucode address in
4255 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004256
wdenkc6097192002-11-03 00:24:07 +00004257Building the Software:
4258======================
4259
Wolfgang Denk218ca722008-03-26 10:40:12 +01004260Building U-Boot has been tested in several native build environments
4261and in many different cross environments. Of course we cannot support
4262all possibly existing versions of cross development tools in all
4263(potentially obsolete) versions. In case of tool chain problems we
4264recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4265which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004266
Wolfgang Denk218ca722008-03-26 10:40:12 +01004267If you are not using a native environment, it is assumed that you
4268have GNU cross compiling tools available in your path. In this case,
4269you must set the environment variable CROSS_COMPILE in your shell.
4270Note that no changes to the Makefile or any other source files are
4271necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004272
Wolfgang Denk218ca722008-03-26 10:40:12 +01004273 $ CROSS_COMPILE=ppc_4xx-
4274 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004275
Peter Tyser2f8d3962009-03-13 18:54:51 -05004276Note: If you wish to generate Windows versions of the utilities in
4277 the tools directory you can use the MinGW toolchain
4278 (http://www.mingw.org). Set your HOST tools to the MinGW
4279 toolchain and execute 'make tools'. For example:
4280
4281 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4282
4283 Binaries such as tools/mkimage.exe will be created which can
4284 be executed on computers running Windows.
4285
Wolfgang Denk218ca722008-03-26 10:40:12 +01004286U-Boot is intended to be simple to build. After installing the
4287sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004288is done by typing:
4289
4290 make NAME_config
4291
Wolfgang Denk218ca722008-03-26 10:40:12 +01004292where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004293rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004294
wdenk2729af92004-05-03 20:45:30 +00004295Note: for some board special configuration names may exist; check if
4296 additional information is available from the board vendor; for
4297 instance, the TQM823L systems are available without (standard)
4298 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004299 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301 make TQM823L_config
4302 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304 make TQM823L_LCD_config
4305 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk2729af92004-05-03 20:45:30 +00004307 etc.
wdenkc6097192002-11-03 00:24:07 +00004308
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk2729af92004-05-03 20:45:30 +00004310Finally, type "make all", and you should get some working U-Boot
4311images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004312
wdenk2729af92004-05-03 20:45:30 +00004313- "u-boot.bin" is a raw binary image
4314- "u-boot" is an image in ELF binary format
4315- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004316
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004317By default the build is performed locally and the objects are saved
4318in the source directory. One of the two methods can be used to change
4319this behavior and build U-Boot to some external directory:
4320
43211. Add O= to the make command line invocations:
4322
4323 make O=/tmp/build distclean
4324 make O=/tmp/build NAME_config
4325 make O=/tmp/build all
4326
43272. Set environment variable BUILD_DIR to point to the desired location:
4328
4329 export BUILD_DIR=/tmp/build
4330 make distclean
4331 make NAME_config
4332 make all
4333
4334Note that the command line "O=" setting overrides the BUILD_DIR environment
4335variable.
4336
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk2729af92004-05-03 20:45:30 +00004338Please be aware that the Makefiles assume you are using GNU make, so
4339for instance on NetBSD you might need to use "gmake" instead of
4340native "make".
wdenkc6097192002-11-03 00:24:07 +00004341
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343If the system board that you have is not listed, then you will need
4344to port U-Boot to your hardware platform. To do this, follow these
4345steps:
wdenkc6097192002-11-03 00:24:07 +00004346
wdenk2729af92004-05-03 20:45:30 +000043471. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004348 "boards.cfg" file, using the existing entries as examples.
4349 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000043502. Create a new directory to hold your board specific code. Add any
4351 files you need. In your board directory, you will need at least
4352 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
43533. Create a new configuration file "include/configs/<board>.h" for
4354 your board
43553. If you're porting U-Boot to a new CPU, then also create a new
4356 directory to hold your CPU specific code. Add any files you need.
43574. Run "make <board>_config" with your new name.
43585. Type "make", and you should get a working "u-boot.srec" file
4359 to be installed on your target system.
43606. Debug and solve any problems that might arise.
4361 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004362
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4365==============================================================
wdenkc6097192002-11-03 00:24:07 +00004366
Wolfgang Denk218ca722008-03-26 10:40:12 +01004367If you have modified U-Boot sources (for instance added a new board
4368or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004369provide feedback to the other developers. The feedback normally takes
4370the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004371official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004372
Wolfgang Denk218ca722008-03-26 10:40:12 +01004373But before you submit such a patch, please verify that your modifi-
4374cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004375the supported boards compile WITHOUT ANY compiler warnings. To do so,
4376just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004377for ALL supported system. Be warned, this will take a while. You can
4378select which (cross) compiler to use by passing a `CROSS_COMPILE'
4379environment variable to the script, i. e. to use the ELDK cross tools
4380you can type
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004387
Wolfgang Denk218ca722008-03-26 10:40:12 +01004388When using the MAKEALL script, the default behaviour is to build
4389U-Boot in the source directory. This location can be changed by
4390setting the BUILD_DIR environment variable. Also, for each target
4391built, the MAKEALL script saves two log files (<target>.ERR and
4392<target>.MAKEALL) in the <source dir>/LOG directory. This default
4393location can be changed by setting the MAKEALL_LOGDIR environment
4394variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004395
4396 export BUILD_DIR=/tmp/build
4397 export MAKEALL_LOGDIR=/tmp/log
4398 CROSS_COMPILE=ppc_8xx- MAKEALL
4399
Wolfgang Denk218ca722008-03-26 10:40:12 +01004400With the above settings build objects are saved in the /tmp/build,
4401log files are saved in the /tmp/log and the source tree remains clean
4402during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004403
4404
wdenk2729af92004-05-03 20:45:30 +00004405See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004406
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408Monitor Commands - Overview:
4409============================
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk2729af92004-05-03 20:45:30 +00004411go - start application at address 'addr'
4412run - run commands in an environment variable
4413bootm - boot application image from memory
4414bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004415bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004416tftpboot- boot image via network using TFTP protocol
4417 and env variables "ipaddr" and "serverip"
4418 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004419tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004420rarpboot- boot image via network using RARP/TFTP protocol
4421diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4422loads - load S-Record file over serial line
4423loadb - load binary file over serial line (kermit mode)
4424md - memory display
4425mm - memory modify (auto-incrementing)
4426nm - memory modify (constant address)
4427mw - memory write (fill)
4428cp - memory copy
4429cmp - memory compare
4430crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004431i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004432sspi - SPI utility commands
4433base - print or set address offset
4434printenv- print environment variables
4435setenv - set environment variables
4436saveenv - save environment variables to persistent storage
4437protect - enable or disable FLASH write protection
4438erase - erase FLASH memory
4439flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004440nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004441bdinfo - print Board Info structure
4442iminfo - print header information for application image
4443coninfo - print console devices and informations
4444ide - IDE sub-system
4445loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004446loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004447mtest - simple RAM test
4448icache - enable or disable instruction cache
4449dcache - enable or disable data cache
4450reset - Perform RESET of the CPU
4451echo - echo args to console
4452version - print monitor version
4453help - print online help
4454? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004455
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk2729af92004-05-03 20:45:30 +00004457Monitor Commands - Detailed Description:
4458========================================
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460TODO.
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004463
4464
wdenk2729af92004-05-03 20:45:30 +00004465Environment Variables:
4466======================
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468U-Boot supports user configuration using Environment Variables which
4469can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk2729af92004-05-03 20:45:30 +00004471Environment Variables are set using "setenv", printed using
4472"printenv", and saved to Flash using "saveenv". Using "setenv"
4473without a value can be used to delete a variable from the
4474environment. As long as you don't save the environment you are
4475working with an in-memory copy. In case the Flash area containing the
4476environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004477
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004478Some configuration options can be set using Environment Variables.
4479
4480List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004481
wdenk2729af92004-05-03 20:45:30 +00004482 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004483
wdenk2729af92004-05-03 20:45:30 +00004484 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004489
wdenk2729af92004-05-03 20:45:30 +00004490 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004491
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004492 bootm_low - Memory range available for image processing in the bootm
4493 command can be restricted. This variable is given as
4494 a hexadecimal number and defines lowest address allowed
4495 for use by the bootm command. See also "bootm_size"
4496 environment variable. Address defined by "bootm_low" is
4497 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004498 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4499 bootm_mapsize.
4500
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004501 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004502 This variable is given as a hexadecimal number and it
4503 defines the size of the memory region starting at base
4504 address bootm_low that is accessible by the Linux kernel
4505 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4506 as the default value if it is defined, and bootm_size is
4507 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004508
4509 bootm_size - Memory range available for image processing in the bootm
4510 command can be restricted. This variable is given as
4511 a hexadecimal number and defines the size of the region
4512 allowed for use by the bootm command. See also "bootm_low"
4513 environment variable.
4514
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004515 updatefile - Location of the software update file on a TFTP server, used
4516 by the automatic software update feature. Please refer to
4517 documentation in doc/README.update for more details.
4518
wdenk2729af92004-05-03 20:45:30 +00004519 autoload - if set to "no" (any string beginning with 'n'),
4520 "bootp" will just load perform a lookup of the
4521 configuration from the BOOTP server, but not try to
4522 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524 autostart - if set to "yes", an image loaded using the "bootp",
4525 "rarpboot", "tftpboot" or "diskboot" commands will
4526 be automatically started (by internally calling
4527 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk2729af92004-05-03 20:45:30 +00004529 If set to "no", a standalone image passed to the
4530 "bootm" command will be copied to the load address
4531 (and eventually uncompressed), but NOT be started.
4532 This can be used to load and uncompress arbitrary
4533 data.
wdenkc6097192002-11-03 00:24:07 +00004534
David A. Longa28afca2011-07-09 16:40:19 -04004535 fdt_high - if set this restricts the maximum address that the
4536 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004537 For example, if you have a system with 1 GB memory
4538 at physical address 0x10000000, while Linux kernel
4539 only recognizes the first 704 MB as low memory, you
4540 may need to set fdt_high as 0x3C000000 to have the
4541 device tree blob be copied to the maximum address
4542 of the 704 MB low memory, so that Linux kernel can
4543 access it during the boot procedure.
4544
David A. Longa28afca2011-07-09 16:40:19 -04004545 If this is set to the special value 0xFFFFFFFF then
4546 the fdt will not be copied at all on boot. For this
4547 to work it must reside in writable memory, have
4548 sufficient padding on the end of it for u-boot to
4549 add the information it needs into it, and the memory
4550 must be accessible by the kernel.
4551
Simon Glasseea63e02011-10-24 19:15:34 +00004552 fdtcontroladdr- if set this is the address of the control flattened
4553 device tree used by U-Boot when CONFIG_OF_CONTROL is
4554 defined.
4555
wdenk17ea1172004-06-06 21:51:03 +00004556 i2cfast - (PPC405GP|PPC405EP only)
4557 if set to 'y' configures Linux I2C driver for fast
4558 mode (400kHZ). This environment variable is used in
4559 initialization code. So, for changes to be effective
4560 it must be saved and board must be reset.
4561
wdenk2729af92004-05-03 20:45:30 +00004562 initrd_high - restrict positioning of initrd images:
4563 If this variable is not set, initrd images will be
4564 copied to the highest possible address in RAM; this
4565 is usually what you want since it allows for
4566 maximum initrd size. If for some reason you want to
4567 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004568 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004569 variable to a value of "no" or "off" or "0".
4570 Alternatively, you can set it to a maximum upper
4571 address to use (U-Boot will still check that it
4572 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 For instance, when you have a system with 16 MB
4575 RAM, and want to reserve 4 MB from use by Linux,
4576 you can do this by adding "mem=12M" to the value of
4577 the "bootargs" variable. However, now you must make
4578 sure that the initrd image is placed in the first
4579 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004580
wdenk2729af92004-05-03 20:45:30 +00004581 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583 If you set initrd_high to 0xFFFFFFFF, this is an
4584 indication to U-Boot that all addresses are legal
4585 for the Linux kernel, including addresses in flash
4586 memory. In this case U-Boot will NOT COPY the
4587 ramdisk at all. This may be useful to reduce the
4588 boot time on your system, but requires that this
4589 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004590
wdenk2729af92004-05-03 20:45:30 +00004591 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593 loadaddr - Default load address for commands like "bootp",
4594 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004601
wdenk2729af92004-05-03 20:45:30 +00004602 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004603
wdenk2729af92004-05-03 20:45:30 +00004604 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004605
Mike Frysingere2a53452011-10-02 10:01:27 +00004606 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004607
Mike Frysingere2a53452011-10-02 10:01:27 +00004608 ethact - controls which interface is currently active.
4609 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004610
Heiko Schocher48690d82010-07-20 17:45:02 +02004611 => setenv ethact FEC
4612 => ping 192.168.0.1 # traffic sent on FEC
4613 => setenv ethact SCC
4614 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004615
Matthias Fuchse1692572008-01-17 07:45:05 +01004616 ethrotate - When set to "no" U-Boot does not go through all
4617 available network interfaces.
4618 It just stays at the currently selected interface.
4619
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004620 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004621 either succeed or fail without retrying.
4622 When set to "once" the network operation will
4623 fail when all the available network interfaces
4624 are tried once without success.
4625 Useful on scripts which control the retry operation
4626 themselves.
wdenkc6097192002-11-03 00:24:07 +00004627
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004628 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004629
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004630 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004631 UDP source port.
4632
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004633 tftpdstport - If this is set, the value is used for TFTP's UDP
4634 destination port instead of the Well Know Port 69.
4635
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004636 tftpblocksize - Block size to use for TFTP transfers; if not set,
4637 we use the TFTP server's default block size
4638
4639 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4640 seconds, minimum value is 1000 = 1 second). Defines
4641 when a packet is considered to be lost so it has to
4642 be retransmitted. The default is 5000 = 5 seconds.
4643 Lowering this value may make downloads succeed
4644 faster in networks with high packet loss rates or
4645 with unreliable TFTP servers.
4646
4647 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004648 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004649 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004650
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004651The following image location variables contain the location of images
4652used in booting. The "Image" column gives the role of the image and is
4653not an environment variable name. The other columns are environment
4654variable names. "File Name" gives the name of the file on a TFTP
4655server, "RAM Address" gives the location in RAM the image will be
4656loaded to, and "Flash Location" gives the image's address in NOR
4657flash or offset in NAND flash.
4658
4659*Note* - these variables don't have to be defined for all boards, some
4660boards currenlty use other variables for these purposes, and some
4661boards use these variables for other purposes.
4662
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004663Image File Name RAM Address Flash Location
4664----- --------- ----------- --------------
4665u-boot u-boot u-boot_addr_r u-boot_addr
4666Linux kernel bootfile kernel_addr_r kernel_addr
4667device tree blob fdtfile fdt_addr_r fdt_addr
4668ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004669
wdenk2729af92004-05-03 20:45:30 +00004670The following environment variables may be used and automatically
4671updated by the network boot commands ("bootp" and "rarpboot"),
4672depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004673
wdenk2729af92004-05-03 20:45:30 +00004674 bootfile - see above
4675 dnsip - IP address of your Domain Name Server
4676 dnsip2 - IP address of your secondary Domain Name Server
4677 gatewayip - IP address of the Gateway (Router) to use
4678 hostname - Target hostname
4679 ipaddr - see above
4680 netmask - Subnet Mask
4681 rootpath - Pathname of the root filesystem on the NFS server
4682 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004683
wdenka3d991b2004-04-15 21:48:45 +00004684
wdenk2729af92004-05-03 20:45:30 +00004685There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk2729af92004-05-03 20:45:30 +00004687 serial# - contains hardware identification information such
4688 as type string and/or serial number
4689 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk2729af92004-05-03 20:45:30 +00004691These variables can be set only once (usually during manufacturing of
4692the board). U-Boot refuses to delete or overwrite these variables
4693once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004694
4695
wdenk2729af92004-05-03 20:45:30 +00004696Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk2729af92004-05-03 20:45:30 +00004698 ver - Contains the U-Boot version string as printed
4699 with the "version" command. This variable is
4700 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004701
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703Please note that changes to some configuration parameters may take
4704only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004705
stroesec1551ea2003-04-04 15:53:41 +00004706
Joe Hershberger170ab112012-12-11 22:16:24 -06004707Callback functions for environment variables:
4708---------------------------------------------
4709
4710For some environment variables, the behavior of u-boot needs to change
4711when their values are changed. This functionailty allows functions to
4712be associated with arbitrary variables. On creation, overwrite, or
4713deletion, the callback will provide the opportunity for some side
4714effect to happen or for the change to be rejected.
4715
4716The callbacks are named and associated with a function using the
4717U_BOOT_ENV_CALLBACK macro in your board or driver code.
4718
4719These callbacks are associated with variables in one of two ways. The
4720static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4721in the board configuration to a string that defines a list of
4722associations. The list must be in the following format:
4723
4724 entry = variable_name[:callback_name]
4725 list = entry[,list]
4726
4727If the callback name is not specified, then the callback is deleted.
4728Spaces are also allowed anywhere in the list.
4729
4730Callbacks can also be associated by defining the ".callbacks" variable
4731with the same list format above. Any association in ".callbacks" will
4732override any association in the static list. You can define
4733CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4734".callbacks" envirnoment variable in the default or embedded environment.
4735
4736
wdenk2729af92004-05-03 20:45:30 +00004737Command Line Parsing:
4738=====================
stroesec1551ea2003-04-04 15:53:41 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740There are two different command line parsers available with U-Boot:
4741the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004742
wdenk2729af92004-05-03 20:45:30 +00004743Old, simple command line parser:
4744--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004745
wdenk2729af92004-05-03 20:45:30 +00004746- supports environment variables (through setenv / saveenv commands)
4747- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004748- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004749- special characters ('$', ';') can be escaped by prefixing with '\',
4750 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004751 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004752- You can also escape text by enclosing in single apostrophes, for example:
4753 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755Hush shell:
4756-----------
wdenkf07771c2003-05-28 08:06:31 +00004757
wdenk2729af92004-05-03 20:45:30 +00004758- similar to Bourne shell, with control structures like
4759 if...then...else...fi, for...do...done; while...do...done,
4760 until...do...done, ...
4761- supports environment ("global") variables (through setenv / saveenv
4762 commands) and local shell variables (through standard shell syntax
4763 "name=value"); only environment variables can be used with "run"
4764 command
wdenkf07771c2003-05-28 08:06:31 +00004765
wdenk2729af92004-05-03 20:45:30 +00004766General rules:
4767--------------
wdenkf07771c2003-05-28 08:06:31 +00004768
wdenk2729af92004-05-03 20:45:30 +00004769(1) If a command line (or an environment variable executed by a "run"
4770 command) contains several commands separated by semicolon, and
4771 one of these commands fails, then the remaining commands will be
4772 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004775 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004776 command will cause "run" to terminate, i. e. the remaining
4777 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779Note for Redundant Ethernet Interfaces:
4780=======================================
wdenkf07771c2003-05-28 08:06:31 +00004781
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004782Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004783such configurations and is capable of automatic selection of a
4784"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4787MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4788"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790If the network interface stores some valid MAC address (for instance
4791in SROM), this is used as default address if there is NO correspon-
4792ding setting in the environment; if the corresponding environment
4793variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004794
wdenk2729af92004-05-03 20:45:30 +00004795o If the SROM has a valid MAC address, and there is no address in the
4796 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004797
wdenk2729af92004-05-03 20:45:30 +00004798o If there is no valid address in the SROM, and a definition in the
4799 environment exists, then the value from the environment variable is
4800 used.
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802o If both the SROM and the environment contain a MAC address, and
4803 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004804
wdenk2729af92004-05-03 20:45:30 +00004805o If both the SROM and the environment contain a MAC address, and the
4806 addresses differ, the value from the environment is used and a
4807 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk2729af92004-05-03 20:45:30 +00004809o If neither SROM nor the environment contain a MAC address, an error
4810 is raised.
wdenkc6097192002-11-03 00:24:07 +00004811
Ben Warrenecee9322010-04-26 11:11:46 -07004812If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004813will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004814may be skipped by setting the appropriate 'ethmacskip' environment variable.
4815The naming convention is as follows:
4816"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk2729af92004-05-03 20:45:30 +00004818Image Formats:
4819==============
wdenkc6097192002-11-03 00:24:07 +00004820
Marian Balakowicz3310c542008-03-12 12:13:13 +01004821U-Boot is capable of booting (and performing other auxiliary operations on)
4822images in two formats:
4823
4824New uImage format (FIT)
4825-----------------------
4826
4827Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4828to Flattened Device Tree). It allows the use of images with multiple
4829components (several kernels, ramdisks, etc.), with contents protected by
4830SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4831
4832
4833Old uImage format
4834-----------------
4835
4836Old image format is based on binary files which can be basically anything,
4837preceded by a special header; see the definitions in include/image.h for
4838details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk2729af92004-05-03 20:45:30 +00004840* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4841 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004842 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4843 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4844 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004845* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004846 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4847 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004848* Compression Type (uncompressed, gzip, bzip2)
4849* Load Address
4850* Entry Point
4851* Image Name
4852* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk2729af92004-05-03 20:45:30 +00004854The header is marked by a special Magic Number, and both the header
4855and the data portions of the image are secured against corruption by
4856CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004857
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk2729af92004-05-03 20:45:30 +00004859Linux Support:
4860==============
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862Although U-Boot should support any OS or standalone application
4863easily, the main focus has always been on Linux during the design of
4864U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866U-Boot includes many features that so far have been part of some
4867special "boot loader" code within the Linux kernel. Also, any
4868"initrd" images to be used are no longer part of one big Linux image;
4869instead, kernel and "initrd" are separate images. This implementation
4870serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872- the same features can be used for other OS or standalone
4873 applications (for instance: using compressed images to reduce the
4874 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk2729af92004-05-03 20:45:30 +00004876- it becomes much easier to port new Linux kernel versions because
4877 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk2729af92004-05-03 20:45:30 +00004879- the same Linux kernel image can now be used with different "initrd"
4880 images; of course this also means that different kernel images can
4881 be run with the same "initrd". This makes testing easier (you don't
4882 have to build a new "zImage.initrd" Linux image when you just
4883 change a file in your "initrd"). Also, a field-upgrade of the
4884 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004885
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887Linux HOWTO:
4888============
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890Porting Linux to U-Boot based systems:
4891---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk2729af92004-05-03 20:45:30 +00004893U-Boot cannot save you from doing all the necessary modifications to
4894configure the Linux device drivers for use with your target hardware
4895(no, we don't intend to provide a full virtual machine interface to
4896Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004897
Stefan Roesea47a12b2010-04-15 16:07:28 +02004898But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900Just make sure your machine specific header file (for instance
4901include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004902Information structure as we define in include/asm-<arch>/u-boot.h,
4903and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004904as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004905
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk2729af92004-05-03 20:45:30 +00004907Configuring the Linux kernel:
4908-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk2729af92004-05-03 20:45:30 +00004910No specific requirements for U-Boot. Make sure you have some root
4911device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004912
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk2729af92004-05-03 20:45:30 +00004914Building a Linux Image:
4915-----------------------
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk2729af92004-05-03 20:45:30 +00004917With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4918not used. If you use recent kernel source, a new build target
4919"uImage" will exist which automatically builds an image usable by
4920U-Boot. Most older kernels also have support for a "pImage" target,
4921which was introduced for our predecessor project PPCBoot and uses a
4922100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk2729af92004-05-03 20:45:30 +00004924Example:
wdenkc6097192002-11-03 00:24:07 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926 make TQM850L_config
4927 make oldconfig
4928 make dep
4929 make uImage
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931The "uImage" build target uses a special tool (in 'tools/mkimage') to
4932encapsulate a compressed Linux kernel image with header information,
4933CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk2729af92004-05-03 20:45:30 +00004935* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004936
wdenk2729af92004-05-03 20:45:30 +00004937* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004938
wdenk2729af92004-05-03 20:45:30 +00004939 ${CROSS_COMPILE}-objcopy -O binary \
4940 -R .note -R .comment \
4941 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004942
wdenk2729af92004-05-03 20:45:30 +00004943* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk2729af92004-05-03 20:45:30 +00004945 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk2729af92004-05-03 20:45:30 +00004947* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004948
wdenk2729af92004-05-03 20:45:30 +00004949 mkimage -A ppc -O linux -T kernel -C gzip \
4950 -a 0 -e 0 -n "Linux Kernel Image" \
4951 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004952
wdenk24ee89b2002-11-03 17:56:27 +00004953
wdenk2729af92004-05-03 20:45:30 +00004954The "mkimage" tool can also be used to create ramdisk images for use
4955with U-Boot, either separated from the Linux kernel image, or
4956combined into one file. "mkimage" encapsulates the images with a 64
4957byte header containing information about target architecture,
4958operating system, image type, compression method, entry points, time
4959stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004960
wdenk2729af92004-05-03 20:45:30 +00004961"mkimage" can be called in two ways: to verify existing images and
4962print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004963
wdenk2729af92004-05-03 20:45:30 +00004964In the first form (with "-l" option) mkimage lists the information
4965contained in the header of an existing U-Boot image; this includes
4966checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004967
wdenk2729af92004-05-03 20:45:30 +00004968 tools/mkimage -l image
4969 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004970
wdenk2729af92004-05-03 20:45:30 +00004971The second form (with "-d" option) is used to build a U-Boot image
4972from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004973
wdenk2729af92004-05-03 20:45:30 +00004974 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4975 -n name -d data_file image
4976 -A ==> set architecture to 'arch'
4977 -O ==> set operating system to 'os'
4978 -T ==> set image type to 'type'
4979 -C ==> set compression type 'comp'
4980 -a ==> set load address to 'addr' (hex)
4981 -e ==> set entry point to 'ep' (hex)
4982 -n ==> set image name to 'name'
4983 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004984
wdenk69459792004-05-29 16:53:29 +00004985Right now, all Linux kernels for PowerPC systems use the same load
4986address (0x00000000), but the entry point address depends on the
4987kernel version:
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989- 2.2.x kernels have the entry point at 0x0000000C,
4990- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk2729af92004-05-03 20:45:30 +00004994 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4995 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004996 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004997 > examples/uImage.TQM850L
4998 Image Name: 2.4.4 kernel for TQM850L
4999 Created: Wed Jul 19 02:34:59 2000
5000 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5001 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5002 Load Address: 0x00000000
5003 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk2729af92004-05-03 20:45:30 +00005007 -> tools/mkimage -l examples/uImage.TQM850L
5008 Image Name: 2.4.4 kernel for TQM850L
5009 Created: Wed Jul 19 02:34:59 2000
5010 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5011 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5012 Load Address: 0x00000000
5013 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk2729af92004-05-03 20:45:30 +00005015NOTE: for embedded systems where boot time is critical you can trade
5016speed for memory and install an UNCOMPRESSED image instead: this
5017needs more space in Flash, but boots much faster since it does not
5018need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005019
Stefan Roesea47a12b2010-04-15 16:07:28 +02005020 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005021 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5022 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005023 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005024 > examples/uImage.TQM850L-uncompressed
5025 Image Name: 2.4.4 kernel for TQM850L
5026 Created: Wed Jul 19 02:34:59 2000
5027 Image Type: PowerPC Linux Kernel Image (uncompressed)
5028 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5029 Load Address: 0x00000000
5030 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005031
wdenkc6097192002-11-03 00:24:07 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5034when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036 -> tools/mkimage -n 'Simple Ramdisk Image' \
5037 > -A ppc -O linux -T ramdisk -C gzip \
5038 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5039 Image Name: Simple Ramdisk Image
5040 Created: Wed Jan 12 14:01:50 2000
5041 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5042 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5043 Load Address: 0x00000000
5044 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005045
wdenkdb01a2e2004-04-15 23:14:49 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047Installing a Linux Image:
5048-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005049
wdenk2729af92004-05-03 20:45:30 +00005050To downloading a U-Boot image over the serial (console) interface,
5051you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055The 'objcopy' does not understand the information in the U-Boot
5056image header, so the resulting S-Record file will be relative to
5057address 0x00000000. To load it to a given address, you need to
5058specify the target address as 'offset' parameter with the 'loads'
5059command.
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061Example: install the image to address 0x40100000 (which on the
5062TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005063
wdenk2729af92004-05-03 20:45:30 +00005064 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk2729af92004-05-03 20:45:30 +00005066 .......... done
5067 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069 => loads 40100000
5070 ## Ready for S-Record download ...
5071 ~>examples/image.srec
5072 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5073 ...
5074 15989 15990 15991 15992
5075 [file transfer complete]
5076 [connected]
5077 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005078
5079
wdenk2729af92004-05-03 20:45:30 +00005080You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005081this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005082corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005085
wdenk2729af92004-05-03 20:45:30 +00005086 ## Checking Image at 40100000 ...
5087 Image Name: 2.2.13 for initrd on TQM850L
5088 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5089 Data Size: 335725 Bytes = 327 kB = 0 MB
5090 Load Address: 00000000
5091 Entry Point: 0000000c
5092 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005093
5094
wdenk2729af92004-05-03 20:45:30 +00005095Boot Linux:
5096-----------
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098The "bootm" command is used to boot an application that is stored in
5099memory (RAM or Flash). In case of a Linux kernel image, the contents
5100of the "bootargs" environment variable is passed to the kernel as
5101parameters. You can check and modify this variable using the
5102"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005103
5104
wdenk2729af92004-05-03 20:45:30 +00005105 => printenv bootargs
5106 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk2729af92004-05-03 20:45:30 +00005108 => 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 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110 => printenv bootargs
5111 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 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113 => bootm 40020000
5114 ## Booting Linux kernel at 40020000 ...
5115 Image Name: 2.2.13 for NFS on TQM850L
5116 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5117 Data Size: 381681 Bytes = 372 kB = 0 MB
5118 Load Address: 00000000
5119 Entry Point: 0000000c
5120 Verifying Checksum ... OK
5121 Uncompressing Kernel Image ... OK
5122 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
5123 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5124 time_init: decrementer frequency = 187500000/60
5125 Calibrating delay loop... 49.77 BogoMIPS
5126 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5127 ...
wdenkc6097192002-11-03 00:24:07 +00005128
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005129If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005130the memory addresses of both the kernel and the initrd image (PPBCOOT
5131format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk2729af92004-05-03 20:45:30 +00005133 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005134
wdenk2729af92004-05-03 20:45:30 +00005135 ## Checking Image at 40100000 ...
5136 Image Name: 2.2.13 for initrd on TQM850L
5137 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5138 Data Size: 335725 Bytes = 327 kB = 0 MB
5139 Load Address: 00000000
5140 Entry Point: 0000000c
5141 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk2729af92004-05-03 20:45:30 +00005143 ## Checking Image at 40200000 ...
5144 Image Name: Simple Ramdisk Image
5145 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5146 Data Size: 566530 Bytes = 553 kB = 0 MB
5147 Load Address: 00000000
5148 Entry Point: 00000000
5149 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151 => bootm 40100000 40200000
5152 ## Booting Linux kernel at 40100000 ...
5153 Image Name: 2.2.13 for initrd on TQM850L
5154 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5155 Data Size: 335725 Bytes = 327 kB = 0 MB
5156 Load Address: 00000000
5157 Entry Point: 0000000c
5158 Verifying Checksum ... OK
5159 Uncompressing Kernel Image ... OK
5160 ## Loading RAMDisk Image at 40200000 ...
5161 Image Name: Simple Ramdisk Image
5162 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5163 Data Size: 566530 Bytes = 553 kB = 0 MB
5164 Load Address: 00000000
5165 Entry Point: 00000000
5166 Verifying Checksum ... OK
5167 Loading Ramdisk ... OK
5168 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
5169 Boot arguments: root=/dev/ram
5170 time_init: decrementer frequency = 187500000/60
5171 Calibrating delay loop... 49.77 BogoMIPS
5172 ...
5173 RAMDISK: Compressed image found at block 0
5174 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176 bash#
wdenkc6097192002-11-03 00:24:07 +00005177
Matthew McClintock02677682006-06-28 10:41:37 -05005178Boot Linux and pass a flat device tree:
5179-----------
5180
5181First, U-Boot must be compiled with the appropriate defines. See the section
5182titled "Linux Kernel Interface" above for a more in depth explanation. The
5183following is an example of how to start a kernel and pass an updated
5184flat device tree:
5185
5186=> print oftaddr
5187oftaddr=0x300000
5188=> print oft
5189oft=oftrees/mpc8540ads.dtb
5190=> tftp $oftaddr $oft
5191Speed: 1000, full duplex
5192Using TSEC0 device
5193TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5194Filename 'oftrees/mpc8540ads.dtb'.
5195Load address: 0x300000
5196Loading: #
5197done
5198Bytes transferred = 4106 (100a hex)
5199=> tftp $loadaddr $bootfile
5200Speed: 1000, full duplex
5201Using TSEC0 device
5202TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5203Filename 'uImage'.
5204Load address: 0x200000
5205Loading:############
5206done
5207Bytes transferred = 1029407 (fb51f hex)
5208=> print loadaddr
5209loadaddr=200000
5210=> print oftaddr
5211oftaddr=0x300000
5212=> bootm $loadaddr - $oftaddr
5213## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005214 Image Name: Linux-2.6.17-dirty
5215 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5216 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005217 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005218 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005219 Verifying Checksum ... OK
5220 Uncompressing Kernel Image ... OK
5221Booting using flat device tree at 0x300000
5222Using MPC85xx ADS machine description
5223Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5224[snip]
5225
5226
wdenk2729af92004-05-03 20:45:30 +00005227More About U-Boot Image Types:
5228------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005231
wdenk2729af92004-05-03 20:45:30 +00005232 "Standalone Programs" are directly runnable in the environment
5233 provided by U-Boot; it is expected that (if they behave
5234 well) you can continue to work in U-Boot after return from
5235 the Standalone Program.
5236 "OS Kernel Images" are usually images of some Embedded OS which
5237 will take over control completely. Usually these programs
5238 will install their own set of exception handlers, device
5239 drivers, set up the MMU, etc. - this means, that you cannot
5240 expect to re-enter U-Boot except by resetting the CPU.
5241 "RAMDisk Images" are more or less just data blocks, and their
5242 parameters (address, size) are passed to an OS kernel that is
5243 being started.
5244 "Multi-File Images" contain several images, typically an OS
5245 (Linux) kernel image and one or more data images like
5246 RAMDisks. This construct is useful for instance when you want
5247 to boot over the network using BOOTP etc., where the boot
5248 server provides just a single image file, but you want to get
5249 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005250
wdenk2729af92004-05-03 20:45:30 +00005251 "Multi-File Images" start with a list of image sizes, each
5252 image size (in bytes) specified by an "uint32_t" in network
5253 byte order. This list is terminated by an "(uint32_t)0".
5254 Immediately after the terminating 0 follow the images, one by
5255 one, all aligned on "uint32_t" boundaries (size rounded up to
5256 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258 "Firmware Images" are binary images containing firmware (like
5259 U-Boot or FPGA images) which usually will be programmed to
5260 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262 "Script files" are command sequences that will be executed by
5263 U-Boot's command interpreter; this feature is especially
5264 useful when you configure U-Boot to use a real shell (hush)
5265 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005266
Marek Vasut44f074c2012-03-14 21:52:45 +00005267Booting the Linux zImage:
5268-------------------------
5269
5270On some platforms, it's possible to boot Linux zImage. This is done
5271using the "bootz" command. The syntax of "bootz" command is the same
5272as the syntax of "bootm" command.
5273
Tom Rini8ac28562013-05-16 11:40:11 -04005274Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005275kernel with raw initrd images. The syntax is slightly different, the
5276address of the initrd must be augmented by it's size, in the following
5277format: "<initrd addres>:<initrd size>".
5278
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk2729af92004-05-03 20:45:30 +00005280Standalone HOWTO:
5281=================
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk2729af92004-05-03 20:45:30 +00005283One of the features of U-Boot is that you can dynamically load and
5284run "standalone" applications, which can use some resources of
5285U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk2729af92004-05-03 20:45:30 +00005287Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk2729af92004-05-03 20:45:30 +00005289"Hello World" Demo:
5290-------------------
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk2729af92004-05-03 20:45:30 +00005292'examples/hello_world.c' contains a small "Hello World" Demo
5293application; it is automatically compiled when you build U-Boot.
5294It's configured to run at address 0x00040004, so you can play with it
5295like that:
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297 => loads
5298 ## Ready for S-Record download ...
5299 ~>examples/hello_world.srec
5300 1 2 3 4 5 6 7 8 9 10 11 ...
5301 [file transfer complete]
5302 [connected]
5303 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk2729af92004-05-03 20:45:30 +00005305 => go 40004 Hello World! This is a test.
5306 ## Starting application at 0x00040004 ...
5307 Hello World
5308 argc = 7
5309 argv[0] = "40004"
5310 argv[1] = "Hello"
5311 argv[2] = "World!"
5312 argv[3] = "This"
5313 argv[4] = "is"
5314 argv[5] = "a"
5315 argv[6] = "test."
5316 argv[7] = "<NULL>"
5317 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk2729af92004-05-03 20:45:30 +00005319 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk2729af92004-05-03 20:45:30 +00005321Another example, which demonstrates how to register a CPM interrupt
5322handler with the U-Boot code, can be found in 'examples/timer.c'.
5323Here, a CPM timer is set up to generate an interrupt every second.
5324The interrupt service routine is trivial, just printing a '.'
5325character, but this is just a demo program. The application can be
5326controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328 ? - print current values og the CPM Timer registers
5329 b - enable interrupts and start timer
5330 e - stop timer and disable interrupts
5331 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk2729af92004-05-03 20:45:30 +00005333 => loads
5334 ## Ready for S-Record download ...
5335 ~>examples/timer.srec
5336 1 2 3 4 5 6 7 8 9 10 11 ...
5337 [file transfer complete]
5338 [connected]
5339 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341 => go 40004
5342 ## Starting application at 0x00040004 ...
5343 TIMERS=0xfff00980
5344 Using timer 1
5345 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk2729af92004-05-03 20:45:30 +00005347Hit 'b':
5348 [q, b, e, ?] Set interval 1000000 us
5349 Enabling timer
5350Hit '?':
5351 [q, b, e, ?] ........
5352 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5353Hit '?':
5354 [q, b, e, ?] .
5355 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5356Hit '?':
5357 [q, b, e, ?] .
5358 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5359Hit '?':
5360 [q, b, e, ?] .
5361 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5362Hit 'e':
5363 [q, b, e, ?] ...Stopping timer
5364Hit 'q':
5365 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005366
5367
wdenk2729af92004-05-03 20:45:30 +00005368Minicom warning:
5369================
wdenk85ec0bc2003-03-31 16:34:49 +00005370
wdenk2729af92004-05-03 20:45:30 +00005371Over time, many people have reported problems when trying to use the
5372"minicom" terminal emulation program for serial download. I (wd)
5373consider minicom to be broken, and recommend not to use it. Under
5374Unix, I recommend to use C-Kermit for general purpose use (and
5375especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005376use "cu" for S-Record download ("loads" command). See
5377http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5378for help with kermit.
5379
wdenk85ec0bc2003-03-31 16:34:49 +00005380
wdenk2729af92004-05-03 20:45:30 +00005381Nevertheless, if you absolutely want to use it try adding this
5382configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384 Name Program Name U/D FullScr IO-Red. Multi
5385 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5386 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005387
5388
wdenk2729af92004-05-03 20:45:30 +00005389NetBSD Notes:
5390=============
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392Starting at version 0.9.2, U-Boot supports NetBSD both as host
5393(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395Building requires a cross environment; it is known to work on
5396NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5397need gmake since the Makefiles are not compatible with BSD make).
5398Note that the cross-powerpc package does not install include files;
5399attempting to build U-Boot will fail because <machine/ansi.h> is
5400missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk2729af92004-05-03 20:45:30 +00005402 # cd /usr/pkg/cross/powerpc-netbsd/include
5403 # mkdir powerpc
5404 # ln -s powerpc machine
5405 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5406 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk2729af92004-05-03 20:45:30 +00005408Native builds *don't* work due to incompatibilities between native
5409and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk2729af92004-05-03 20:45:30 +00005411Booting assumes that (the first part of) the image booted is a
5412stage-2 loader which in turn loads and then invokes the kernel
5413proper. Loader sources will eventually appear in the NetBSD source
5414tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005415meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005416
5417
wdenk2729af92004-05-03 20:45:30 +00005418Implementation Internals:
5419=========================
wdenkc6097192002-11-03 00:24:07 +00005420
wdenk2729af92004-05-03 20:45:30 +00005421The following is not intended to be a complete description of every
5422implementation detail. However, it should help to understand the
5423inner workings of U-Boot and make it easier to port it to custom
5424hardware.
wdenkc6097192002-11-03 00:24:07 +00005425
5426
wdenk2729af92004-05-03 20:45:30 +00005427Initial Stack, Global Data:
5428---------------------------
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk2729af92004-05-03 20:45:30 +00005430The implementation of U-Boot is complicated by the fact that U-Boot
5431starts running out of ROM (flash memory), usually without access to
5432system RAM (because the memory controller is not initialized yet).
5433This means that we don't have writable Data or BSS segments, and BSS
5434is not initialized as zero. To be able to get a C environment working
5435at all, we have to allocate at least a minimal stack. Implementation
5436options for this are defined and restricted by the CPU used: Some CPU
5437models provide on-chip memory (like the IMMR area on MPC8xx and
5438MPC826x processors), on others (parts of) the data cache can be
5439locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005440
Wolfgang Denk218ca722008-03-26 10:40:12 +01005441 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005442 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5445 From: "Chris Hallinan" <clh@net1plus.com>
5446 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5447 ...
wdenk43d96162003-03-06 00:02:04 +00005448
wdenk2729af92004-05-03 20:45:30 +00005449 Correct me if I'm wrong, folks, but the way I understand it
5450 is this: Using DCACHE as initial RAM for Stack, etc, does not
5451 require any physical RAM backing up the cache. The cleverness
5452 is that the cache is being used as a temporary supply of
5453 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005454 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005455 can see how this works by studying the cache architecture and
5456 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005457
wdenk2729af92004-05-03 20:45:30 +00005458 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5459 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005460 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005461 option should work for you. Using CS 4 should be fine if your
5462 board designers haven't used it for something that would
5463 cause you grief during the initial boot! It is frequently not
5464 used.
wdenk43d96162003-03-06 00:02:04 +00005465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005466 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005467 with your processor/board/system design. The default value
5468 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005469 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005470 than your SDRAM module. If you have a 64MB SDRAM module, set
5471 it above 400_0000. Just make sure your board has no resources
5472 that are supposed to respond to that address! That code in
5473 start.S has been around a while and should work as is when
5474 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005475
wdenk2729af92004-05-03 20:45:30 +00005476 -Chris Hallinan
5477 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005478
wdenk2729af92004-05-03 20:45:30 +00005479It is essential to remember this, since it has some impact on the C
5480code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk2729af92004-05-03 20:45:30 +00005482* Initialized global data (data segment) is read-only. Do not attempt
5483 to write it.
wdenkc6097192002-11-03 00:24:07 +00005484
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005485* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005486 as zero data - BSS segment) at all - this is undefined, initiali-
5487 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk2729af92004-05-03 20:45:30 +00005489* Stack space is very limited. Avoid big data buffers or things like
5490 that.
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492Having only the stack as writable memory limits means we cannot use
5493normal global data to share information beween the code. But it
5494turned out that the implementation of U-Boot can be greatly
5495simplified by making a global data structure (gd_t) available to all
5496functions. We could pass a pointer to this data as argument to _all_
5497functions, but this would bloat the code. Instead we use a feature of
5498the GCC compiler (Global Register Variables) to share the data: we
5499place a pointer (gd) to the global data into a register which we
5500reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005501
wdenk2729af92004-05-03 20:45:30 +00005502When choosing a register for such a purpose we are restricted by the
5503relevant (E)ABI specifications for the current architecture, and by
5504GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk2729af92004-05-03 20:45:30 +00005506For PowerPC, the following registers have specific use:
5507 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005508 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005509 R3-R4: parameter passing and return values
5510 R5-R10: parameter passing
5511 R13: small data area pointer
5512 R30: GOT pointer
5513 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005514
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005515 (U-Boot also uses R12 as internal GOT pointer. r12
5516 is a volatile register so r12 needs to be reset when
5517 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005518
Wolfgang Denke7670f62008-02-14 22:43:22 +01005519 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk2729af92004-05-03 20:45:30 +00005521 Note: on PPC, we could use a static initializer (since the
5522 address of the global data structure is known at compile time),
5523 but it turned out that reserving a register results in somewhat
5524 smaller code - although the code savings are not that big (on
5525 average for all boards 752 bytes for the whole U-Boot image,
5526 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005527
Robin Getzc4db3352009-08-17 15:23:02 +00005528On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005529 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5530
Robin Getzc4db3352009-08-17 15:23:02 +00005531 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005532
wdenk2729af92004-05-03 20:45:30 +00005533On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005534
wdenk2729af92004-05-03 20:45:30 +00005535 R0: function argument word/integer result
5536 R1-R3: function argument word
5537 R9: GOT pointer
5538 R10: stack limit (used only if stack checking if enabled)
5539 R11: argument (frame) pointer
5540 R12: temporary workspace
5541 R13: stack pointer
5542 R14: link register
5543 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk2729af92004-05-03 20:45:30 +00005545 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005546
Thomas Chou0df01fd2010-05-21 11:08:03 +08005547On Nios II, the ABI is documented here:
5548 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5549
5550 ==> U-Boot will use gp to hold a pointer to the global data
5551
5552 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5553 to access small data sections, so gp is free.
5554
Macpaul Linafc1ce82011-10-19 20:41:11 +00005555On NDS32, the following registers are used:
5556
5557 R0-R1: argument/return
5558 R2-R5: argument
5559 R15: temporary register for assembler
5560 R16: trampoline register
5561 R28: frame pointer (FP)
5562 R29: global pointer (GP)
5563 R30: link register (LP)
5564 R31: stack pointer (SP)
5565 PC: program counter (PC)
5566
5567 ==> U-Boot will use R10 to hold a pointer to the global data
5568
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005569NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5570or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk2729af92004-05-03 20:45:30 +00005572Memory Management:
5573------------------
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk2729af92004-05-03 20:45:30 +00005575U-Boot runs in system state and uses physical addresses, i.e. the
5576MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk2729af92004-05-03 20:45:30 +00005578The available memory is mapped to fixed addresses using the memory
5579controller. In this process, a contiguous block is formed for each
5580memory type (Flash, SDRAM, SRAM), even when it consists of several
5581physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk2729af92004-05-03 20:45:30 +00005583U-Boot is installed in the first 128 kB of the first Flash bank (on
5584TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5585booting and sizing and initializing DRAM, the code relocates itself
5586to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005587memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005588configuration setting]. Below that, a structure with global Board
5589Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005590
wdenk2729af92004-05-03 20:45:30 +00005591Additionally, some exception handler code is copied to the low 8 kB
5592of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594So a typical memory configuration with 16 MB of DRAM could look like
5595this:
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597 0x0000 0000 Exception Vector code
5598 :
5599 0x0000 1FFF
5600 0x0000 2000 Free for Application Use
5601 :
5602 :
wdenkc6097192002-11-03 00:24:07 +00005603
wdenk2729af92004-05-03 20:45:30 +00005604 :
5605 :
5606 0x00FB FF20 Monitor Stack (Growing downward)
5607 0x00FB FFAC Board Info Data and permanent copy of global data
5608 0x00FC 0000 Malloc Arena
5609 :
5610 0x00FD FFFF
5611 0x00FE 0000 RAM Copy of Monitor Code
5612 ... eventually: LCD or video framebuffer
5613 ... eventually: pRAM (Protected RAM - unchanged by reset)
5614 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005615
5616
wdenk2729af92004-05-03 20:45:30 +00005617System Initialization:
5618----------------------
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005621(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005622configuration for CS0# this is a mirror of the onboard Flash memory.
5623To be able to re-map memory U-Boot then jumps to its link address.
5624To be able to implement the initialization code in C, a (small!)
5625initial stack is set up in the internal Dual Ported RAM (in case CPUs
5626which provide such a feature like MPC8xx or MPC8260), or in a locked
5627part of the data cache. After that, U-Boot initializes the CPU core,
5628the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk2729af92004-05-03 20:45:30 +00005630Next, all (potentially) available memory banks are mapped using a
5631preliminary mapping. For example, we put them on 512 MB boundaries
5632(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5633on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5634programmed for SDRAM access. Using the temporary configuration, a
5635simple memory test is run that determines the size of the SDRAM
5636banks.
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk2729af92004-05-03 20:45:30 +00005638When there is more than one SDRAM bank, and the banks are of
5639different size, the largest is mapped first. For equal size, the first
5640bank (CS2#) is mapped first. The first mapping is always for address
56410x00000000, with any additional banks following immediately to create
5642contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk2729af92004-05-03 20:45:30 +00005644Then, the monitor installs itself at the upper end of the SDRAM area
5645and allocates memory for use by malloc() and for the global Board
5646Info data; also, the exception vector code is copied to the low RAM
5647pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649Only after this relocation will you have a "normal" C environment;
5650until that you are restricted in several ways, mostly because you are
5651running from ROM, and because the code will have to be relocated to a
5652new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005653
5654
wdenk2729af92004-05-03 20:45:30 +00005655U-Boot Porting Guide:
5656----------------------
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk2729af92004-05-03 20:45:30 +00005658[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5659list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005660
5661
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005662int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005663{
5664 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005665
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005666 signal(SIGALRM, no_more_time);
5667 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005668
wdenk2729af92004-05-03 20:45:30 +00005669 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005670 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005671 return 0;
5672 }
5673
wdenk2729af92004-05-03 20:45:30 +00005674 Download latest U-Boot source;
5675
Wolfgang Denk06682362008-12-30 22:56:11 +01005676 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005677
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005678 if (clueless)
5679 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk2729af92004-05-03 20:45:30 +00005681 while (learning) {
5682 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005683 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5684 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005685 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005686 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005687 }
wdenkc6097192002-11-03 00:24:07 +00005688
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005689 if (available_money > toLocalCurrency ($2500))
5690 Buy a BDI3000;
5691 else
wdenk2729af92004-05-03 20:45:30 +00005692 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005693
5694 if (a similar board exists) { /* hopefully... */
5695 cp -a board/<similar> board/<myboard>
5696 cp include/configs/<similar>.h include/configs/<myboard>.h
5697 } else {
5698 Create your own board support subdirectory;
5699 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005700 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005701 Edit new board/<myboard> files
5702 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005703
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005704 while (!accepted) {
5705 while (!running) {
5706 do {
5707 Add / modify source code;
5708 } until (compiles);
5709 Debug;
5710 if (clueless)
5711 email("Hi, I am having problems...");
5712 }
5713 Send patch file to the U-Boot email list;
5714 if (reasonable critiques)
5715 Incorporate improvements from email list code review;
5716 else
5717 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005718 }
wdenkc6097192002-11-03 00:24:07 +00005719
wdenk2729af92004-05-03 20:45:30 +00005720 return 0;
5721}
5722
5723void no_more_time (int sig)
5724{
5725 hire_a_guru();
5726}
wdenkc6097192002-11-03 00:24:07 +00005727
5728
wdenk2729af92004-05-03 20:45:30 +00005729Coding Standards:
5730-----------------
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk2729af92004-05-03 20:45:30 +00005732All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005733coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005734"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005735
Detlev Zundel2c051652006-09-01 15:39:02 +02005736Source files originating from a different project (for example the
5737MTD subsystem) are generally exempt from these guidelines and are not
5738reformated to ease subsequent migration to newer versions of those
5739sources.
5740
5741Please note that U-Boot is implemented in C (and to some small parts in
5742Assembler); no C++ is used, so please do not use C++ style comments (//)
5743in your code.
wdenk2729af92004-05-03 20:45:30 +00005744
5745Please also stick to the following formatting rules:
5746- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005747- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005748- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005749- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005750- do not add trailing empty lines to source files
5751
5752Submissions which do not conform to the standards may be returned
5753with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005754
5755
wdenk2729af92004-05-03 20:45:30 +00005756Submitting Patches:
5757-------------------
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk2729af92004-05-03 20:45:30 +00005759Since the number of patches for U-Boot is growing, we need to
5760establish some rules. Submissions which do not conform to these rules
5761may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005762
Magnus Lilja0d28f342008-08-06 19:32:33 +02005763Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005764
Wolfgang Denk06682362008-12-30 22:56:11 +01005765Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5766see http://lists.denx.de/mailman/listinfo/u-boot
5767
wdenk2729af92004-05-03 20:45:30 +00005768When you send a patch, please include the following information with
5769it:
wdenkc6097192002-11-03 00:24:07 +00005770
wdenk2729af92004-05-03 20:45:30 +00005771* For bug fixes: a description of the bug and how your patch fixes
5772 this bug. Please try to include a way of demonstrating that the
5773 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005774
wdenk2729af92004-05-03 20:45:30 +00005775* For new features: a description of the feature and your
5776 implementation.
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk2729af92004-05-03 20:45:30 +00005778* A CHANGELOG entry as plaintext (separate from the patch)
5779
5780* For major contributions, your entry to the CREDITS file
5781
5782* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005783 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005784
5785* If your patch adds new configuration options, don't forget to
5786 document these in the README file.
5787
Wolfgang Denk218ca722008-03-26 10:40:12 +01005788* The patch itself. If you are using git (which is *strongly*
5789 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005790 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005791 the U-Boot mailing list, you will avoid most of the common problems
5792 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005793
Wolfgang Denk218ca722008-03-26 10:40:12 +01005794 If you cannot use git, use "diff -purN OLD NEW". If your version of
5795 diff does not support these options, then get the latest version of
5796 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005797
Wolfgang Denk218ca722008-03-26 10:40:12 +01005798 The current directory when running this command shall be the parent
5799 directory of the U-Boot source tree (i. e. please make sure that
5800 your patch includes sufficient directory information for the
5801 affected files).
5802
5803 We prefer patches as plain text. MIME attachments are discouraged,
5804 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005805
5806* If one logical set of modifications affects or creates several
5807 files, all these changes shall be submitted in a SINGLE patch file.
5808
5809* Changesets that contain different, unrelated modifications shall be
5810 submitted as SEPARATE patches, one patch per changeset.
5811
5812
5813Notes:
5814
5815* Before sending the patch, run the MAKEALL script on your patched
5816 source tree and make sure that no errors or warnings are reported
5817 for any of the boards.
5818
5819* Keep your modifications to the necessary minimum: A patch
5820 containing several unrelated changes or arbitrary reformats will be
5821 returned with a request to re-formatting / split it.
5822
5823* If you modify existing code, make sure that your new code does not
5824 add to the memory footprint of the code ;-) Small is beautiful!
5825 When adding new features, these should compile conditionally only
5826 (using #ifdef), and the resulting code with the new feature
5827 disabled must not need more memory than the old code without your
5828 modification.
wdenk90dc6702005-05-03 14:12:25 +00005829
Wolfgang Denk06682362008-12-30 22:56:11 +01005830* Remember that there is a size limit of 100 kB per message on the
5831 u-boot mailing list. Bigger patches will be moderated. If they are
5832 reasonable and not too big, they will be acknowledged. But patches
5833 bigger than the size limit should be avoided.