blob: cb96322fb71d0e4301182759fa53c4afdc6b3167 [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
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
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 /arm926ejs Files specific to ARM 926 CPUs
143 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500144 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
146 /lib Architecture specific library files
147 /avr32 Files generic to AVR32 architecture
148 /cpu CPU specific files
149 /lib Architecture specific library files
150 /blackfin Files generic to Analog Devices Blackfin architecture
151 /cpu CPU specific files
152 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /m68k Files generic to m68k architecture
154 /cpu CPU specific files
155 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
156 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
157 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
158 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
159 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
160 /lib Architecture specific library files
161 /microblaze Files generic to microblaze architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /mips Files generic to MIPS architecture
165 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200166 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800167 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000169 /nds32 Files generic to NDS32 architecture
170 /cpu CPU specific files
171 /n1213 Files specific to Andes Technology N1213 CPUs
172 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500173 /nios2 Files generic to Altera NIOS2 architecture
174 /cpu CPU specific files
175 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400176 /openrisc Files generic to OpenRISC architecture
177 /cpu CPU specific files
178 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200179 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500180 /cpu CPU specific files
181 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
182 /mpc5xx Files specific to Freescale MPC5xx CPUs
183 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
184 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc824x Files specific to Freescale MPC824x CPUs
186 /mpc8260 Files specific to Freescale MPC8260 CPUs
187 /mpc85xx Files specific to Freescale MPC85xx CPUs
188 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
189 /lib Architecture specific library files
190 /sh Files generic to SH architecture
191 /cpu CPU specific files
192 /sh2 Files specific to sh2 CPUs
193 /sh3 Files specific to sh3 CPUs
194 /sh4 Files specific to sh4 CPUs
195 /lib Architecture specific library files
196 /sparc Files generic to SPARC architecture
197 /cpu CPU specific files
198 /leon2 Files specific to Gaisler LEON2 SPARC CPU
199 /leon3 Files specific to Gaisler LEON3 SPARC CPU
200 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400201 /x86 Files generic to x86 architecture
202 /cpu CPU specific files
203 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500204/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
Robert P. J. Day33c77312013-09-15 18:34:15 -0400210/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500211/examples Example code for standalone applications, etc.
212/fs Filesystem code (cramfs, ext2, jffs2, etc.)
213/include Header Files
214/lib Files generic to all architectures
215 /libfdt Library files to support flattened device trees
216 /lzma Library files to support LZMA decompression
217 /lzo Library files to support LZO decompression
218/net Networking code
219/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400220/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500221/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000222
wdenkc6097192002-11-03 00:24:07 +0000223Software Configuration:
224=======================
225
226Configuration is usually done using C preprocessor defines; the
227rationale behind that is to avoid dead code whenever possible.
228
229There are two classes of configuration variables:
230
231* Configuration _OPTIONS_:
232 These are selectable by the user and have names beginning with
233 "CONFIG_".
234
235* Configuration _SETTINGS_:
236 These depend on the hardware etc. and should not be meddled with if
237 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200238 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000239
240Later we will add a configuration tool - probably similar to or even
241identical to what's used for the Linux kernel. Right now, we have to
242do the configuration by hand, which means creating some symbolic
243links and editing some configuration files. We use the TQM8xxL boards
244as an example here.
245
246
247Selection of Processor Architecture and Board Type:
248---------------------------------------------------
249
250For all supported boards there are ready-to-use default
251configurations available; just type "make <board_name>_config".
252
253Example: For a TQM823L module type:
254
255 cd u-boot
256 make TQM823L_config
257
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200258For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000259e.g. "make cogent_mpc8xx_config". And also configure the cogent
260directory according to the instructions in cogent/README.
261
262
263Configuration Options:
264----------------------
265
266Configuration depends on the combination of board and CPU type; all
267such information is kept in a configuration file
268"include/configs/<board_name>.h".
269
270Example: For a TQM823L module, all configuration settings are in
271"include/configs/TQM823L.h".
272
273
wdenk7f6c2cb2002-11-10 22:06:23 +0000274Many of the options are named exactly as the corresponding Linux
275kernel configuration options. The intention is to make it easier to
276build a config tool - later.
277
278
wdenkc6097192002-11-03 00:24:07 +0000279The following options need to be configured:
280
Kim Phillips26281142007-08-10 13:28:25 -0500281- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000282
Kim Phillips26281142007-08-10 13:28:25 -0500283- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200284
285- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100286 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000287
288- CPU Module Type: (if CONFIG_COGENT is defined)
289 Define exactly one of
290 CONFIG_CMA286_60_OLD
291--- FIXME --- not tested yet:
292 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
293 CONFIG_CMA287_23, CONFIG_CMA287_50
294
295- Motherboard Type: (if CONFIG_COGENT is defined)
296 Define exactly one of
297 CONFIG_CMA101, CONFIG_CMA102
298
299- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
300 Define one or more of
301 CONFIG_CMA302
302
303- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
304 Define one or more of
305 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200306 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000307 a "rotator" |\-/|\-/
308
wdenk2535d602003-07-17 23:16:40 +0000309- Board flavour: (if CONFIG_MPC8260ADS is defined)
310 CONFIG_ADSTYPE
311 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200312 CONFIG_SYS_8260ADS - original MPC8260ADS
313 CONFIG_SYS_8266ADS - MPC8266ADS
314 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
315 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000316
Lei Wencf946c62011-02-09 18:06:58 +0530317- Marvell Family Member
318 CONFIG_SYS_MVFS - define it if you want to enable
319 multiple fs option at one time
320 for marvell soc family
321
wdenkc6097192002-11-03 00:24:07 +0000322- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000323 Define exactly one of
324 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000325
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200326- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000327 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
328 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000329 e.g. if there is no 32KHz
330 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000331 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
332 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000333
wdenk66ca92a2004-09-28 17:59:53 +0000334- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200335 CONFIG_SYS_8xx_CPUCLK_MIN
336 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000338 See doc/README.MPC866
339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000341
wdenkba56f622004-02-06 23:19:44 +0000342 Define this to measure the actual CPU clock instead
343 of relying on the correctness of the configured
344 values. Mostly useful for board bringup to make sure
345 the PLL is locked at the intended frequency. Note
346 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000348
Heiko Schocher506f3912009-03-12 07:37:15 +0100349 CONFIG_SYS_DELAYED_ICACHE
350
351 Define this option if you want to enable the
352 ICache only when Code runs from RAM.
353
Kumar Gala66412c62011-02-18 05:40:54 -0600354- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000355 CONFIG_SYS_PPC64
356
357 Specifies that the core is a 64-bit PowerPC implementation (implements
358 the "64" category of the Power ISA). This is necessary for ePAPR
359 compliance, among other possible reasons.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361 CONFIG_SYS_FSL_TBCLK_DIV
362
363 Defines the core time base clock divider ratio compared to the
364 system clock. On most PQ3 devices this is 8, on newer QorIQ
365 devices it can be 16 or 32. The ratio varies from SoC to Soc.
366
Kumar Gala8f290842011-05-20 00:39:21 -0500367 CONFIG_SYS_FSL_PCIE_COMPAT
368
369 Defines the string to utilize when trying to match PCIe device
370 tree nodes for the given platform.
371
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000372 CONFIG_SYS_PPC_E500_DEBUG_TLB
373
374 Enables a temporary TLB entry to be used during boot to work
375 around limitations in e500v1 and e500v2 external debugger
376 support. This reduces the portions of the boot code where
377 breakpoints and single stepping do not work. The value of this
378 symbol should be set to the TLB1 entry to be used for this
379 purpose.
380
Scott Wood33eee332012-08-14 10:14:53 +0000381 CONFIG_SYS_FSL_ERRATUM_A004510
382
383 Enables a workaround for erratum A004510. If set,
384 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
385 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
386
387 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
389
390 Defines one or two SoC revisions (low 8 bits of SVR)
391 for which the A004510 workaround should be applied.
392
393 The rest of SVR is either not relevant to the decision
394 of whether the erratum is present (e.g. p2040 versus
395 p2041) or is implied by the build target, which controls
396 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
397
398 See Freescale App Note 4493 for more information about
399 this erratum.
400
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530401 CONFIG_A003399_NOR_WORKAROUND
402 Enables a workaround for IFC erratum A003399. It is only
403 requred during NOR boot.
404
Scott Wood33eee332012-08-14 10:14:53 +0000405 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
406
407 This is the value to write into CCSR offset 0x18600
408 according to the A004510 workaround.
409
Priyanka Jain64501c62013-07-02 09:21:04 +0530410 CONFIG_SYS_FSL_DSP_DDR_ADDR
411 This value denotes start offset of DDR memory which is
412 connected exclusively to the DSP cores.
413
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530414 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415 This value denotes start offset of M2 memory
416 which is directly connected to the DSP core.
417
Priyanka Jain64501c62013-07-02 09:21:04 +0530418 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
419 This value denotes start offset of M3 memory which is directly
420 connected to the DSP core.
421
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jainb1359912013-12-17 14:25:52 +0530425 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426 Single Source Clock is clocking mode present in some of FSL SoC's.
427 In this mode, a single differential clock is used to supply
428 clocks to the sysclock, ddrclock and usbclock.
429
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530430 CONFIG_SYS_CPC_REINIT_F
431 This CONFIG is defined when the CPC is configured as SRAM at the
432 time of U-boot entry and is required to be re-initialized.
433
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000434- Generic CPU options:
435 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
436
437 Defines the endianess of the CPU. Implementation of those
438 values is arch specific.
439
York Sun5614e712013-09-30 09:22:09 -0700440 CONFIG_SYS_FSL_DDR
441 Freescale DDR driver in use. This type of DDR controller is
442 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
443 SoCs.
444
445 CONFIG_SYS_FSL_DDR_ADDR
446 Freescale DDR memory-mapped register base.
447
448 CONFIG_SYS_FSL_DDR_EMU
449 Specify emulator support for DDR. Some DDR features such as
450 deskew training are not available.
451
452 CONFIG_SYS_FSL_DDRC_GEN1
453 Freescale DDR1 controller.
454
455 CONFIG_SYS_FSL_DDRC_GEN2
456 Freescale DDR2 controller.
457
458 CONFIG_SYS_FSL_DDRC_GEN3
459 Freescale DDR3 controller.
460
York Sun9ac4ffb2013-09-30 14:20:51 -0700461 CONFIG_SYS_FSL_DDRC_ARM_GEN3
462 Freescale DDR3 controller for ARM-based SoCs.
463
York Sun5614e712013-09-30 09:22:09 -0700464 CONFIG_SYS_FSL_DDR1
465 Board config to use DDR1. It can be enabled for SoCs with
466 Freescale DDR1 or DDR2 controllers, depending on the board
467 implemetation.
468
469 CONFIG_SYS_FSL_DDR2
470 Board config to use DDR2. It can be eanbeld for SoCs with
471 Freescale DDR2 or DDR3 controllers, depending on the board
472 implementation.
473
474 CONFIG_SYS_FSL_DDR3
475 Board config to use DDR3. It can be enabled for SoCs with
476 Freescale DDR3 controllers.
477
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530478 CONFIG_SYS_FSL_IFC_BE
479 Defines the IFC controller register space as Big Endian
480
481 CONFIG_SYS_FSL_IFC_LE
482 Defines the IFC controller register space as Little Endian
483
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530484 CONFIG_SYS_FSL_PBL_PBI
485 It enables addition of RCW (Power on reset configuration) in built image.
486 Please refer doc/README.pblimage for more details
487
488 CONFIG_SYS_FSL_PBL_RCW
489 It adds PBI(pre-boot instructions) commands in u-boot build image.
490 PBI commands can be used to configure SoC before it starts the execution.
491 Please refer doc/README.pblimage for more details
492
York Sun4e5b1bd2014-02-10 13:59:42 -0800493 CONFIG_SYS_FSL_DDR_BE
494 Defines the DDR controller register space as Big Endian
495
496 CONFIG_SYS_FSL_DDR_LE
497 Defines the DDR controller register space as Little Endian
498
York Sun6b9e3092014-02-10 13:59:43 -0800499 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
500 Physical address from the view of DDR controllers. It is the
501 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
502 it could be different for ARM SoCs.
503
York Sun6b1e1252014-02-10 13:59:44 -0800504 CONFIG_SYS_FSL_DDR_INTLV_256B
505 DDR controller interleaving on 256-byte. This is a special
506 interleaving mode, handled by Dickens for Freescale layerscape
507 SoCs with ARM core.
508
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100509- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200510 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100511
512 Defines the Monahans run mode to oscillator
513 ratio. Valid values are 8, 16, 24, 31. The core
514 frequency is this value multiplied by 13 MHz.
515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200516 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200517
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100518 Defines the Monahans turbo mode to oscillator
519 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200520 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100521 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200522
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200523- MIPS CPU options:
524 CONFIG_SYS_INIT_SP_OFFSET
525
526 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
527 pointer. This is needed for the temporary stack before
528 relocation.
529
530 CONFIG_SYS_MIPS_CACHE_MODE
531
532 Cache operation mode for the MIPS CPU.
533 See also arch/mips/include/asm/mipsregs.h.
534 Possible values are:
535 CONF_CM_CACHABLE_NO_WA
536 CONF_CM_CACHABLE_WA
537 CONF_CM_UNCACHED
538 CONF_CM_CACHABLE_NONCOHERENT
539 CONF_CM_CACHABLE_CE
540 CONF_CM_CACHABLE_COW
541 CONF_CM_CACHABLE_CUW
542 CONF_CM_CACHABLE_ACCELERATED
543
544 CONFIG_SYS_XWAY_EBU_BOOTCFG
545
546 Special option for Lantiq XWAY SoCs for booting from NOR flash.
547 See also arch/mips/cpu/mips32/start.S.
548
549 CONFIG_XWAY_SWAP_BYTES
550
551 Enable compilation of tools/xway-swap-bytes needed for Lantiq
552 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
553 be swapped if a flash programmer is used.
554
Christian Rieschb67d8812012-02-02 00:44:39 +0000555- ARM options:
556 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
557
558 Select high exception vectors of the ARM core, e.g., do not
559 clear the V bit of the c1 register of CP15.
560
Aneesh V5356f542012-03-08 07:20:19 +0000561 CONFIG_SYS_THUMB_BUILD
562
563 Use this flag to build U-Boot using the Thumb instruction
564 set for ARM architectures. Thumb instruction set provides
565 better code density. For ARM architectures that support
566 Thumb2 this flag will result in Thumb2 code generated by
567 GCC.
568
Stephen Warrenc5d47522013-03-04 13:29:40 +0000569 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000570 CONFIG_ARM_ERRATA_742230
571 CONFIG_ARM_ERRATA_743622
572 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500573 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500574 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000575
576 If set, the workarounds for these ARM errata are applied early
577 during U-Boot startup. Note that these options force the
578 workarounds to be applied; no CPU-type/version detection
579 exists, unlike the similar options in the Linux kernel. Do not
580 set these options unless they apply!
581
Stephen Warren795659d2013-03-27 17:06:41 +0000582- CPU timer options:
583 CONFIG_SYS_HZ
584
585 The frequency of the timer returned by get_timer().
586 get_timer() must operate in milliseconds and this CONFIG
587 option must be set to 1000.
588
wdenk5da627a2003-10-09 20:09:04 +0000589- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000590 CONFIG_CLOCKS_IN_MHZ
591
592 U-Boot stores all clock information in Hz
593 internally. For binary compatibility with older Linux
594 kernels (which expect the clocks passed in the
595 bd_info data to be in MHz) the environment variable
596 "clocks_in_mhz" can be defined so that U-Boot
597 converts clock data to MHZ before passing it to the
598 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000599 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100600 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000601 default environment.
602
wdenk5da627a2003-10-09 20:09:04 +0000603 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
604
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200605 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000606 expect it to be in bytes, others in MB.
607 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
608
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400609 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200610
611 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400612 passed using flattened device trees (based on open firmware
613 concepts).
614
615 CONFIG_OF_LIBFDT
616 * New libfdt-based support
617 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500618 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400619
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200620 OF_CPU - The proper name of the cpus node (only required for
621 MPC512X and MPC5xxx based boards).
622 OF_SOC - The proper name of the soc node (only required for
623 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200624 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600625 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200626
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200627 boards with QUICC Engines require OF_QE to set UCC MAC
628 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500629
Kumar Gala4e253132006-01-11 13:54:17 -0600630 CONFIG_OF_BOARD_SETUP
631
632 Board code has addition modification that it wants to make
633 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000634
Matthew McClintock02677682006-06-28 10:41:37 -0500635 CONFIG_OF_BOOT_CPU
636
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200637 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500638 param header, the default value is zero if undefined.
639
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200640 CONFIG_OF_IDE_FIXUP
641
642 U-Boot can detect if an IDE device is present or not.
643 If not, and this new config option is activated, U-Boot
644 removes the ATA node from the DTS before booting Linux,
645 so the Linux IDE driver does not probe the device and
646 crash. This is needed for buggy hardware (uc101) where
647 no pull down resistor is connected to the signal IDE5V_DD7.
648
Igor Grinberg7eb29392011-07-14 05:45:07 +0000649 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
650
651 This setting is mandatory for all boards that have only one
652 machine type and must be used to specify the machine type
653 number as it appears in the ARM machine registry
654 (see http://www.arm.linux.org.uk/developer/machines/).
655 Only boards that have multiple machine types supported
656 in a single configuration file and the machine type is
657 runtime discoverable, do not have to use this setting.
658
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100659- vxWorks boot parameters:
660
661 bootvx constructs a valid bootline using the following
662 environments variables: bootfile, ipaddr, serverip, hostname.
663 It loads the vxWorks image pointed bootfile.
664
665 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
666 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
667 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
668 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
669
670 CONFIG_SYS_VXWORKS_ADD_PARAMS
671
672 Add it at the end of the bootline. E.g "u=username pw=secret"
673
674 Note: If a "bootargs" environment is defined, it will overwride
675 the defaults discussed just above.
676
Aneesh V2c451f72011-06-16 23:30:47 +0000677- Cache Configuration:
678 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
679 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
680 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
681
Aneesh V93bc2192011-06-16 23:30:51 +0000682- Cache Configuration for ARM:
683 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
684 controller
685 CONFIG_SYS_PL310_BASE - Physical base address of PL310
686 controller register space
687
wdenk6705d812004-08-02 23:22:59 +0000688- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200689 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000690
691 Define this if you want support for Amba PrimeCell PL010 UARTs.
692
Andreas Engel48d01922008-09-08 14:30:53 +0200693 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000694
695 Define this if you want support for Amba PrimeCell PL011 UARTs.
696
697 CONFIG_PL011_CLOCK
698
699 If you have Amba PrimeCell PL011 UARTs, set this variable to
700 the clock speed of the UARTs.
701
702 CONFIG_PL01x_PORTS
703
704 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
705 define this to a list of base addresses for each (supported)
706 port. See e.g. include/configs/versatile.h
707
John Rigby910f1ae2011-04-19 10:42:39 +0000708 CONFIG_PL011_SERIAL_RLCR
709
710 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
711 have separate receive and transmit line control registers. Set
712 this variable to initialize the extra register.
713
714 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
715
716 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
717 boot loader that has already initialized the UART. Define this
718 variable to flush the UART at init time.
719
wdenk6705d812004-08-02 23:22:59 +0000720
wdenkc6097192002-11-03 00:24:07 +0000721- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000722 Depending on board, define exactly one serial port
723 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
724 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
725 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000726
727 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
728 port routines must be defined elsewhere
729 (i.e. serial_init(), serial_getc(), ...)
730
731 CONFIG_CFB_CONSOLE
732 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000733 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000734 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
735 (default big endian)
736 VIDEO_HW_RECTFILL graphic chip supports
737 rectangle fill
738 (cf. smiLynxEM)
739 VIDEO_HW_BITBLT graphic chip supports
740 bit-blit (cf. smiLynxEM)
741 VIDEO_VISIBLE_COLS visible pixel columns
742 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000743 VIDEO_VISIBLE_ROWS visible pixel rows
744 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000745 VIDEO_DATA_FORMAT graphic data format
746 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000747 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000748 VIDEO_KBD_INIT_FCT keyboard int fct
749 (i.e. i8042_kbd_init())
750 VIDEO_TSTC_FCT test char fct
751 (i.e. i8042_tstc)
752 VIDEO_GETC_FCT get char fct
753 (i.e. i8042_getc)
754 CONFIG_CONSOLE_CURSOR cursor drawing on/off
755 (requires blink timer
756 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200757 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000758 CONFIG_CONSOLE_TIME display time/date info in
759 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500760 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000761 CONFIG_VIDEO_LOGO display Linux logo in
762 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000763 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
764 linux_logo.h for logo.
765 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000766 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200767 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000768 the logo
769
Pali Rohár33a35bb2012-10-19 13:30:09 +0000770 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
771 a limited number of ANSI escape sequences (cursor control,
772 erase functions and limited graphics rendition control).
773
wdenk43d96162003-03-06 00:02:04 +0000774 When CONFIG_CFB_CONSOLE is defined, video console is
775 default i/o. Serial console can be forced with
776 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000777
wdenkd4ca31c2004-01-02 14:00:00 +0000778 When CONFIG_SILENT_CONSOLE is defined, all console
779 messages (by U-Boot and Linux!) can be silenced with
780 the "silent" environment variable. See
781 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000782
Heiko Schocher45ae2542013-10-22 11:06:06 +0200783 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
784 is 0x00.
785 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
786 is 0xa0.
787
wdenkc6097192002-11-03 00:24:07 +0000788- Console Baudrate:
789 CONFIG_BAUDRATE - in bps
790 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200791 CONFIG_SYS_BAUDRATE_TABLE, see below.
792 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000793
Heiko Schocherc92fac92009-01-30 12:55:38 +0100794- Console Rx buffer length
795 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
796 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100797 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100798 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
799 must be defined, to setup the maximum idle timeout for
800 the SMC.
801
Graeme Russ9558b482011-09-01 00:48:27 +0000802- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200803 Prior to the console being initialised (i.e. serial UART
804 initialised etc) all console output is silently discarded.
805 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
806 buffer any console messages prior to the console being
807 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
808 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
809 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200810 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200811 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000812
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200813 'Sane' compilers will generate smaller code if
814 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000815
Sonny Rao046a37b2011-11-02 09:52:08 +0000816- Safe printf() functions
817 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
818 the printf() functions. These are defined in
819 include/vsprintf.h and include snprintf(), vsnprintf() and
820 so on. Code size increase is approximately 300-500 bytes.
821 If this option is not given then these functions will
822 silently discard their buffer size argument - this means
823 you are not getting any overflow checking in this case.
824
wdenkc6097192002-11-03 00:24:07 +0000825- Boot Delay: CONFIG_BOOTDELAY - in seconds
826 Delay before automatically booting the default image;
827 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000828 set to -2 to autoboot with no delay and not check for abort
829 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000830
831 See doc/README.autoboot for these options that
832 work with CONFIG_BOOTDELAY. None are required.
833 CONFIG_BOOT_RETRY_TIME
834 CONFIG_BOOT_RETRY_MIN
835 CONFIG_AUTOBOOT_KEYED
836 CONFIG_AUTOBOOT_PROMPT
837 CONFIG_AUTOBOOT_DELAY_STR
838 CONFIG_AUTOBOOT_STOP_STR
839 CONFIG_AUTOBOOT_DELAY_STR2
840 CONFIG_AUTOBOOT_STOP_STR2
841 CONFIG_ZERO_BOOTDELAY_CHECK
842 CONFIG_RESET_TO_RETRY
843
844- Autoboot Command:
845 CONFIG_BOOTCOMMAND
846 Only needed when CONFIG_BOOTDELAY is enabled;
847 define a command string that is automatically executed
848 when no character is read on the console interface
849 within "Boot Delay" after reset.
850
851 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000852 This can be used to pass arguments to the bootm
853 command. The value of CONFIG_BOOTARGS goes into the
854 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000855
856 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000857 The value of these goes into the environment as
858 "ramboot" and "nfsboot" respectively, and can be used
859 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200860 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000861
Heiko Schochereda0ba32013-11-04 14:04:59 +0100862- Bootcount:
863 CONFIG_BOOTCOUNT_LIMIT
864 Implements a mechanism for detecting a repeating reboot
865 cycle, see:
866 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
867
868 CONFIG_BOOTCOUNT_ENV
869 If no softreset save registers are found on the hardware
870 "bootcount" is stored in the environment. To prevent a
871 saveenv on all reboots, the environment variable
872 "upgrade_available" is used. If "upgrade_available" is
873 0, "bootcount" is always 0, if "upgrade_available" is
874 1 "bootcount" is incremented in the environment.
875 So the Userspace Applikation must set the "upgrade_available"
876 and "bootcount" variable to 0, if a boot was successfully.
877
wdenkc6097192002-11-03 00:24:07 +0000878- Pre-Boot Commands:
879 CONFIG_PREBOOT
880
881 When this option is #defined, the existence of the
882 environment variable "preboot" will be checked
883 immediately before starting the CONFIG_BOOTDELAY
884 countdown and/or running the auto-boot command resp.
885 entering interactive mode.
886
887 This feature is especially useful when "preboot" is
888 automatically generated or modified. For an example
889 see the LWMON board specific code: here "preboot" is
890 modified when the user holds down a certain
891 combination of keys on the (special) keyboard when
892 booting the systems
893
894- Serial Download Echo Mode:
895 CONFIG_LOADS_ECHO
896 If defined to 1, all characters received during a
897 serial download (using the "loads" command) are
898 echoed back. This might be needed by some terminal
899 emulations (like "cu"), but may as well just take
900 time on others. This setting #define's the initial
901 value of the "loads_echo" environment variable.
902
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000904 CONFIG_KGDB_BAUDRATE
905 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200906 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000907
908- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500909 Monitor commands can be included or excluded
910 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000911 <config_cmd_all.h> and #undef'ing unwanted
912 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500913 and augmenting with additional #define's
914 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000915
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500916 The default command configuration includes all commands
917 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000918
Marek Vasutb401b732014-03-05 19:58:39 +0100919 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500921 CONFIG_CMD_BDI bdinfo
922 CONFIG_CMD_BEDBUG * Include BedBug Debugger
923 CONFIG_CMD_BMP * BMP support
924 CONFIG_CMD_BSP * Board specific commands
925 CONFIG_CMD_BOOTD bootd
926 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800927 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500928 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500929 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500930 CONFIG_CMD_DATE * support for RTC, date/time...
931 CONFIG_CMD_DHCP * DHCP support
932 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600933 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
934 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
935 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
936 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500937 CONFIG_CMD_DTT * Digital Therm and Thermostat
938 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500939 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500940 CONFIG_CMD_EEPROM * EEPROM read/write support
941 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600942 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600943 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500944 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500945 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000946 CONFIG_CMD_EXT2 * ext2 command support
947 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700948 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
949 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500950 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500951 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000952 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500953 CONFIG_CMD_FLASH flinfo, erase, protect
954 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200955 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000956 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500957 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000958 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000959 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500960 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
961 CONFIG_CMD_I2C * I2C serial bus support
962 CONFIG_CMD_IDE * IDE harddisk support
963 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000964 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200965 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500966 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500967 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000968 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500969 CONFIG_CMD_IRQ * irqinfo
970 CONFIG_CMD_ITEST Integer/string test of 2 values
971 CONFIG_CMD_JFFS2 * JFFS2 Support
972 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200973 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000974 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
975 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500976 CONFIG_CMD_LOADB loadb
977 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200978 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400979 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000980 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500981 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000982 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200983 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500984 CONFIG_CMD_MISC Misc functions like sleep etc
985 CONFIG_CMD_MMC * MMC memory mapped support
986 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100987 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500988 CONFIG_CMD_NAND * NAND support
989 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200990 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600991 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000992 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_PCI * pciinfo
994 CONFIG_CMD_PCMCIA * PCMCIA support
995 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
996 host
997 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000998 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500999 CONFIG_CMD_REGINFO * Register dump
1000 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001001 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_SAVES * save S record dump
1003 CONFIG_CMD_SCSI * SCSI Support
1004 CONFIG_CMD_SDRAM * print SDRAM configuration information
1005 (requires CONFIG_CMD_I2C)
1006 CONFIG_CMD_SETGETDCR Support for DCR Register access
1007 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001008 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001009 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001010 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001011 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001012 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001014 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001015 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001016 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1017 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001018 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001020 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001021 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001022 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001023
1024 EXAMPLE: If you want all functions except of network
1025 support you can write:
1026
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001027 #include "config_cmd_all.h"
1028 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001029
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001030 Other Commands:
1031 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001032
1033 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001034 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001035 what you (and your U-Boot users) are doing. Data
1036 cache cannot be enabled on systems like the 8xx or
1037 8260 (where accesses to the IMMR region must be
1038 uncached), and it cannot be disabled on all other
1039 systems where we (mis-) use the data cache to hold an
1040 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001041
1042
1043 XXX - this list needs to get updated!
1044
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001045- Regular expression support:
1046 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001047 If this variable is defined, U-Boot is linked against
1048 the SLRE (Super Light Regular Expression) library,
1049 which adds regex support to some commands, as for
1050 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001051
Simon Glass45ba8072011-10-15 05:48:20 +00001052- Device tree:
1053 CONFIG_OF_CONTROL
1054 If this variable is defined, U-Boot will use a device tree
1055 to configure its devices, instead of relying on statically
1056 compiled #defines in the board file. This option is
1057 experimental and only available on a few boards. The device
1058 tree is available in the global data as gd->fdt_blob.
1059
Simon Glass2c0f79e2011-10-24 19:15:31 +00001060 U-Boot needs to get its device tree from somewhere. This can
1061 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001062
1063 CONFIG_OF_EMBED
1064 If this variable is defined, U-Boot will embed a device tree
1065 binary in its image. This device tree file should be in the
1066 board directory and called <soc>-<board>.dts. The binary file
1067 is then picked up in board_init_f() and made available through
1068 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001069
Simon Glass2c0f79e2011-10-24 19:15:31 +00001070 CONFIG_OF_SEPARATE
1071 If this variable is defined, U-Boot will build a device tree
1072 binary. It will be called u-boot.dtb. Architecture-specific
1073 code will locate it at run-time. Generally this works by:
1074
1075 cat u-boot.bin u-boot.dtb >image.bin
1076
1077 and in fact, U-Boot does this for you, creating a file called
1078 u-boot-dtb.bin which is useful in the common case. You can
1079 still use the individual files if you need something more
1080 exotic.
1081
wdenkc6097192002-11-03 00:24:07 +00001082- Watchdog:
1083 CONFIG_WATCHDOG
1084 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001085 support for the SoC. There must be support in the SoC
1086 specific code for a watchdog. For the 8xx and 8260
1087 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1088 register. When supported for a specific SoC is
1089 available, then no further board specific code should
1090 be needed to use it.
1091
1092 CONFIG_HW_WATCHDOG
1093 When using a watchdog circuitry external to the used
1094 SoC, then define this variable and provide board
1095 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001096
stroesec1551ea2003-04-04 15:53:41 +00001097- U-Boot Version:
1098 CONFIG_VERSION_VARIABLE
1099 If this variable is defined, an environment variable
1100 named "ver" is created by U-Boot showing the U-Boot
1101 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001102 Any change to this variable will be reverted at the
1103 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001104
wdenkc6097192002-11-03 00:24:07 +00001105- Real-Time Clock:
1106
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001107 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001108 has to be selected, too. Define exactly one of the
1109 following options:
1110
1111 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1112 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001113 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001114 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001115 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001116 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001117 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001118 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001119 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001120 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001121 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001122 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1123 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001124
wdenkb37c7e52003-06-30 16:24:52 +00001125 Note that if the RTC uses I2C, then the I2C interface
1126 must also be configured. See I2C Support, below.
1127
Peter Tysere92739d2008-12-17 16:36:21 -06001128- GPIO Support:
1129 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001130
Chris Packham5dec49c2010-12-19 10:12:13 +00001131 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1132 chip-ngpio pairs that tell the PCA953X driver the number of
1133 pins supported by a particular chip.
1134
Peter Tysere92739d2008-12-17 16:36:21 -06001135 Note that if the GPIO device uses I2C, then the I2C interface
1136 must also be configured. See I2C Support, below.
1137
wdenkc6097192002-11-03 00:24:07 +00001138- Timestamp Support:
1139
wdenk43d96162003-03-06 00:02:04 +00001140 When CONFIG_TIMESTAMP is selected, the timestamp
1141 (date and time) of an image is printed by image
1142 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001143 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001144
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001145- Partition Labels (disklabels) Supported:
1146 Zero or more of the following:
1147 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1148 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1149 Intel architecture, USB sticks, etc.
1150 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1151 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1152 bootloader. Note 2TB partition limit; see
1153 disk/part_efi.c
1154 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001155
Wolfgang Denk218ca722008-03-26 10:40:12 +01001156 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1157 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001158 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001159
1160- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001161 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1162 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001163
wdenk4d13cba2004-03-14 14:09:05 +00001164 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1165 be performed by calling the function
1166 ide_set_reset(int reset)
1167 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001168
1169- ATAPI Support:
1170 CONFIG_ATAPI
1171
1172 Set this to enable ATAPI support.
1173
wdenkc40b2952004-03-13 23:29:43 +00001174- LBA48 Support
1175 CONFIG_LBA48
1176
1177 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001178 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001179 Whithout these , LBA48 support uses 32bit variables and will 'only'
1180 support disks up to 2.1TB.
1181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001182 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001183 When enabled, makes the IDE subsystem use 64bit sector addresses.
1184 Default is 32bit.
1185
wdenkc6097192002-11-03 00:24:07 +00001186- SCSI Support:
1187 At the moment only there is only support for the
1188 SYM53C8XX SCSI controller; define
1189 CONFIG_SCSI_SYM53C8XX to enable it.
1190
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001191 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1192 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1193 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001194 maximum numbers of LUNs, SCSI ID's and target
1195 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001196 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001197
Wolfgang Denk93e14592013-10-04 17:43:24 +02001198 The environment variable 'scsidevs' is set to the number of
1199 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001200
wdenkc6097192002-11-03 00:24:07 +00001201- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001202 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001203 Support for Intel 8254x/8257x gigabit chips.
1204
1205 CONFIG_E1000_SPI
1206 Utility code for direct access to the SPI bus on Intel 8257x.
1207 This does not do anything useful unless you set at least one
1208 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1209
1210 CONFIG_E1000_SPI_GENERIC
1211 Allow generic access to the SPI bus on the Intel 8257x, for
1212 example with the "sspi" command.
1213
1214 CONFIG_CMD_E1000
1215 Management command for E1000 devices. When used on devices
1216 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001217
Andre Schwarzac3315c2008-03-06 16:45:44 +01001218 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001219 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001220
wdenkc6097192002-11-03 00:24:07 +00001221 CONFIG_EEPRO100
1222 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001223 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001224 write routine for first time initialisation.
1225
1226 CONFIG_TULIP
1227 Support for Digital 2114x chips.
1228 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1229 modem chip initialisation (KS8761/QS6611).
1230
1231 CONFIG_NATSEMI
1232 Support for National dp83815 chips.
1233
1234 CONFIG_NS8382X
1235 Support for National dp8382[01] gigabit chips.
1236
wdenk45219c42003-05-12 21:50:16 +00001237- NETWORK Support (other):
1238
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001239 CONFIG_DRIVER_AT91EMAC
1240 Support for AT91RM9200 EMAC.
1241
1242 CONFIG_RMII
1243 Define this to use reduced MII inteface
1244
1245 CONFIG_DRIVER_AT91EMAC_QUIET
1246 If this defined, the driver is quiet.
1247 The driver doen't show link status messages.
1248
Rob Herringefdd7312011-12-15 11:15:49 +00001249 CONFIG_CALXEDA_XGMAC
1250 Support for the Calxeda XGMAC device
1251
Ashok3bb46d22012-10-15 06:20:47 +00001252 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001253 Support for SMSC's LAN91C96 chips.
1254
1255 CONFIG_LAN91C96_BASE
1256 Define this to hold the physical address
1257 of the LAN91C96's I/O space
1258
1259 CONFIG_LAN91C96_USE_32_BIT
1260 Define this to enable 32 bit addressing
1261
Ashok3bb46d22012-10-15 06:20:47 +00001262 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001263 Support for SMSC's LAN91C111 chip
1264
1265 CONFIG_SMC91111_BASE
1266 Define this to hold the physical address
1267 of the device (I/O space)
1268
1269 CONFIG_SMC_USE_32_BIT
1270 Define this if data bus is 32 bits
1271
1272 CONFIG_SMC_USE_IOFUNCS
1273 Define this to use i/o functions instead of macros
1274 (some hardware wont work with macros)
1275
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001276 CONFIG_DRIVER_TI_EMAC
1277 Support for davinci emac
1278
1279 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1280 Define this if you have more then 3 PHYs.
1281
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001282 CONFIG_FTGMAC100
1283 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1284
1285 CONFIG_FTGMAC100_EGIGA
1286 Define this to use GE link update with gigabit PHY.
1287 Define this if FTGMAC100 is connected to gigabit PHY.
1288 If your system has 10/100 PHY only, it might not occur
1289 wrong behavior. Because PHY usually return timeout or
1290 useless data when polling gigabit status and gigabit
1291 control registers. This behavior won't affect the
1292 correctnessof 10/100 link speed update.
1293
Mike Rapoportc2fff332009-11-11 10:03:03 +02001294 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001295 Support for SMSC's LAN911x and LAN921x chips
1296
Mike Rapoportc2fff332009-11-11 10:03:03 +02001297 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001298 Define this to hold the physical address
1299 of the device (I/O space)
1300
Mike Rapoportc2fff332009-11-11 10:03:03 +02001301 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001302 Define this if data bus is 32 bits
1303
Mike Rapoportc2fff332009-11-11 10:03:03 +02001304 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001305 Define this if data bus is 16 bits. If your processor
1306 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001307 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001308
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001309 CONFIG_SH_ETHER
1310 Support for Renesas on-chip Ethernet controller
1311
1312 CONFIG_SH_ETHER_USE_PORT
1313 Define the number of ports to be used
1314
1315 CONFIG_SH_ETHER_PHY_ADDR
1316 Define the ETH PHY's address
1317
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001318 CONFIG_SH_ETHER_CACHE_WRITEBACK
1319 If this option is set, the driver enables cache flush.
1320
Vadim Bendebury5e124722011-10-17 08:36:14 +00001321- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001322 CONFIG_TPM
1323 Support TPM devices.
1324
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001325 CONFIG_TPM_TIS_I2C
1326 Support for i2c bus TPM devices. Only one device
1327 per system is supported at this time.
1328
1329 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1330 Define the the i2c bus number for the TPM device
1331
1332 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1333 Define the TPM's address on the i2c bus
1334
1335 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1336 Define the burst count bytes upper limit
1337
Dirk Eibachc01939c2013-06-26 15:55:15 +02001338 CONFIG_TPM_ATMEL_TWI
1339 Support for Atmel TWI TPM device. Requires I2C support.
1340
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001341 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001342 Support for generic parallel port TPM devices. Only one device
1343 per system is supported at this time.
1344
1345 CONFIG_TPM_TIS_BASE_ADDRESS
1346 Base address where the generic TPM device is mapped
1347 to. Contemporary x86 systems usually map it at
1348 0xfed40000.
1349
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001350 CONFIG_CMD_TPM
1351 Add tpm monitor functions.
1352 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1353 provides monitor access to authorized functions.
1354
1355 CONFIG_TPM
1356 Define this to enable the TPM support library which provides
1357 functional interfaces to some TPM commands.
1358 Requires support for a TPM device.
1359
1360 CONFIG_TPM_AUTH_SESSIONS
1361 Define this to enable authorized functions in the TPM library.
1362 Requires CONFIG_TPM and CONFIG_SHA1.
1363
wdenkc6097192002-11-03 00:24:07 +00001364- USB Support:
1365 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001366 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001367 CONFIG_USB_UHCI to enable it.
1368 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001369 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001370 storage devices.
1371 Note:
1372 Supported are USB Keyboards and USB Floppy drives
1373 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001374 MPC5200 USB requires additional defines:
1375 CONFIG_USB_CLOCK
1376 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001377 CONFIG_PSC3_USB
1378 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001379 CONFIG_USB_CONFIG
1380 for differential drivers: 0x00001000
1381 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001382 for differential drivers on PSC3: 0x00000100
1383 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001384 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001385 May be defined to allow interrupt polling
1386 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001387
Simon Glass9ab4ce22012-02-27 10:52:47 +00001388 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1389 txfilltuning field in the EHCI controller on reset.
1390
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001391 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1392 interval for usb hub power-on delay.(minimum 100msec)
1393
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001394- USB Device:
1395 Define the below if you wish to use the USB console.
1396 Once firmware is rebuilt from a serial console issue the
1397 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001398 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001399 it has found a new device. The environment variable usbtty
1400 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001401 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001402 Common Device Class Abstract Control Model serial device.
1403 If you select usbtty = gserial you should be able to enumerate
1404 a Linux host by
1405 # modprobe usbserial vendor=0xVendorID product=0xProductID
1406 else if using cdc_acm, simply setting the environment
1407 variable usbtty to be cdc_acm should suffice. The following
1408 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001409
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001410 CONFIG_USB_DEVICE
1411 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001412
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001413 CONFIG_USB_TTY
1414 Define this to have a tty type of device available to
1415 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001416
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301417 CONFIG_USBD_HS
1418 Define this to enable the high speed support for usb
1419 device and usbtty. If this feature is enabled, a routine
1420 int is_usbd_high_speed(void)
1421 also needs to be defined by the driver to dynamically poll
1422 whether the enumeration has succeded at high speed or full
1423 speed.
1424
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001425 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001426 Define this if you want stdin, stdout &/or stderr to
1427 be set to usbtty.
1428
1429 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001430 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001431 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001432 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001434 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001435 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001436 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001437
Wolfgang Denk386eda02006-06-14 18:14:56 +02001438 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001439 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001440 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001441 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1442 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1443 should pretend to be a Linux device to it's target host.
1444
1445 CONFIG_USBD_MANUFACTURER
1446 Define this string as the name of your company for
1447 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001448
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001449 CONFIG_USBD_PRODUCT_NAME
1450 Define this string as the name of your product
1451 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1452
1453 CONFIG_USBD_VENDORID
1454 Define this as your assigned Vendor ID from the USB
1455 Implementors Forum. This *must* be a genuine Vendor ID
1456 to avoid polluting the USB namespace.
1457 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001458
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001459 CONFIG_USBD_PRODUCTID
1460 Define this as the unique Product ID
1461 for your device
1462 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001463
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001464 Some USB device drivers may need to check USB cable attachment.
1465 In this case you can enable following config in BoardName.h:
1466 CONFIG_USB_CABLE_CHECK
1467 This enables function definition:
1468 - usb_cable_connected() in include/usb.h
1469 Implementation of this function is board-specific.
1470
Igor Grinbergd70a5602011-12-12 12:08:35 +02001471- ULPI Layer Support:
1472 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1473 the generic ULPI layer. The generic layer accesses the ULPI PHY
1474 via the platform viewport, so you need both the genric layer and
1475 the viewport enabled. Currently only Chipidea/ARC based
1476 viewport is supported.
1477 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1478 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001479 If your ULPI phy needs a different reference clock than the
1480 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1481 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001482
1483- MMC Support:
1484 The MMC controller on the Intel PXA is supported. To
1485 enable this define CONFIG_MMC. The MMC can be
1486 accessed from the boot prompt by mapping the device
1487 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001488 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1489 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001490
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001491 CONFIG_SH_MMCIF
1492 Support for Renesas on-chip MMCIF controller
1493
1494 CONFIG_SH_MMCIF_ADDR
1495 Define the base address of MMCIF registers
1496
1497 CONFIG_SH_MMCIF_CLK
1498 Define the clock frequency for MMCIF
1499
Tom Rinib3ba6e92013-03-14 05:32:47 +00001500- USB Device Firmware Update (DFU) class support:
1501 CONFIG_DFU_FUNCTION
1502 This enables the USB portion of the DFU USB class
1503
1504 CONFIG_CMD_DFU
1505 This enables the command "dfu" which is used to have
1506 U-Boot create a DFU class device via USB. This command
1507 requires that the "dfu_alt_info" environment variable be
1508 set and define the alt settings to expose to the host.
1509
1510 CONFIG_DFU_MMC
1511 This enables support for exposing (e)MMC devices via DFU.
1512
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001513 CONFIG_DFU_NAND
1514 This enables support for exposing NAND devices via DFU.
1515
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301516 CONFIG_DFU_RAM
1517 This enables support for exposing RAM via DFU.
1518 Note: DFU spec refer to non-volatile memory usage, but
1519 allow usages beyond the scope of spec - here RAM usage,
1520 one that would help mostly the developer.
1521
Heiko Schochere7e75c72013-06-12 06:05:51 +02001522 CONFIG_SYS_DFU_DATA_BUF_SIZE
1523 Dfu transfer uses a buffer before writing data to the
1524 raw storage device. Make the size (in bytes) of this buffer
1525 configurable. The size of this buffer is also configurable
1526 through the "dfu_bufsiz" environment variable.
1527
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001528 CONFIG_SYS_DFU_MAX_FILE_SIZE
1529 When updating files rather than the raw storage device,
1530 we use a static buffer to copy the file into and then write
1531 the buffer once we've been given the whole file. Define
1532 this to the maximum filesize (in bytes) for the buffer.
1533 Default is 4 MiB if undefined.
1534
Heiko Schocher001a8312014-03-18 08:09:56 +01001535 DFU_DEFAULT_POLL_TIMEOUT
1536 Poll timeout [ms], is the timeout a device can send to the
1537 host. The host must wait for this timeout before sending
1538 a subsequent DFU_GET_STATUS request to the device.
1539
1540 DFU_MANIFEST_POLL_TIMEOUT
1541 Poll timeout [ms], which the device sends to the host when
1542 entering dfuMANIFEST state. Host waits this timeout, before
1543 sending again an USB request to the device.
1544
wdenk6705d812004-08-02 23:22:59 +00001545- Journaling Flash filesystem support:
1546 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1547 CONFIG_JFFS2_NAND_DEV
1548 Define these for a default partition on a NAND device
1549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001550 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1551 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001552 Define these for a default partition on a NOR device
1553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001554 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001555 Define this to create an own partition. You have to provide a
1556 function struct part_info* jffs2_part_info(int part_num)
1557
1558 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001559 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001560 to disable the command chpart. This is the default when you
1561 have not defined a custom partition
1562
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001563- FAT(File Allocation Table) filesystem write function support:
1564 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001565
1566 Define this to enable support for saving memory data as a
1567 file in FAT formatted partition.
1568
1569 This will also enable the command "fatwrite" enabling the
1570 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001571
Gabe Black84cd9322012-10-12 14:26:11 +00001572CBFS (Coreboot Filesystem) support
1573 CONFIG_CMD_CBFS
1574
1575 Define this to enable support for reading from a Coreboot
1576 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1577 and cbfsload.
1578
wdenkc6097192002-11-03 00:24:07 +00001579- Keyboard Support:
1580 CONFIG_ISA_KEYBOARD
1581
1582 Define this to enable standard (PC-Style) keyboard
1583 support
1584
1585 CONFIG_I8042_KBD
1586 Standard PC keyboard driver with US (is default) and
1587 GERMAN key layout (switch via environment 'keymap=de') support.
1588 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1589 for cfb_console. Supports cursor blinking.
1590
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001591 CONFIG_CROS_EC_KEYB
1592 Enables a Chrome OS keyboard using the CROS_EC interface.
1593 This uses CROS_EC to communicate with a second microcontroller
1594 which provides key scans on request.
1595
wdenkc6097192002-11-03 00:24:07 +00001596- Video support:
1597 CONFIG_VIDEO
1598
1599 Define this to enable video support (for output to
1600 video).
1601
1602 CONFIG_VIDEO_CT69000
1603
1604 Enable Chips & Technologies 69000 Video chip
1605
1606 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001607 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001608 video output is selected via environment 'videoout'
1609 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1610 assumed.
wdenkc6097192002-11-03 00:24:07 +00001611
wdenkb79a11c2004-03-25 15:14:43 +00001612 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001613 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001614 are possible:
1615 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001616 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001617
1618 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1619 -------------+---------------------------------------------
1620 8 bits | 0x301* 0x303 0x305 0x161 0x307
1621 15 bits | 0x310 0x313 0x316 0x162 0x319
1622 16 bits | 0x311 0x314 0x317 0x163 0x31A
1623 24 bits | 0x312 0x315 0x318 ? 0x31B
1624 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001625 (i.e. setenv videomode 317; saveenv; reset;)
1626
wdenkb79a11c2004-03-25 15:14:43 +00001627 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001628 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001629
1630
stroesec1551ea2003-04-04 15:53:41 +00001631 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001632 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001633 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1634 or CONFIG_VIDEO_SED13806_16BPP
1635
Timur Tabi7d3053f2011-02-15 17:09:19 -06001636 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001637 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001638 SOCs that have a DIU should define this macro to enable DIU
1639 support, and should also define these other macros:
1640
1641 CONFIG_SYS_DIU_ADDR
1642 CONFIG_VIDEO
1643 CONFIG_CMD_BMP
1644 CONFIG_CFB_CONSOLE
1645 CONFIG_VIDEO_SW_CURSOR
1646 CONFIG_VGA_AS_SINGLE_DEVICE
1647 CONFIG_VIDEO_LOGO
1648 CONFIG_VIDEO_BMP_LOGO
1649
Timur Tabiba8e76b2011-04-11 14:18:22 -05001650 The DIU driver will look for the 'video-mode' environment
1651 variable, and if defined, enable the DIU as a console during
1652 boot. See the documentation file README.video for a
1653 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001654
Simon Glass058d59b2012-12-03 13:59:47 +00001655 CONFIG_VIDEO_VGA
1656
1657 Enable the VGA video / BIOS for x86. The alternative if you
1658 are using coreboot is to use the coreboot frame buffer
1659 driver.
1660
1661
wdenk682011f2003-06-03 23:54:09 +00001662- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001663 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001664
wdenk8bde7f72003-06-27 21:31:46 +00001665 Define this to enable a custom keyboard support.
1666 This simply calls drv_keyboard_init() which must be
1667 defined in your board-specific files.
1668 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001669
wdenkc6097192002-11-03 00:24:07 +00001670- LCD Support: CONFIG_LCD
1671
1672 Define this to enable LCD support (for output to LCD
1673 display); also select one of the supported displays
1674 by defining one of these:
1675
Stelian Pop39cf4802008-05-09 21:57:18 +02001676 CONFIG_ATMEL_LCD:
1677
1678 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1679
wdenkfd3103b2003-11-25 16:55:19 +00001680 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001681
wdenkfd3103b2003-11-25 16:55:19 +00001682 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001683
wdenkfd3103b2003-11-25 16:55:19 +00001684 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001685
wdenkfd3103b2003-11-25 16:55:19 +00001686 NEC NL6448BC20-08. 6.5", 640x480.
1687 Active, color, single scan.
1688
1689 CONFIG_NEC_NL6448BC33_54
1690
1691 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001692 Active, color, single scan.
1693
1694 CONFIG_SHARP_16x9
1695
1696 Sharp 320x240. Active, color, single scan.
1697 It isn't 16x9, and I am not sure what it is.
1698
1699 CONFIG_SHARP_LQ64D341
1700
1701 Sharp LQ64D341 display, 640x480.
1702 Active, color, single scan.
1703
1704 CONFIG_HLD1045
1705
1706 HLD1045 display, 640x480.
1707 Active, color, single scan.
1708
1709 CONFIG_OPTREX_BW
1710
1711 Optrex CBL50840-2 NF-FW 99 22 M5
1712 or
1713 Hitachi LMG6912RPFC-00T
1714 or
1715 Hitachi SP14Q002
1716
1717 320x240. Black & white.
1718
1719 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001720 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001721
Simon Glass676d3192012-10-17 13:24:54 +00001722 CONFIG_LCD_ALIGNMENT
1723
1724 Normally the LCD is page-aligned (tyically 4KB). If this is
1725 defined then the LCD will be aligned to this value instead.
1726 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1727 here, since it is cheaper to change data cache settings on
1728 a per-section basis.
1729
Simon Glass0d89efe2012-10-17 13:24:59 +00001730 CONFIG_CONSOLE_SCROLL_LINES
1731
1732 When the console need to be scrolled, this is the number of
1733 lines to scroll by. It defaults to 1. Increasing this makes
1734 the console jump but can help speed up operation when scrolling
1735 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001736
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001737 CONFIG_LCD_BMP_RLE8
1738
1739 Support drawing of RLE8-compressed bitmaps on the LCD.
1740
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001741 CONFIG_I2C_EDID
1742
1743 Enables an 'i2c edid' command which can read EDID
1744 information over I2C from an attached LCD display.
1745
wdenk7152b1d2003-09-05 23:19:14 +00001746- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001747
wdenk8bde7f72003-06-27 21:31:46 +00001748 If this option is set, the environment is checked for
1749 a variable "splashimage". If found, the usual display
1750 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001751 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001752 specified in "splashimage" is loaded instead. The
1753 console is redirected to the "nulldev", too. This
1754 allows for a "silent" boot where a splash screen is
1755 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001756
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001757 CONFIG_SPLASHIMAGE_GUARD
1758
1759 If this option is set, then U-Boot will prevent the environment
1760 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001761 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001762 This option is useful for targets where, due to alignment
1763 restrictions, an improperly aligned BMP image will cause a data
1764 abort. If you think you will not have problems with unaligned
1765 accesses (for example because your toolchain prevents them)
1766 there is no need to set this option.
1767
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001768 CONFIG_SPLASH_SCREEN_ALIGN
1769
1770 If this option is set the splash image can be freely positioned
1771 on the screen. Environment variable "splashpos" specifies the
1772 position as "x,y". If a positive number is given it is used as
1773 number of pixel from left/top. If a negative number is given it
1774 is used as number of pixel from right/bottom. You can also
1775 specify 'm' for centering the image.
1776
1777 Example:
1778 setenv splashpos m,m
1779 => image at center of screen
1780
1781 setenv splashpos 30,20
1782 => image at x = 30 and y = 20
1783
1784 setenv splashpos -10,m
1785 => vertically centered image
1786 at x = dspWidth - bmpWidth - 9
1787
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001788- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1789
1790 If this option is set, additionally to standard BMP
1791 images, gzipped BMP images can be displayed via the
1792 splashscreen support or the bmp command.
1793
Anatolij Gustschind5011762010-03-15 14:50:25 +01001794- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1795
1796 If this option is set, 8-bit RLE compressed BMP images
1797 can be displayed via the splashscreen support or the
1798 bmp command.
1799
Lei Wenf2b96df2012-09-28 04:26:47 +00001800- Do compresssing for memory range:
1801 CONFIG_CMD_ZIP
1802
1803 If this option is set, it would use zlib deflate method
1804 to compress the specified memory at its best effort.
1805
wdenkc29fdfc2003-08-29 20:57:53 +00001806- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001807 CONFIG_GZIP
1808
1809 Enabled by default to support gzip compressed images.
1810
wdenkc29fdfc2003-08-29 20:57:53 +00001811 CONFIG_BZIP2
1812
1813 If this option is set, support for bzip2 compressed
1814 images is included. If not, only uncompressed and gzip
1815 compressed images are supported.
1816
wdenk42d1f032003-10-15 23:53:47 +00001817 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001818 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001819 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001820
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001821 CONFIG_LZMA
1822
1823 If this option is set, support for lzma compressed
1824 images is included.
1825
1826 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1827 requires an amount of dynamic memory that is given by the
1828 formula:
1829
1830 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1831
1832 Where lc and lp stand for, respectively, Literal context bits
1833 and Literal pos bits.
1834
1835 This value is upper-bounded by 14MB in the worst case. Anyway,
1836 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1837 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1838 a very small buffer.
1839
1840 Use the lzmainfo tool to determinate the lc and lp values and
1841 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001842 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001843
Kees Cook8ef70472013-08-16 07:59:12 -07001844 CONFIG_LZO
1845
1846 If this option is set, support for LZO compressed images
1847 is included.
1848
wdenk17ea1172004-06-06 21:51:03 +00001849- MII/PHY support:
1850 CONFIG_PHY_ADDR
1851
1852 The address of PHY on MII bus.
1853
1854 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1855
1856 The clock frequency of the MII bus
1857
1858 CONFIG_PHY_GIGE
1859
1860 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001861 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001862
1863 CONFIG_PHY_RESET_DELAY
1864
1865 Some PHY like Intel LXT971A need extra delay after
1866 reset before any MII register access is possible.
1867 For such PHY, set this option to the usec delay
1868 required. (minimum 300usec for LXT971A)
1869
1870 CONFIG_PHY_CMD_DELAY (ppc4xx)
1871
1872 Some PHY like Intel LXT971A need extra delay after
1873 command issued before MII status register can be read
1874
wdenkc6097192002-11-03 00:24:07 +00001875- Ethernet address:
1876 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001877 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001878 CONFIG_ETH2ADDR
1879 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001880 CONFIG_ETH4ADDR
1881 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001882
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001883 Define a default value for Ethernet address to use
1884 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001885 is not determined automatically.
1886
1887- IP address:
1888 CONFIG_IPADDR
1889
1890 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001891 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001892 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001893 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001894
1895- Server IP address:
1896 CONFIG_SERVERIP
1897
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001898 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001899 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001900 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001901
Robin Getz97cfe862009-07-21 12:15:28 -04001902 CONFIG_KEEP_SERVERADDR
1903
1904 Keeps the server's MAC address, in the env 'serveraddr'
1905 for passing to bootargs (like Linux's netconsole option)
1906
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001907- Gateway IP address:
1908 CONFIG_GATEWAYIP
1909
1910 Defines a default value for the IP address of the
1911 default router where packets to other networks are
1912 sent to.
1913 (Environment variable "gatewayip")
1914
1915- Subnet mask:
1916 CONFIG_NETMASK
1917
1918 Defines a default value for the subnet mask (or
1919 routing prefix) which is used to determine if an IP
1920 address belongs to the local subnet or needs to be
1921 forwarded through a router.
1922 (Environment variable "netmask")
1923
David Updegraff53a5c422007-06-11 10:41:07 -05001924- Multicast TFTP Mode:
1925 CONFIG_MCAST_TFTP
1926
1927 Defines whether you want to support multicast TFTP as per
1928 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001929 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001930 driver in use must provide a function: mcast() to join/leave a
1931 multicast group.
1932
wdenkc6097192002-11-03 00:24:07 +00001933- BOOTP Recovery Mode:
1934 CONFIG_BOOTP_RANDOM_DELAY
1935
1936 If you have many targets in a network that try to
1937 boot using BOOTP, you may want to avoid that all
1938 systems send out BOOTP requests at precisely the same
1939 moment (which would happen for instance at recovery
1940 from a power failure, when all systems will try to
1941 boot, thus flooding the BOOTP server. Defining
1942 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1943 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001944 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001945
1946 1st BOOTP request: delay 0 ... 1 sec
1947 2nd BOOTP request: delay 0 ... 2 sec
1948 3rd BOOTP request: delay 0 ... 4 sec
1949 4th and following
1950 BOOTP requests: delay 0 ... 8 sec
1951
stroesefe389a82003-08-28 14:17:32 +00001952- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001953 You can fine tune the DHCP functionality by defining
1954 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001955
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001956 CONFIG_BOOTP_SUBNETMASK
1957 CONFIG_BOOTP_GATEWAY
1958 CONFIG_BOOTP_HOSTNAME
1959 CONFIG_BOOTP_NISDOMAIN
1960 CONFIG_BOOTP_BOOTPATH
1961 CONFIG_BOOTP_BOOTFILESIZE
1962 CONFIG_BOOTP_DNS
1963 CONFIG_BOOTP_DNS2
1964 CONFIG_BOOTP_SEND_HOSTNAME
1965 CONFIG_BOOTP_NTPSERVER
1966 CONFIG_BOOTP_TIMEOFFSET
1967 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001968 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001969
Wilson Callan5d110f02007-07-28 10:56:13 -04001970 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1971 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001972
Joe Hershberger2c00e092012-05-23 07:59:19 +00001973 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1974 after the configured retry count, the call will fail
1975 instead of starting over. This can be used to fail over
1976 to Link-local IP address configuration if the DHCP server
1977 is not available.
1978
stroesefe389a82003-08-28 14:17:32 +00001979 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1980 serverip from a DHCP server, it is possible that more
1981 than one DNS serverip is offered to the client.
1982 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1983 serverip will be stored in the additional environment
1984 variable "dnsip2". The first DNS serverip is always
1985 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001986 is defined.
stroesefe389a82003-08-28 14:17:32 +00001987
1988 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1989 to do a dynamic update of a DNS server. To do this, they
1990 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001991 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001992 of the "hostname" environment variable is passed as
1993 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001994
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001995 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1996
1997 A 32bit value in microseconds for a delay between
1998 receiving a "DHCP Offer" and sending the "DHCP Request".
1999 This fixes a problem with certain DHCP servers that don't
2000 respond 100% of the time to a "DHCP request". E.g. On an
2001 AT91RM9200 processor running at 180MHz, this delay needed
2002 to be *at least* 15,000 usec before a Windows Server 2003
2003 DHCP server would reply 100% of the time. I recommend at
2004 least 50,000 usec to be safe. The alternative is to hope
2005 that one of the retries will be successful but note that
2006 the DHCP timeout and retry process takes a longer than
2007 this delay.
2008
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002009 - Link-local IP address negotiation:
2010 Negotiate with other link-local clients on the local network
2011 for an address that doesn't require explicit configuration.
2012 This is especially useful if a DHCP server cannot be guaranteed
2013 to exist in all environments that the device must operate.
2014
2015 See doc/README.link-local for more information.
2016
wdenka3d991b2004-04-15 21:48:45 +00002017 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002018 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002019
2020 The device id used in CDP trigger frames.
2021
2022 CONFIG_CDP_DEVICE_ID_PREFIX
2023
2024 A two character string which is prefixed to the MAC address
2025 of the device.
2026
2027 CONFIG_CDP_PORT_ID
2028
2029 A printf format string which contains the ascii name of
2030 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002031 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002032
2033 CONFIG_CDP_CAPABILITIES
2034
2035 A 32bit integer which indicates the device capabilities;
2036 0x00000010 for a normal host which does not forwards.
2037
2038 CONFIG_CDP_VERSION
2039
2040 An ascii string containing the version of the software.
2041
2042 CONFIG_CDP_PLATFORM
2043
2044 An ascii string containing the name of the platform.
2045
2046 CONFIG_CDP_TRIGGER
2047
2048 A 32bit integer sent on the trigger.
2049
2050 CONFIG_CDP_POWER_CONSUMPTION
2051
2052 A 16bit integer containing the power consumption of the
2053 device in .1 of milliwatts.
2054
2055 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2056
2057 A byte containing the id of the VLAN.
2058
wdenkc6097192002-11-03 00:24:07 +00002059- Status LED: CONFIG_STATUS_LED
2060
2061 Several configurations allow to display the current
2062 status using a LED. For instance, the LED will blink
2063 fast while running U-Boot code, stop blinking as
2064 soon as a reply to a BOOTP request was received, and
2065 start blinking slow once the Linux kernel is running
2066 (supported by a status LED driver in the Linux
2067 kernel). Defining CONFIG_STATUS_LED enables this
2068 feature in U-Boot.
2069
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002070 Additional options:
2071
2072 CONFIG_GPIO_LED
2073 The status LED can be connected to a GPIO pin.
2074 In such cases, the gpio_led driver can be used as a
2075 status LED backend implementation. Define CONFIG_GPIO_LED
2076 to include the gpio_led driver in the U-Boot binary.
2077
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002078 CONFIG_GPIO_LED_INVERTED_TABLE
2079 Some GPIO connected LEDs may have inverted polarity in which
2080 case the GPIO high value corresponds to LED off state and
2081 GPIO low value corresponds to LED on state.
2082 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2083 with a list of GPIO LEDs that have inverted polarity.
2084
wdenkc6097192002-11-03 00:24:07 +00002085- CAN Support: CONFIG_CAN_DRIVER
2086
2087 Defining CONFIG_CAN_DRIVER enables CAN driver support
2088 on those systems that support this (optional)
2089 feature, like the TQM8xxL modules.
2090
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002091- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002092
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002093 This enable the NEW i2c subsystem, and will allow you to use
2094 i2c commands at the u-boot command line (as long as you set
2095 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2096 based realtime clock chips or other i2c devices. See
2097 common/cmd_i2c.c for a description of the command line
2098 interface.
2099
2100 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002101 - drivers/i2c/soft_i2c.c:
2102 - activate first bus with CONFIG_SYS_I2C_SOFT define
2103 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2104 for defining speed and slave address
2105 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2106 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2107 for defining speed and slave address
2108 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2109 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2110 for defining speed and slave address
2111 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2112 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2113 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002114
Heiko Schocher00f792e2012-10-24 13:48:22 +02002115 - drivers/i2c/fsl_i2c.c:
2116 - activate i2c driver with CONFIG_SYS_I2C_FSL
2117 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2118 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2119 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2120 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002121 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002122 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2123 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2124 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2125 second bus.
2126
Simon Glass1f2ba722012-10-30 07:28:53 +00002127 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002128 - activate this driver with CONFIG_SYS_I2C_TEGRA
2129 - This driver adds 4 i2c buses with a fix speed from
2130 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002131
Dirk Eibach880540d2013-04-25 02:40:01 +00002132 - drivers/i2c/ppc4xx_i2c.c
2133 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2134 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2135 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2136
tremfac96402013-09-21 18:13:35 +02002137 - drivers/i2c/i2c_mxc.c
2138 - activate this driver with CONFIG_SYS_I2C_MXC
2139 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2140 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2141 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2142 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2143 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2144 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2145 If thoses defines are not set, default value is 100000
2146 for speed, and 0 for slave.
2147
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002148 - drivers/i2c/rcar_i2c.c:
2149 - activate this driver with CONFIG_SYS_I2C_RCAR
2150 - This driver adds 4 i2c buses
2151
2152 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2153 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2154 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2155 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2156 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2157 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2158 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2159 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2160 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2161
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002162 - drivers/i2c/sh_i2c.c:
2163 - activate this driver with CONFIG_SYS_I2C_SH
2164 - This driver adds from 2 to 5 i2c buses
2165
2166 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2167 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2168 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2169 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2170 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2171 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2172 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2173 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2174 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2175 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2176 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2177 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2178 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2179
Heiko Schocher6789e842013-10-22 11:03:18 +02002180 - drivers/i2c/omap24xx_i2c.c
2181 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2182 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2183 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2184 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2185 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2186 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2187 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2188 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2189 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2190 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2191 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2192
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002193 - drivers/i2c/zynq_i2c.c
2194 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2195 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2196 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2197
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302198 - drivers/i2c/s3c24x0_i2c.c:
2199 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2200 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2201 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2202 with a fix speed from 100000 and the slave addr 0!
2203
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002204 additional defines:
2205
2206 CONFIG_SYS_NUM_I2C_BUSES
2207 Hold the number of i2c busses you want to use. If you
2208 don't use/have i2c muxes on your i2c bus, this
2209 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2210 omit this define.
2211
2212 CONFIG_SYS_I2C_DIRECT_BUS
2213 define this, if you don't use i2c muxes on your hardware.
2214 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2215 omit this define.
2216
2217 CONFIG_SYS_I2C_MAX_HOPS
2218 define how many muxes are maximal consecutively connected
2219 on one i2c bus. If you not use i2c muxes, omit this
2220 define.
2221
2222 CONFIG_SYS_I2C_BUSES
2223 hold a list of busses you want to use, only used if
2224 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2225 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2226 CONFIG_SYS_NUM_I2C_BUSES = 9:
2227
2228 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2229 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2230 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2231 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2232 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2233 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2234 {1, {I2C_NULL_HOP}}, \
2235 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2236 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2237 }
2238
2239 which defines
2240 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002241 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2242 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2243 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2244 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2245 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002246 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002247 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2248 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002249
2250 If you do not have i2c muxes on your board, omit this define.
2251
Heiko Schocherea818db2013-01-29 08:53:15 +01002252- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002253
2254 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2255 provides the following compelling advantages:
2256
2257 - more than one i2c adapter is usable
2258 - approved multibus support
2259 - better i2c mux support
2260
2261 ** Please consider updating your I2C driver now. **
2262
Heiko Schocherea818db2013-01-29 08:53:15 +01002263 These enable legacy I2C serial bus commands. Defining
2264 CONFIG_HARD_I2C will include the appropriate I2C driver
2265 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002266
wdenk945af8d2003-07-16 21:53:01 +00002267 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002268 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002269 CONFIG_COMMANDS) and communicate with i2c based realtime
2270 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002271 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002272
Ben Warrenbb99ad62006-09-07 16:50:54 -04002273 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002274
wdenk945af8d2003-07-16 21:53:01 +00002275 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002276 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002278 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002279 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002280 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002281 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002282
Peter Tyser8d321b82010-04-12 22:28:21 -05002283 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002284 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002285 and so its address should therefore be cleared to 0 (See,
2286 eg, MPC823e User's Manual p.16-473). So, set
2287 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002288
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002289 CONFIG_SYS_I2C_INIT_MPC5XXX
2290
2291 When a board is reset during an i2c bus transfer
2292 chips might think that the current transfer is still
2293 in progress. Reset the slave devices by sending start
2294 commands until the slave device responds.
2295
wdenk945af8d2003-07-16 21:53:01 +00002296 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002297
Heiko Schocherea818db2013-01-29 08:53:15 +01002298 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002299 then the following macros need to be defined (examples are
2300 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002301
2302 I2C_INIT
2303
wdenkb37c7e52003-06-30 16:24:52 +00002304 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002305 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002306
wdenkba56f622004-02-06 23:19:44 +00002307 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002308
wdenkc6097192002-11-03 00:24:07 +00002309 I2C_PORT
2310
wdenk43d96162003-03-06 00:02:04 +00002311 (Only for MPC8260 CPU). The I/O port to use (the code
2312 assumes both bits are on the same port). Valid values
2313 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002314
2315 I2C_ACTIVE
2316
2317 The code necessary to make the I2C data line active
2318 (driven). If the data line is open collector, this
2319 define can be null.
2320
wdenkb37c7e52003-06-30 16:24:52 +00002321 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2322
wdenkc6097192002-11-03 00:24:07 +00002323 I2C_TRISTATE
2324
2325 The code necessary to make the I2C data line tri-stated
2326 (inactive). If the data line is open collector, this
2327 define can be null.
2328
wdenkb37c7e52003-06-30 16:24:52 +00002329 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2330
wdenkc6097192002-11-03 00:24:07 +00002331 I2C_READ
2332
York Sun472d5462013-04-01 11:29:11 -07002333 Code that returns true if the I2C data line is high,
2334 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002335
wdenkb37c7e52003-06-30 16:24:52 +00002336 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2337
wdenkc6097192002-11-03 00:24:07 +00002338 I2C_SDA(bit)
2339
York Sun472d5462013-04-01 11:29:11 -07002340 If <bit> is true, sets the I2C data line high. If it
2341 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002342
wdenkb37c7e52003-06-30 16:24:52 +00002343 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002344 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002345 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002346
wdenkc6097192002-11-03 00:24:07 +00002347 I2C_SCL(bit)
2348
York Sun472d5462013-04-01 11:29:11 -07002349 If <bit> is true, sets the I2C clock line high. If it
2350 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002351
wdenkb37c7e52003-06-30 16:24:52 +00002352 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002353 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002354 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002355
wdenkc6097192002-11-03 00:24:07 +00002356 I2C_DELAY
2357
2358 This delay is invoked four times per clock cycle so this
2359 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002360 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002361 like:
2362
wdenkb37c7e52003-06-30 16:24:52 +00002363 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002364
Mike Frysinger793b5722010-07-21 13:38:02 -04002365 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2366
2367 If your arch supports the generic GPIO framework (asm/gpio.h),
2368 then you may alternatively define the two GPIOs that are to be
2369 used as SCL / SDA. Any of the previous I2C_xxx macros will
2370 have GPIO-based defaults assigned to them as appropriate.
2371
2372 You should define these to the GPIO value as given directly to
2373 the generic GPIO functions.
2374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002375 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002376
wdenk8bde7f72003-06-27 21:31:46 +00002377 When a board is reset during an i2c bus transfer
2378 chips might think that the current transfer is still
2379 in progress. On some boards it is possible to access
2380 the i2c SCLK line directly, either by using the
2381 processor pin as a GPIO or by having a second pin
2382 connected to the bus. If this option is defined a
2383 custom i2c_init_board() routine in boards/xxx/board.c
2384 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002385
Richard Retanubun26a33502010-04-12 15:08:17 -04002386 CONFIG_SYS_I2C_BOARD_LATE_INIT
2387
2388 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2389 defined a custom i2c_board_late_init() routine in
2390 boards/xxx/board.c is run AFTER the operations in i2c_init()
2391 is completed. This callpoint can be used to unreset i2c bus
2392 using CPU i2c controller register accesses for CPUs whose i2c
2393 controller provide such a method. It is called at the end of
2394 i2c_init() to allow i2c_init operations to setup the i2c bus
2395 controller on the CPU (e.g. setting bus speed & slave address).
2396
wdenk17ea1172004-06-06 21:51:03 +00002397 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2398
2399 This option enables configuration of bi_iic_fast[] flags
2400 in u-boot bd_info structure based on u-boot environment
2401 variable "i2cfast". (see also i2cfast)
2402
Ben Warrenbb99ad62006-09-07 16:50:54 -04002403 CONFIG_I2C_MULTI_BUS
2404
2405 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002406 must have a controller. At any point in time, only one bus is
2407 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002408 Note that bus numbering is zero-based.
2409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002410 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002411
2412 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002413 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002414 is set, specify a list of bus-device pairs. Otherwise, specify
2415 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002416
2417 e.g.
2418 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002419 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002420
2421 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2422
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002423 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002424 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002425
2426 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002429
2430 If defined, then this indicates the I2C bus number for DDR SPD.
2431 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2432
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002433 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002434
2435 If defined, then this indicates the I2C bus number for the RTC.
2436 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002439
2440 If defined, then this indicates the I2C bus number for the DTT.
2441 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2442
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002443 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002444
2445 If defined, specifies the I2C address of the DTT device.
2446 If not defined, then U-Boot uses predefined value for
2447 specified DTT device.
2448
Andrew Dyer2ac69852008-12-29 17:36:01 -06002449 CONFIG_SOFT_I2C_READ_REPEATED_START
2450
2451 defining this will force the i2c_read() function in
2452 the soft_i2c driver to perform an I2C repeated start
2453 between writing the address pointer and reading the
2454 data. If this define is omitted the default behaviour
2455 of doing a stop-start sequence will be used. Most I2C
2456 devices can use either method, but some require one or
2457 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002458
wdenkc6097192002-11-03 00:24:07 +00002459- SPI Support: CONFIG_SPI
2460
2461 Enables SPI driver (so far only tested with
2462 SPI EEPROM, also an instance works with Crystal A/D and
2463 D/As on the SACSng board)
2464
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002465 CONFIG_SH_SPI
2466
2467 Enables the driver for SPI controller on SuperH. Currently
2468 only SH7757 is supported.
2469
wdenkc6097192002-11-03 00:24:07 +00002470 CONFIG_SPI_X
2471
2472 Enables extended (16-bit) SPI EEPROM addressing.
2473 (symmetrical to CONFIG_I2C_X)
2474
2475 CONFIG_SOFT_SPI
2476
wdenk43d96162003-03-06 00:02:04 +00002477 Enables a software (bit-bang) SPI driver rather than
2478 using hardware support. This is a general purpose
2479 driver that only requires three general I/O port pins
2480 (two outputs, one input) to function. If this is
2481 defined, the board configuration must define several
2482 SPI configuration items (port pins to use, etc). For
2483 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002484
Ben Warren04a9e112008-01-16 22:37:35 -05002485 CONFIG_HARD_SPI
2486
2487 Enables a hardware SPI driver for general-purpose reads
2488 and writes. As with CONFIG_SOFT_SPI, the board configuration
2489 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002490 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002491 example, see include/configs/mpc8349emds.h.
2492
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002493 CONFIG_MXC_SPI
2494
2495 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002496 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002497
Matthias Fuchs01335022007-12-27 17:12:34 +01002498- FPGA Support: CONFIG_FPGA
2499
2500 Enables FPGA subsystem.
2501
2502 CONFIG_FPGA_<vendor>
2503
2504 Enables support for specific chip vendors.
2505 (ALTERA, XILINX)
2506
2507 CONFIG_FPGA_<family>
2508
2509 Enables support for FPGA family.
2510 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2511
2512 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002513
wdenk43d96162003-03-06 00:02:04 +00002514 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002517
wdenk8bde7f72003-06-27 21:31:46 +00002518 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002520 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002521
wdenk43d96162003-03-06 00:02:04 +00002522 Enable checks on FPGA configuration interface busy
2523 status by the configuration function. This option
2524 will require a board or device specific function to
2525 be written.
wdenkc6097192002-11-03 00:24:07 +00002526
2527 CONFIG_FPGA_DELAY
2528
2529 If defined, a function that provides delays in the FPGA
2530 configuration driver.
2531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002532 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002533 Allow Control-C to interrupt FPGA configuration
2534
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002535 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk43d96162003-03-06 00:02:04 +00002537 Check for configuration errors during FPGA bitfile
2538 loading. For example, abort during Virtex II
2539 configuration if the INIT_B line goes low (which
2540 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002541
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002542 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002543
wdenk43d96162003-03-06 00:02:04 +00002544 Maximum time to wait for the INIT_B line to deassert
2545 after PROB_B has been deasserted during a Virtex II
2546 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002547 ms.
wdenkc6097192002-11-03 00:24:07 +00002548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002549 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002550
wdenk43d96162003-03-06 00:02:04 +00002551 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002552 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002554 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002555
wdenk43d96162003-03-06 00:02:04 +00002556 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002557 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002558
2559- Configuration Management:
2560 CONFIG_IDENT_STRING
2561
wdenk43d96162003-03-06 00:02:04 +00002562 If defined, this string will be added to the U-Boot
2563 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002564
2565- Vendor Parameter Protection:
2566
wdenk43d96162003-03-06 00:02:04 +00002567 U-Boot considers the values of the environment
2568 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002569 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002570 are set once by the board vendor / manufacturer, and
2571 protects these variables from casual modification by
2572 the user. Once set, these variables are read-only,
2573 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002574 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002575
2576 If CONFIG_ENV_OVERWRITE is #defined in your config
2577 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002578 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002579 these parameters.
2580
2581 Alternatively, if you #define _both_ CONFIG_ETHADDR
2582 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002583 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002584 which can be changed exactly ONCE by the user. [The
2585 serial# is unaffected by this, i. e. it remains
2586 read-only.]
2587
Joe Hershberger25980902012-12-11 22:16:31 -06002588 The same can be accomplished in a more flexible way
2589 for any variable by configuring the type of access
2590 to allow for those variables in the ".flags" variable
2591 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2592
wdenkc6097192002-11-03 00:24:07 +00002593- Protected RAM:
2594 CONFIG_PRAM
2595
2596 Define this variable to enable the reservation of
2597 "protected RAM", i. e. RAM which is not overwritten
2598 by U-Boot. Define CONFIG_PRAM to hold the number of
2599 kB you want to reserve for pRAM. You can overwrite
2600 this default value by defining an environment
2601 variable "pram" to the number of kB you want to
2602 reserve. Note that the board info structure will
2603 still show the full amount of RAM. If pRAM is
2604 reserved, a new environment variable "mem" will
2605 automatically be defined to hold the amount of
2606 remaining RAM in a form that can be passed as boot
2607 argument to Linux, for instance like that:
2608
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002609 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002610 saveenv
2611
2612 This way you can tell Linux not to use this memory,
2613 either, which results in a memory region that will
2614 not be affected by reboots.
2615
2616 *WARNING* If your board configuration uses automatic
2617 detection of the RAM size, you must make sure that
2618 this memory test is non-destructive. So far, the
2619 following board configurations are known to be
2620 "pRAM-clean":
2621
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002622 IVMS8, IVML24, SPD8xx, TQM8xxL,
2623 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002624 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002625
Gabe Black40fef042012-12-02 04:55:18 +00002626- Access to physical memory region (> 4GB)
2627 Some basic support is provided for operations on memory not
2628 normally accessible to U-Boot - e.g. some architectures
2629 support access to more than 4GB of memory on 32-bit
2630 machines using physical address extension or similar.
2631 Define CONFIG_PHYSMEM to access this basic support, which
2632 currently only supports clearing the memory.
2633
wdenkc6097192002-11-03 00:24:07 +00002634- Error Recovery:
2635 CONFIG_PANIC_HANG
2636
2637 Define this variable to stop the system in case of a
2638 fatal error, so that you have to reset it manually.
2639 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002640 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002641 automatically as fast as possible, but it may be
2642 useful during development since you can try to debug
2643 the conditions that lead to the situation.
2644
2645 CONFIG_NET_RETRY_COUNT
2646
wdenk43d96162003-03-06 00:02:04 +00002647 This variable defines the number of retries for
2648 network operations like ARP, RARP, TFTP, or BOOTP
2649 before giving up the operation. If not defined, a
2650 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002651
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002652 CONFIG_ARP_TIMEOUT
2653
2654 Timeout waiting for an ARP reply in milliseconds.
2655
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002656 CONFIG_NFS_TIMEOUT
2657
2658 Timeout in milliseconds used in NFS protocol.
2659 If you encounter "ERROR: Cannot umount" in nfs command,
2660 try longer timeout such as
2661 #define CONFIG_NFS_TIMEOUT 10000UL
2662
wdenkc6097192002-11-03 00:24:07 +00002663- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002664 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002665
2666 Enable auto completion of commands using TAB.
2667
Wolfgang Denka9398e02006-11-27 15:32:42 +01002668 Note that this feature has NOT been implemented yet
2669 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002670
2671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002672 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002673
2674 Define this variable to enable the "hush" shell (from
2675 Busybox) as command line interpreter, thus enabling
2676 powerful command line syntax like
2677 if...then...else...fi conditionals or `&&' and '||'
2678 constructs ("shell scripts").
2679
2680 If undefined, you get the old, much simpler behaviour
2681 with a somewhat smaller memory footprint.
2682
2683
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002684 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002685
2686 This defines the secondary prompt string, which is
2687 printed when the command interpreter needs more input
2688 to complete a command. Usually "> ".
2689
2690 Note:
2691
wdenk8bde7f72003-06-27 21:31:46 +00002692 In the current implementation, the local variables
2693 space and global environment variables space are
2694 separated. Local variables are those you define by
2695 simply typing `name=value'. To access a local
2696 variable later on, you have write `$name' or
2697 `${name}'; to execute the contents of a variable
2698 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk43d96162003-03-06 00:02:04 +00002700 Global environment variables are those you use
2701 setenv/printenv to work with. To run a command stored
2702 in such a variable, you need to use the run command,
2703 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002704
2705 To store commands and special characters in a
2706 variable, please use double quotation marks
2707 surrounding the whole text of the variable, instead
2708 of the backslashes before semicolons and special
2709 symbols.
2710
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002711- Commandline Editing and History:
2712 CONFIG_CMDLINE_EDITING
2713
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002714 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002715 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002716
wdenka8c7c702003-12-06 19:49:23 +00002717- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002718 CONFIG_EXTRA_ENV_SETTINGS
2719
wdenk43d96162003-03-06 00:02:04 +00002720 Define this to contain any number of null terminated
2721 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002722 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002723
wdenk43d96162003-03-06 00:02:04 +00002724 For example, place something like this in your
2725 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002726
2727 #define CONFIG_EXTRA_ENV_SETTINGS \
2728 "myvar1=value1\0" \
2729 "myvar2=value2\0"
2730
wdenk43d96162003-03-06 00:02:04 +00002731 Warning: This method is based on knowledge about the
2732 internal format how the environment is stored by the
2733 U-Boot code. This is NOT an official, exported
2734 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002735 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002736 You better know what you are doing here.
2737
wdenk43d96162003-03-06 00:02:04 +00002738 Note: overly (ab)use of the default environment is
2739 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002740 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002741 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002742
Stephen Warren5e724ca2012-05-22 09:21:54 +00002743 CONFIG_ENV_VARS_UBOOT_CONFIG
2744
2745 Define this in order to add variables describing the
2746 U-Boot build configuration to the default environment.
2747 These will be named arch, cpu, board, vendor, and soc.
2748
2749 Enabling this option will cause the following to be defined:
2750
2751 - CONFIG_SYS_ARCH
2752 - CONFIG_SYS_CPU
2753 - CONFIG_SYS_BOARD
2754 - CONFIG_SYS_VENDOR
2755 - CONFIG_SYS_SOC
2756
Tom Rini7e27f892012-10-24 07:28:16 +00002757 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2758
2759 Define this in order to add variables describing certain
2760 run-time determined information about the hardware to the
2761 environment. These will be named board_name, board_rev.
2762
Simon Glass06fd8532012-11-30 13:01:17 +00002763 CONFIG_DELAY_ENVIRONMENT
2764
2765 Normally the environment is loaded when the board is
2766 intialised so that it is available to U-Boot. This inhibits
2767 that so that the environment is not available until
2768 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2769 this is instead controlled by the value of
2770 /config/load-environment.
2771
wdenka8c7c702003-12-06 19:49:23 +00002772- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002773 CONFIG_HAS_DATAFLASH
2774
wdenk8bde7f72003-06-27 21:31:46 +00002775 Defining this option enables DataFlash features and
2776 allows to read/write in Dataflash via the standard
2777 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002778
Eric Nelsonf61ec452012-01-31 10:52:08 -07002779- Serial Flash support
2780 CONFIG_CMD_SF
2781
2782 Defining this option enables SPI flash commands
2783 'sf probe/read/write/erase/update'.
2784
2785 Usage requires an initial 'probe' to define the serial
2786 flash parameters, followed by read/write/erase/update
2787 commands.
2788
2789 The following defaults may be provided by the platform
2790 to handle the common case when only a single serial
2791 flash is present on the system.
2792
2793 CONFIG_SF_DEFAULT_BUS Bus identifier
2794 CONFIG_SF_DEFAULT_CS Chip-select
2795 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2796 CONFIG_SF_DEFAULT_SPEED in Hz
2797
Simon Glass24007272012-10-08 13:16:02 +00002798 CONFIG_CMD_SF_TEST
2799
2800 Define this option to include a destructive SPI flash
2801 test ('sf test').
2802
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302803 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2804
2805 Define this option to use the Bank addr/Extended addr
2806 support on SPI flashes which has size > 16Mbytes.
2807
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302808 CONFIG_SF_DUAL_FLASH Dual flash memories
2809
2810 Define this option to use dual flash support where two flash
2811 memories can be connected with a given cs line.
2812 currently Xilinx Zynq qspi support these type of connections.
2813
wdenk3f85ce22004-02-23 16:11:30 +00002814- SystemACE Support:
2815 CONFIG_SYSTEMACE
2816
2817 Adding this option adds support for Xilinx SystemACE
2818 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002819 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002821
2822 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002823 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002824
2825 When SystemACE support is added, the "ace" device type
2826 becomes available to the fat commands, i.e. fatls.
2827
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002828- TFTP Fixed UDP Port:
2829 CONFIG_TFTP_PORT
2830
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002831 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002832 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002833 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002834 number generator is used.
2835
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002836 Also, the environment variable tftpdstp is used to supply
2837 the TFTP UDP destination port value. If tftpdstp isn't
2838 defined, the normal port 69 is used.
2839
2840 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002841 blindly start the TFTP transfer using the pre-configured
2842 target IP address and UDP port. This has the effect of
2843 "punching through" the (Windows XP) firewall, allowing
2844 the remainder of the TFTP transfer to proceed normally.
2845 A better solution is to properly configure the firewall,
2846 but sometimes that is not allowed.
2847
Simon Glassbf36c5d2012-12-05 14:46:38 +00002848- Hashing support:
2849 CONFIG_CMD_HASH
2850
2851 This enables a generic 'hash' command which can produce
2852 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2853
2854 CONFIG_HASH_VERIFY
2855
2856 Enable the hash verify command (hash -v). This adds to code
2857 size a little.
2858
2859 CONFIG_SHA1 - support SHA1 hashing
2860 CONFIG_SHA256 - support SHA256 hashing
2861
2862 Note: There is also a sha1sum command, which should perhaps
2863 be deprecated in favour of 'hash sha1'.
2864
Robert Winklera11f1872013-07-24 17:57:06 -07002865- Freescale i.MX specific commands:
2866 CONFIG_CMD_HDMIDETECT
2867 This enables 'hdmidet' command which returns true if an
2868 HDMI monitor is detected. This command is i.MX 6 specific.
2869
2870 CONFIG_CMD_BMODE
2871 This enables the 'bmode' (bootmode) command for forcing
2872 a boot from specific media.
2873
2874 This is useful for forcing the ROM's usb downloader to
2875 activate upon a watchdog reset which is nice when iterating
2876 on U-Boot. Using the reset button or running bmode normal
2877 will set it back to normal. This command currently
2878 supports i.MX53 and i.MX6.
2879
Simon Glass19c402a2013-06-13 15:10:02 -07002880- Signing support:
2881 CONFIG_RSA
2882
2883 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01002884 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07002885
2886 The signing part is build into mkimage regardless of this
2887 option.
2888
Heiko Schocher9e50c402014-01-25 07:27:13 +01002889- bootcount support:
2890 CONFIG_BOOTCOUNT_LIMIT
2891
2892 This enables the bootcounter support, see:
2893 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2894
2895 CONFIG_AT91SAM9XE
2896 enable special bootcounter support on at91sam9xe based boards.
2897 CONFIG_BLACKFIN
2898 enable special bootcounter support on blackfin based boards.
2899 CONFIG_SOC_DA8XX
2900 enable special bootcounter support on da850 based boards.
2901 CONFIG_BOOTCOUNT_RAM
2902 enable support for the bootcounter in RAM
2903 CONFIG_BOOTCOUNT_I2C
2904 enable support for the bootcounter on an i2c (like RTC) device.
2905 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2906 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2907 the bootcounter.
2908 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002909
wdenka8c7c702003-12-06 19:49:23 +00002910- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002911 CONFIG_SHOW_BOOT_PROGRESS
2912
wdenk43d96162003-03-06 00:02:04 +00002913 Defining this option allows to add some board-
2914 specific code (calling a user-provided function
2915 "show_boot_progress(int)") that enables you to show
2916 the system's boot progress on some display (for
2917 example, some LED's) on your board. At the moment,
2918 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002919
Simon Glass3a608ca2012-02-13 13:51:19 +00002920- Detailed boot stage timing
2921 CONFIG_BOOTSTAGE
2922 Define this option to get detailed timing of each stage
2923 of the boot process.
2924
2925 CONFIG_BOOTSTAGE_USER_COUNT
2926 This is the number of available user bootstage records.
2927 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2928 a new ID will be allocated from this stash. If you exceed
2929 the limit, recording will stop.
2930
2931 CONFIG_BOOTSTAGE_REPORT
2932 Define this to print a report before boot, similar to this:
2933
2934 Timer summary in microseconds:
2935 Mark Elapsed Stage
2936 0 0 reset
2937 3,575,678 3,575,678 board_init_f start
2938 3,575,695 17 arch_cpu_init A9
2939 3,575,777 82 arch_cpu_init done
2940 3,659,598 83,821 board_init_r start
2941 3,910,375 250,777 main_loop
2942 29,916,167 26,005,792 bootm_start
2943 30,361,327 445,160 start_kernel
2944
Simon Glass2eba38c2012-09-28 08:56:39 +00002945 CONFIG_CMD_BOOTSTAGE
2946 Add a 'bootstage' command which supports printing a report
2947 and un/stashing of bootstage data.
2948
Simon Glass94fd1312012-09-28 08:56:37 +00002949 CONFIG_BOOTSTAGE_FDT
2950 Stash the bootstage information in the FDT. A root 'bootstage'
2951 node is created with each bootstage id as a child. Each child
2952 has a 'name' property and either 'mark' containing the
2953 mark time in microsecond, or 'accum' containing the
2954 accumulated time for that bootstage id in microseconds.
2955 For example:
2956
2957 bootstage {
2958 154 {
2959 name = "board_init_f";
2960 mark = <3575678>;
2961 };
2962 170 {
2963 name = "lcd";
2964 accum = <33482>;
2965 };
2966 };
2967
2968 Code in the Linux kernel can find this in /proc/devicetree.
2969
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002970Legacy uImage format:
2971
wdenkc6097192002-11-03 00:24:07 +00002972 Arg Where When
2973 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002974 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002975 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002976 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002977 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002978 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002979 4 common/cmd_bootm.c Image data has correct checksum
2980 -4 common/cmd_bootm.c Image is for unsupported architecture
2981 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002982 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002983 6 common/cmd_bootm.c Image Type check OK
2984 -6 common/cmd_bootm.c gunzip uncompression error
2985 -7 common/cmd_bootm.c Unimplemented compression type
2986 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002987 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002988 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002989
2990 9 common/image.c Start initial ramdisk verification
2991 -10 common/image.c Ramdisk header has bad magic number
2992 -11 common/image.c Ramdisk header has bad checksum
2993 10 common/image.c Ramdisk header is OK
2994 -12 common/image.c Ramdisk data has bad checksum
2995 11 common/image.c Ramdisk data has correct checksum
2996 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002997 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002998 13 common/image.c Start multifile image verification
2999 14 common/image.c No initial ramdisk, no multifile, continue.
3000
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003001 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003002
Stefan Roesea47a12b2010-04-15 16:07:28 +02003003 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003004 -31 post/post.c POST test failed, detected by post_output_backlog()
3005 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003006
Heiko Schocher566a4942007-06-22 19:11:54 +02003007 34 common/cmd_doc.c before loading a Image from a DOC device
3008 -35 common/cmd_doc.c Bad usage of "doc" command
3009 35 common/cmd_doc.c correct usage of "doc" command
3010 -36 common/cmd_doc.c No boot device
3011 36 common/cmd_doc.c correct boot device
3012 -37 common/cmd_doc.c Unknown Chip ID on boot device
3013 37 common/cmd_doc.c correct chip ID found, device available
3014 -38 common/cmd_doc.c Read Error on boot device
3015 38 common/cmd_doc.c reading Image header from DOC device OK
3016 -39 common/cmd_doc.c Image header has bad magic number
3017 39 common/cmd_doc.c Image header has correct magic number
3018 -40 common/cmd_doc.c Error reading Image from DOC device
3019 40 common/cmd_doc.c Image header has correct magic number
3020 41 common/cmd_ide.c before loading a Image from a IDE device
3021 -42 common/cmd_ide.c Bad usage of "ide" command
3022 42 common/cmd_ide.c correct usage of "ide" command
3023 -43 common/cmd_ide.c No boot device
3024 43 common/cmd_ide.c boot device found
3025 -44 common/cmd_ide.c Device not available
3026 44 common/cmd_ide.c Device available
3027 -45 common/cmd_ide.c wrong partition selected
3028 45 common/cmd_ide.c partition selected
3029 -46 common/cmd_ide.c Unknown partition table
3030 46 common/cmd_ide.c valid partition table found
3031 -47 common/cmd_ide.c Invalid partition type
3032 47 common/cmd_ide.c correct partition type
3033 -48 common/cmd_ide.c Error reading Image Header on boot device
3034 48 common/cmd_ide.c reading Image Header from IDE device OK
3035 -49 common/cmd_ide.c Image header has bad magic number
3036 49 common/cmd_ide.c Image header has correct magic number
3037 -50 common/cmd_ide.c Image header has bad checksum
3038 50 common/cmd_ide.c Image header has correct checksum
3039 -51 common/cmd_ide.c Error reading Image from IDE device
3040 51 common/cmd_ide.c reading Image from IDE device OK
3041 52 common/cmd_nand.c before loading a Image from a NAND device
3042 -53 common/cmd_nand.c Bad usage of "nand" command
3043 53 common/cmd_nand.c correct usage of "nand" command
3044 -54 common/cmd_nand.c No boot device
3045 54 common/cmd_nand.c boot device found
3046 -55 common/cmd_nand.c Unknown Chip ID on boot device
3047 55 common/cmd_nand.c correct chip ID found, device available
3048 -56 common/cmd_nand.c Error reading Image Header on boot device
3049 56 common/cmd_nand.c reading Image Header from NAND device OK
3050 -57 common/cmd_nand.c Image header has bad magic number
3051 57 common/cmd_nand.c Image header has correct magic number
3052 -58 common/cmd_nand.c Error reading Image from NAND device
3053 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003054
Heiko Schocher566a4942007-06-22 19:11:54 +02003055 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003056
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003057 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003058 -64 net/eth.c no Ethernet found.
3059 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003060
Heiko Schocher566a4942007-06-22 19:11:54 +02003061 -80 common/cmd_net.c usage wrong
3062 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003063 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003064 81 common/cmd_net.c NetLoop() back without error
3065 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3066 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003067 83 common/cmd_net.c running "source" command
3068 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003069 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003070
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003071FIT uImage format:
3072
3073 Arg Where When
3074 100 common/cmd_bootm.c Kernel FIT Image has correct format
3075 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3076 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3077 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3078 102 common/cmd_bootm.c Kernel unit name specified
3079 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003080 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003081 104 common/cmd_bootm.c Got kernel subimage node offset
3082 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3083 105 common/cmd_bootm.c Kernel subimage hash verification OK
3084 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3085 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003086 -106 common/cmd_bootm.c Kernel subimage has wrong type
3087 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003088 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3089 108 common/cmd_bootm.c Got kernel subimage data/size
3090 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3091 -109 common/cmd_bootm.c Can't get kernel subimage type
3092 -110 common/cmd_bootm.c Can't get kernel subimage comp
3093 -111 common/cmd_bootm.c Can't get kernel subimage os
3094 -112 common/cmd_bootm.c Can't get kernel subimage load address
3095 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3096
3097 120 common/image.c Start initial ramdisk verification
3098 -120 common/image.c Ramdisk FIT image has incorrect format
3099 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003100 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003101 -122 common/image.c Can't get configuration for ramdisk subimage
3102 123 common/image.c Ramdisk unit name specified
3103 -124 common/image.c Can't get ramdisk subimage node offset
3104 125 common/image.c Got ramdisk subimage node offset
3105 -125 common/image.c Ramdisk subimage hash verification failed
3106 126 common/image.c Ramdisk subimage hash verification OK
3107 -126 common/image.c Ramdisk subimage for unsupported architecture
3108 127 common/image.c Architecture check OK
3109 -127 common/image.c Can't get ramdisk subimage data/size
3110 128 common/image.c Got ramdisk subimage data/size
3111 129 common/image.c Can't get ramdisk load address
3112 -129 common/image.c Got ramdisk load address
3113
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003114 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003115 131 common/cmd_doc.c FIT image format OK
3116
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003117 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003118 141 common/cmd_ide.c FIT image format OK
3119
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003120 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003121 151 common/cmd_nand.c FIT image format OK
3122
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003123- FIT image support:
3124 CONFIG_FIT
3125 Enable support for the FIT uImage format.
3126
3127 CONFIG_FIT_BEST_MATCH
3128 When no configuration is explicitly selected, default to the
3129 one whose fdt's compatibility field best matches that of
3130 U-Boot itself. A match is considered "best" if it matches the
3131 most specific compatibility entry of U-Boot's fdt's root node.
3132 The order of entries in the configuration's fdt is ignored.
3133
Simon Glass3e569a62013-06-13 15:10:00 -07003134 CONFIG_FIT_SIGNATURE
3135 This option enables signature verification of FIT uImages,
3136 using a hash signed and verified using RSA. See
3137 doc/uImage.FIT/signature.txt for more details.
3138
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003139- Standalone program support:
3140 CONFIG_STANDALONE_LOAD_ADDR
3141
Wolfgang Denk6feff892011-10-09 21:06:34 +02003142 This option defines a board specific value for the
3143 address where standalone program gets loaded, thus
3144 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003145 settings.
3146
3147- Frame Buffer Address:
3148 CONFIG_FB_ADDR
3149
3150 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003151 address for frame buffer. This is typically the case
3152 when using a graphics controller has separate video
3153 memory. U-Boot will then place the frame buffer at
3154 the given address instead of dynamically reserving it
3155 in system RAM by calling lcd_setmem(), which grabs
3156 the memory for the frame buffer depending on the
3157 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003158
3159 Please see board_init_f function.
3160
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003161- Automatic software updates via TFTP server
3162 CONFIG_UPDATE_TFTP
3163 CONFIG_UPDATE_TFTP_CNT_MAX
3164 CONFIG_UPDATE_TFTP_MSEC_MAX
3165
3166 These options enable and control the auto-update feature;
3167 for a more detailed description refer to doc/README.update.
3168
3169- MTD Support (mtdparts command, UBI support)
3170 CONFIG_MTD_DEVICE
3171
3172 Adds the MTD device infrastructure from the Linux kernel.
3173 Needed for mtdparts command support.
3174
3175 CONFIG_MTD_PARTITIONS
3176
3177 Adds the MTD partitioning infrastructure from the Linux
3178 kernel. Needed for UBI support.
3179
Joe Hershberger70c219c2013-04-08 10:32:48 +00003180- UBI support
3181 CONFIG_CMD_UBI
3182
3183 Adds commands for interacting with MTD partitions formatted
3184 with the UBI flash translation layer
3185
3186 Requires also defining CONFIG_RBTREE
3187
Joe Hershberger147162d2013-04-08 10:32:49 +00003188 CONFIG_UBI_SILENCE_MSG
3189
3190 Make the verbose messages from UBI stop printing. This leaves
3191 warnings and errors enabled.
3192
Joe Hershberger70c219c2013-04-08 10:32:48 +00003193- UBIFS support
3194 CONFIG_CMD_UBIFS
3195
3196 Adds commands for interacting with UBI volumes formatted as
3197 UBIFS. UBIFS is read-only in u-boot.
3198
3199 Requires UBI support as well as CONFIG_LZO
3200
Joe Hershberger147162d2013-04-08 10:32:49 +00003201 CONFIG_UBIFS_SILENCE_MSG
3202
3203 Make the verbose messages from UBIFS stop printing. This leaves
3204 warnings and errors enabled.
3205
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003206- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003207 CONFIG_SPL
3208 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003209
Tom Rini95579792012-02-14 07:29:40 +00003210 CONFIG_SPL_LDSCRIPT
3211 LDSCRIPT for linking the SPL binary.
3212
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003213 CONFIG_SPL_MAX_FOOTPRINT
3214 Maximum size in memory allocated to the SPL, BSS included.
3215 When defined, the linker checks that the actual memory
3216 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003217 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003218 must not be both defined at the same time.
3219
Tom Rini95579792012-02-14 07:29:40 +00003220 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003221 Maximum size of the SPL image (text, data, rodata, and
3222 linker lists sections), BSS excluded.
3223 When defined, the linker checks that the actual size does
3224 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003225
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003226 CONFIG_SPL_TEXT_BASE
3227 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003228
Scott Wood94a45bb2012-09-20 19:05:12 -05003229 CONFIG_SPL_RELOC_TEXT_BASE
3230 Address to relocate to. If unspecified, this is equal to
3231 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3232
Tom Rini95579792012-02-14 07:29:40 +00003233 CONFIG_SPL_BSS_START_ADDR
3234 Link address for the BSS within the SPL binary.
3235
3236 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003237 Maximum size in memory allocated to the SPL BSS.
3238 When defined, the linker checks that the actual memory used
3239 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003240 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003241 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003242
3243 CONFIG_SPL_STACK
3244 Adress of the start of the stack SPL will use
3245
Scott Wood94a45bb2012-09-20 19:05:12 -05003246 CONFIG_SPL_RELOC_STACK
3247 Adress of the start of the stack SPL will use after
3248 relocation. If unspecified, this is equal to
3249 CONFIG_SPL_STACK.
3250
Tom Rini95579792012-02-14 07:29:40 +00003251 CONFIG_SYS_SPL_MALLOC_START
3252 Starting address of the malloc pool used in SPL.
3253
3254 CONFIG_SYS_SPL_MALLOC_SIZE
3255 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003256
Tom Rini47f7bca2012-08-13 12:03:19 -07003257 CONFIG_SPL_FRAMEWORK
3258 Enable the SPL framework under common/. This framework
3259 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3260 NAND loading of the Linux Kernel.
3261
Tom Rini861a86f2012-08-13 11:37:56 -07003262 CONFIG_SPL_DISPLAY_PRINT
3263 For ARM, enable an optional function to print more information
3264 about the running system.
3265
Scott Wood4b919722012-09-20 16:35:21 -05003266 CONFIG_SPL_INIT_MINIMAL
3267 Arch init code should be built for a very small image
3268
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003269 CONFIG_SPL_LIBCOMMON_SUPPORT
3270 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003271
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003272 CONFIG_SPL_LIBDISK_SUPPORT
3273 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003274
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003275 CONFIG_SPL_I2C_SUPPORT
3276 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003277
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003278 CONFIG_SPL_GPIO_SUPPORT
3279 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003280
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003281 CONFIG_SPL_MMC_SUPPORT
3282 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003283
Tom Rini95579792012-02-14 07:29:40 +00003284 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3285 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3286 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3287 Address, size and partition on the MMC to load U-Boot from
3288 when the MMC is being used in raw mode.
3289
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003290 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3291 Sector to load kernel uImage from when MMC is being
3292 used in raw mode (for Falcon mode)
3293
3294 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3295 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3296 Sector and number of sectors to load kernel argument
3297 parameters from when MMC is being used in raw mode
3298 (for falcon mode)
3299
Tom Rini95579792012-02-14 07:29:40 +00003300 CONFIG_SPL_FAT_SUPPORT
3301 Support for fs/fat/libfat.o in SPL binary
3302
3303 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3304 Filename to read to load U-Boot when reading from FAT
3305
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003306 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3307 Filename to read to load kernel uImage when reading
3308 from FAT (for Falcon mode)
3309
3310 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3311 Filename to read to load kernel argument parameters
3312 when reading from FAT (for Falcon mode)
3313
Scott Wood06f60ae2012-12-06 13:33:17 +00003314 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3315 Set this for NAND SPL on PPC mpc83xx targets, so that
3316 start.S waits for the rest of the SPL to load before
3317 continuing (the hardware starts execution after just
3318 loading the first page rather than the full 4K).
3319
Scott Wood6f2f01b2012-09-20 19:09:07 -05003320 CONFIG_SPL_NAND_BASE
3321 Include nand_base.c in the SPL. Requires
3322 CONFIG_SPL_NAND_DRIVERS.
3323
3324 CONFIG_SPL_NAND_DRIVERS
3325 SPL uses normal NAND drivers, not minimal drivers.
3326
3327 CONFIG_SPL_NAND_ECC
3328 Include standard software ECC in the SPL
3329
Tom Rini95579792012-02-14 07:29:40 +00003330 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003331 Support for NAND boot using simple NAND drivers that
3332 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003333
Ying Zhangbb0dc102013-08-16 15:16:11 +08003334 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3335 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003336 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003337
Ying Zhang7c8eea52013-08-16 15:16:12 +08003338 CONFIG_SPL_COMMON_INIT_DDR
3339 Set for common ddr init with serial presence detect in
3340 SPL binary.
3341
Tom Rini95579792012-02-14 07:29:40 +00003342 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3343 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3344 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3345 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3346 CONFIG_SYS_NAND_ECCBYTES
3347 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003348 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003349
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303350 CONFIG_SPL_NAND_BOOT
3351 Add support NAND boot
3352
Tom Rini95579792012-02-14 07:29:40 +00003353 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003354 Location in NAND to read U-Boot from
3355
3356 CONFIG_SYS_NAND_U_BOOT_DST
3357 Location in memory to load U-Boot to
3358
3359 CONFIG_SYS_NAND_U_BOOT_SIZE
3360 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003361
3362 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003363 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003364
3365 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3366 Define this if you need to first read the OOB and then the
3367 data. This is used for example on davinci plattforms.
3368
3369 CONFIG_SPL_OMAP3_ID_NAND
3370 Support for an OMAP3-specific set of functions to return the
3371 ID and MFR of the first attached NAND chip, if present.
3372
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003373 CONFIG_SPL_SERIAL_SUPPORT
3374 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003375
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003376 CONFIG_SPL_SPI_FLASH_SUPPORT
3377 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003378
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003379 CONFIG_SPL_SPI_SUPPORT
3380 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003381
Pavel Machekc57b9532012-08-30 22:42:11 +02003382 CONFIG_SPL_RAM_DEVICE
3383 Support for running image already present in ram, in SPL binary
3384
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003385 CONFIG_SPL_LIBGENERIC_SUPPORT
3386 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003387
Ying Zhangba1bee42013-05-20 14:07:25 +08003388 CONFIG_SPL_ENV_SUPPORT
3389 Support for the environment operating in SPL binary
3390
3391 CONFIG_SPL_NET_SUPPORT
3392 Support for the net/libnet.o in SPL binary.
3393 It conflicts with SPL env from storage medium specified by
3394 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3395
Scott Wood74752ba2012-12-06 13:33:16 +00003396 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003397 Image offset to which the SPL should be padded before appending
3398 the SPL payload. By default, this is defined as
3399 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3400 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3401 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003402
Scott Woodca2fca22012-09-21 16:27:32 -05003403 CONFIG_SPL_TARGET
3404 Final target image containing SPL and payload. Some SPLs
3405 use an arch-specific makefile fragment instead, for
3406 example if more than one image needs to be produced.
3407
Simon Glass87ebee32013-05-08 08:05:59 +00003408 CONFIG_FIT_SPL_PRINT
3409 Printing information about a FIT image adds quite a bit of
3410 code to SPL. So this is normally disabled in SPL. Use this
3411 option to re-enable it. This will affect the output of the
3412 bootm command when booting a FIT image.
3413
Ying Zhang3aa29de2013-08-16 15:16:15 +08003414- TPL framework
3415 CONFIG_TPL
3416 Enable building of TPL globally.
3417
3418 CONFIG_TPL_PAD_TO
3419 Image offset to which the TPL should be padded before appending
3420 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003421 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3422 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3423 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003424
wdenkc6097192002-11-03 00:24:07 +00003425Modem Support:
3426--------------
3427
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003428[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003429
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003430- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003431 CONFIG_MODEM_SUPPORT
3432
3433- RTS/CTS Flow control enable:
3434 CONFIG_HWFLOW
3435
3436- Modem debug support:
3437 CONFIG_MODEM_SUPPORT_DEBUG
3438
wdenk43d96162003-03-06 00:02:04 +00003439 Enables debugging stuff (char screen[1024], dbg())
3440 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003441
wdenka8c7c702003-12-06 19:49:23 +00003442- Interrupt support (PPC):
3443
wdenkd4ca31c2004-01-02 14:00:00 +00003444 There are common interrupt_init() and timer_interrupt()
3445 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003446 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003447 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003448 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003449 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003450 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003451 specific handling. If board has watchdog / status_led
3452 / other_activity_monitor it works automatically from
3453 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003454
wdenkc6097192002-11-03 00:24:07 +00003455- General:
3456
wdenk43d96162003-03-06 00:02:04 +00003457 In the target system modem support is enabled when a
3458 specific key (key combination) is pressed during
3459 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003460 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003461 board_init(). Currently key_pressed() is a dummy
3462 function, returning 1 and thus enabling modem
3463 initialization.
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk43d96162003-03-06 00:02:04 +00003465 If there are no modem init strings in the
3466 environment, U-Boot proceed to autoboot; the
3467 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003468 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003469
3470 See also: doc/README.Modem
3471
Helmut Raiger9660e442011-10-20 04:19:47 +00003472Board initialization settings:
3473------------------------------
3474
3475During Initialization u-boot calls a number of board specific functions
3476to allow the preparation of board specific prerequisites, e.g. pin setup
3477before drivers are initialized. To enable these callbacks the
3478following configuration macros have to be defined. Currently this is
3479architecture specific, so please check arch/your_architecture/lib/board.c
3480typically in board_init_f() and board_init_r().
3481
3482- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3483- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3484- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3485- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003486
wdenkc6097192002-11-03 00:24:07 +00003487Configuration Settings:
3488-----------------------
3489
York Sun4d1fd7f2014-02-26 17:03:19 -08003490- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3491 Optionally it can be defined to support 64-bit memory commands.
3492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003493- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003494 undefine this when you're short of memory.
3495
Peter Tyser2fb26042009-01-27 18:03:12 -06003496- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3497 width of the commands listed in the 'help' command output.
3498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003500 prompt for user input.
3501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003504- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003505
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003506- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003508- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003509 the application (usually a Linux kernel) when it is
3510 booted
3511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003512- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003513 List of legal baudrate settings for this board.
3514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003515- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003516 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003519 If the board specific function
3520 extern int overwrite_console (void);
3521 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003522 serial port, else the settings in the environment are used.
3523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003525 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003528 Enable overwrite of previous console environment settings.
3529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003531 Begin and End addresses of the area used by the
3532 simple memory test.
3533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003534- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003535 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003536
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003537- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003538 Scratch address used by the alternate memory test
3539 You only need to set this if address zero isn't writeable
3540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003541- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3542 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003543 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003544 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003545 fixing up gd->ram_size the Linux kernel should gets passed
3546 the now "corrected" memory size and won't touch it either.
3547 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003548 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003549 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003550 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003551
3552 This option can be used as a workaround for the 440EPx/GRx
3553 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3554 be touched.
3555
3556 WARNING: Please make sure that this value is a multiple of
3557 the Linux page size (normally 4k). If this is not the case,
3558 then the end address of the Linux memory will be located at a
3559 non page size aligned address and this could cause major
3560 problems.
3561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003562- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003563 Enable temporary baudrate change while serial download
3564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003565- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003566 Physical start address of SDRAM. _Must_ be 0 here.
3567
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003568- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003569 Physical start address of Motherboard I/O (if using a
3570 Cogent motherboard)
3571
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003572- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003573 Physical start address of Flash memory.
3574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003575- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003576 Physical start address of boot monitor code (set by
3577 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003578 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003579 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003580
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003581- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003582 Size of memory reserved for monitor code, used to
3583 determine _at_compile_time_ (!) if the environment is
3584 embedded within the U-Boot image, or in a separate
3585 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003586
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003587- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003588 Size of DRAM reserved for malloc() use.
3589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003590- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003591 Normally compressed uImages are limited to an
3592 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003593 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003594 to adjust this setting to your needs.
3595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003596- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003597 Maximum size of memory mapped by the startup code of
3598 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003599 the Linux kernel (bd_info, boot arguments, FDT blob if
3600 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003601 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003602 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003603 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003604 variable "bootm_mapsize" will override the value of
3605 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3606 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003607
John Rigbyfca43cc2010-10-13 13:57:35 -06003608- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3609 Enable initrd_high functionality. If defined then the
3610 initrd_high feature is enabled and the bootm ramdisk subcommand
3611 is enabled.
3612
3613- CONFIG_SYS_BOOT_GET_CMDLINE:
3614 Enables allocating and saving kernel cmdline in space between
3615 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3616
3617- CONFIG_SYS_BOOT_GET_KBD:
3618 Enables allocating and saving a kernel copy of the bd_info in
3619 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003621- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003622 Max number of Flash memory banks
3623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003624- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003625 Max number of sectors on a Flash chip
3626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003627- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003628 Timeout for Flash erase operations (in ms)
3629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003630- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003631 Timeout for Flash write operations (in ms)
3632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003633- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003634 Timeout for Flash set sector lock bit operation (in ms)
3635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003636- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003637 Timeout for Flash clear lock bits operation (in ms)
3638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003639- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003640 If defined, hardware flash sectors protection is used
3641 instead of U-Boot software protection.
3642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003643- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003644
3645 Enable TFTP transfers directly to flash memory;
3646 without this option such a download has to be
3647 performed in two steps: (1) download to RAM, and (2)
3648 copy from RAM to flash.
3649
3650 The two-step approach is usually more reliable, since
3651 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003652 the flash, but in some situations (when system RAM is
3653 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003654 downloaded image) this option may be very useful.
3655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003656- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003657 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003658 common flash structure for storing flash geometry.
3659
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003660- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003661 This option also enables the building of the cfi_flash driver
3662 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003663
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003664- CONFIG_FLASH_CFI_MTD
3665 This option enables the building of the cfi_mtd driver
3666 in the drivers directory. The driver exports CFI flash
3667 to the MTD layer.
3668
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003669- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003670 Use buffered writes to flash.
3671
3672- CONFIG_FLASH_SPANSION_S29WS_N
3673 s29ws-n MirrorBit flash has non-standard addresses for buffered
3674 write commands.
3675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003676- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003677 If this option is defined, the common CFI flash doesn't
3678 print it's warning upon not recognized FLASH banks. This
3679 is useful, if some of the configured banks are only
3680 optionally available.
3681
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003682- CONFIG_FLASH_SHOW_PROGRESS
3683 If defined (must be an integer), print out countdown
3684 digits and dots. Recommended value: 45 (9..1) for 80
3685 column displays, 15 (3..1) for 40 column displays.
3686
Stefan Roese352ef3f2013-04-04 15:53:14 +02003687- CONFIG_FLASH_VERIFY
3688 If defined, the content of the flash (destination) is compared
3689 against the source after the write operation. An error message
3690 will be printed when the contents are not identical.
3691 Please note that this option is useless in nearly all cases,
3692 since such flash programming errors usually are detected earlier
3693 while unprotecting/erasing/programming. Please only enable
3694 this option if you really know what you are doing.
3695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003696- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003697 Defines the number of Ethernet receive buffers. On some
3698 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003699 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3700 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003701 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003702 Defaults to 4 if not defined.
3703
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003704- CONFIG_ENV_MAX_ENTRIES
3705
Wolfgang Denk071bc922010-10-27 22:48:30 +02003706 Maximum number of entries in the hash table that is used
3707 internally to store the environment settings. The default
3708 setting is supposed to be generous and should work in most
3709 cases. This setting can be used to tune behaviour; see
3710 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003711
Joe Hershberger25980902012-12-11 22:16:31 -06003712- CONFIG_ENV_FLAGS_LIST_DEFAULT
3713- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003714 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003715 calling env set. Variables can be restricted to only decimal,
3716 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3717 the variables can also be restricted to IP address or MAC address.
3718
3719 The format of the list is:
3720 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003721 access_atribute = [a|r|o|c]
3722 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003723 entry = variable_name[:attributes]
3724 list = entry[,list]
3725
3726 The type attributes are:
3727 s - String (default)
3728 d - Decimal
3729 x - Hexadecimal
3730 b - Boolean ([1yYtT|0nNfF])
3731 i - IP address
3732 m - MAC address
3733
Joe Hershberger267541f2012-12-11 22:16:34 -06003734 The access attributes are:
3735 a - Any (default)
3736 r - Read-only
3737 o - Write-once
3738 c - Change-default
3739
Joe Hershberger25980902012-12-11 22:16:31 -06003740 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3741 Define this to a list (string) to define the ".flags"
3742 envirnoment variable in the default or embedded environment.
3743
3744 - CONFIG_ENV_FLAGS_LIST_STATIC
3745 Define this to a list (string) to define validation that
3746 should be done if an entry is not found in the ".flags"
3747 environment variable. To override a setting in the static
3748 list, simply add an entry for the same variable name to the
3749 ".flags" variable.
3750
Joe Hershberger267541f2012-12-11 22:16:34 -06003751- CONFIG_ENV_ACCESS_IGNORE_FORCE
3752 If defined, don't allow the -f switch to env set override variable
3753 access flags.
3754
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003755- CONFIG_SYS_GENERIC_BOARD
3756 This selects the architecture-generic board system instead of the
3757 architecture-specific board files. It is intended to move boards
3758 to this new framework over time. Defining this will disable the
3759 arch/foo/lib/board.c file and use common/board_f.c and
3760 common/board_r.c instead. To use this option your architecture
3761 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3762 its config.mk file). If you find problems enabling this option on
3763 your board please report the problem and send patches!
3764
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003765- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3766 This is set by OMAP boards for the max time that reset should
3767 be asserted. See doc/README.omap-reset-time for details on how
3768 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003769
wdenkc6097192002-11-03 00:24:07 +00003770The following definitions that deal with the placement and management
3771of environment data (variable area); in general, we support the
3772following configurations:
3773
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003774- CONFIG_BUILD_ENVCRC:
3775
3776 Builds up envcrc with the target environment so that external utils
3777 may easily extract it and embed it in final U-Boot images.
3778
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003779- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003780
3781 Define this if the environment is in flash memory.
3782
3783 a) The environment occupies one whole flash sector, which is
3784 "embedded" in the text segment with the U-Boot code. This
3785 happens usually with "bottom boot sector" or "top boot
3786 sector" type flash chips, which have several smaller
3787 sectors at the start or the end. For instance, such a
3788 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3789 such a case you would place the environment in one of the
3790 4 kB sectors - with U-Boot code before and after it. With
3791 "top boot sector" type flash chips, you would put the
3792 environment in one of the last sectors, leaving a gap
3793 between U-Boot and the environment.
3794
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003795 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003796
3797 Offset of environment data (variable area) to the
3798 beginning of flash memory; for instance, with bottom boot
3799 type flash chips the second sector can be used: the offset
3800 for this sector is given here.
3801
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003802 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003803
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003804 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003805
3806 This is just another way to specify the start address of
3807 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003808 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003809
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003810 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003811
3812 Size of the sector containing the environment.
3813
3814
3815 b) Sometimes flash chips have few, equal sized, BIG sectors.
3816 In such a case you don't want to spend a whole sector for
3817 the environment.
3818
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003819 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003820
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003821 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003822 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003823 of this flash sector for the environment. This saves
3824 memory for the RAM copy of the environment.
3825
3826 It may also save flash memory if you decide to use this
3827 when your environment is "embedded" within U-Boot code,
3828 since then the remainder of the flash sector could be used
3829 for U-Boot code. It should be pointed out that this is
3830 STRONGLY DISCOURAGED from a robustness point of view:
3831 updating the environment in flash makes it always
3832 necessary to erase the WHOLE sector. If something goes
3833 wrong before the contents has been restored from a copy in
3834 RAM, your target system will be dead.
3835
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003836 - CONFIG_ENV_ADDR_REDUND
3837 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003838
wdenk43d96162003-03-06 00:02:04 +00003839 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003840 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003841 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003842 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003843
3844BE CAREFUL! Any changes to the flash layout, and some changes to the
3845source code will make it necessary to adapt <board>/u-boot.lds*
3846accordingly!
3847
3848
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003849- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003850
3851 Define this if you have some non-volatile memory device
3852 (NVRAM, battery buffered SRAM) which you want to use for the
3853 environment.
3854
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003855 - CONFIG_ENV_ADDR:
3856 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003857
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003858 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003859 want to use for environment. It is assumed that this memory
3860 can just be read and written to, without any special
3861 provision.
3862
3863BE CAREFUL! The first access to the environment happens quite early
3864in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003865console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003866U-Boot will hang.
3867
3868Please note that even with NVRAM we still use a copy of the
3869environment in RAM: we could work on NVRAM directly, but we want to
3870keep settings there always unmodified except somebody uses "saveenv"
3871to save the current settings.
3872
3873
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003874- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003875
3876 Use this if you have an EEPROM or similar serial access
3877 device and a driver for it.
3878
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003879 - CONFIG_ENV_OFFSET:
3880 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003881
3882 These two #defines specify the offset and size of the
3883 environment area within the total memory of your EEPROM.
3884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003885 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003886 If defined, specified the chip address of the EEPROM device.
3887 The default address is zero.
3888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003889 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003890 If defined, the number of bits used to address bytes in a
3891 single page in the EEPROM device. A 64 byte page, for example
3892 would require six bits.
3893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003894 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003895 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003896 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003898 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003899 The length in bytes of the EEPROM memory array address. Note
3900 that this is NOT the chip address length!
3901
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003902 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003903 EEPROM chips that implement "address overflow" are ones
3904 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3905 address and the extra bits end up in the "chip address" bit
3906 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3907 byte chips.
3908
3909 Note that we consider the length of the address field to
3910 still be one byte because the extra address bits are hidden
3911 in the chip address.
3912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003913 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003914 The size in bytes of the EEPROM device.
3915
Heiko Schocher548738b2010-01-07 08:55:40 +01003916 - CONFIG_ENV_EEPROM_IS_ON_I2C
3917 define this, if you have I2C and SPI activated, and your
3918 EEPROM, which holds the environment, is on the I2C bus.
3919
3920 - CONFIG_I2C_ENV_EEPROM_BUS
3921 if you have an Environment on an EEPROM reached over
3922 I2C muxes, you can define here, how to reach this
3923 EEPROM. For example:
3924
Heiko Schocherea818db2013-01-29 08:53:15 +01003925 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003926
3927 EEPROM which holds the environment, is reached over
3928 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003929
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003930- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003931
wdenkd4ca31c2004-01-02 14:00:00 +00003932 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003933 want to use for the environment.
3934
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003935 - CONFIG_ENV_OFFSET:
3936 - CONFIG_ENV_ADDR:
3937 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003938
3939 These three #defines specify the offset and size of the
3940 environment area within the total memory of your DataFlash placed
3941 at the specified address.
3942
Liu Gang0a85a9e2012-03-08 00:33:20 +00003943- CONFIG_ENV_IS_IN_REMOTE:
3944
3945 Define this if you have a remote memory space which you
3946 want to use for the local device's environment.
3947
3948 - CONFIG_ENV_ADDR:
3949 - CONFIG_ENV_SIZE:
3950
3951 These two #defines specify the address and size of the
3952 environment area within the remote memory space. The
3953 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003954 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003955
3956BE CAREFUL! For some special cases, the local device can not use
3957"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003958environment stored in a remote NOR flash by SRIO or PCIE link,
3959but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003960
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003961- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003962
3963 Define this if you have a NAND device which you want to use
3964 for the environment.
3965
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003966 - CONFIG_ENV_OFFSET:
3967 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003968
3969 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003970 area within the first NAND device. CONFIG_ENV_OFFSET must be
3971 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003972
Scott Woodfdd813d2010-09-17 14:38:37 -05003973 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003974
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003975 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003976 size used to hold a redundant copy of the environment data, so
3977 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003978 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003979 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003980
Scott Woodfdd813d2010-09-17 14:38:37 -05003981 - CONFIG_ENV_RANGE (optional):
3982
3983 Specifies the length of the region in which the environment
3984 can be written. This should be a multiple of the NAND device's
3985 block size. Specifying a range with more erase blocks than
3986 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3987 the range to be avoided.
3988
3989 - CONFIG_ENV_OFFSET_OOB (optional):
3990
3991 Enables support for dynamically retrieving the offset of the
3992 environment from block zero's out-of-band data. The
3993 "nand env.oob" command can be used to record this offset.
3994 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3995 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003996
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003997- CONFIG_NAND_ENV_DST
3998
3999 Defines address in RAM to which the nand_spl code should copy the
4000 environment. If redundant environment is used, it will be copied to
4001 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4002
Joe Hershberger2b744332013-04-08 10:32:51 +00004003- CONFIG_ENV_IS_IN_UBI:
4004
4005 Define this if you have an UBI volume that you want to use for the
4006 environment. This has the benefit of wear-leveling the environment
4007 accesses, which is important on NAND.
4008
4009 - CONFIG_ENV_UBI_PART:
4010
4011 Define this to a string that is the mtd partition containing the UBI.
4012
4013 - CONFIG_ENV_UBI_VOLUME:
4014
4015 Define this to the name of the volume that you want to store the
4016 environment in.
4017
Joe Hershberger785881f2013-04-08 10:32:52 +00004018 - CONFIG_ENV_UBI_VOLUME_REDUND:
4019
4020 Define this to the name of another volume to store a second copy of
4021 the environment in. This will enable redundant environments in UBI.
4022 It is assumed that both volumes are in the same MTD partition.
4023
Joe Hershberger2b744332013-04-08 10:32:51 +00004024 - CONFIG_UBI_SILENCE_MSG
4025 - CONFIG_UBIFS_SILENCE_MSG
4026
4027 You will probably want to define these to avoid a really noisy system
4028 when storing the env in UBI.
4029
Stephen Warren06e4ae52013-06-11 15:14:00 -06004030- CONFIG_ENV_IS_IN_MMC:
4031
4032 Define this if you have an MMC device which you want to use for the
4033 environment.
4034
4035 - CONFIG_SYS_MMC_ENV_DEV:
4036
4037 Specifies which MMC device the environment is stored in.
4038
4039 - CONFIG_SYS_MMC_ENV_PART (optional):
4040
4041 Specifies which MMC partition the environment is stored in. If not
4042 set, defaults to partition 0, the user area. Common values might be
4043 1 (first MMC boot partition), 2 (second MMC boot partition).
4044
4045 - CONFIG_ENV_OFFSET:
4046 - CONFIG_ENV_SIZE:
4047
4048 These two #defines specify the offset and size of the environment
4049 area within the specified MMC device.
4050
Stephen Warren5c088ee2013-06-11 15:14:02 -06004051 If offset is positive (the usual case), it is treated as relative to
4052 the start of the MMC partition. If offset is negative, it is treated
4053 as relative to the end of the MMC partition. This can be useful if
4054 your board may be fitted with different MMC devices, which have
4055 different sizes for the MMC partitions, and you always want the
4056 environment placed at the very end of the partition, to leave the
4057 maximum possible space before it, to store other data.
4058
Stephen Warren06e4ae52013-06-11 15:14:00 -06004059 These two values are in units of bytes, but must be aligned to an
4060 MMC sector boundary.
4061
4062 - CONFIG_ENV_OFFSET_REDUND (optional):
4063
4064 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4065 hold a redundant copy of the environment data. This provides a
4066 valid backup copy in case the other copy is corrupted, e.g. due
4067 to a power failure during a "saveenv" operation.
4068
Stephen Warren5c088ee2013-06-11 15:14:02 -06004069 This value may also be positive or negative; this is handled in the
4070 same way as CONFIG_ENV_OFFSET.
4071
Stephen Warren06e4ae52013-06-11 15:14:00 -06004072 This value is also in units of bytes, but must also be aligned to
4073 an MMC sector boundary.
4074
4075 - CONFIG_ENV_SIZE_REDUND (optional):
4076
4077 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4078 set. If this value is set, it must be set to the same value as
4079 CONFIG_ENV_SIZE.
4080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004081- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004082
4083 Defines offset to the initial SPI buffer area in DPRAM. The
4084 area is used at an early stage (ROM part) if the environment
4085 is configured to reside in the SPI EEPROM: We need a 520 byte
4086 scratch DPRAM area. It is used between the two initialization
4087 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4088 to be a good choice since it makes it far enough from the
4089 start of the data area as well as from the stack pointer.
4090
Bruce Adlere881cb52007-11-02 13:15:42 -07004091Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004092has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004093created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004094until then to read environment variables.
4095
wdenk85ec0bc2003-03-31 16:34:49 +00004096The environment is protected by a CRC32 checksum. Before the monitor
4097is relocated into RAM, as a result of a bad CRC you will be working
4098with the compiled-in default environment - *silently*!!! [This is
4099necessary, because the first environment variable we need is the
4100"baudrate" setting for the console - if we have a bad CRC, we don't
4101have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004102
4103Note: once the monitor has been relocated, then it will complain if
4104the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004105use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004107- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004108 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004109
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004110 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004111 also needs to be defined.
4112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004113- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004114 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004115
Ron Madridf5675aa2009-02-18 14:30:44 -08004116- CONFIG_NS16550_MIN_FUNCTIONS:
4117 Define this if you desire to only have use of the NS16550_init
4118 and NS16550_putc functions for the serial driver located at
4119 drivers/serial/ns16550.c. This option is useful for saving
4120 space for already greatly restricted images, including but not
4121 limited to NAND_SPL configurations.
4122
Simon Glassb2b92f52012-11-30 13:01:18 +00004123- CONFIG_DISPLAY_BOARDINFO
4124 Display information about the board that U-Boot is running on
4125 when U-Boot starts up. The board function checkboard() is called
4126 to do this.
4127
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004128- CONFIG_DISPLAY_BOARDINFO_LATE
4129 Similar to the previous option, but display this information
4130 later, once stdio is running and output goes to the LCD, if
4131 present.
4132
wdenkc6097192002-11-03 00:24:07 +00004133Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004134---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004136- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004137 Cache Line Size of the CPU.
4138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004139- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004140 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004141
wdenk42d1f032003-10-15 23:53:47 +00004142 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4143 and RPXsuper) to be able to adjust the position of
4144 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004145
Timur Tabie46fedf2011-08-04 18:03:41 -05004146- CONFIG_SYS_CCSRBAR_DEFAULT:
4147 Default (power-on reset) physical address of CCSR on Freescale
4148 PowerPC SOCs.
4149
4150- CONFIG_SYS_CCSRBAR:
4151 Virtual address of CCSR. On a 32-bit build, this is typically
4152 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4153
4154 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4155 for cross-platform code that uses that macro instead.
4156
4157- CONFIG_SYS_CCSRBAR_PHYS:
4158 Physical address of CCSR. CCSR can be relocated to a new
4159 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004160 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004161 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4162 is typically relocated on 36-bit builds. It is recommended
4163 that this macro be defined via the _HIGH and _LOW macros:
4164
4165 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4166 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4167
4168- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004169 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4170 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004171 used in assembly code, so it must not contain typecasts or
4172 integer size suffixes (e.g. "ULL").
4173
4174- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4175 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4176 used in assembly code, so it must not contain typecasts or
4177 integer size suffixes (e.g. "ULL").
4178
4179- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4180 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4181 forced to a value that ensures that CCSR is not relocated.
4182
wdenk7f6c2cb2002-11-10 22:06:23 +00004183- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004184 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004185
4186 the default drive number (default value 0)
4187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004188 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004189
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004190 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004191 (default value 1)
4192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004193 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004194
wdenk43d96162003-03-06 00:02:04 +00004195 defines the offset of register from address. It
4196 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004197 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004199 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4200 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004201 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004203 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004204 fdc_hw_init() is called at the beginning of the FDC
4205 setup. fdc_hw_init() must be provided by the board
4206 source code. It is used to make hardware dependant
4207 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004208
Macpaul Lin0abddf82011-04-11 20:45:32 +00004209- CONFIG_IDE_AHB:
4210 Most IDE controllers were designed to be connected with PCI
4211 interface. Only few of them were designed for AHB interface.
4212 When software is doing ATA command and data transfer to
4213 IDE devices through IDE-AHB controller, some additional
4214 registers accessing to these kind of IDE-AHB controller
4215 is requierd.
4216
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004217- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004218 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004219 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004221- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004222
wdenk7152b1d2003-09-05 23:19:14 +00004223 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004224 initial data and stack; please note that this must be
4225 writable memory that is working WITHOUT special
4226 initialization, i. e. you CANNOT use normal RAM which
4227 will become available only after programming the
4228 memory controller and running certain initialization
4229 sequences.
4230
4231 U-Boot uses the following memory types:
4232 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4233 - MPC824X: data cache
4234 - PPC4xx: data cache
4235
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004236- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004237
4238 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004239 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4240 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004241 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004242 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004243 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4244 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4245 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004246
4247 Note:
4248 On the MPC824X (or other systems that use the data
4249 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004250 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004251 point to an otherwise UNUSED address space between
4252 the top of RAM and the start of the PCI space.
4253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004254- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004256- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004258- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004260- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004262- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004263
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004264- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004266- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004267 SDRAM timing
4268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004269- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004270 periodic timer for refresh
4271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004272- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004274- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4275 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4276 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4277 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004278 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4279
4280- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004281 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4282 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004283 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004285- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4286 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004287 Machine Mode Register and Memory Periodic Timer
4288 Prescaler definitions (SDRAM timing)
4289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004290- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004291 enable I2C microcode relocation patch (MPC8xx);
4292 define relocation offset in DPRAM [DSP2]
4293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004294- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004295 enable SMC microcode relocation patch (MPC8xx);
4296 define relocation offset in DPRAM [SMC1]
4297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004298- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004299 enable SPI microcode relocation patch (MPC8xx);
4300 define relocation offset in DPRAM [SCC4]
4301
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004302- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004303 Use OSCM clock mode on MBX8xx board. Be careful,
4304 wrong setting might damage your board. Read
4305 doc/README.MBX before setting this variable!
4306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004307- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004308 Offset of the bootmode word in DPRAM used by post
4309 (Power On Self Tests). This definition overrides
4310 #define'd default value in commproc.h resp.
4311 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004313- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4314 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4315 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4316 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4317 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4318 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4319 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4320 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004321 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004322
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004323- CONFIG_PCI_DISABLE_PCIE:
4324 Disable PCI-Express on systems where it is supported but not
4325 required.
4326
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004327- CONFIG_PCI_ENUM_ONLY
4328 Only scan through and get the devices on the busses.
4329 Don't do any setup work, presumably because someone or
4330 something has already done it, and we don't need to do it
4331 a second time. Useful for platforms that are pre-booted
4332 by coreboot or similar.
4333
Gabor Juhos842033e2013-05-30 07:06:12 +00004334- CONFIG_PCI_INDIRECT_BRIDGE:
4335 Enable support for indirect PCI bridges.
4336
Kumar Galaa09b9b62010-12-30 12:09:53 -06004337- CONFIG_SYS_SRIO:
4338 Chip has SRIO or not
4339
4340- CONFIG_SRIO1:
4341 Board has SRIO 1 port available
4342
4343- CONFIG_SRIO2:
4344 Board has SRIO 2 port available
4345
Liu Gangc8b28152013-05-07 16:30:46 +08004346- CONFIG_SRIO_PCIE_BOOT_MASTER
4347 Board can support master function for Boot from SRIO and PCIE
4348
Kumar Galaa09b9b62010-12-30 12:09:53 -06004349- CONFIG_SYS_SRIOn_MEM_VIRT:
4350 Virtual Address of SRIO port 'n' memory region
4351
4352- CONFIG_SYS_SRIOn_MEM_PHYS:
4353 Physical Address of SRIO port 'n' memory region
4354
4355- CONFIG_SYS_SRIOn_MEM_SIZE:
4356 Size of SRIO port 'n' memory region
4357
Fabio Estevam66bd1842013-04-11 09:35:34 +00004358- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4359 Defined to tell the NAND controller that the NAND chip is using
4360 a 16 bit bus.
4361 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004362 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004363 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004364 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004365
4366- CONFIG_SYS_NDFC_EBC0_CFG
4367 Sets the EBC0_CFG register for the NDFC. If not defined
4368 a default value will be used.
4369
Ben Warrenbb99ad62006-09-07 16:50:54 -04004370- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004371 Get DDR timing information from an I2C EEPROM. Common
4372 with pluggable memory modules such as SODIMMs
4373
Ben Warrenbb99ad62006-09-07 16:50:54 -04004374 SPD_EEPROM_ADDRESS
4375 I2C address of the SPD EEPROM
4376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004377- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004378 If SPD EEPROM is on an I2C bus other than the first
4379 one, specify here. Note that the value must resolve
4380 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004381
York Sun1b3e3c42011-06-07 09:42:16 +08004382- CONFIG_SYS_DDR_RAW_TIMING
4383 Get DDR timing information from other than SPD. Common with
4384 soldered DDR chips onboard without SPD. DDR raw timing
4385 parameters are extracted from datasheet and hard-coded into
4386 header files or board specific files.
4387
York Sun6f5e1dc2011-09-16 13:21:35 -07004388- CONFIG_FSL_DDR_INTERACTIVE
4389 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004391- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004392 Only for 83xx systems. If specified, then DDR should
4393 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004394
wdenkc26e4542004-04-18 10:13:26 +00004395- CONFIG_ETHER_ON_FEC[12]
4396 Define to enable FEC[12] on a 8xx series processor.
4397
4398- CONFIG_FEC[12]_PHY
4399 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004400 to the given FEC; i. e.
4401 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004402 means that the PHY with address 4 is connected to FEC1
4403
4404 When set to -1, means to probe for first available.
4405
4406- CONFIG_FEC[12]_PHY_NORXERR
4407 The PHY does not have a RXERR line (RMII only).
4408 (so program the FEC to ignore it).
4409
4410- CONFIG_RMII
4411 Enable RMII mode for all FECs.
4412 Note that this is a global option, we can't
4413 have one FEC in standard MII mode and another in RMII mode.
4414
wdenk5cf91d62004-04-23 20:32:05 +00004415- CONFIG_CRC32_VERIFY
4416 Add a verify option to the crc32 command.
4417 The syntax is:
4418
4419 => crc32 -v <address> <count> <crc32>
4420
4421 Where address/count indicate a memory area
4422 and crc32 is the correct crc32 which the
4423 area should have.
4424
wdenk56523f12004-07-11 17:40:54 +00004425- CONFIG_LOOPW
4426 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004427 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004428
stroese7b466642004-12-16 18:46:55 +00004429- CONFIG_MX_CYCLIC
4430 Add the "mdc" and "mwc" memory commands. These are cyclic
4431 "md/mw" commands.
4432 Examples:
4433
wdenkefe2a4d2004-12-16 21:44:03 +00004434 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004435 This command will print 4 bytes (10,11,12,13) each 500 ms.
4436
wdenkefe2a4d2004-12-16 21:44:03 +00004437 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004438 This command will write 12345678 to address 100 all 10 ms.
4439
wdenkefe2a4d2004-12-16 21:44:03 +00004440 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004441 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004442
wdenk8aa1a2d2005-04-04 12:44:11 +00004443- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004444 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004445 low level initializations (like setting up the memory
4446 controller) are omitted and/or U-Boot does not
4447 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004448
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004449 Normally this variable MUST NOT be defined. The only
4450 exception is when U-Boot is loaded (to RAM) by some
4451 other boot loader or by a debugger which performs
4452 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004453
Aneesh V401bb302011-07-13 05:11:07 +00004454- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004455 Modifies the behaviour of start.S when compiling a loader
4456 that is executed before the actual U-Boot. E.g. when
4457 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004458
Ying Zhang3aa29de2013-08-16 15:16:15 +08004459- CONFIG_TPL_BUILD
4460 Modifies the behaviour of start.S when compiling a loader
4461 that is executed after the SPL and before the actual U-Boot.
4462 It is loaded by the SPL.
4463
Ying Zhang5df572f2013-05-20 14:07:23 +08004464- CONFIG_SYS_MPC85XX_NO_RESETVEC
4465 Only for 85xx systems. If this variable is specified, the section
4466 .resetvec is not kept and the section .bootpg is placed in the
4467 previous 4k of the .text section.
4468
Simon Glass4213fc22013-02-24 17:33:14 +00004469- CONFIG_ARCH_MAP_SYSMEM
4470 Generally U-Boot (and in particular the md command) uses
4471 effective address. It is therefore not necessary to regard
4472 U-Boot address as virtual addresses that need to be translated
4473 to physical addresses. However, sandbox requires this, since
4474 it maintains its own little RAM buffer which contains all
4475 addressable memory. This option causes some memory accesses
4476 to be mapped through map_sysmem() / unmap_sysmem().
4477
Matthias Weisserd8834a12011-03-10 21:36:32 +00004478- CONFIG_USE_ARCH_MEMCPY
4479 CONFIG_USE_ARCH_MEMSET
4480 If these options are used a optimized version of memcpy/memset will
4481 be used if available. These functions may be faster under some
4482 conditions but may increase the binary size.
4483
Simon Glass588a13f2013-02-14 04:18:54 +00004484- CONFIG_X86_RESET_VECTOR
4485 If defined, the x86 reset vector code is included. This is not
4486 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004487
Mark Jacksonfc337052013-03-04 01:27:20 +00004488- CONFIG_SYS_MPUCLK
4489 Defines the MPU clock speed (in MHz).
4490
4491 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004492
Heiko Schocher16678eb2013-11-04 14:05:00 +01004493- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4494 Enables the RTC32K OSC on AM33xx based plattforms
4495
Timur Tabif2717b42011-11-22 09:21:25 -06004496Freescale QE/FMAN Firmware Support:
4497-----------------------------------
4498
4499The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4500loading of "firmware", which is encoded in the QE firmware binary format.
4501This firmware often needs to be loaded during U-Boot booting, so macros
4502are used to identify the storage device (NOR flash, SPI, etc) and the address
4503within that device.
4504
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004505- CONFIG_SYS_FMAN_FW_ADDR
4506 The address in the storage device where the FMAN microcode is located. The
4507 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4508 is also specified.
4509
4510- CONFIG_SYS_QE_FW_ADDR
4511 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004512 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4513 is also specified.
4514
4515- CONFIG_SYS_QE_FMAN_FW_LENGTH
4516 The maximum possible size of the firmware. The firmware binary format
4517 has a field that specifies the actual size of the firmware, but it
4518 might not be possible to read any part of the firmware unless some
4519 local storage is allocated to hold the entire firmware first.
4520
4521- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4522 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4523 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4524 virtual address in NOR flash.
4525
4526- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4527 Specifies that QE/FMAN firmware is located in NAND flash.
4528 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4529
4530- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4531 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4532 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4533
4534- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4535 Specifies that QE/FMAN firmware is located on the primary SPI
4536 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4537
Liu Gang292dc6c2012-03-08 00:33:18 +00004538- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4539 Specifies that QE/FMAN firmware is located in the remote (master)
4540 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004541 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4542 window->master inbound window->master LAW->the ucode address in
4543 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004544
wdenkc6097192002-11-03 00:24:07 +00004545Building the Software:
4546======================
4547
Wolfgang Denk218ca722008-03-26 10:40:12 +01004548Building U-Boot has been tested in several native build environments
4549and in many different cross environments. Of course we cannot support
4550all possibly existing versions of cross development tools in all
4551(potentially obsolete) versions. In case of tool chain problems we
4552recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4553which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004554
Wolfgang Denk218ca722008-03-26 10:40:12 +01004555If you are not using a native environment, it is assumed that you
4556have GNU cross compiling tools available in your path. In this case,
4557you must set the environment variable CROSS_COMPILE in your shell.
4558Note that no changes to the Makefile or any other source files are
4559necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004560
Wolfgang Denk218ca722008-03-26 10:40:12 +01004561 $ CROSS_COMPILE=ppc_4xx-
4562 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004563
Peter Tyser2f8d3962009-03-13 18:54:51 -05004564Note: If you wish to generate Windows versions of the utilities in
4565 the tools directory you can use the MinGW toolchain
4566 (http://www.mingw.org). Set your HOST tools to the MinGW
4567 toolchain and execute 'make tools'. For example:
4568
4569 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4570
4571 Binaries such as tools/mkimage.exe will be created which can
4572 be executed on computers running Windows.
4573
Wolfgang Denk218ca722008-03-26 10:40:12 +01004574U-Boot is intended to be simple to build. After installing the
4575sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004576is done by typing:
4577
4578 make NAME_config
4579
Wolfgang Denk218ca722008-03-26 10:40:12 +01004580where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004581rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583Note: for some board special configuration names may exist; check if
4584 additional information is available from the board vendor; for
4585 instance, the TQM823L systems are available without (standard)
4586 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004587 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004588
wdenk2729af92004-05-03 20:45:30 +00004589 make TQM823L_config
4590 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004591
wdenk2729af92004-05-03 20:45:30 +00004592 make TQM823L_LCD_config
4593 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk2729af92004-05-03 20:45:30 +00004595 etc.
wdenkc6097192002-11-03 00:24:07 +00004596
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598Finally, type "make all", and you should get some working U-Boot
4599images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004600
wdenk2729af92004-05-03 20:45:30 +00004601- "u-boot.bin" is a raw binary image
4602- "u-boot" is an image in ELF binary format
4603- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004604
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004605By default the build is performed locally and the objects are saved
4606in the source directory. One of the two methods can be used to change
4607this behavior and build U-Boot to some external directory:
4608
46091. Add O= to the make command line invocations:
4610
4611 make O=/tmp/build distclean
4612 make O=/tmp/build NAME_config
4613 make O=/tmp/build all
4614
46152. Set environment variable BUILD_DIR to point to the desired location:
4616
4617 export BUILD_DIR=/tmp/build
4618 make distclean
4619 make NAME_config
4620 make all
4621
4622Note that the command line "O=" setting overrides the BUILD_DIR environment
4623variable.
4624
wdenkc6097192002-11-03 00:24:07 +00004625
wdenk2729af92004-05-03 20:45:30 +00004626Please be aware that the Makefiles assume you are using GNU make, so
4627for instance on NetBSD you might need to use "gmake" instead of
4628native "make".
wdenkc6097192002-11-03 00:24:07 +00004629
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk2729af92004-05-03 20:45:30 +00004631If the system board that you have is not listed, then you will need
4632to port U-Boot to your hardware platform. To do this, follow these
4633steps:
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk2729af92004-05-03 20:45:30 +000046351. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004636 "boards.cfg" file, using the existing entries as examples.
4637 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000046382. Create a new directory to hold your board specific code. Add any
4639 files you need. In your board directory, you will need at least
4640 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
46413. Create a new configuration file "include/configs/<board>.h" for
4642 your board
46433. If you're porting U-Boot to a new CPU, then also create a new
4644 directory to hold your CPU specific code. Add any files you need.
46454. Run "make <board>_config" with your new name.
46465. Type "make", and you should get a working "u-boot.srec" file
4647 to be installed on your target system.
46486. Debug and solve any problems that might arise.
4649 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004650
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk2729af92004-05-03 20:45:30 +00004652Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4653==============================================================
wdenkc6097192002-11-03 00:24:07 +00004654
Wolfgang Denk218ca722008-03-26 10:40:12 +01004655If you have modified U-Boot sources (for instance added a new board
4656or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004657provide feedback to the other developers. The feedback normally takes
4658the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004659official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004660
Wolfgang Denk218ca722008-03-26 10:40:12 +01004661But before you submit such a patch, please verify that your modifi-
4662cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004663the supported boards compile WITHOUT ANY compiler warnings. To do so,
4664just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004665for ALL supported system. Be warned, this will take a while. You can
4666select which (cross) compiler to use by passing a `CROSS_COMPILE'
4667environment variable to the script, i. e. to use the ELDK cross tools
4668you can type
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk2729af92004-05-03 20:45:30 +00004670 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk2729af92004-05-03 20:45:30 +00004674 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004675
Wolfgang Denk218ca722008-03-26 10:40:12 +01004676When using the MAKEALL script, the default behaviour is to build
4677U-Boot in the source directory. This location can be changed by
4678setting the BUILD_DIR environment variable. Also, for each target
4679built, the MAKEALL script saves two log files (<target>.ERR and
4680<target>.MAKEALL) in the <source dir>/LOG directory. This default
4681location can be changed by setting the MAKEALL_LOGDIR environment
4682variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004683
4684 export BUILD_DIR=/tmp/build
4685 export MAKEALL_LOGDIR=/tmp/log
4686 CROSS_COMPILE=ppc_8xx- MAKEALL
4687
Wolfgang Denk218ca722008-03-26 10:40:12 +01004688With the above settings build objects are saved in the /tmp/build,
4689log files are saved in the /tmp/log and the source tree remains clean
4690during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004691
4692
wdenk2729af92004-05-03 20:45:30 +00004693See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004694
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk2729af92004-05-03 20:45:30 +00004696Monitor Commands - Overview:
4697============================
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk2729af92004-05-03 20:45:30 +00004699go - start application at address 'addr'
4700run - run commands in an environment variable
4701bootm - boot application image from memory
4702bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004703bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004704tftpboot- boot image via network using TFTP protocol
4705 and env variables "ipaddr" and "serverip"
4706 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004707tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004708rarpboot- boot image via network using RARP/TFTP protocol
4709diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4710loads - load S-Record file over serial line
4711loadb - load binary file over serial line (kermit mode)
4712md - memory display
4713mm - memory modify (auto-incrementing)
4714nm - memory modify (constant address)
4715mw - memory write (fill)
4716cp - memory copy
4717cmp - memory compare
4718crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004719i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004720sspi - SPI utility commands
4721base - print or set address offset
4722printenv- print environment variables
4723setenv - set environment variables
4724saveenv - save environment variables to persistent storage
4725protect - enable or disable FLASH write protection
4726erase - erase FLASH memory
4727flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004728nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004729bdinfo - print Board Info structure
4730iminfo - print header information for application image
4731coninfo - print console devices and informations
4732ide - IDE sub-system
4733loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004734loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004735mtest - simple RAM test
4736icache - enable or disable instruction cache
4737dcache - enable or disable data cache
4738reset - Perform RESET of the CPU
4739echo - echo args to console
4740version - print monitor version
4741help - print online help
4742? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004743
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk2729af92004-05-03 20:45:30 +00004745Monitor Commands - Detailed Description:
4746========================================
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748TODO.
wdenkc6097192002-11-03 00:24:07 +00004749
wdenk2729af92004-05-03 20:45:30 +00004750For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004751
4752
wdenk2729af92004-05-03 20:45:30 +00004753Environment Variables:
4754======================
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk2729af92004-05-03 20:45:30 +00004756U-Boot supports user configuration using Environment Variables which
4757can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk2729af92004-05-03 20:45:30 +00004759Environment Variables are set using "setenv", printed using
4760"printenv", and saved to Flash using "saveenv". Using "setenv"
4761without a value can be used to delete a variable from the
4762environment. As long as you don't save the environment you are
4763working with an in-memory copy. In case the Flash area containing the
4764environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004765
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004766Some configuration options can be set using Environment Variables.
4767
4768List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk2729af92004-05-03 20:45:30 +00004770 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk2729af92004-05-03 20:45:30 +00004772 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk2729af92004-05-03 20:45:30 +00004776 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk2729af92004-05-03 20:45:30 +00004778 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004779
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004780 bootm_low - Memory range available for image processing in the bootm
4781 command can be restricted. This variable is given as
4782 a hexadecimal number and defines lowest address allowed
4783 for use by the bootm command. See also "bootm_size"
4784 environment variable. Address defined by "bootm_low" is
4785 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004786 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4787 bootm_mapsize.
4788
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004789 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004790 This variable is given as a hexadecimal number and it
4791 defines the size of the memory region starting at base
4792 address bootm_low that is accessible by the Linux kernel
4793 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4794 as the default value if it is defined, and bootm_size is
4795 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004796
4797 bootm_size - Memory range available for image processing in the bootm
4798 command can be restricted. This variable is given as
4799 a hexadecimal number and defines the size of the region
4800 allowed for use by the bootm command. See also "bootm_low"
4801 environment variable.
4802
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004803 updatefile - Location of the software update file on a TFTP server, used
4804 by the automatic software update feature. Please refer to
4805 documentation in doc/README.update for more details.
4806
wdenk2729af92004-05-03 20:45:30 +00004807 autoload - if set to "no" (any string beginning with 'n'),
4808 "bootp" will just load perform a lookup of the
4809 configuration from the BOOTP server, but not try to
4810 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk2729af92004-05-03 20:45:30 +00004812 autostart - if set to "yes", an image loaded using the "bootp",
4813 "rarpboot", "tftpboot" or "diskboot" commands will
4814 be automatically started (by internally calling
4815 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk2729af92004-05-03 20:45:30 +00004817 If set to "no", a standalone image passed to the
4818 "bootm" command will be copied to the load address
4819 (and eventually uncompressed), but NOT be started.
4820 This can be used to load and uncompress arbitrary
4821 data.
wdenkc6097192002-11-03 00:24:07 +00004822
David A. Longa28afca2011-07-09 16:40:19 -04004823 fdt_high - if set this restricts the maximum address that the
4824 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004825 For example, if you have a system with 1 GB memory
4826 at physical address 0x10000000, while Linux kernel
4827 only recognizes the first 704 MB as low memory, you
4828 may need to set fdt_high as 0x3C000000 to have the
4829 device tree blob be copied to the maximum address
4830 of the 704 MB low memory, so that Linux kernel can
4831 access it during the boot procedure.
4832
David A. Longa28afca2011-07-09 16:40:19 -04004833 If this is set to the special value 0xFFFFFFFF then
4834 the fdt will not be copied at all on boot. For this
4835 to work it must reside in writable memory, have
4836 sufficient padding on the end of it for u-boot to
4837 add the information it needs into it, and the memory
4838 must be accessible by the kernel.
4839
Simon Glasseea63e02011-10-24 19:15:34 +00004840 fdtcontroladdr- if set this is the address of the control flattened
4841 device tree used by U-Boot when CONFIG_OF_CONTROL is
4842 defined.
4843
wdenk17ea1172004-06-06 21:51:03 +00004844 i2cfast - (PPC405GP|PPC405EP only)
4845 if set to 'y' configures Linux I2C driver for fast
4846 mode (400kHZ). This environment variable is used in
4847 initialization code. So, for changes to be effective
4848 it must be saved and board must be reset.
4849
wdenk2729af92004-05-03 20:45:30 +00004850 initrd_high - restrict positioning of initrd images:
4851 If this variable is not set, initrd images will be
4852 copied to the highest possible address in RAM; this
4853 is usually what you want since it allows for
4854 maximum initrd size. If for some reason you want to
4855 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004856 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004857 variable to a value of "no" or "off" or "0".
4858 Alternatively, you can set it to a maximum upper
4859 address to use (U-Boot will still check that it
4860 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862 For instance, when you have a system with 16 MB
4863 RAM, and want to reserve 4 MB from use by Linux,
4864 you can do this by adding "mem=12M" to the value of
4865 the "bootargs" variable. However, now you must make
4866 sure that the initrd image is placed in the first
4867 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk2729af92004-05-03 20:45:30 +00004871 If you set initrd_high to 0xFFFFFFFF, this is an
4872 indication to U-Boot that all addresses are legal
4873 for the Linux kernel, including addresses in flash
4874 memory. In this case U-Boot will NOT COPY the
4875 ramdisk at all. This may be useful to reduce the
4876 boot time on your system, but requires that this
4877 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004878
wdenk2729af92004-05-03 20:45:30 +00004879 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk2729af92004-05-03 20:45:30 +00004881 loadaddr - Default load address for commands like "bootp",
4882 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk2729af92004-05-03 20:45:30 +00004884 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk2729af92004-05-03 20:45:30 +00004886 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004887
wdenk2729af92004-05-03 20:45:30 +00004888 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk2729af92004-05-03 20:45:30 +00004892 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004893
Mike Frysingere2a53452011-10-02 10:01:27 +00004894 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004895
Mike Frysingere2a53452011-10-02 10:01:27 +00004896 ethact - controls which interface is currently active.
4897 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004898
Heiko Schocher48690d82010-07-20 17:45:02 +02004899 => setenv ethact FEC
4900 => ping 192.168.0.1 # traffic sent on FEC
4901 => setenv ethact SCC
4902 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004903
Matthias Fuchse1692572008-01-17 07:45:05 +01004904 ethrotate - When set to "no" U-Boot does not go through all
4905 available network interfaces.
4906 It just stays at the currently selected interface.
4907
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004908 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004909 either succeed or fail without retrying.
4910 When set to "once" the network operation will
4911 fail when all the available network interfaces
4912 are tried once without success.
4913 Useful on scripts which control the retry operation
4914 themselves.
wdenkc6097192002-11-03 00:24:07 +00004915
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004916 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004917
Simon Glass8d51aac2013-07-16 20:10:00 -07004918 silent_linux - If set then linux will be told to boot silently, by
4919 changing the console to be empty. If "yes" it will be
4920 made silent. If "no" it will not be made silent. If
4921 unset, then it will be made silent if the U-Boot console
4922 is silent.
4923
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004924 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004925 UDP source port.
4926
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004927 tftpdstport - If this is set, the value is used for TFTP's UDP
4928 destination port instead of the Well Know Port 69.
4929
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004930 tftpblocksize - Block size to use for TFTP transfers; if not set,
4931 we use the TFTP server's default block size
4932
4933 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4934 seconds, minimum value is 1000 = 1 second). Defines
4935 when a packet is considered to be lost so it has to
4936 be retransmitted. The default is 5000 = 5 seconds.
4937 Lowering this value may make downloads succeed
4938 faster in networks with high packet loss rates or
4939 with unreliable TFTP servers.
4940
4941 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004942 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004943 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004944
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004945The following image location variables contain the location of images
4946used in booting. The "Image" column gives the role of the image and is
4947not an environment variable name. The other columns are environment
4948variable names. "File Name" gives the name of the file on a TFTP
4949server, "RAM Address" gives the location in RAM the image will be
4950loaded to, and "Flash Location" gives the image's address in NOR
4951flash or offset in NAND flash.
4952
4953*Note* - these variables don't have to be defined for all boards, some
4954boards currenlty use other variables for these purposes, and some
4955boards use these variables for other purposes.
4956
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004957Image File Name RAM Address Flash Location
4958----- --------- ----------- --------------
4959u-boot u-boot u-boot_addr_r u-boot_addr
4960Linux kernel bootfile kernel_addr_r kernel_addr
4961device tree blob fdtfile fdt_addr_r fdt_addr
4962ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004963
wdenk2729af92004-05-03 20:45:30 +00004964The following environment variables may be used and automatically
4965updated by the network boot commands ("bootp" and "rarpboot"),
4966depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004967
wdenk2729af92004-05-03 20:45:30 +00004968 bootfile - see above
4969 dnsip - IP address of your Domain Name Server
4970 dnsip2 - IP address of your secondary Domain Name Server
4971 gatewayip - IP address of the Gateway (Router) to use
4972 hostname - Target hostname
4973 ipaddr - see above
4974 netmask - Subnet Mask
4975 rootpath - Pathname of the root filesystem on the NFS server
4976 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004977
wdenka3d991b2004-04-15 21:48:45 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981 serial# - contains hardware identification information such
4982 as type string and/or serial number
4983 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004984
wdenk2729af92004-05-03 20:45:30 +00004985These variables can be set only once (usually during manufacturing of
4986the board). U-Boot refuses to delete or overwrite these variables
4987once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004988
4989
wdenk2729af92004-05-03 20:45:30 +00004990Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992 ver - Contains the U-Boot version string as printed
4993 with the "version" command. This variable is
4994 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004995
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997Please note that changes to some configuration parameters may take
4998only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004999
stroesec1551ea2003-04-04 15:53:41 +00005000
Joe Hershberger170ab112012-12-11 22:16:24 -06005001Callback functions for environment variables:
5002---------------------------------------------
5003
5004For some environment variables, the behavior of u-boot needs to change
5005when their values are changed. This functionailty allows functions to
5006be associated with arbitrary variables. On creation, overwrite, or
5007deletion, the callback will provide the opportunity for some side
5008effect to happen or for the change to be rejected.
5009
5010The callbacks are named and associated with a function using the
5011U_BOOT_ENV_CALLBACK macro in your board or driver code.
5012
5013These callbacks are associated with variables in one of two ways. The
5014static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5015in the board configuration to a string that defines a list of
5016associations. The list must be in the following format:
5017
5018 entry = variable_name[:callback_name]
5019 list = entry[,list]
5020
5021If the callback name is not specified, then the callback is deleted.
5022Spaces are also allowed anywhere in the list.
5023
5024Callbacks can also be associated by defining the ".callbacks" variable
5025with the same list format above. Any association in ".callbacks" will
5026override any association in the static list. You can define
5027CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5028".callbacks" envirnoment variable in the default or embedded environment.
5029
5030
wdenk2729af92004-05-03 20:45:30 +00005031Command Line Parsing:
5032=====================
stroesec1551ea2003-04-04 15:53:41 +00005033
wdenk2729af92004-05-03 20:45:30 +00005034There are two different command line parsers available with U-Boot:
5035the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005036
wdenk2729af92004-05-03 20:45:30 +00005037Old, simple command line parser:
5038--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk2729af92004-05-03 20:45:30 +00005040- supports environment variables (through setenv / saveenv commands)
5041- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005042- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005043- special characters ('$', ';') can be escaped by prefixing with '\',
5044 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005045 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005046- You can also escape text by enclosing in single apostrophes, for example:
5047 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk2729af92004-05-03 20:45:30 +00005049Hush shell:
5050-----------
wdenkf07771c2003-05-28 08:06:31 +00005051
wdenk2729af92004-05-03 20:45:30 +00005052- similar to Bourne shell, with control structures like
5053 if...then...else...fi, for...do...done; while...do...done,
5054 until...do...done, ...
5055- supports environment ("global") variables (through setenv / saveenv
5056 commands) and local shell variables (through standard shell syntax
5057 "name=value"); only environment variables can be used with "run"
5058 command
wdenkf07771c2003-05-28 08:06:31 +00005059
wdenk2729af92004-05-03 20:45:30 +00005060General rules:
5061--------------
wdenkf07771c2003-05-28 08:06:31 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063(1) If a command line (or an environment variable executed by a "run"
5064 command) contains several commands separated by semicolon, and
5065 one of these commands fails, then the remaining commands will be
5066 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005067
wdenk2729af92004-05-03 20:45:30 +00005068(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005069 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005070 command will cause "run" to terminate, i. e. the remaining
5071 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005072
wdenk2729af92004-05-03 20:45:30 +00005073Note for Redundant Ethernet Interfaces:
5074=======================================
wdenkf07771c2003-05-28 08:06:31 +00005075
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005076Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005077such configurations and is capable of automatic selection of a
5078"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5081MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5082"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084If the network interface stores some valid MAC address (for instance
5085in SROM), this is used as default address if there is NO correspon-
5086ding setting in the environment; if the corresponding environment
5087variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089o If the SROM has a valid MAC address, and there is no address in the
5090 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092o If there is no valid address in the SROM, and a definition in the
5093 environment exists, then the value from the environment variable is
5094 used.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk2729af92004-05-03 20:45:30 +00005096o If both the SROM and the environment contain a MAC address, and
5097 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005098
wdenk2729af92004-05-03 20:45:30 +00005099o If both the SROM and the environment contain a MAC address, and the
5100 addresses differ, the value from the environment is used and a
5101 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005102
wdenk2729af92004-05-03 20:45:30 +00005103o If neither SROM nor the environment contain a MAC address, an error
5104 is raised.
wdenkc6097192002-11-03 00:24:07 +00005105
Ben Warrenecee9322010-04-26 11:11:46 -07005106If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005107will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005108may be skipped by setting the appropriate 'ethmacskip' environment variable.
5109The naming convention is as follows:
5110"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112Image Formats:
5113==============
wdenkc6097192002-11-03 00:24:07 +00005114
Marian Balakowicz3310c542008-03-12 12:13:13 +01005115U-Boot is capable of booting (and performing other auxiliary operations on)
5116images in two formats:
5117
5118New uImage format (FIT)
5119-----------------------
5120
5121Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5122to Flattened Device Tree). It allows the use of images with multiple
5123components (several kernels, ramdisks, etc.), with contents protected by
5124SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5125
5126
5127Old uImage format
5128-----------------
5129
5130Old image format is based on binary files which can be basically anything,
5131preceded by a special header; see the definitions in include/image.h for
5132details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk2729af92004-05-03 20:45:30 +00005134* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5135 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005136 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5137 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5138 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005139* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005140 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5141 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005142* Compression Type (uncompressed, gzip, bzip2)
5143* Load Address
5144* Entry Point
5145* Image Name
5146* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148The header is marked by a special Magic Number, and both the header
5149and the data portions of the image are secured against corruption by
5150CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005151
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk2729af92004-05-03 20:45:30 +00005153Linux Support:
5154==============
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156Although U-Boot should support any OS or standalone application
5157easily, the main focus has always been on Linux during the design of
5158U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk2729af92004-05-03 20:45:30 +00005160U-Boot includes many features that so far have been part of some
5161special "boot loader" code within the Linux kernel. Also, any
5162"initrd" images to be used are no longer part of one big Linux image;
5163instead, kernel and "initrd" are separate images. This implementation
5164serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk2729af92004-05-03 20:45:30 +00005166- the same features can be used for other OS or standalone
5167 applications (for instance: using compressed images to reduce the
5168 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk2729af92004-05-03 20:45:30 +00005170- it becomes much easier to port new Linux kernel versions because
5171 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173- the same Linux kernel image can now be used with different "initrd"
5174 images; of course this also means that different kernel images can
5175 be run with the same "initrd". This makes testing easier (you don't
5176 have to build a new "zImage.initrd" Linux image when you just
5177 change a file in your "initrd"). Also, a field-upgrade of the
5178 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005179
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk2729af92004-05-03 20:45:30 +00005181Linux HOWTO:
5182============
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk2729af92004-05-03 20:45:30 +00005184Porting Linux to U-Boot based systems:
5185---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187U-Boot cannot save you from doing all the necessary modifications to
5188configure the Linux device drivers for use with your target hardware
5189(no, we don't intend to provide a full virtual machine interface to
5190Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005191
Stefan Roesea47a12b2010-04-15 16:07:28 +02005192But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk2729af92004-05-03 20:45:30 +00005194Just make sure your machine specific header file (for instance
5195include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005196Information structure as we define in include/asm-<arch>/u-boot.h,
5197and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005198as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005199
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk2729af92004-05-03 20:45:30 +00005201Configuring the Linux kernel:
5202-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204No specific requirements for U-Boot. Make sure you have some root
5205device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005206
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk2729af92004-05-03 20:45:30 +00005208Building a Linux Image:
5209-----------------------
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk2729af92004-05-03 20:45:30 +00005211With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5212not used. If you use recent kernel source, a new build target
5213"uImage" will exist which automatically builds an image usable by
5214U-Boot. Most older kernels also have support for a "pImage" target,
5215which was introduced for our predecessor project PPCBoot and uses a
5216100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk2729af92004-05-03 20:45:30 +00005218Example:
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk2729af92004-05-03 20:45:30 +00005220 make TQM850L_config
5221 make oldconfig
5222 make dep
5223 make uImage
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk2729af92004-05-03 20:45:30 +00005225The "uImage" build target uses a special tool (in 'tools/mkimage') to
5226encapsulate a compressed Linux kernel image with header information,
5227CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk2729af92004-05-03 20:45:30 +00005229* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk2729af92004-05-03 20:45:30 +00005233 ${CROSS_COMPILE}-objcopy -O binary \
5234 -R .note -R .comment \
5235 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk2729af92004-05-03 20:45:30 +00005237* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk2729af92004-05-03 20:45:30 +00005239 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005242
wdenk2729af92004-05-03 20:45:30 +00005243 mkimage -A ppc -O linux -T kernel -C gzip \
5244 -a 0 -e 0 -n "Linux Kernel Image" \
5245 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005246
wdenk24ee89b2002-11-03 17:56:27 +00005247
wdenk2729af92004-05-03 20:45:30 +00005248The "mkimage" tool can also be used to create ramdisk images for use
5249with U-Boot, either separated from the Linux kernel image, or
5250combined into one file. "mkimage" encapsulates the images with a 64
5251byte header containing information about target architecture,
5252operating system, image type, compression method, entry points, time
5253stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005254
wdenk2729af92004-05-03 20:45:30 +00005255"mkimage" can be called in two ways: to verify existing images and
5256print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258In the first form (with "-l" option) mkimage lists the information
5259contained in the header of an existing U-Boot image; this includes
5260checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262 tools/mkimage -l image
5263 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005264
wdenk2729af92004-05-03 20:45:30 +00005265The second form (with "-d" option) is used to build a U-Boot image
5266from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005267
wdenk2729af92004-05-03 20:45:30 +00005268 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5269 -n name -d data_file image
5270 -A ==> set architecture to 'arch'
5271 -O ==> set operating system to 'os'
5272 -T ==> set image type to 'type'
5273 -C ==> set compression type 'comp'
5274 -a ==> set load address to 'addr' (hex)
5275 -e ==> set entry point to 'ep' (hex)
5276 -n ==> set image name to 'name'
5277 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005278
wdenk69459792004-05-29 16:53:29 +00005279Right now, all Linux kernels for PowerPC systems use the same load
5280address (0x00000000), but the entry point address depends on the
5281kernel version:
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk2729af92004-05-03 20:45:30 +00005283- 2.2.x kernels have the entry point at 0x0000000C,
5284- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk2729af92004-05-03 20:45:30 +00005286So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5289 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005290 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005291 > examples/uImage.TQM850L
5292 Image Name: 2.4.4 kernel for TQM850L
5293 Created: Wed Jul 19 02:34:59 2000
5294 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5295 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5296 Load Address: 0x00000000
5297 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk2729af92004-05-03 20:45:30 +00005299To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301 -> tools/mkimage -l examples/uImage.TQM850L
5302 Image Name: 2.4.4 kernel for TQM850L
5303 Created: Wed Jul 19 02:34:59 2000
5304 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5305 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5306 Load Address: 0x00000000
5307 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk2729af92004-05-03 20:45:30 +00005309NOTE: for embedded systems where boot time is critical you can trade
5310speed for memory and install an UNCOMPRESSED image instead: this
5311needs more space in Flash, but boots much faster since it does not
5312need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005313
Stefan Roesea47a12b2010-04-15 16:07:28 +02005314 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005315 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5316 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005317 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005318 > examples/uImage.TQM850L-uncompressed
5319 Image Name: 2.4.4 kernel for TQM850L
5320 Created: Wed Jul 19 02:34:59 2000
5321 Image Type: PowerPC Linux Kernel Image (uncompressed)
5322 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5323 Load Address: 0x00000000
5324 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005325
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk2729af92004-05-03 20:45:30 +00005327Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5328when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005329
wdenk2729af92004-05-03 20:45:30 +00005330 -> tools/mkimage -n 'Simple Ramdisk Image' \
5331 > -A ppc -O linux -T ramdisk -C gzip \
5332 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5333 Image Name: Simple Ramdisk Image
5334 Created: Wed Jan 12 14:01:50 2000
5335 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5336 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5337 Load Address: 0x00000000
5338 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005339
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005340The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5341option performs the converse operation of the mkimage's second form (the "-d"
5342option). Given an image built by mkimage, the dumpimage extracts a "data file"
5343from the image:
5344
5345 tools/dumpimage -i image -p position data_file
5346 -i ==> extract from the 'image' a specific 'data_file', \
5347 indexed by 'position'
5348
wdenkdb01a2e2004-04-15 23:14:49 +00005349
wdenk2729af92004-05-03 20:45:30 +00005350Installing a Linux Image:
5351-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005352
wdenk2729af92004-05-03 20:45:30 +00005353To downloading a U-Boot image over the serial (console) interface,
5354you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005355
wdenk2729af92004-05-03 20:45:30 +00005356 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005357
wdenk2729af92004-05-03 20:45:30 +00005358The 'objcopy' does not understand the information in the U-Boot
5359image header, so the resulting S-Record file will be relative to
5360address 0x00000000. To load it to a given address, you need to
5361specify the target address as 'offset' parameter with the 'loads'
5362command.
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364Example: install the image to address 0x40100000 (which on the
5365TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 .......... done
5370 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372 => loads 40100000
5373 ## Ready for S-Record download ...
5374 ~>examples/image.srec
5375 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5376 ...
5377 15989 15990 15991 15992
5378 [file transfer complete]
5379 [connected]
5380 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005381
5382
wdenk2729af92004-05-03 20:45:30 +00005383You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005384this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005385corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk2729af92004-05-03 20:45:30 +00005387 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk2729af92004-05-03 20:45:30 +00005389 ## Checking Image at 40100000 ...
5390 Image Name: 2.2.13 for initrd on TQM850L
5391 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5392 Data Size: 335725 Bytes = 327 kB = 0 MB
5393 Load Address: 00000000
5394 Entry Point: 0000000c
5395 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005396
5397
wdenk2729af92004-05-03 20:45:30 +00005398Boot Linux:
5399-----------
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401The "bootm" command is used to boot an application that is stored in
5402memory (RAM or Flash). In case of a Linux kernel image, the contents
5403of the "bootargs" environment variable is passed to the kernel as
5404parameters. You can check and modify this variable using the
5405"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005406
5407
wdenk2729af92004-05-03 20:45:30 +00005408 => printenv bootargs
5409 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk2729af92004-05-03 20:45:30 +00005411 => 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 +00005412
wdenk2729af92004-05-03 20:45:30 +00005413 => printenv bootargs
5414 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 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416 => bootm 40020000
5417 ## Booting Linux kernel at 40020000 ...
5418 Image Name: 2.2.13 for NFS on TQM850L
5419 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5420 Data Size: 381681 Bytes = 372 kB = 0 MB
5421 Load Address: 00000000
5422 Entry Point: 0000000c
5423 Verifying Checksum ... OK
5424 Uncompressing Kernel Image ... OK
5425 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
5426 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5427 time_init: decrementer frequency = 187500000/60
5428 Calibrating delay loop... 49.77 BogoMIPS
5429 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5430 ...
wdenkc6097192002-11-03 00:24:07 +00005431
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005432If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005433the memory addresses of both the kernel and the initrd image (PPBCOOT
5434format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk2729af92004-05-03 20:45:30 +00005436 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk2729af92004-05-03 20:45:30 +00005438 ## Checking Image at 40100000 ...
5439 Image Name: 2.2.13 for initrd on TQM850L
5440 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5441 Data Size: 335725 Bytes = 327 kB = 0 MB
5442 Load Address: 00000000
5443 Entry Point: 0000000c
5444 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446 ## Checking Image at 40200000 ...
5447 Image Name: Simple Ramdisk Image
5448 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5449 Data Size: 566530 Bytes = 553 kB = 0 MB
5450 Load Address: 00000000
5451 Entry Point: 00000000
5452 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005453
wdenk2729af92004-05-03 20:45:30 +00005454 => bootm 40100000 40200000
5455 ## Booting Linux kernel at 40100000 ...
5456 Image Name: 2.2.13 for initrd on TQM850L
5457 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5458 Data Size: 335725 Bytes = 327 kB = 0 MB
5459 Load Address: 00000000
5460 Entry Point: 0000000c
5461 Verifying Checksum ... OK
5462 Uncompressing Kernel Image ... OK
5463 ## Loading RAMDisk Image at 40200000 ...
5464 Image Name: Simple Ramdisk Image
5465 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5466 Data Size: 566530 Bytes = 553 kB = 0 MB
5467 Load Address: 00000000
5468 Entry Point: 00000000
5469 Verifying Checksum ... OK
5470 Loading Ramdisk ... OK
5471 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
5472 Boot arguments: root=/dev/ram
5473 time_init: decrementer frequency = 187500000/60
5474 Calibrating delay loop... 49.77 BogoMIPS
5475 ...
5476 RAMDISK: Compressed image found at block 0
5477 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005478
wdenk2729af92004-05-03 20:45:30 +00005479 bash#
wdenkc6097192002-11-03 00:24:07 +00005480
Matthew McClintock02677682006-06-28 10:41:37 -05005481Boot Linux and pass a flat device tree:
5482-----------
5483
5484First, U-Boot must be compiled with the appropriate defines. See the section
5485titled "Linux Kernel Interface" above for a more in depth explanation. The
5486following is an example of how to start a kernel and pass an updated
5487flat device tree:
5488
5489=> print oftaddr
5490oftaddr=0x300000
5491=> print oft
5492oft=oftrees/mpc8540ads.dtb
5493=> tftp $oftaddr $oft
5494Speed: 1000, full duplex
5495Using TSEC0 device
5496TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5497Filename 'oftrees/mpc8540ads.dtb'.
5498Load address: 0x300000
5499Loading: #
5500done
5501Bytes transferred = 4106 (100a hex)
5502=> tftp $loadaddr $bootfile
5503Speed: 1000, full duplex
5504Using TSEC0 device
5505TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5506Filename 'uImage'.
5507Load address: 0x200000
5508Loading:############
5509done
5510Bytes transferred = 1029407 (fb51f hex)
5511=> print loadaddr
5512loadaddr=200000
5513=> print oftaddr
5514oftaddr=0x300000
5515=> bootm $loadaddr - $oftaddr
5516## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005517 Image Name: Linux-2.6.17-dirty
5518 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5519 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005520 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005521 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005522 Verifying Checksum ... OK
5523 Uncompressing Kernel Image ... OK
5524Booting using flat device tree at 0x300000
5525Using MPC85xx ADS machine description
5526Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5527[snip]
5528
5529
wdenk2729af92004-05-03 20:45:30 +00005530More About U-Boot Image Types:
5531------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005532
wdenk2729af92004-05-03 20:45:30 +00005533U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005534
wdenk2729af92004-05-03 20:45:30 +00005535 "Standalone Programs" are directly runnable in the environment
5536 provided by U-Boot; it is expected that (if they behave
5537 well) you can continue to work in U-Boot after return from
5538 the Standalone Program.
5539 "OS Kernel Images" are usually images of some Embedded OS which
5540 will take over control completely. Usually these programs
5541 will install their own set of exception handlers, device
5542 drivers, set up the MMU, etc. - this means, that you cannot
5543 expect to re-enter U-Boot except by resetting the CPU.
5544 "RAMDisk Images" are more or less just data blocks, and their
5545 parameters (address, size) are passed to an OS kernel that is
5546 being started.
5547 "Multi-File Images" contain several images, typically an OS
5548 (Linux) kernel image and one or more data images like
5549 RAMDisks. This construct is useful for instance when you want
5550 to boot over the network using BOOTP etc., where the boot
5551 server provides just a single image file, but you want to get
5552 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005553
wdenk2729af92004-05-03 20:45:30 +00005554 "Multi-File Images" start with a list of image sizes, each
5555 image size (in bytes) specified by an "uint32_t" in network
5556 byte order. This list is terminated by an "(uint32_t)0".
5557 Immediately after the terminating 0 follow the images, one by
5558 one, all aligned on "uint32_t" boundaries (size rounded up to
5559 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005560
wdenk2729af92004-05-03 20:45:30 +00005561 "Firmware Images" are binary images containing firmware (like
5562 U-Boot or FPGA images) which usually will be programmed to
5563 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005564
wdenk2729af92004-05-03 20:45:30 +00005565 "Script files" are command sequences that will be executed by
5566 U-Boot's command interpreter; this feature is especially
5567 useful when you configure U-Boot to use a real shell (hush)
5568 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005569
Marek Vasut44f074c2012-03-14 21:52:45 +00005570Booting the Linux zImage:
5571-------------------------
5572
5573On some platforms, it's possible to boot Linux zImage. This is done
5574using the "bootz" command. The syntax of "bootz" command is the same
5575as the syntax of "bootm" command.
5576
Tom Rini8ac28562013-05-16 11:40:11 -04005577Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005578kernel with raw initrd images. The syntax is slightly different, the
5579address of the initrd must be augmented by it's size, in the following
5580format: "<initrd addres>:<initrd size>".
5581
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk2729af92004-05-03 20:45:30 +00005583Standalone HOWTO:
5584=================
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk2729af92004-05-03 20:45:30 +00005586One of the features of U-Boot is that you can dynamically load and
5587run "standalone" applications, which can use some resources of
5588U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005589
wdenk2729af92004-05-03 20:45:30 +00005590Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592"Hello World" Demo:
5593-------------------
wdenkc6097192002-11-03 00:24:07 +00005594
wdenk2729af92004-05-03 20:45:30 +00005595'examples/hello_world.c' contains a small "Hello World" Demo
5596application; it is automatically compiled when you build U-Boot.
5597It's configured to run at address 0x00040004, so you can play with it
5598like that:
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk2729af92004-05-03 20:45:30 +00005600 => loads
5601 ## Ready for S-Record download ...
5602 ~>examples/hello_world.srec
5603 1 2 3 4 5 6 7 8 9 10 11 ...
5604 [file transfer complete]
5605 [connected]
5606 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk2729af92004-05-03 20:45:30 +00005608 => go 40004 Hello World! This is a test.
5609 ## Starting application at 0x00040004 ...
5610 Hello World
5611 argc = 7
5612 argv[0] = "40004"
5613 argv[1] = "Hello"
5614 argv[2] = "World!"
5615 argv[3] = "This"
5616 argv[4] = "is"
5617 argv[5] = "a"
5618 argv[6] = "test."
5619 argv[7] = "<NULL>"
5620 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk2729af92004-05-03 20:45:30 +00005622 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk2729af92004-05-03 20:45:30 +00005624Another example, which demonstrates how to register a CPM interrupt
5625handler with the U-Boot code, can be found in 'examples/timer.c'.
5626Here, a CPM timer is set up to generate an interrupt every second.
5627The interrupt service routine is trivial, just printing a '.'
5628character, but this is just a demo program. The application can be
5629controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631 ? - print current values og the CPM Timer registers
5632 b - enable interrupts and start timer
5633 e - stop timer and disable interrupts
5634 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636 => loads
5637 ## Ready for S-Record download ...
5638 ~>examples/timer.srec
5639 1 2 3 4 5 6 7 8 9 10 11 ...
5640 [file transfer complete]
5641 [connected]
5642 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk2729af92004-05-03 20:45:30 +00005644 => go 40004
5645 ## Starting application at 0x00040004 ...
5646 TIMERS=0xfff00980
5647 Using timer 1
5648 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk2729af92004-05-03 20:45:30 +00005650Hit 'b':
5651 [q, b, e, ?] Set interval 1000000 us
5652 Enabling timer
5653Hit '?':
5654 [q, b, e, ?] ........
5655 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5656Hit '?':
5657 [q, b, e, ?] .
5658 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5659Hit '?':
5660 [q, b, e, ?] .
5661 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5662Hit '?':
5663 [q, b, e, ?] .
5664 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5665Hit 'e':
5666 [q, b, e, ?] ...Stopping timer
5667Hit 'q':
5668 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005669
5670
wdenk2729af92004-05-03 20:45:30 +00005671Minicom warning:
5672================
wdenk85ec0bc2003-03-31 16:34:49 +00005673
wdenk2729af92004-05-03 20:45:30 +00005674Over time, many people have reported problems when trying to use the
5675"minicom" terminal emulation program for serial download. I (wd)
5676consider minicom to be broken, and recommend not to use it. Under
5677Unix, I recommend to use C-Kermit for general purpose use (and
5678especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005679use "cu" for S-Record download ("loads" command). See
5680http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5681for help with kermit.
5682
wdenk85ec0bc2003-03-31 16:34:49 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684Nevertheless, if you absolutely want to use it try adding this
5685configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005686
wdenk2729af92004-05-03 20:45:30 +00005687 Name Program Name U/D FullScr IO-Red. Multi
5688 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5689 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005690
5691
wdenk2729af92004-05-03 20:45:30 +00005692NetBSD Notes:
5693=============
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk2729af92004-05-03 20:45:30 +00005695Starting at version 0.9.2, U-Boot supports NetBSD both as host
5696(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698Building requires a cross environment; it is known to work on
5699NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5700need gmake since the Makefiles are not compatible with BSD make).
5701Note that the cross-powerpc package does not install include files;
5702attempting to build U-Boot will fail because <machine/ansi.h> is
5703missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705 # cd /usr/pkg/cross/powerpc-netbsd/include
5706 # mkdir powerpc
5707 # ln -s powerpc machine
5708 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5709 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711Native builds *don't* work due to incompatibilities between native
5712and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714Booting assumes that (the first part of) the image booted is a
5715stage-2 loader which in turn loads and then invokes the kernel
5716proper. Loader sources will eventually appear in the NetBSD source
5717tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005718meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005719
5720
wdenk2729af92004-05-03 20:45:30 +00005721Implementation Internals:
5722=========================
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724The following is not intended to be a complete description of every
5725implementation detail. However, it should help to understand the
5726inner workings of U-Boot and make it easier to port it to custom
5727hardware.
wdenkc6097192002-11-03 00:24:07 +00005728
5729
wdenk2729af92004-05-03 20:45:30 +00005730Initial Stack, Global Data:
5731---------------------------
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733The implementation of U-Boot is complicated by the fact that U-Boot
5734starts running out of ROM (flash memory), usually without access to
5735system RAM (because the memory controller is not initialized yet).
5736This means that we don't have writable Data or BSS segments, and BSS
5737is not initialized as zero. To be able to get a C environment working
5738at all, we have to allocate at least a minimal stack. Implementation
5739options for this are defined and restricted by the CPU used: Some CPU
5740models provide on-chip memory (like the IMMR area on MPC8xx and
5741MPC826x processors), on others (parts of) the data cache can be
5742locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005743
Wolfgang Denk218ca722008-03-26 10:40:12 +01005744 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005745 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5748 From: "Chris Hallinan" <clh@net1plus.com>
5749 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5750 ...
wdenk43d96162003-03-06 00:02:04 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752 Correct me if I'm wrong, folks, but the way I understand it
5753 is this: Using DCACHE as initial RAM for Stack, etc, does not
5754 require any physical RAM backing up the cache. The cleverness
5755 is that the cache is being used as a temporary supply of
5756 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005757 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005758 can see how this works by studying the cache architecture and
5759 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005760
wdenk2729af92004-05-03 20:45:30 +00005761 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5762 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005763 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005764 option should work for you. Using CS 4 should be fine if your
5765 board designers haven't used it for something that would
5766 cause you grief during the initial boot! It is frequently not
5767 used.
wdenk43d96162003-03-06 00:02:04 +00005768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005769 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005770 with your processor/board/system design. The default value
5771 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005772 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005773 than your SDRAM module. If you have a 64MB SDRAM module, set
5774 it above 400_0000. Just make sure your board has no resources
5775 that are supposed to respond to that address! That code in
5776 start.S has been around a while and should work as is when
5777 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005778
wdenk2729af92004-05-03 20:45:30 +00005779 -Chris Hallinan
5780 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005781
wdenk2729af92004-05-03 20:45:30 +00005782It is essential to remember this, since it has some impact on the C
5783code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk2729af92004-05-03 20:45:30 +00005785* Initialized global data (data segment) is read-only. Do not attempt
5786 to write it.
wdenkc6097192002-11-03 00:24:07 +00005787
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005788* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005789 as zero data - BSS segment) at all - this is undefined, initiali-
5790 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792* Stack space is very limited. Avoid big data buffers or things like
5793 that.
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk2729af92004-05-03 20:45:30 +00005795Having only the stack as writable memory limits means we cannot use
5796normal global data to share information beween the code. But it
5797turned out that the implementation of U-Boot can be greatly
5798simplified by making a global data structure (gd_t) available to all
5799functions. We could pass a pointer to this data as argument to _all_
5800functions, but this would bloat the code. Instead we use a feature of
5801the GCC compiler (Global Register Variables) to share the data: we
5802place a pointer (gd) to the global data into a register which we
5803reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805When choosing a register for such a purpose we are restricted by the
5806relevant (E)ABI specifications for the current architecture, and by
5807GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk2729af92004-05-03 20:45:30 +00005809For PowerPC, the following registers have specific use:
5810 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005811 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005812 R3-R4: parameter passing and return values
5813 R5-R10: parameter passing
5814 R13: small data area pointer
5815 R30: GOT pointer
5816 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005817
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005818 (U-Boot also uses R12 as internal GOT pointer. r12
5819 is a volatile register so r12 needs to be reset when
5820 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005821
Wolfgang Denke7670f62008-02-14 22:43:22 +01005822 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005823
wdenk2729af92004-05-03 20:45:30 +00005824 Note: on PPC, we could use a static initializer (since the
5825 address of the global data structure is known at compile time),
5826 but it turned out that reserving a register results in somewhat
5827 smaller code - although the code savings are not that big (on
5828 average for all boards 752 bytes for the whole U-Boot image,
5829 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005830
Robin Getzc4db3352009-08-17 15:23:02 +00005831On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005832 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5833
Robin Getzc4db3352009-08-17 15:23:02 +00005834 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005835
wdenk2729af92004-05-03 20:45:30 +00005836On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005837
wdenk2729af92004-05-03 20:45:30 +00005838 R0: function argument word/integer result
5839 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005840 R9: platform specific
5841 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005842 R11: argument (frame) pointer
5843 R12: temporary workspace
5844 R13: stack pointer
5845 R14: link register
5846 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005847
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005848 ==> U-Boot will use R9 to hold a pointer to the global data
5849
5850 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005851
Thomas Chou0df01fd2010-05-21 11:08:03 +08005852On Nios II, the ABI is documented here:
5853 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5854
5855 ==> U-Boot will use gp to hold a pointer to the global data
5856
5857 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5858 to access small data sections, so gp is free.
5859
Macpaul Linafc1ce82011-10-19 20:41:11 +00005860On NDS32, the following registers are used:
5861
5862 R0-R1: argument/return
5863 R2-R5: argument
5864 R15: temporary register for assembler
5865 R16: trampoline register
5866 R28: frame pointer (FP)
5867 R29: global pointer (GP)
5868 R30: link register (LP)
5869 R31: stack pointer (SP)
5870 PC: program counter (PC)
5871
5872 ==> U-Boot will use R10 to hold a pointer to the global data
5873
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005874NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5875or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk2729af92004-05-03 20:45:30 +00005877Memory Management:
5878------------------
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk2729af92004-05-03 20:45:30 +00005880U-Boot runs in system state and uses physical addresses, i.e. the
5881MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005882
wdenk2729af92004-05-03 20:45:30 +00005883The available memory is mapped to fixed addresses using the memory
5884controller. In this process, a contiguous block is formed for each
5885memory type (Flash, SDRAM, SRAM), even when it consists of several
5886physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888U-Boot is installed in the first 128 kB of the first Flash bank (on
5889TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5890booting and sizing and initializing DRAM, the code relocates itself
5891to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005892memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005893configuration setting]. Below that, a structure with global Board
5894Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005895
wdenk2729af92004-05-03 20:45:30 +00005896Additionally, some exception handler code is copied to the low 8 kB
5897of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk2729af92004-05-03 20:45:30 +00005899So a typical memory configuration with 16 MB of DRAM could look like
5900this:
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk2729af92004-05-03 20:45:30 +00005902 0x0000 0000 Exception Vector code
5903 :
5904 0x0000 1FFF
5905 0x0000 2000 Free for Application Use
5906 :
5907 :
wdenkc6097192002-11-03 00:24:07 +00005908
wdenk2729af92004-05-03 20:45:30 +00005909 :
5910 :
5911 0x00FB FF20 Monitor Stack (Growing downward)
5912 0x00FB FFAC Board Info Data and permanent copy of global data
5913 0x00FC 0000 Malloc Arena
5914 :
5915 0x00FD FFFF
5916 0x00FE 0000 RAM Copy of Monitor Code
5917 ... eventually: LCD or video framebuffer
5918 ... eventually: pRAM (Protected RAM - unchanged by reset)
5919 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005920
5921
wdenk2729af92004-05-03 20:45:30 +00005922System Initialization:
5923----------------------
wdenkc6097192002-11-03 00:24:07 +00005924
wdenk2729af92004-05-03 20:45:30 +00005925In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005926(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005927configuration for CS0# this is a mirror of the onboard Flash memory.
5928To be able to re-map memory U-Boot then jumps to its link address.
5929To be able to implement the initialization code in C, a (small!)
5930initial stack is set up in the internal Dual Ported RAM (in case CPUs
5931which provide such a feature like MPC8xx or MPC8260), or in a locked
5932part of the data cache. After that, U-Boot initializes the CPU core,
5933the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk2729af92004-05-03 20:45:30 +00005935Next, all (potentially) available memory banks are mapped using a
5936preliminary mapping. For example, we put them on 512 MB boundaries
5937(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5938on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5939programmed for SDRAM access. Using the temporary configuration, a
5940simple memory test is run that determines the size of the SDRAM
5941banks.
wdenkc6097192002-11-03 00:24:07 +00005942
wdenk2729af92004-05-03 20:45:30 +00005943When there is more than one SDRAM bank, and the banks are of
5944different size, the largest is mapped first. For equal size, the first
5945bank (CS2#) is mapped first. The first mapping is always for address
59460x00000000, with any additional banks following immediately to create
5947contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005948
wdenk2729af92004-05-03 20:45:30 +00005949Then, the monitor installs itself at the upper end of the SDRAM area
5950and allocates memory for use by malloc() and for the global Board
5951Info data; also, the exception vector code is copied to the low RAM
5952pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005953
wdenk2729af92004-05-03 20:45:30 +00005954Only after this relocation will you have a "normal" C environment;
5955until that you are restricted in several ways, mostly because you are
5956running from ROM, and because the code will have to be relocated to a
5957new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005958
5959
wdenk2729af92004-05-03 20:45:30 +00005960U-Boot Porting Guide:
5961----------------------
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk2729af92004-05-03 20:45:30 +00005963[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5964list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005965
5966
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005967int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005968{
5969 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005970
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005971 signal(SIGALRM, no_more_time);
5972 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk2729af92004-05-03 20:45:30 +00005974 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005975 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005976 return 0;
5977 }
5978
wdenk2729af92004-05-03 20:45:30 +00005979 Download latest U-Boot source;
5980
Wolfgang Denk06682362008-12-30 22:56:11 +01005981 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005982
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005983 if (clueless)
5984 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005985
wdenk2729af92004-05-03 20:45:30 +00005986 while (learning) {
5987 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005988 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5989 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005990 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005991 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005992 }
wdenkc6097192002-11-03 00:24:07 +00005993
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005994 if (available_money > toLocalCurrency ($2500))
5995 Buy a BDI3000;
5996 else
wdenk2729af92004-05-03 20:45:30 +00005997 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005998
5999 if (a similar board exists) { /* hopefully... */
6000 cp -a board/<similar> board/<myboard>
6001 cp include/configs/<similar>.h include/configs/<myboard>.h
6002 } else {
6003 Create your own board support subdirectory;
6004 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006005 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006006 Edit new board/<myboard> files
6007 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006008
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006009 while (!accepted) {
6010 while (!running) {
6011 do {
6012 Add / modify source code;
6013 } until (compiles);
6014 Debug;
6015 if (clueless)
6016 email("Hi, I am having problems...");
6017 }
6018 Send patch file to the U-Boot email list;
6019 if (reasonable critiques)
6020 Incorporate improvements from email list code review;
6021 else
6022 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006023 }
wdenkc6097192002-11-03 00:24:07 +00006024
wdenk2729af92004-05-03 20:45:30 +00006025 return 0;
6026}
6027
6028void no_more_time (int sig)
6029{
6030 hire_a_guru();
6031}
wdenkc6097192002-11-03 00:24:07 +00006032
6033
wdenk2729af92004-05-03 20:45:30 +00006034Coding Standards:
6035-----------------
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk2729af92004-05-03 20:45:30 +00006037All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006038coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006039"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006040
Detlev Zundel2c051652006-09-01 15:39:02 +02006041Source files originating from a different project (for example the
6042MTD subsystem) are generally exempt from these guidelines and are not
6043reformated to ease subsequent migration to newer versions of those
6044sources.
6045
6046Please note that U-Boot is implemented in C (and to some small parts in
6047Assembler); no C++ is used, so please do not use C++ style comments (//)
6048in your code.
wdenk2729af92004-05-03 20:45:30 +00006049
6050Please also stick to the following formatting rules:
6051- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006052- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006053- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006054- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006055- do not add trailing empty lines to source files
6056
6057Submissions which do not conform to the standards may be returned
6058with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006059
6060
wdenk2729af92004-05-03 20:45:30 +00006061Submitting Patches:
6062-------------------
wdenkc6097192002-11-03 00:24:07 +00006063
wdenk2729af92004-05-03 20:45:30 +00006064Since the number of patches for U-Boot is growing, we need to
6065establish some rules. Submissions which do not conform to these rules
6066may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006067
Magnus Lilja0d28f342008-08-06 19:32:33 +02006068Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006069
Wolfgang Denk06682362008-12-30 22:56:11 +01006070Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6071see http://lists.denx.de/mailman/listinfo/u-boot
6072
wdenk2729af92004-05-03 20:45:30 +00006073When you send a patch, please include the following information with
6074it:
wdenkc6097192002-11-03 00:24:07 +00006075
wdenk2729af92004-05-03 20:45:30 +00006076* For bug fixes: a description of the bug and how your patch fixes
6077 this bug. Please try to include a way of demonstrating that the
6078 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006079
wdenk2729af92004-05-03 20:45:30 +00006080* For new features: a description of the feature and your
6081 implementation.
wdenkc6097192002-11-03 00:24:07 +00006082
wdenk2729af92004-05-03 20:45:30 +00006083* A CHANGELOG entry as plaintext (separate from the patch)
6084
6085* For major contributions, your entry to the CREDITS file
6086
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006087* When you add support for a new board, don't forget to add a
6088 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006089
6090* If your patch adds new configuration options, don't forget to
6091 document these in the README file.
6092
Wolfgang Denk218ca722008-03-26 10:40:12 +01006093* The patch itself. If you are using git (which is *strongly*
6094 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006095 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006096 the U-Boot mailing list, you will avoid most of the common problems
6097 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006098
Wolfgang Denk218ca722008-03-26 10:40:12 +01006099 If you cannot use git, use "diff -purN OLD NEW". If your version of
6100 diff does not support these options, then get the latest version of
6101 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006102
Wolfgang Denk218ca722008-03-26 10:40:12 +01006103 The current directory when running this command shall be the parent
6104 directory of the U-Boot source tree (i. e. please make sure that
6105 your patch includes sufficient directory information for the
6106 affected files).
6107
6108 We prefer patches as plain text. MIME attachments are discouraged,
6109 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006110
6111* If one logical set of modifications affects or creates several
6112 files, all these changes shall be submitted in a SINGLE patch file.
6113
6114* Changesets that contain different, unrelated modifications shall be
6115 submitted as SEPARATE patches, one patch per changeset.
6116
6117
6118Notes:
6119
6120* Before sending the patch, run the MAKEALL script on your patched
6121 source tree and make sure that no errors or warnings are reported
6122 for any of the boards.
6123
6124* Keep your modifications to the necessary minimum: A patch
6125 containing several unrelated changes or arbitrary reformats will be
6126 returned with a request to re-formatting / split it.
6127
6128* If you modify existing code, make sure that your new code does not
6129 add to the memory footprint of the code ;-) Small is beautiful!
6130 When adding new features, these should compile conditionally only
6131 (using #ifdef), and the resulting code with the new feature
6132 disabled must not need more memory than the old code without your
6133 modification.
wdenk90dc6702005-05-03 14:12:25 +00006134
Wolfgang Denk06682362008-12-30 22:56:11 +01006135* Remember that there is a size limit of 100 kB per message on the
6136 u-boot mailing list. Bigger patches will be moderated. If they are
6137 reasonable and not too big, they will be acknowledged. But patches
6138 bigger than the size limit should be avoided.