blob: fd717bf085fab6a44b4a41c7b833e978cbaed897 [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
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000430- Generic CPU options:
431 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
432
433 Defines the endianess of the CPU. Implementation of those
434 values is arch specific.
435
York Sun5614e712013-09-30 09:22:09 -0700436 CONFIG_SYS_FSL_DDR
437 Freescale DDR driver in use. This type of DDR controller is
438 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
439 SoCs.
440
441 CONFIG_SYS_FSL_DDR_ADDR
442 Freescale DDR memory-mapped register base.
443
444 CONFIG_SYS_FSL_DDR_EMU
445 Specify emulator support for DDR. Some DDR features such as
446 deskew training are not available.
447
448 CONFIG_SYS_FSL_DDRC_GEN1
449 Freescale DDR1 controller.
450
451 CONFIG_SYS_FSL_DDRC_GEN2
452 Freescale DDR2 controller.
453
454 CONFIG_SYS_FSL_DDRC_GEN3
455 Freescale DDR3 controller.
456
York Sun9ac4ffb2013-09-30 14:20:51 -0700457 CONFIG_SYS_FSL_DDRC_ARM_GEN3
458 Freescale DDR3 controller for ARM-based SoCs.
459
York Sun5614e712013-09-30 09:22:09 -0700460 CONFIG_SYS_FSL_DDR1
461 Board config to use DDR1. It can be enabled for SoCs with
462 Freescale DDR1 or DDR2 controllers, depending on the board
463 implemetation.
464
465 CONFIG_SYS_FSL_DDR2
466 Board config to use DDR2. It can be eanbeld for SoCs with
467 Freescale DDR2 or DDR3 controllers, depending on the board
468 implementation.
469
470 CONFIG_SYS_FSL_DDR3
471 Board config to use DDR3. It can be enabled for SoCs with
472 Freescale DDR3 controllers.
473
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530474 CONFIG_SYS_FSL_IFC_BE
475 Defines the IFC controller register space as Big Endian
476
477 CONFIG_SYS_FSL_IFC_LE
478 Defines the IFC controller register space as Little Endian
479
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530480 CONFIG_SYS_FSL_PBL_PBI
481 It enables addition of RCW (Power on reset configuration) in built image.
482 Please refer doc/README.pblimage for more details
483
484 CONFIG_SYS_FSL_PBL_RCW
485 It adds PBI(pre-boot instructions) commands in u-boot build image.
486 PBI commands can be used to configure SoC before it starts the execution.
487 Please refer doc/README.pblimage for more details
488
York Sun4e5b1bd2014-02-10 13:59:42 -0800489 CONFIG_SYS_FSL_DDR_BE
490 Defines the DDR controller register space as Big Endian
491
492 CONFIG_SYS_FSL_DDR_LE
493 Defines the DDR controller register space as Little Endian
494
York Sun6b9e3092014-02-10 13:59:43 -0800495 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
496 Physical address from the view of DDR controllers. It is the
497 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
498 it could be different for ARM SoCs.
499
York Sun6b1e1252014-02-10 13:59:44 -0800500 CONFIG_SYS_FSL_DDR_INTLV_256B
501 DDR controller interleaving on 256-byte. This is a special
502 interleaving mode, handled by Dickens for Freescale layerscape
503 SoCs with ARM core.
504
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100505- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200506 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100507
508 Defines the Monahans run mode to oscillator
509 ratio. Valid values are 8, 16, 24, 31. The core
510 frequency is this value multiplied by 13 MHz.
511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200512 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200513
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100514 Defines the Monahans turbo mode to oscillator
515 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200516 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100517 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200518
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200519- MIPS CPU options:
520 CONFIG_SYS_INIT_SP_OFFSET
521
522 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
523 pointer. This is needed for the temporary stack before
524 relocation.
525
526 CONFIG_SYS_MIPS_CACHE_MODE
527
528 Cache operation mode for the MIPS CPU.
529 See also arch/mips/include/asm/mipsregs.h.
530 Possible values are:
531 CONF_CM_CACHABLE_NO_WA
532 CONF_CM_CACHABLE_WA
533 CONF_CM_UNCACHED
534 CONF_CM_CACHABLE_NONCOHERENT
535 CONF_CM_CACHABLE_CE
536 CONF_CM_CACHABLE_COW
537 CONF_CM_CACHABLE_CUW
538 CONF_CM_CACHABLE_ACCELERATED
539
540 CONFIG_SYS_XWAY_EBU_BOOTCFG
541
542 Special option for Lantiq XWAY SoCs for booting from NOR flash.
543 See also arch/mips/cpu/mips32/start.S.
544
545 CONFIG_XWAY_SWAP_BYTES
546
547 Enable compilation of tools/xway-swap-bytes needed for Lantiq
548 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
549 be swapped if a flash programmer is used.
550
Christian Rieschb67d8812012-02-02 00:44:39 +0000551- ARM options:
552 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
553
554 Select high exception vectors of the ARM core, e.g., do not
555 clear the V bit of the c1 register of CP15.
556
Aneesh V5356f542012-03-08 07:20:19 +0000557 CONFIG_SYS_THUMB_BUILD
558
559 Use this flag to build U-Boot using the Thumb instruction
560 set for ARM architectures. Thumb instruction set provides
561 better code density. For ARM architectures that support
562 Thumb2 this flag will result in Thumb2 code generated by
563 GCC.
564
Stephen Warrenc5d47522013-03-04 13:29:40 +0000565 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000566 CONFIG_ARM_ERRATA_742230
567 CONFIG_ARM_ERRATA_743622
568 CONFIG_ARM_ERRATA_751472
569
570 If set, the workarounds for these ARM errata are applied early
571 during U-Boot startup. Note that these options force the
572 workarounds to be applied; no CPU-type/version detection
573 exists, unlike the similar options in the Linux kernel. Do not
574 set these options unless they apply!
575
Stephen Warren795659d2013-03-27 17:06:41 +0000576- CPU timer options:
577 CONFIG_SYS_HZ
578
579 The frequency of the timer returned by get_timer().
580 get_timer() must operate in milliseconds and this CONFIG
581 option must be set to 1000.
582
wdenk5da627a2003-10-09 20:09:04 +0000583- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000584 CONFIG_CLOCKS_IN_MHZ
585
586 U-Boot stores all clock information in Hz
587 internally. For binary compatibility with older Linux
588 kernels (which expect the clocks passed in the
589 bd_info data to be in MHz) the environment variable
590 "clocks_in_mhz" can be defined so that U-Boot
591 converts clock data to MHZ before passing it to the
592 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000593 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100594 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000595 default environment.
596
wdenk5da627a2003-10-09 20:09:04 +0000597 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
598
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200599 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000600 expect it to be in bytes, others in MB.
601 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
602
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400603 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200604
605 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400606 passed using flattened device trees (based on open firmware
607 concepts).
608
609 CONFIG_OF_LIBFDT
610 * New libfdt-based support
611 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500612 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400613
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200614 OF_CPU - The proper name of the cpus node (only required for
615 MPC512X and MPC5xxx based boards).
616 OF_SOC - The proper name of the soc node (only required for
617 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200618 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600619 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200620
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200621 boards with QUICC Engines require OF_QE to set UCC MAC
622 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500623
Kumar Gala4e253132006-01-11 13:54:17 -0600624 CONFIG_OF_BOARD_SETUP
625
626 Board code has addition modification that it wants to make
627 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000628
Matthew McClintock02677682006-06-28 10:41:37 -0500629 CONFIG_OF_BOOT_CPU
630
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200631 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500632 param header, the default value is zero if undefined.
633
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200634 CONFIG_OF_IDE_FIXUP
635
636 U-Boot can detect if an IDE device is present or not.
637 If not, and this new config option is activated, U-Boot
638 removes the ATA node from the DTS before booting Linux,
639 so the Linux IDE driver does not probe the device and
640 crash. This is needed for buggy hardware (uc101) where
641 no pull down resistor is connected to the signal IDE5V_DD7.
642
Igor Grinberg7eb29392011-07-14 05:45:07 +0000643 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
644
645 This setting is mandatory for all boards that have only one
646 machine type and must be used to specify the machine type
647 number as it appears in the ARM machine registry
648 (see http://www.arm.linux.org.uk/developer/machines/).
649 Only boards that have multiple machine types supported
650 in a single configuration file and the machine type is
651 runtime discoverable, do not have to use this setting.
652
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100653- vxWorks boot parameters:
654
655 bootvx constructs a valid bootline using the following
656 environments variables: bootfile, ipaddr, serverip, hostname.
657 It loads the vxWorks image pointed bootfile.
658
659 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
660 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
661 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
662 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
663
664 CONFIG_SYS_VXWORKS_ADD_PARAMS
665
666 Add it at the end of the bootline. E.g "u=username pw=secret"
667
668 Note: If a "bootargs" environment is defined, it will overwride
669 the defaults discussed just above.
670
Aneesh V2c451f72011-06-16 23:30:47 +0000671- Cache Configuration:
672 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
673 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
674 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
675
Aneesh V93bc2192011-06-16 23:30:51 +0000676- Cache Configuration for ARM:
677 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
678 controller
679 CONFIG_SYS_PL310_BASE - Physical base address of PL310
680 controller register space
681
wdenk6705d812004-08-02 23:22:59 +0000682- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200683 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000684
685 Define this if you want support for Amba PrimeCell PL010 UARTs.
686
Andreas Engel48d01922008-09-08 14:30:53 +0200687 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000688
689 Define this if you want support for Amba PrimeCell PL011 UARTs.
690
691 CONFIG_PL011_CLOCK
692
693 If you have Amba PrimeCell PL011 UARTs, set this variable to
694 the clock speed of the UARTs.
695
696 CONFIG_PL01x_PORTS
697
698 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
699 define this to a list of base addresses for each (supported)
700 port. See e.g. include/configs/versatile.h
701
John Rigby910f1ae2011-04-19 10:42:39 +0000702 CONFIG_PL011_SERIAL_RLCR
703
704 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
705 have separate receive and transmit line control registers. Set
706 this variable to initialize the extra register.
707
708 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
709
710 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
711 boot loader that has already initialized the UART. Define this
712 variable to flush the UART at init time.
713
wdenk6705d812004-08-02 23:22:59 +0000714
wdenkc6097192002-11-03 00:24:07 +0000715- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000716 Depending on board, define exactly one serial port
717 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
718 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
719 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000720
721 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
722 port routines must be defined elsewhere
723 (i.e. serial_init(), serial_getc(), ...)
724
725 CONFIG_CFB_CONSOLE
726 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000727 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000728 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
729 (default big endian)
730 VIDEO_HW_RECTFILL graphic chip supports
731 rectangle fill
732 (cf. smiLynxEM)
733 VIDEO_HW_BITBLT graphic chip supports
734 bit-blit (cf. smiLynxEM)
735 VIDEO_VISIBLE_COLS visible pixel columns
736 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000737 VIDEO_VISIBLE_ROWS visible pixel rows
738 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000739 VIDEO_DATA_FORMAT graphic data format
740 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000741 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000742 VIDEO_KBD_INIT_FCT keyboard int fct
743 (i.e. i8042_kbd_init())
744 VIDEO_TSTC_FCT test char fct
745 (i.e. i8042_tstc)
746 VIDEO_GETC_FCT get char fct
747 (i.e. i8042_getc)
748 CONFIG_CONSOLE_CURSOR cursor drawing on/off
749 (requires blink timer
750 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200751 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000752 CONFIG_CONSOLE_TIME display time/date info in
753 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000755 CONFIG_VIDEO_LOGO display Linux logo in
756 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000757 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
758 linux_logo.h for logo.
759 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000760 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200761 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000762 the logo
763
Pali Rohár33a35bb2012-10-19 13:30:09 +0000764 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
765 a limited number of ANSI escape sequences (cursor control,
766 erase functions and limited graphics rendition control).
767
wdenk43d96162003-03-06 00:02:04 +0000768 When CONFIG_CFB_CONSOLE is defined, video console is
769 default i/o. Serial console can be forced with
770 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000771
wdenkd4ca31c2004-01-02 14:00:00 +0000772 When CONFIG_SILENT_CONSOLE is defined, all console
773 messages (by U-Boot and Linux!) can be silenced with
774 the "silent" environment variable. See
775 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000776
Heiko Schocher45ae2542013-10-22 11:06:06 +0200777 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
778 is 0x00.
779 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
780 is 0xa0.
781
wdenkc6097192002-11-03 00:24:07 +0000782- Console Baudrate:
783 CONFIG_BAUDRATE - in bps
784 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200785 CONFIG_SYS_BAUDRATE_TABLE, see below.
786 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000787
Heiko Schocherc92fac92009-01-30 12:55:38 +0100788- Console Rx buffer length
789 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
790 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100791 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100792 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
793 must be defined, to setup the maximum idle timeout for
794 the SMC.
795
Graeme Russ9558b482011-09-01 00:48:27 +0000796- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200797 Prior to the console being initialised (i.e. serial UART
798 initialised etc) all console output is silently discarded.
799 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
800 buffer any console messages prior to the console being
801 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
802 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
803 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200804 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200805 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000806
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200807 'Sane' compilers will generate smaller code if
808 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000809
Sonny Rao046a37b2011-11-02 09:52:08 +0000810- Safe printf() functions
811 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
812 the printf() functions. These are defined in
813 include/vsprintf.h and include snprintf(), vsnprintf() and
814 so on. Code size increase is approximately 300-500 bytes.
815 If this option is not given then these functions will
816 silently discard their buffer size argument - this means
817 you are not getting any overflow checking in this case.
818
wdenkc6097192002-11-03 00:24:07 +0000819- Boot Delay: CONFIG_BOOTDELAY - in seconds
820 Delay before automatically booting the default image;
821 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000822 set to -2 to autoboot with no delay and not check for abort
823 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000824
825 See doc/README.autoboot for these options that
826 work with CONFIG_BOOTDELAY. None are required.
827 CONFIG_BOOT_RETRY_TIME
828 CONFIG_BOOT_RETRY_MIN
829 CONFIG_AUTOBOOT_KEYED
830 CONFIG_AUTOBOOT_PROMPT
831 CONFIG_AUTOBOOT_DELAY_STR
832 CONFIG_AUTOBOOT_STOP_STR
833 CONFIG_AUTOBOOT_DELAY_STR2
834 CONFIG_AUTOBOOT_STOP_STR2
835 CONFIG_ZERO_BOOTDELAY_CHECK
836 CONFIG_RESET_TO_RETRY
837
838- Autoboot Command:
839 CONFIG_BOOTCOMMAND
840 Only needed when CONFIG_BOOTDELAY is enabled;
841 define a command string that is automatically executed
842 when no character is read on the console interface
843 within "Boot Delay" after reset.
844
845 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000846 This can be used to pass arguments to the bootm
847 command. The value of CONFIG_BOOTARGS goes into the
848 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000849
850 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000851 The value of these goes into the environment as
852 "ramboot" and "nfsboot" respectively, and can be used
853 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200854 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000855
Heiko Schochereda0ba32013-11-04 14:04:59 +0100856- Bootcount:
857 CONFIG_BOOTCOUNT_LIMIT
858 Implements a mechanism for detecting a repeating reboot
859 cycle, see:
860 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
861
862 CONFIG_BOOTCOUNT_ENV
863 If no softreset save registers are found on the hardware
864 "bootcount" is stored in the environment. To prevent a
865 saveenv on all reboots, the environment variable
866 "upgrade_available" is used. If "upgrade_available" is
867 0, "bootcount" is always 0, if "upgrade_available" is
868 1 "bootcount" is incremented in the environment.
869 So the Userspace Applikation must set the "upgrade_available"
870 and "bootcount" variable to 0, if a boot was successfully.
871
wdenkc6097192002-11-03 00:24:07 +0000872- Pre-Boot Commands:
873 CONFIG_PREBOOT
874
875 When this option is #defined, the existence of the
876 environment variable "preboot" will be checked
877 immediately before starting the CONFIG_BOOTDELAY
878 countdown and/or running the auto-boot command resp.
879 entering interactive mode.
880
881 This feature is especially useful when "preboot" is
882 automatically generated or modified. For an example
883 see the LWMON board specific code: here "preboot" is
884 modified when the user holds down a certain
885 combination of keys on the (special) keyboard when
886 booting the systems
887
888- Serial Download Echo Mode:
889 CONFIG_LOADS_ECHO
890 If defined to 1, all characters received during a
891 serial download (using the "loads" command) are
892 echoed back. This might be needed by some terminal
893 emulations (like "cu"), but may as well just take
894 time on others. This setting #define's the initial
895 value of the "loads_echo" environment variable.
896
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500897- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000898 CONFIG_KGDB_BAUDRATE
899 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200900 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000901
902- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 Monitor commands can be included or excluded
904 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000905 <config_cmd_all.h> and #undef'ing unwanted
906 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500907 and augmenting with additional #define's
908 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000909
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500910 The default command configuration includes all commands
911 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000912
Marek Vasutb401b732014-03-05 19:58:39 +0100913 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500914 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 CONFIG_CMD_BDI bdinfo
916 CONFIG_CMD_BEDBUG * Include BedBug Debugger
917 CONFIG_CMD_BMP * BMP support
918 CONFIG_CMD_BSP * Board specific commands
919 CONFIG_CMD_BOOTD bootd
920 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800921 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500922 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500923 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500924 CONFIG_CMD_DATE * support for RTC, date/time...
925 CONFIG_CMD_DHCP * DHCP support
926 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600927 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
928 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
929 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
930 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500931 CONFIG_CMD_DTT * Digital Therm and Thermostat
932 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500933 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500934 CONFIG_CMD_EEPROM * EEPROM read/write support
935 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600936 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600937 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500938 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500939 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000940 CONFIG_CMD_EXT2 * ext2 command support
941 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700942 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
943 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500944 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000946 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500947 CONFIG_CMD_FLASH flinfo, erase, protect
948 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200949 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000950 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500951 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000952 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000953 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500954 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
955 CONFIG_CMD_I2C * I2C serial bus support
956 CONFIG_CMD_IDE * IDE harddisk support
957 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000958 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200959 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500960 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500961 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000962 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500963 CONFIG_CMD_IRQ * irqinfo
964 CONFIG_CMD_ITEST Integer/string test of 2 values
965 CONFIG_CMD_JFFS2 * JFFS2 Support
966 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200967 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000968 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
969 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500970 CONFIG_CMD_LOADB loadb
971 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200972 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400973 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000974 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500975 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000976 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200977 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500978 CONFIG_CMD_MISC Misc functions like sleep etc
979 CONFIG_CMD_MMC * MMC memory mapped support
980 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100981 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500982 CONFIG_CMD_NAND * NAND support
983 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200984 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600985 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000986 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500987 CONFIG_CMD_PCI * pciinfo
988 CONFIG_CMD_PCMCIA * PCMCIA support
989 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
990 host
991 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000992 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_REGINFO * Register dump
994 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000995 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 CONFIG_CMD_SAVES * save S record dump
997 CONFIG_CMD_SCSI * SCSI Support
998 CONFIG_CMD_SDRAM * print SDRAM configuration information
999 (requires CONFIG_CMD_I2C)
1000 CONFIG_CMD_SETGETDCR Support for DCR Register access
1001 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001002 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001003 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001004 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001005 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001006 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001007 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001008 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001009 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001010 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1011 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001012 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001014 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001015 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +00001016
wdenkc6097192002-11-03 00:24:07 +00001017
1018 EXAMPLE: If you want all functions except of network
1019 support you can write:
1020
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001021 #include "config_cmd_all.h"
1022 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001023
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001024 Other Commands:
1025 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001026
1027 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001028 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001029 what you (and your U-Boot users) are doing. Data
1030 cache cannot be enabled on systems like the 8xx or
1031 8260 (where accesses to the IMMR region must be
1032 uncached), and it cannot be disabled on all other
1033 systems where we (mis-) use the data cache to hold an
1034 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001035
1036
1037 XXX - this list needs to get updated!
1038
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001039- Regular expression support:
1040 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001041 If this variable is defined, U-Boot is linked against
1042 the SLRE (Super Light Regular Expression) library,
1043 which adds regex support to some commands, as for
1044 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001045
Simon Glass45ba8072011-10-15 05:48:20 +00001046- Device tree:
1047 CONFIG_OF_CONTROL
1048 If this variable is defined, U-Boot will use a device tree
1049 to configure its devices, instead of relying on statically
1050 compiled #defines in the board file. This option is
1051 experimental and only available on a few boards. The device
1052 tree is available in the global data as gd->fdt_blob.
1053
Simon Glass2c0f79e2011-10-24 19:15:31 +00001054 U-Boot needs to get its device tree from somewhere. This can
1055 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001056
1057 CONFIG_OF_EMBED
1058 If this variable is defined, U-Boot will embed a device tree
1059 binary in its image. This device tree file should be in the
1060 board directory and called <soc>-<board>.dts. The binary file
1061 is then picked up in board_init_f() and made available through
1062 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001063
Simon Glass2c0f79e2011-10-24 19:15:31 +00001064 CONFIG_OF_SEPARATE
1065 If this variable is defined, U-Boot will build a device tree
1066 binary. It will be called u-boot.dtb. Architecture-specific
1067 code will locate it at run-time. Generally this works by:
1068
1069 cat u-boot.bin u-boot.dtb >image.bin
1070
1071 and in fact, U-Boot does this for you, creating a file called
1072 u-boot-dtb.bin which is useful in the common case. You can
1073 still use the individual files if you need something more
1074 exotic.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- Watchdog:
1077 CONFIG_WATCHDOG
1078 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001079 support for the SoC. There must be support in the SoC
1080 specific code for a watchdog. For the 8xx and 8260
1081 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1082 register. When supported for a specific SoC is
1083 available, then no further board specific code should
1084 be needed to use it.
1085
1086 CONFIG_HW_WATCHDOG
1087 When using a watchdog circuitry external to the used
1088 SoC, then define this variable and provide board
1089 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001090
stroesec1551ea2003-04-04 15:53:41 +00001091- U-Boot Version:
1092 CONFIG_VERSION_VARIABLE
1093 If this variable is defined, an environment variable
1094 named "ver" is created by U-Boot showing the U-Boot
1095 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001096 Any change to this variable will be reverted at the
1097 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001098
wdenkc6097192002-11-03 00:24:07 +00001099- Real-Time Clock:
1100
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001101 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001102 has to be selected, too. Define exactly one of the
1103 following options:
1104
1105 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1106 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001107 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001108 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001109 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001110 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001111 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001112 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001113 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001114 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001115 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001116 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1117 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001118
wdenkb37c7e52003-06-30 16:24:52 +00001119 Note that if the RTC uses I2C, then the I2C interface
1120 must also be configured. See I2C Support, below.
1121
Peter Tysere92739d2008-12-17 16:36:21 -06001122- GPIO Support:
1123 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001124
Chris Packham5dec49c2010-12-19 10:12:13 +00001125 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1126 chip-ngpio pairs that tell the PCA953X driver the number of
1127 pins supported by a particular chip.
1128
Peter Tysere92739d2008-12-17 16:36:21 -06001129 Note that if the GPIO device uses I2C, then the I2C interface
1130 must also be configured. See I2C Support, below.
1131
wdenkc6097192002-11-03 00:24:07 +00001132- Timestamp Support:
1133
wdenk43d96162003-03-06 00:02:04 +00001134 When CONFIG_TIMESTAMP is selected, the timestamp
1135 (date and time) of an image is printed by image
1136 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001137 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001138
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001139- Partition Labels (disklabels) Supported:
1140 Zero or more of the following:
1141 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1142 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1143 Intel architecture, USB sticks, etc.
1144 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1145 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1146 bootloader. Note 2TB partition limit; see
1147 disk/part_efi.c
1148 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001149
Wolfgang Denk218ca722008-03-26 10:40:12 +01001150 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1151 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001152 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001153
1154- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001155 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1156 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001157
wdenk4d13cba2004-03-14 14:09:05 +00001158 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1159 be performed by calling the function
1160 ide_set_reset(int reset)
1161 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001162
1163- ATAPI Support:
1164 CONFIG_ATAPI
1165
1166 Set this to enable ATAPI support.
1167
wdenkc40b2952004-03-13 23:29:43 +00001168- LBA48 Support
1169 CONFIG_LBA48
1170
1171 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001172 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001173 Whithout these , LBA48 support uses 32bit variables and will 'only'
1174 support disks up to 2.1TB.
1175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001176 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001177 When enabled, makes the IDE subsystem use 64bit sector addresses.
1178 Default is 32bit.
1179
wdenkc6097192002-11-03 00:24:07 +00001180- SCSI Support:
1181 At the moment only there is only support for the
1182 SYM53C8XX SCSI controller; define
1183 CONFIG_SCSI_SYM53C8XX to enable it.
1184
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001185 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1186 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1187 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001188 maximum numbers of LUNs, SCSI ID's and target
1189 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001190 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001191
Wolfgang Denk93e14592013-10-04 17:43:24 +02001192 The environment variable 'scsidevs' is set to the number of
1193 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001194
wdenkc6097192002-11-03 00:24:07 +00001195- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001196 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001197 Support for Intel 8254x/8257x gigabit chips.
1198
1199 CONFIG_E1000_SPI
1200 Utility code for direct access to the SPI bus on Intel 8257x.
1201 This does not do anything useful unless you set at least one
1202 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1203
1204 CONFIG_E1000_SPI_GENERIC
1205 Allow generic access to the SPI bus on the Intel 8257x, for
1206 example with the "sspi" command.
1207
1208 CONFIG_CMD_E1000
1209 Management command for E1000 devices. When used on devices
1210 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001211
Andre Schwarzac3315c2008-03-06 16:45:44 +01001212 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001213 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001214
wdenkc6097192002-11-03 00:24:07 +00001215 CONFIG_EEPRO100
1216 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001217 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001218 write routine for first time initialisation.
1219
1220 CONFIG_TULIP
1221 Support for Digital 2114x chips.
1222 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1223 modem chip initialisation (KS8761/QS6611).
1224
1225 CONFIG_NATSEMI
1226 Support for National dp83815 chips.
1227
1228 CONFIG_NS8382X
1229 Support for National dp8382[01] gigabit chips.
1230
wdenk45219c42003-05-12 21:50:16 +00001231- NETWORK Support (other):
1232
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001233 CONFIG_DRIVER_AT91EMAC
1234 Support for AT91RM9200 EMAC.
1235
1236 CONFIG_RMII
1237 Define this to use reduced MII inteface
1238
1239 CONFIG_DRIVER_AT91EMAC_QUIET
1240 If this defined, the driver is quiet.
1241 The driver doen't show link status messages.
1242
Rob Herringefdd7312011-12-15 11:15:49 +00001243 CONFIG_CALXEDA_XGMAC
1244 Support for the Calxeda XGMAC device
1245
Ashok3bb46d22012-10-15 06:20:47 +00001246 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001247 Support for SMSC's LAN91C96 chips.
1248
1249 CONFIG_LAN91C96_BASE
1250 Define this to hold the physical address
1251 of the LAN91C96's I/O space
1252
1253 CONFIG_LAN91C96_USE_32_BIT
1254 Define this to enable 32 bit addressing
1255
Ashok3bb46d22012-10-15 06:20:47 +00001256 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001257 Support for SMSC's LAN91C111 chip
1258
1259 CONFIG_SMC91111_BASE
1260 Define this to hold the physical address
1261 of the device (I/O space)
1262
1263 CONFIG_SMC_USE_32_BIT
1264 Define this if data bus is 32 bits
1265
1266 CONFIG_SMC_USE_IOFUNCS
1267 Define this to use i/o functions instead of macros
1268 (some hardware wont work with macros)
1269
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001270 CONFIG_DRIVER_TI_EMAC
1271 Support for davinci emac
1272
1273 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1274 Define this if you have more then 3 PHYs.
1275
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001276 CONFIG_FTGMAC100
1277 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1278
1279 CONFIG_FTGMAC100_EGIGA
1280 Define this to use GE link update with gigabit PHY.
1281 Define this if FTGMAC100 is connected to gigabit PHY.
1282 If your system has 10/100 PHY only, it might not occur
1283 wrong behavior. Because PHY usually return timeout or
1284 useless data when polling gigabit status and gigabit
1285 control registers. This behavior won't affect the
1286 correctnessof 10/100 link speed update.
1287
Mike Rapoportc2fff332009-11-11 10:03:03 +02001288 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001289 Support for SMSC's LAN911x and LAN921x chips
1290
Mike Rapoportc2fff332009-11-11 10:03:03 +02001291 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001292 Define this to hold the physical address
1293 of the device (I/O space)
1294
Mike Rapoportc2fff332009-11-11 10:03:03 +02001295 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001296 Define this if data bus is 32 bits
1297
Mike Rapoportc2fff332009-11-11 10:03:03 +02001298 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001299 Define this if data bus is 16 bits. If your processor
1300 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001301 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001302
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001303 CONFIG_SH_ETHER
1304 Support for Renesas on-chip Ethernet controller
1305
1306 CONFIG_SH_ETHER_USE_PORT
1307 Define the number of ports to be used
1308
1309 CONFIG_SH_ETHER_PHY_ADDR
1310 Define the ETH PHY's address
1311
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001312 CONFIG_SH_ETHER_CACHE_WRITEBACK
1313 If this option is set, the driver enables cache flush.
1314
Vadim Bendebury5e124722011-10-17 08:36:14 +00001315- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001316 CONFIG_TPM
1317 Support TPM devices.
1318
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001319 CONFIG_TPM_TIS_I2C
1320 Support for i2c bus TPM devices. Only one device
1321 per system is supported at this time.
1322
1323 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1324 Define the the i2c bus number for the TPM device
1325
1326 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1327 Define the TPM's address on the i2c bus
1328
1329 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1330 Define the burst count bytes upper limit
1331
Dirk Eibachc01939c2013-06-26 15:55:15 +02001332 CONFIG_TPM_ATMEL_TWI
1333 Support for Atmel TWI TPM device. Requires I2C support.
1334
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001335 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001336 Support for generic parallel port TPM devices. Only one device
1337 per system is supported at this time.
1338
1339 CONFIG_TPM_TIS_BASE_ADDRESS
1340 Base address where the generic TPM device is mapped
1341 to. Contemporary x86 systems usually map it at
1342 0xfed40000.
1343
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001344 CONFIG_CMD_TPM
1345 Add tpm monitor functions.
1346 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1347 provides monitor access to authorized functions.
1348
1349 CONFIG_TPM
1350 Define this to enable the TPM support library which provides
1351 functional interfaces to some TPM commands.
1352 Requires support for a TPM device.
1353
1354 CONFIG_TPM_AUTH_SESSIONS
1355 Define this to enable authorized functions in the TPM library.
1356 Requires CONFIG_TPM and CONFIG_SHA1.
1357
wdenkc6097192002-11-03 00:24:07 +00001358- USB Support:
1359 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001360 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001361 CONFIG_USB_UHCI to enable it.
1362 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001363 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001364 storage devices.
1365 Note:
1366 Supported are USB Keyboards and USB Floppy drives
1367 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001368 MPC5200 USB requires additional defines:
1369 CONFIG_USB_CLOCK
1370 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001371 CONFIG_PSC3_USB
1372 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001373 CONFIG_USB_CONFIG
1374 for differential drivers: 0x00001000
1375 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001376 for differential drivers on PSC3: 0x00000100
1377 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001378 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001379 May be defined to allow interrupt polling
1380 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001381
Simon Glass9ab4ce22012-02-27 10:52:47 +00001382 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1383 txfilltuning field in the EHCI controller on reset.
1384
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001385 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1386 interval for usb hub power-on delay.(minimum 100msec)
1387
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001388- USB Device:
1389 Define the below if you wish to use the USB console.
1390 Once firmware is rebuilt from a serial console issue the
1391 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001392 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001393 it has found a new device. The environment variable usbtty
1394 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001395 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001396 Common Device Class Abstract Control Model serial device.
1397 If you select usbtty = gserial you should be able to enumerate
1398 a Linux host by
1399 # modprobe usbserial vendor=0xVendorID product=0xProductID
1400 else if using cdc_acm, simply setting the environment
1401 variable usbtty to be cdc_acm should suffice. The following
1402 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001403
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001404 CONFIG_USB_DEVICE
1405 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001406
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001407 CONFIG_USB_TTY
1408 Define this to have a tty type of device available to
1409 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001410
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301411 CONFIG_USBD_HS
1412 Define this to enable the high speed support for usb
1413 device and usbtty. If this feature is enabled, a routine
1414 int is_usbd_high_speed(void)
1415 also needs to be defined by the driver to dynamically poll
1416 whether the enumeration has succeded at high speed or full
1417 speed.
1418
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001419 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001420 Define this if you want stdin, stdout &/or stderr to
1421 be set to usbtty.
1422
1423 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001424 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001425 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001426 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001428 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001429 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001430 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001431
Wolfgang Denk386eda02006-06-14 18:14:56 +02001432 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001433 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001434 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001435 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1436 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1437 should pretend to be a Linux device to it's target host.
1438
1439 CONFIG_USBD_MANUFACTURER
1440 Define this string as the name of your company for
1441 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001442
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001443 CONFIG_USBD_PRODUCT_NAME
1444 Define this string as the name of your product
1445 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1446
1447 CONFIG_USBD_VENDORID
1448 Define this as your assigned Vendor ID from the USB
1449 Implementors Forum. This *must* be a genuine Vendor ID
1450 to avoid polluting the USB namespace.
1451 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001452
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001453 CONFIG_USBD_PRODUCTID
1454 Define this as the unique Product ID
1455 for your device
1456 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001457
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001458 Some USB device drivers may need to check USB cable attachment.
1459 In this case you can enable following config in BoardName.h:
1460 CONFIG_USB_CABLE_CHECK
1461 This enables function definition:
1462 - usb_cable_connected() in include/usb.h
1463 Implementation of this function is board-specific.
1464
Igor Grinbergd70a5602011-12-12 12:08:35 +02001465- ULPI Layer Support:
1466 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1467 the generic ULPI layer. The generic layer accesses the ULPI PHY
1468 via the platform viewport, so you need both the genric layer and
1469 the viewport enabled. Currently only Chipidea/ARC based
1470 viewport is supported.
1471 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1472 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001473 If your ULPI phy needs a different reference clock than the
1474 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1475 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001476
1477- MMC Support:
1478 The MMC controller on the Intel PXA is supported. To
1479 enable this define CONFIG_MMC. The MMC can be
1480 accessed from the boot prompt by mapping the device
1481 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001482 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1483 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001484
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001485 CONFIG_SH_MMCIF
1486 Support for Renesas on-chip MMCIF controller
1487
1488 CONFIG_SH_MMCIF_ADDR
1489 Define the base address of MMCIF registers
1490
1491 CONFIG_SH_MMCIF_CLK
1492 Define the clock frequency for MMCIF
1493
Tom Rinib3ba6e92013-03-14 05:32:47 +00001494- USB Device Firmware Update (DFU) class support:
1495 CONFIG_DFU_FUNCTION
1496 This enables the USB portion of the DFU USB class
1497
1498 CONFIG_CMD_DFU
1499 This enables the command "dfu" which is used to have
1500 U-Boot create a DFU class device via USB. This command
1501 requires that the "dfu_alt_info" environment variable be
1502 set and define the alt settings to expose to the host.
1503
1504 CONFIG_DFU_MMC
1505 This enables support for exposing (e)MMC devices via DFU.
1506
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001507 CONFIG_DFU_NAND
1508 This enables support for exposing NAND devices via DFU.
1509
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301510 CONFIG_DFU_RAM
1511 This enables support for exposing RAM via DFU.
1512 Note: DFU spec refer to non-volatile memory usage, but
1513 allow usages beyond the scope of spec - here RAM usage,
1514 one that would help mostly the developer.
1515
Heiko Schochere7e75c72013-06-12 06:05:51 +02001516 CONFIG_SYS_DFU_DATA_BUF_SIZE
1517 Dfu transfer uses a buffer before writing data to the
1518 raw storage device. Make the size (in bytes) of this buffer
1519 configurable. The size of this buffer is also configurable
1520 through the "dfu_bufsiz" environment variable.
1521
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001522 CONFIG_SYS_DFU_MAX_FILE_SIZE
1523 When updating files rather than the raw storage device,
1524 we use a static buffer to copy the file into and then write
1525 the buffer once we've been given the whole file. Define
1526 this to the maximum filesize (in bytes) for the buffer.
1527 Default is 4 MiB if undefined.
1528
wdenk6705d812004-08-02 23:22:59 +00001529- Journaling Flash filesystem support:
1530 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1531 CONFIG_JFFS2_NAND_DEV
1532 Define these for a default partition on a NAND device
1533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001534 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1535 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001536 Define these for a default partition on a NOR device
1537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001538 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001539 Define this to create an own partition. You have to provide a
1540 function struct part_info* jffs2_part_info(int part_num)
1541
1542 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001543 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001544 to disable the command chpart. This is the default when you
1545 have not defined a custom partition
1546
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001547- FAT(File Allocation Table) filesystem write function support:
1548 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001549
1550 Define this to enable support for saving memory data as a
1551 file in FAT formatted partition.
1552
1553 This will also enable the command "fatwrite" enabling the
1554 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001555
Gabe Black84cd9322012-10-12 14:26:11 +00001556CBFS (Coreboot Filesystem) support
1557 CONFIG_CMD_CBFS
1558
1559 Define this to enable support for reading from a Coreboot
1560 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1561 and cbfsload.
1562
wdenkc6097192002-11-03 00:24:07 +00001563- Keyboard Support:
1564 CONFIG_ISA_KEYBOARD
1565
1566 Define this to enable standard (PC-Style) keyboard
1567 support
1568
1569 CONFIG_I8042_KBD
1570 Standard PC keyboard driver with US (is default) and
1571 GERMAN key layout (switch via environment 'keymap=de') support.
1572 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1573 for cfb_console. Supports cursor blinking.
1574
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001575 CONFIG_CROS_EC_KEYB
1576 Enables a Chrome OS keyboard using the CROS_EC interface.
1577 This uses CROS_EC to communicate with a second microcontroller
1578 which provides key scans on request.
1579
wdenkc6097192002-11-03 00:24:07 +00001580- Video support:
1581 CONFIG_VIDEO
1582
1583 Define this to enable video support (for output to
1584 video).
1585
1586 CONFIG_VIDEO_CT69000
1587
1588 Enable Chips & Technologies 69000 Video chip
1589
1590 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001591 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001592 video output is selected via environment 'videoout'
1593 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1594 assumed.
wdenkc6097192002-11-03 00:24:07 +00001595
wdenkb79a11c2004-03-25 15:14:43 +00001596 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001597 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001598 are possible:
1599 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001600 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001601
1602 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1603 -------------+---------------------------------------------
1604 8 bits | 0x301* 0x303 0x305 0x161 0x307
1605 15 bits | 0x310 0x313 0x316 0x162 0x319
1606 16 bits | 0x311 0x314 0x317 0x163 0x31A
1607 24 bits | 0x312 0x315 0x318 ? 0x31B
1608 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001609 (i.e. setenv videomode 317; saveenv; reset;)
1610
wdenkb79a11c2004-03-25 15:14:43 +00001611 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001612 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001613
1614
stroesec1551ea2003-04-04 15:53:41 +00001615 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001616 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001617 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1618 or CONFIG_VIDEO_SED13806_16BPP
1619
Timur Tabi7d3053f2011-02-15 17:09:19 -06001620 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001621 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001622 SOCs that have a DIU should define this macro to enable DIU
1623 support, and should also define these other macros:
1624
1625 CONFIG_SYS_DIU_ADDR
1626 CONFIG_VIDEO
1627 CONFIG_CMD_BMP
1628 CONFIG_CFB_CONSOLE
1629 CONFIG_VIDEO_SW_CURSOR
1630 CONFIG_VGA_AS_SINGLE_DEVICE
1631 CONFIG_VIDEO_LOGO
1632 CONFIG_VIDEO_BMP_LOGO
1633
Timur Tabiba8e76b2011-04-11 14:18:22 -05001634 The DIU driver will look for the 'video-mode' environment
1635 variable, and if defined, enable the DIU as a console during
1636 boot. See the documentation file README.video for a
1637 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001638
Simon Glass058d59b2012-12-03 13:59:47 +00001639 CONFIG_VIDEO_VGA
1640
1641 Enable the VGA video / BIOS for x86. The alternative if you
1642 are using coreboot is to use the coreboot frame buffer
1643 driver.
1644
1645
wdenk682011f2003-06-03 23:54:09 +00001646- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001647 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001648
wdenk8bde7f72003-06-27 21:31:46 +00001649 Define this to enable a custom keyboard support.
1650 This simply calls drv_keyboard_init() which must be
1651 defined in your board-specific files.
1652 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001653
wdenkc6097192002-11-03 00:24:07 +00001654- LCD Support: CONFIG_LCD
1655
1656 Define this to enable LCD support (for output to LCD
1657 display); also select one of the supported displays
1658 by defining one of these:
1659
Stelian Pop39cf4802008-05-09 21:57:18 +02001660 CONFIG_ATMEL_LCD:
1661
1662 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1663
wdenkfd3103b2003-11-25 16:55:19 +00001664 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001665
wdenkfd3103b2003-11-25 16:55:19 +00001666 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001667
wdenkfd3103b2003-11-25 16:55:19 +00001668 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001669
wdenkfd3103b2003-11-25 16:55:19 +00001670 NEC NL6448BC20-08. 6.5", 640x480.
1671 Active, color, single scan.
1672
1673 CONFIG_NEC_NL6448BC33_54
1674
1675 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001676 Active, color, single scan.
1677
1678 CONFIG_SHARP_16x9
1679
1680 Sharp 320x240. Active, color, single scan.
1681 It isn't 16x9, and I am not sure what it is.
1682
1683 CONFIG_SHARP_LQ64D341
1684
1685 Sharp LQ64D341 display, 640x480.
1686 Active, color, single scan.
1687
1688 CONFIG_HLD1045
1689
1690 HLD1045 display, 640x480.
1691 Active, color, single scan.
1692
1693 CONFIG_OPTREX_BW
1694
1695 Optrex CBL50840-2 NF-FW 99 22 M5
1696 or
1697 Hitachi LMG6912RPFC-00T
1698 or
1699 Hitachi SP14Q002
1700
1701 320x240. Black & white.
1702
1703 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001704 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001705
Simon Glass676d3192012-10-17 13:24:54 +00001706 CONFIG_LCD_ALIGNMENT
1707
1708 Normally the LCD is page-aligned (tyically 4KB). If this is
1709 defined then the LCD will be aligned to this value instead.
1710 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1711 here, since it is cheaper to change data cache settings on
1712 a per-section basis.
1713
Simon Glass0d89efe2012-10-17 13:24:59 +00001714 CONFIG_CONSOLE_SCROLL_LINES
1715
1716 When the console need to be scrolled, this is the number of
1717 lines to scroll by. It defaults to 1. Increasing this makes
1718 the console jump but can help speed up operation when scrolling
1719 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001720
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001721 CONFIG_LCD_BMP_RLE8
1722
1723 Support drawing of RLE8-compressed bitmaps on the LCD.
1724
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001725 CONFIG_I2C_EDID
1726
1727 Enables an 'i2c edid' command which can read EDID
1728 information over I2C from an attached LCD display.
1729
wdenk7152b1d2003-09-05 23:19:14 +00001730- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001731
wdenk8bde7f72003-06-27 21:31:46 +00001732 If this option is set, the environment is checked for
1733 a variable "splashimage". If found, the usual display
1734 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001735 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001736 specified in "splashimage" is loaded instead. The
1737 console is redirected to the "nulldev", too. This
1738 allows for a "silent" boot where a splash screen is
1739 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001740
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001741 CONFIG_SPLASHIMAGE_GUARD
1742
1743 If this option is set, then U-Boot will prevent the environment
1744 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001745 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001746 This option is useful for targets where, due to alignment
1747 restrictions, an improperly aligned BMP image will cause a data
1748 abort. If you think you will not have problems with unaligned
1749 accesses (for example because your toolchain prevents them)
1750 there is no need to set this option.
1751
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001752 CONFIG_SPLASH_SCREEN_ALIGN
1753
1754 If this option is set the splash image can be freely positioned
1755 on the screen. Environment variable "splashpos" specifies the
1756 position as "x,y". If a positive number is given it is used as
1757 number of pixel from left/top. If a negative number is given it
1758 is used as number of pixel from right/bottom. You can also
1759 specify 'm' for centering the image.
1760
1761 Example:
1762 setenv splashpos m,m
1763 => image at center of screen
1764
1765 setenv splashpos 30,20
1766 => image at x = 30 and y = 20
1767
1768 setenv splashpos -10,m
1769 => vertically centered image
1770 at x = dspWidth - bmpWidth - 9
1771
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001772- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1773
1774 If this option is set, additionally to standard BMP
1775 images, gzipped BMP images can be displayed via the
1776 splashscreen support or the bmp command.
1777
Anatolij Gustschind5011762010-03-15 14:50:25 +01001778- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1779
1780 If this option is set, 8-bit RLE compressed BMP images
1781 can be displayed via the splashscreen support or the
1782 bmp command.
1783
Lei Wenf2b96df2012-09-28 04:26:47 +00001784- Do compresssing for memory range:
1785 CONFIG_CMD_ZIP
1786
1787 If this option is set, it would use zlib deflate method
1788 to compress the specified memory at its best effort.
1789
wdenkc29fdfc2003-08-29 20:57:53 +00001790- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001791 CONFIG_GZIP
1792
1793 Enabled by default to support gzip compressed images.
1794
wdenkc29fdfc2003-08-29 20:57:53 +00001795 CONFIG_BZIP2
1796
1797 If this option is set, support for bzip2 compressed
1798 images is included. If not, only uncompressed and gzip
1799 compressed images are supported.
1800
wdenk42d1f032003-10-15 23:53:47 +00001801 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001802 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001803 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001804
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001805 CONFIG_LZMA
1806
1807 If this option is set, support for lzma compressed
1808 images is included.
1809
1810 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1811 requires an amount of dynamic memory that is given by the
1812 formula:
1813
1814 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1815
1816 Where lc and lp stand for, respectively, Literal context bits
1817 and Literal pos bits.
1818
1819 This value is upper-bounded by 14MB in the worst case. Anyway,
1820 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1821 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1822 a very small buffer.
1823
1824 Use the lzmainfo tool to determinate the lc and lp values and
1825 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001826 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001827
Kees Cook8ef70472013-08-16 07:59:12 -07001828 CONFIG_LZO
1829
1830 If this option is set, support for LZO compressed images
1831 is included.
1832
wdenk17ea1172004-06-06 21:51:03 +00001833- MII/PHY support:
1834 CONFIG_PHY_ADDR
1835
1836 The address of PHY on MII bus.
1837
1838 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1839
1840 The clock frequency of the MII bus
1841
1842 CONFIG_PHY_GIGE
1843
1844 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001845 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001846
1847 CONFIG_PHY_RESET_DELAY
1848
1849 Some PHY like Intel LXT971A need extra delay after
1850 reset before any MII register access is possible.
1851 For such PHY, set this option to the usec delay
1852 required. (minimum 300usec for LXT971A)
1853
1854 CONFIG_PHY_CMD_DELAY (ppc4xx)
1855
1856 Some PHY like Intel LXT971A need extra delay after
1857 command issued before MII status register can be read
1858
wdenkc6097192002-11-03 00:24:07 +00001859- Ethernet address:
1860 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001861 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001862 CONFIG_ETH2ADDR
1863 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001864 CONFIG_ETH4ADDR
1865 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001866
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001867 Define a default value for Ethernet address to use
1868 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001869 is not determined automatically.
1870
1871- IP address:
1872 CONFIG_IPADDR
1873
1874 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001875 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001876 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001877 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001878
1879- Server IP address:
1880 CONFIG_SERVERIP
1881
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001882 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001883 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001884 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001885
Robin Getz97cfe862009-07-21 12:15:28 -04001886 CONFIG_KEEP_SERVERADDR
1887
1888 Keeps the server's MAC address, in the env 'serveraddr'
1889 for passing to bootargs (like Linux's netconsole option)
1890
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001891- Gateway IP address:
1892 CONFIG_GATEWAYIP
1893
1894 Defines a default value for the IP address of the
1895 default router where packets to other networks are
1896 sent to.
1897 (Environment variable "gatewayip")
1898
1899- Subnet mask:
1900 CONFIG_NETMASK
1901
1902 Defines a default value for the subnet mask (or
1903 routing prefix) which is used to determine if an IP
1904 address belongs to the local subnet or needs to be
1905 forwarded through a router.
1906 (Environment variable "netmask")
1907
David Updegraff53a5c422007-06-11 10:41:07 -05001908- Multicast TFTP Mode:
1909 CONFIG_MCAST_TFTP
1910
1911 Defines whether you want to support multicast TFTP as per
1912 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001913 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001914 driver in use must provide a function: mcast() to join/leave a
1915 multicast group.
1916
wdenkc6097192002-11-03 00:24:07 +00001917- BOOTP Recovery Mode:
1918 CONFIG_BOOTP_RANDOM_DELAY
1919
1920 If you have many targets in a network that try to
1921 boot using BOOTP, you may want to avoid that all
1922 systems send out BOOTP requests at precisely the same
1923 moment (which would happen for instance at recovery
1924 from a power failure, when all systems will try to
1925 boot, thus flooding the BOOTP server. Defining
1926 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1927 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001928 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001929
1930 1st BOOTP request: delay 0 ... 1 sec
1931 2nd BOOTP request: delay 0 ... 2 sec
1932 3rd BOOTP request: delay 0 ... 4 sec
1933 4th and following
1934 BOOTP requests: delay 0 ... 8 sec
1935
stroesefe389a82003-08-28 14:17:32 +00001936- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001937 You can fine tune the DHCP functionality by defining
1938 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001939
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001940 CONFIG_BOOTP_SUBNETMASK
1941 CONFIG_BOOTP_GATEWAY
1942 CONFIG_BOOTP_HOSTNAME
1943 CONFIG_BOOTP_NISDOMAIN
1944 CONFIG_BOOTP_BOOTPATH
1945 CONFIG_BOOTP_BOOTFILESIZE
1946 CONFIG_BOOTP_DNS
1947 CONFIG_BOOTP_DNS2
1948 CONFIG_BOOTP_SEND_HOSTNAME
1949 CONFIG_BOOTP_NTPSERVER
1950 CONFIG_BOOTP_TIMEOFFSET
1951 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001952 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001953
Wilson Callan5d110f02007-07-28 10:56:13 -04001954 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1955 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001956
Joe Hershberger2c00e092012-05-23 07:59:19 +00001957 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1958 after the configured retry count, the call will fail
1959 instead of starting over. This can be used to fail over
1960 to Link-local IP address configuration if the DHCP server
1961 is not available.
1962
stroesefe389a82003-08-28 14:17:32 +00001963 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1964 serverip from a DHCP server, it is possible that more
1965 than one DNS serverip is offered to the client.
1966 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1967 serverip will be stored in the additional environment
1968 variable "dnsip2". The first DNS serverip is always
1969 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001970 is defined.
stroesefe389a82003-08-28 14:17:32 +00001971
1972 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1973 to do a dynamic update of a DNS server. To do this, they
1974 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001975 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001976 of the "hostname" environment variable is passed as
1977 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001978
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001979 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1980
1981 A 32bit value in microseconds for a delay between
1982 receiving a "DHCP Offer" and sending the "DHCP Request".
1983 This fixes a problem with certain DHCP servers that don't
1984 respond 100% of the time to a "DHCP request". E.g. On an
1985 AT91RM9200 processor running at 180MHz, this delay needed
1986 to be *at least* 15,000 usec before a Windows Server 2003
1987 DHCP server would reply 100% of the time. I recommend at
1988 least 50,000 usec to be safe. The alternative is to hope
1989 that one of the retries will be successful but note that
1990 the DHCP timeout and retry process takes a longer than
1991 this delay.
1992
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001993 - Link-local IP address negotiation:
1994 Negotiate with other link-local clients on the local network
1995 for an address that doesn't require explicit configuration.
1996 This is especially useful if a DHCP server cannot be guaranteed
1997 to exist in all environments that the device must operate.
1998
1999 See doc/README.link-local for more information.
2000
wdenka3d991b2004-04-15 21:48:45 +00002001 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002002 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002003
2004 The device id used in CDP trigger frames.
2005
2006 CONFIG_CDP_DEVICE_ID_PREFIX
2007
2008 A two character string which is prefixed to the MAC address
2009 of the device.
2010
2011 CONFIG_CDP_PORT_ID
2012
2013 A printf format string which contains the ascii name of
2014 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002015 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002016
2017 CONFIG_CDP_CAPABILITIES
2018
2019 A 32bit integer which indicates the device capabilities;
2020 0x00000010 for a normal host which does not forwards.
2021
2022 CONFIG_CDP_VERSION
2023
2024 An ascii string containing the version of the software.
2025
2026 CONFIG_CDP_PLATFORM
2027
2028 An ascii string containing the name of the platform.
2029
2030 CONFIG_CDP_TRIGGER
2031
2032 A 32bit integer sent on the trigger.
2033
2034 CONFIG_CDP_POWER_CONSUMPTION
2035
2036 A 16bit integer containing the power consumption of the
2037 device in .1 of milliwatts.
2038
2039 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2040
2041 A byte containing the id of the VLAN.
2042
wdenkc6097192002-11-03 00:24:07 +00002043- Status LED: CONFIG_STATUS_LED
2044
2045 Several configurations allow to display the current
2046 status using a LED. For instance, the LED will blink
2047 fast while running U-Boot code, stop blinking as
2048 soon as a reply to a BOOTP request was received, and
2049 start blinking slow once the Linux kernel is running
2050 (supported by a status LED driver in the Linux
2051 kernel). Defining CONFIG_STATUS_LED enables this
2052 feature in U-Boot.
2053
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002054 Additional options:
2055
2056 CONFIG_GPIO_LED
2057 The status LED can be connected to a GPIO pin.
2058 In such cases, the gpio_led driver can be used as a
2059 status LED backend implementation. Define CONFIG_GPIO_LED
2060 to include the gpio_led driver in the U-Boot binary.
2061
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002062 CONFIG_GPIO_LED_INVERTED_TABLE
2063 Some GPIO connected LEDs may have inverted polarity in which
2064 case the GPIO high value corresponds to LED off state and
2065 GPIO low value corresponds to LED on state.
2066 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2067 with a list of GPIO LEDs that have inverted polarity.
2068
wdenkc6097192002-11-03 00:24:07 +00002069- CAN Support: CONFIG_CAN_DRIVER
2070
2071 Defining CONFIG_CAN_DRIVER enables CAN driver support
2072 on those systems that support this (optional)
2073 feature, like the TQM8xxL modules.
2074
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002075- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002076
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002077 This enable the NEW i2c subsystem, and will allow you to use
2078 i2c commands at the u-boot command line (as long as you set
2079 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2080 based realtime clock chips or other i2c devices. See
2081 common/cmd_i2c.c for a description of the command line
2082 interface.
2083
2084 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002085 - drivers/i2c/soft_i2c.c:
2086 - activate first bus with CONFIG_SYS_I2C_SOFT define
2087 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2088 for defining speed and slave address
2089 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2090 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2091 for defining speed and slave address
2092 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2093 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2094 for defining speed and slave address
2095 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2096 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2097 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002098
Heiko Schocher00f792e2012-10-24 13:48:22 +02002099 - drivers/i2c/fsl_i2c.c:
2100 - activate i2c driver with CONFIG_SYS_I2C_FSL
2101 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2102 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2103 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2104 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002105 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002106 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2107 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2108 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2109 second bus.
2110
Simon Glass1f2ba722012-10-30 07:28:53 +00002111 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002112 - activate this driver with CONFIG_SYS_I2C_TEGRA
2113 - This driver adds 4 i2c buses with a fix speed from
2114 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002115
Dirk Eibach880540d2013-04-25 02:40:01 +00002116 - drivers/i2c/ppc4xx_i2c.c
2117 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2118 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2119 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2120
tremfac96402013-09-21 18:13:35 +02002121 - drivers/i2c/i2c_mxc.c
2122 - activate this driver with CONFIG_SYS_I2C_MXC
2123 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2124 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2125 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2126 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2127 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2128 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2129 If thoses defines are not set, default value is 100000
2130 for speed, and 0 for slave.
2131
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002132 - drivers/i2c/rcar_i2c.c:
2133 - activate this driver with CONFIG_SYS_I2C_RCAR
2134 - This driver adds 4 i2c buses
2135
2136 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2137 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2138 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2139 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2140 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2141 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2142 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2143 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2144 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2145
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002146 - drivers/i2c/sh_i2c.c:
2147 - activate this driver with CONFIG_SYS_I2C_SH
2148 - This driver adds from 2 to 5 i2c buses
2149
2150 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2151 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2152 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2153 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2154 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2155 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2156 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2157 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2158 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2159 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2160 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2161 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2162 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2163
Heiko Schocher6789e842013-10-22 11:03:18 +02002164 - drivers/i2c/omap24xx_i2c.c
2165 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2166 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2167 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2168 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2169 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2170 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2171 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2172 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2173 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2174 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2175 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2176
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002177 - drivers/i2c/zynq_i2c.c
2178 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2179 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2180 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2181
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302182 - drivers/i2c/s3c24x0_i2c.c:
2183 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2184 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2185 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2186 with a fix speed from 100000 and the slave addr 0!
2187
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002188 additional defines:
2189
2190 CONFIG_SYS_NUM_I2C_BUSES
2191 Hold the number of i2c busses you want to use. If you
2192 don't use/have i2c muxes on your i2c bus, this
2193 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2194 omit this define.
2195
2196 CONFIG_SYS_I2C_DIRECT_BUS
2197 define this, if you don't use i2c muxes on your hardware.
2198 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2199 omit this define.
2200
2201 CONFIG_SYS_I2C_MAX_HOPS
2202 define how many muxes are maximal consecutively connected
2203 on one i2c bus. If you not use i2c muxes, omit this
2204 define.
2205
2206 CONFIG_SYS_I2C_BUSES
2207 hold a list of busses you want to use, only used if
2208 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2209 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2210 CONFIG_SYS_NUM_I2C_BUSES = 9:
2211
2212 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2213 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2214 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2215 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2216 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2217 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2218 {1, {I2C_NULL_HOP}}, \
2219 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2220 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2221 }
2222
2223 which defines
2224 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002225 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2226 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2227 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2228 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2229 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002230 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002231 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2232 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002233
2234 If you do not have i2c muxes on your board, omit this define.
2235
Heiko Schocherea818db2013-01-29 08:53:15 +01002236- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002237
2238 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2239 provides the following compelling advantages:
2240
2241 - more than one i2c adapter is usable
2242 - approved multibus support
2243 - better i2c mux support
2244
2245 ** Please consider updating your I2C driver now. **
2246
Heiko Schocherea818db2013-01-29 08:53:15 +01002247 These enable legacy I2C serial bus commands. Defining
2248 CONFIG_HARD_I2C will include the appropriate I2C driver
2249 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002250
wdenk945af8d2003-07-16 21:53:01 +00002251 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002252 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002253 CONFIG_COMMANDS) and communicate with i2c based realtime
2254 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002255 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002256
Ben Warrenbb99ad62006-09-07 16:50:54 -04002257 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002258
wdenk945af8d2003-07-16 21:53:01 +00002259 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002260 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002262 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002263 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002264 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002265 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002266
Peter Tyser8d321b82010-04-12 22:28:21 -05002267 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002268 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002269 and so its address should therefore be cleared to 0 (See,
2270 eg, MPC823e User's Manual p.16-473). So, set
2271 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002272
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002273 CONFIG_SYS_I2C_INIT_MPC5XXX
2274
2275 When a board is reset during an i2c bus transfer
2276 chips might think that the current transfer is still
2277 in progress. Reset the slave devices by sending start
2278 commands until the slave device responds.
2279
wdenk945af8d2003-07-16 21:53:01 +00002280 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002281
Heiko Schocherea818db2013-01-29 08:53:15 +01002282 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002283 then the following macros need to be defined (examples are
2284 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002285
2286 I2C_INIT
2287
wdenkb37c7e52003-06-30 16:24:52 +00002288 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002289 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002290
wdenkba56f622004-02-06 23:19:44 +00002291 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002292
wdenkc6097192002-11-03 00:24:07 +00002293 I2C_PORT
2294
wdenk43d96162003-03-06 00:02:04 +00002295 (Only for MPC8260 CPU). The I/O port to use (the code
2296 assumes both bits are on the same port). Valid values
2297 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002298
2299 I2C_ACTIVE
2300
2301 The code necessary to make the I2C data line active
2302 (driven). If the data line is open collector, this
2303 define can be null.
2304
wdenkb37c7e52003-06-30 16:24:52 +00002305 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2306
wdenkc6097192002-11-03 00:24:07 +00002307 I2C_TRISTATE
2308
2309 The code necessary to make the I2C data line tri-stated
2310 (inactive). If the data line is open collector, this
2311 define can be null.
2312
wdenkb37c7e52003-06-30 16:24:52 +00002313 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2314
wdenkc6097192002-11-03 00:24:07 +00002315 I2C_READ
2316
York Sun472d5462013-04-01 11:29:11 -07002317 Code that returns true if the I2C data line is high,
2318 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002319
wdenkb37c7e52003-06-30 16:24:52 +00002320 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2321
wdenkc6097192002-11-03 00:24:07 +00002322 I2C_SDA(bit)
2323
York Sun472d5462013-04-01 11:29:11 -07002324 If <bit> is true, sets the I2C data line high. If it
2325 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002326
wdenkb37c7e52003-06-30 16:24:52 +00002327 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002328 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002329 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002330
wdenkc6097192002-11-03 00:24:07 +00002331 I2C_SCL(bit)
2332
York Sun472d5462013-04-01 11:29:11 -07002333 If <bit> is true, sets the I2C clock line high. If it
2334 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002335
wdenkb37c7e52003-06-30 16:24:52 +00002336 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002337 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002338 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002339
wdenkc6097192002-11-03 00:24:07 +00002340 I2C_DELAY
2341
2342 This delay is invoked four times per clock cycle so this
2343 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002344 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002345 like:
2346
wdenkb37c7e52003-06-30 16:24:52 +00002347 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002348
Mike Frysinger793b5722010-07-21 13:38:02 -04002349 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2350
2351 If your arch supports the generic GPIO framework (asm/gpio.h),
2352 then you may alternatively define the two GPIOs that are to be
2353 used as SCL / SDA. Any of the previous I2C_xxx macros will
2354 have GPIO-based defaults assigned to them as appropriate.
2355
2356 You should define these to the GPIO value as given directly to
2357 the generic GPIO functions.
2358
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002359 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002360
wdenk8bde7f72003-06-27 21:31:46 +00002361 When a board is reset during an i2c bus transfer
2362 chips might think that the current transfer is still
2363 in progress. On some boards it is possible to access
2364 the i2c SCLK line directly, either by using the
2365 processor pin as a GPIO or by having a second pin
2366 connected to the bus. If this option is defined a
2367 custom i2c_init_board() routine in boards/xxx/board.c
2368 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002369
Richard Retanubun26a33502010-04-12 15:08:17 -04002370 CONFIG_SYS_I2C_BOARD_LATE_INIT
2371
2372 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2373 defined a custom i2c_board_late_init() routine in
2374 boards/xxx/board.c is run AFTER the operations in i2c_init()
2375 is completed. This callpoint can be used to unreset i2c bus
2376 using CPU i2c controller register accesses for CPUs whose i2c
2377 controller provide such a method. It is called at the end of
2378 i2c_init() to allow i2c_init operations to setup the i2c bus
2379 controller on the CPU (e.g. setting bus speed & slave address).
2380
wdenk17ea1172004-06-06 21:51:03 +00002381 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2382
2383 This option enables configuration of bi_iic_fast[] flags
2384 in u-boot bd_info structure based on u-boot environment
2385 variable "i2cfast". (see also i2cfast)
2386
Ben Warrenbb99ad62006-09-07 16:50:54 -04002387 CONFIG_I2C_MULTI_BUS
2388
2389 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002390 must have a controller. At any point in time, only one bus is
2391 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002392 Note that bus numbering is zero-based.
2393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002395
2396 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002397 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002398 is set, specify a list of bus-device pairs. Otherwise, specify
2399 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002400
2401 e.g.
2402 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002403 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002404
2405 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2406
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002407 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002408 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002409
2410 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2411
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002412 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002413
2414 If defined, then this indicates the I2C bus number for DDR SPD.
2415 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2416
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002417 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002418
2419 If defined, then this indicates the I2C bus number for the RTC.
2420 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2421
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002422 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002423
2424 If defined, then this indicates the I2C bus number for the DTT.
2425 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2426
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002427 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002428
2429 If defined, specifies the I2C address of the DTT device.
2430 If not defined, then U-Boot uses predefined value for
2431 specified DTT device.
2432
Andrew Dyer2ac69852008-12-29 17:36:01 -06002433 CONFIG_SOFT_I2C_READ_REPEATED_START
2434
2435 defining this will force the i2c_read() function in
2436 the soft_i2c driver to perform an I2C repeated start
2437 between writing the address pointer and reading the
2438 data. If this define is omitted the default behaviour
2439 of doing a stop-start sequence will be used. Most I2C
2440 devices can use either method, but some require one or
2441 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002442
wdenkc6097192002-11-03 00:24:07 +00002443- SPI Support: CONFIG_SPI
2444
2445 Enables SPI driver (so far only tested with
2446 SPI EEPROM, also an instance works with Crystal A/D and
2447 D/As on the SACSng board)
2448
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002449 CONFIG_SH_SPI
2450
2451 Enables the driver for SPI controller on SuperH. Currently
2452 only SH7757 is supported.
2453
wdenkc6097192002-11-03 00:24:07 +00002454 CONFIG_SPI_X
2455
2456 Enables extended (16-bit) SPI EEPROM addressing.
2457 (symmetrical to CONFIG_I2C_X)
2458
2459 CONFIG_SOFT_SPI
2460
wdenk43d96162003-03-06 00:02:04 +00002461 Enables a software (bit-bang) SPI driver rather than
2462 using hardware support. This is a general purpose
2463 driver that only requires three general I/O port pins
2464 (two outputs, one input) to function. If this is
2465 defined, the board configuration must define several
2466 SPI configuration items (port pins to use, etc). For
2467 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002468
Ben Warren04a9e112008-01-16 22:37:35 -05002469 CONFIG_HARD_SPI
2470
2471 Enables a hardware SPI driver for general-purpose reads
2472 and writes. As with CONFIG_SOFT_SPI, the board configuration
2473 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002474 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002475 example, see include/configs/mpc8349emds.h.
2476
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002477 CONFIG_MXC_SPI
2478
2479 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002480 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002481
Matthias Fuchs01335022007-12-27 17:12:34 +01002482- FPGA Support: CONFIG_FPGA
2483
2484 Enables FPGA subsystem.
2485
2486 CONFIG_FPGA_<vendor>
2487
2488 Enables support for specific chip vendors.
2489 (ALTERA, XILINX)
2490
2491 CONFIG_FPGA_<family>
2492
2493 Enables support for FPGA family.
2494 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2495
2496 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002497
wdenk43d96162003-03-06 00:02:04 +00002498 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002501
wdenk8bde7f72003-06-27 21:31:46 +00002502 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002504 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002505
wdenk43d96162003-03-06 00:02:04 +00002506 Enable checks on FPGA configuration interface busy
2507 status by the configuration function. This option
2508 will require a board or device specific function to
2509 be written.
wdenkc6097192002-11-03 00:24:07 +00002510
2511 CONFIG_FPGA_DELAY
2512
2513 If defined, a function that provides delays in the FPGA
2514 configuration driver.
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002517 Allow Control-C to interrupt FPGA configuration
2518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002519 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002520
wdenk43d96162003-03-06 00:02:04 +00002521 Check for configuration errors during FPGA bitfile
2522 loading. For example, abort during Virtex II
2523 configuration if the INIT_B line goes low (which
2524 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002525
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002526 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002527
wdenk43d96162003-03-06 00:02:04 +00002528 Maximum time to wait for the INIT_B line to deassert
2529 after PROB_B has been deasserted during a Virtex II
2530 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002531 ms.
wdenkc6097192002-11-03 00:24:07 +00002532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002533 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002534
wdenk43d96162003-03-06 00:02:04 +00002535 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002536 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002538 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002539
wdenk43d96162003-03-06 00:02:04 +00002540 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002541 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002542
2543- Configuration Management:
2544 CONFIG_IDENT_STRING
2545
wdenk43d96162003-03-06 00:02:04 +00002546 If defined, this string will be added to the U-Boot
2547 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002548
2549- Vendor Parameter Protection:
2550
wdenk43d96162003-03-06 00:02:04 +00002551 U-Boot considers the values of the environment
2552 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002553 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002554 are set once by the board vendor / manufacturer, and
2555 protects these variables from casual modification by
2556 the user. Once set, these variables are read-only,
2557 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002558 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002559
2560 If CONFIG_ENV_OVERWRITE is #defined in your config
2561 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002562 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002563 these parameters.
2564
2565 Alternatively, if you #define _both_ CONFIG_ETHADDR
2566 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002567 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002568 which can be changed exactly ONCE by the user. [The
2569 serial# is unaffected by this, i. e. it remains
2570 read-only.]
2571
Joe Hershberger25980902012-12-11 22:16:31 -06002572 The same can be accomplished in a more flexible way
2573 for any variable by configuring the type of access
2574 to allow for those variables in the ".flags" variable
2575 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2576
wdenkc6097192002-11-03 00:24:07 +00002577- Protected RAM:
2578 CONFIG_PRAM
2579
2580 Define this variable to enable the reservation of
2581 "protected RAM", i. e. RAM which is not overwritten
2582 by U-Boot. Define CONFIG_PRAM to hold the number of
2583 kB you want to reserve for pRAM. You can overwrite
2584 this default value by defining an environment
2585 variable "pram" to the number of kB you want to
2586 reserve. Note that the board info structure will
2587 still show the full amount of RAM. If pRAM is
2588 reserved, a new environment variable "mem" will
2589 automatically be defined to hold the amount of
2590 remaining RAM in a form that can be passed as boot
2591 argument to Linux, for instance like that:
2592
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002593 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002594 saveenv
2595
2596 This way you can tell Linux not to use this memory,
2597 either, which results in a memory region that will
2598 not be affected by reboots.
2599
2600 *WARNING* If your board configuration uses automatic
2601 detection of the RAM size, you must make sure that
2602 this memory test is non-destructive. So far, the
2603 following board configurations are known to be
2604 "pRAM-clean":
2605
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002606 IVMS8, IVML24, SPD8xx, TQM8xxL,
2607 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002608 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002609
Gabe Black40fef042012-12-02 04:55:18 +00002610- Access to physical memory region (> 4GB)
2611 Some basic support is provided for operations on memory not
2612 normally accessible to U-Boot - e.g. some architectures
2613 support access to more than 4GB of memory on 32-bit
2614 machines using physical address extension or similar.
2615 Define CONFIG_PHYSMEM to access this basic support, which
2616 currently only supports clearing the memory.
2617
wdenkc6097192002-11-03 00:24:07 +00002618- Error Recovery:
2619 CONFIG_PANIC_HANG
2620
2621 Define this variable to stop the system in case of a
2622 fatal error, so that you have to reset it manually.
2623 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002624 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002625 automatically as fast as possible, but it may be
2626 useful during development since you can try to debug
2627 the conditions that lead to the situation.
2628
2629 CONFIG_NET_RETRY_COUNT
2630
wdenk43d96162003-03-06 00:02:04 +00002631 This variable defines the number of retries for
2632 network operations like ARP, RARP, TFTP, or BOOTP
2633 before giving up the operation. If not defined, a
2634 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002635
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002636 CONFIG_ARP_TIMEOUT
2637
2638 Timeout waiting for an ARP reply in milliseconds.
2639
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002640 CONFIG_NFS_TIMEOUT
2641
2642 Timeout in milliseconds used in NFS protocol.
2643 If you encounter "ERROR: Cannot umount" in nfs command,
2644 try longer timeout such as
2645 #define CONFIG_NFS_TIMEOUT 10000UL
2646
wdenkc6097192002-11-03 00:24:07 +00002647- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002648 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002649
2650 Enable auto completion of commands using TAB.
2651
Wolfgang Denka9398e02006-11-27 15:32:42 +01002652 Note that this feature has NOT been implemented yet
2653 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002654
2655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002656 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002657
2658 Define this variable to enable the "hush" shell (from
2659 Busybox) as command line interpreter, thus enabling
2660 powerful command line syntax like
2661 if...then...else...fi conditionals or `&&' and '||'
2662 constructs ("shell scripts").
2663
2664 If undefined, you get the old, much simpler behaviour
2665 with a somewhat smaller memory footprint.
2666
2667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002668 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002669
2670 This defines the secondary prompt string, which is
2671 printed when the command interpreter needs more input
2672 to complete a command. Usually "> ".
2673
2674 Note:
2675
wdenk8bde7f72003-06-27 21:31:46 +00002676 In the current implementation, the local variables
2677 space and global environment variables space are
2678 separated. Local variables are those you define by
2679 simply typing `name=value'. To access a local
2680 variable later on, you have write `$name' or
2681 `${name}'; to execute the contents of a variable
2682 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002683
wdenk43d96162003-03-06 00:02:04 +00002684 Global environment variables are those you use
2685 setenv/printenv to work with. To run a command stored
2686 in such a variable, you need to use the run command,
2687 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002688
2689 To store commands and special characters in a
2690 variable, please use double quotation marks
2691 surrounding the whole text of the variable, instead
2692 of the backslashes before semicolons and special
2693 symbols.
2694
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002695- Commandline Editing and History:
2696 CONFIG_CMDLINE_EDITING
2697
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002698 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002699 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002700
wdenka8c7c702003-12-06 19:49:23 +00002701- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002702 CONFIG_EXTRA_ENV_SETTINGS
2703
wdenk43d96162003-03-06 00:02:04 +00002704 Define this to contain any number of null terminated
2705 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002706 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002707
wdenk43d96162003-03-06 00:02:04 +00002708 For example, place something like this in your
2709 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002710
2711 #define CONFIG_EXTRA_ENV_SETTINGS \
2712 "myvar1=value1\0" \
2713 "myvar2=value2\0"
2714
wdenk43d96162003-03-06 00:02:04 +00002715 Warning: This method is based on knowledge about the
2716 internal format how the environment is stored by the
2717 U-Boot code. This is NOT an official, exported
2718 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002719 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002720 You better know what you are doing here.
2721
wdenk43d96162003-03-06 00:02:04 +00002722 Note: overly (ab)use of the default environment is
2723 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002724 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002725 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002726
Stephen Warren5e724ca2012-05-22 09:21:54 +00002727 CONFIG_ENV_VARS_UBOOT_CONFIG
2728
2729 Define this in order to add variables describing the
2730 U-Boot build configuration to the default environment.
2731 These will be named arch, cpu, board, vendor, and soc.
2732
2733 Enabling this option will cause the following to be defined:
2734
2735 - CONFIG_SYS_ARCH
2736 - CONFIG_SYS_CPU
2737 - CONFIG_SYS_BOARD
2738 - CONFIG_SYS_VENDOR
2739 - CONFIG_SYS_SOC
2740
Tom Rini7e27f892012-10-24 07:28:16 +00002741 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2742
2743 Define this in order to add variables describing certain
2744 run-time determined information about the hardware to the
2745 environment. These will be named board_name, board_rev.
2746
Simon Glass06fd8532012-11-30 13:01:17 +00002747 CONFIG_DELAY_ENVIRONMENT
2748
2749 Normally the environment is loaded when the board is
2750 intialised so that it is available to U-Boot. This inhibits
2751 that so that the environment is not available until
2752 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2753 this is instead controlled by the value of
2754 /config/load-environment.
2755
wdenka8c7c702003-12-06 19:49:23 +00002756- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002757 CONFIG_HAS_DATAFLASH
2758
wdenk8bde7f72003-06-27 21:31:46 +00002759 Defining this option enables DataFlash features and
2760 allows to read/write in Dataflash via the standard
2761 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002762
Eric Nelsonf61ec452012-01-31 10:52:08 -07002763- Serial Flash support
2764 CONFIG_CMD_SF
2765
2766 Defining this option enables SPI flash commands
2767 'sf probe/read/write/erase/update'.
2768
2769 Usage requires an initial 'probe' to define the serial
2770 flash parameters, followed by read/write/erase/update
2771 commands.
2772
2773 The following defaults may be provided by the platform
2774 to handle the common case when only a single serial
2775 flash is present on the system.
2776
2777 CONFIG_SF_DEFAULT_BUS Bus identifier
2778 CONFIG_SF_DEFAULT_CS Chip-select
2779 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2780 CONFIG_SF_DEFAULT_SPEED in Hz
2781
Simon Glass24007272012-10-08 13:16:02 +00002782 CONFIG_CMD_SF_TEST
2783
2784 Define this option to include a destructive SPI flash
2785 test ('sf test').
2786
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302787 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2788
2789 Define this option to use the Bank addr/Extended addr
2790 support on SPI flashes which has size > 16Mbytes.
2791
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302792 CONFIG_SF_DUAL_FLASH Dual flash memories
2793
2794 Define this option to use dual flash support where two flash
2795 memories can be connected with a given cs line.
2796 currently Xilinx Zynq qspi support these type of connections.
2797
wdenk3f85ce22004-02-23 16:11:30 +00002798- SystemACE Support:
2799 CONFIG_SYSTEMACE
2800
2801 Adding this option adds support for Xilinx SystemACE
2802 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002803 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002804 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002805
2806 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002808
2809 When SystemACE support is added, the "ace" device type
2810 becomes available to the fat commands, i.e. fatls.
2811
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002812- TFTP Fixed UDP Port:
2813 CONFIG_TFTP_PORT
2814
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002815 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002816 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002817 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002818 number generator is used.
2819
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002820 Also, the environment variable tftpdstp is used to supply
2821 the TFTP UDP destination port value. If tftpdstp isn't
2822 defined, the normal port 69 is used.
2823
2824 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002825 blindly start the TFTP transfer using the pre-configured
2826 target IP address and UDP port. This has the effect of
2827 "punching through" the (Windows XP) firewall, allowing
2828 the remainder of the TFTP transfer to proceed normally.
2829 A better solution is to properly configure the firewall,
2830 but sometimes that is not allowed.
2831
Simon Glassbf36c5d2012-12-05 14:46:38 +00002832- Hashing support:
2833 CONFIG_CMD_HASH
2834
2835 This enables a generic 'hash' command which can produce
2836 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2837
2838 CONFIG_HASH_VERIFY
2839
2840 Enable the hash verify command (hash -v). This adds to code
2841 size a little.
2842
2843 CONFIG_SHA1 - support SHA1 hashing
2844 CONFIG_SHA256 - support SHA256 hashing
2845
2846 Note: There is also a sha1sum command, which should perhaps
2847 be deprecated in favour of 'hash sha1'.
2848
Robert Winklera11f1872013-07-24 17:57:06 -07002849- Freescale i.MX specific commands:
2850 CONFIG_CMD_HDMIDETECT
2851 This enables 'hdmidet' command which returns true if an
2852 HDMI monitor is detected. This command is i.MX 6 specific.
2853
2854 CONFIG_CMD_BMODE
2855 This enables the 'bmode' (bootmode) command for forcing
2856 a boot from specific media.
2857
2858 This is useful for forcing the ROM's usb downloader to
2859 activate upon a watchdog reset which is nice when iterating
2860 on U-Boot. Using the reset button or running bmode normal
2861 will set it back to normal. This command currently
2862 supports i.MX53 and i.MX6.
2863
Simon Glass19c402a2013-06-13 15:10:02 -07002864- Signing support:
2865 CONFIG_RSA
2866
2867 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01002868 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07002869
2870 The signing part is build into mkimage regardless of this
2871 option.
2872
Heiko Schocher9e50c402014-01-25 07:27:13 +01002873- bootcount support:
2874 CONFIG_BOOTCOUNT_LIMIT
2875
2876 This enables the bootcounter support, see:
2877 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2878
2879 CONFIG_AT91SAM9XE
2880 enable special bootcounter support on at91sam9xe based boards.
2881 CONFIG_BLACKFIN
2882 enable special bootcounter support on blackfin based boards.
2883 CONFIG_SOC_DA8XX
2884 enable special bootcounter support on da850 based boards.
2885 CONFIG_BOOTCOUNT_RAM
2886 enable support for the bootcounter in RAM
2887 CONFIG_BOOTCOUNT_I2C
2888 enable support for the bootcounter on an i2c (like RTC) device.
2889 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2890 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2891 the bootcounter.
2892 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002893
wdenka8c7c702003-12-06 19:49:23 +00002894- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002895 CONFIG_SHOW_BOOT_PROGRESS
2896
wdenk43d96162003-03-06 00:02:04 +00002897 Defining this option allows to add some board-
2898 specific code (calling a user-provided function
2899 "show_boot_progress(int)") that enables you to show
2900 the system's boot progress on some display (for
2901 example, some LED's) on your board. At the moment,
2902 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002903
Simon Glass3a608ca2012-02-13 13:51:19 +00002904- Detailed boot stage timing
2905 CONFIG_BOOTSTAGE
2906 Define this option to get detailed timing of each stage
2907 of the boot process.
2908
2909 CONFIG_BOOTSTAGE_USER_COUNT
2910 This is the number of available user bootstage records.
2911 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2912 a new ID will be allocated from this stash. If you exceed
2913 the limit, recording will stop.
2914
2915 CONFIG_BOOTSTAGE_REPORT
2916 Define this to print a report before boot, similar to this:
2917
2918 Timer summary in microseconds:
2919 Mark Elapsed Stage
2920 0 0 reset
2921 3,575,678 3,575,678 board_init_f start
2922 3,575,695 17 arch_cpu_init A9
2923 3,575,777 82 arch_cpu_init done
2924 3,659,598 83,821 board_init_r start
2925 3,910,375 250,777 main_loop
2926 29,916,167 26,005,792 bootm_start
2927 30,361,327 445,160 start_kernel
2928
Simon Glass2eba38c2012-09-28 08:56:39 +00002929 CONFIG_CMD_BOOTSTAGE
2930 Add a 'bootstage' command which supports printing a report
2931 and un/stashing of bootstage data.
2932
Simon Glass94fd1312012-09-28 08:56:37 +00002933 CONFIG_BOOTSTAGE_FDT
2934 Stash the bootstage information in the FDT. A root 'bootstage'
2935 node is created with each bootstage id as a child. Each child
2936 has a 'name' property and either 'mark' containing the
2937 mark time in microsecond, or 'accum' containing the
2938 accumulated time for that bootstage id in microseconds.
2939 For example:
2940
2941 bootstage {
2942 154 {
2943 name = "board_init_f";
2944 mark = <3575678>;
2945 };
2946 170 {
2947 name = "lcd";
2948 accum = <33482>;
2949 };
2950 };
2951
2952 Code in the Linux kernel can find this in /proc/devicetree.
2953
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002954Legacy uImage format:
2955
wdenkc6097192002-11-03 00:24:07 +00002956 Arg Where When
2957 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002958 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002959 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002960 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002961 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002962 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002963 4 common/cmd_bootm.c Image data has correct checksum
2964 -4 common/cmd_bootm.c Image is for unsupported architecture
2965 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002966 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002967 6 common/cmd_bootm.c Image Type check OK
2968 -6 common/cmd_bootm.c gunzip uncompression error
2969 -7 common/cmd_bootm.c Unimplemented compression type
2970 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002971 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002972 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002973
2974 9 common/image.c Start initial ramdisk verification
2975 -10 common/image.c Ramdisk header has bad magic number
2976 -11 common/image.c Ramdisk header has bad checksum
2977 10 common/image.c Ramdisk header is OK
2978 -12 common/image.c Ramdisk data has bad checksum
2979 11 common/image.c Ramdisk data has correct checksum
2980 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002981 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002982 13 common/image.c Start multifile image verification
2983 14 common/image.c No initial ramdisk, no multifile, continue.
2984
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002985 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002986
Stefan Roesea47a12b2010-04-15 16:07:28 +02002987 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002988 -31 post/post.c POST test failed, detected by post_output_backlog()
2989 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002990
Heiko Schocher566a4942007-06-22 19:11:54 +02002991 34 common/cmd_doc.c before loading a Image from a DOC device
2992 -35 common/cmd_doc.c Bad usage of "doc" command
2993 35 common/cmd_doc.c correct usage of "doc" command
2994 -36 common/cmd_doc.c No boot device
2995 36 common/cmd_doc.c correct boot device
2996 -37 common/cmd_doc.c Unknown Chip ID on boot device
2997 37 common/cmd_doc.c correct chip ID found, device available
2998 -38 common/cmd_doc.c Read Error on boot device
2999 38 common/cmd_doc.c reading Image header from DOC device OK
3000 -39 common/cmd_doc.c Image header has bad magic number
3001 39 common/cmd_doc.c Image header has correct magic number
3002 -40 common/cmd_doc.c Error reading Image from DOC device
3003 40 common/cmd_doc.c Image header has correct magic number
3004 41 common/cmd_ide.c before loading a Image from a IDE device
3005 -42 common/cmd_ide.c Bad usage of "ide" command
3006 42 common/cmd_ide.c correct usage of "ide" command
3007 -43 common/cmd_ide.c No boot device
3008 43 common/cmd_ide.c boot device found
3009 -44 common/cmd_ide.c Device not available
3010 44 common/cmd_ide.c Device available
3011 -45 common/cmd_ide.c wrong partition selected
3012 45 common/cmd_ide.c partition selected
3013 -46 common/cmd_ide.c Unknown partition table
3014 46 common/cmd_ide.c valid partition table found
3015 -47 common/cmd_ide.c Invalid partition type
3016 47 common/cmd_ide.c correct partition type
3017 -48 common/cmd_ide.c Error reading Image Header on boot device
3018 48 common/cmd_ide.c reading Image Header from IDE device OK
3019 -49 common/cmd_ide.c Image header has bad magic number
3020 49 common/cmd_ide.c Image header has correct magic number
3021 -50 common/cmd_ide.c Image header has bad checksum
3022 50 common/cmd_ide.c Image header has correct checksum
3023 -51 common/cmd_ide.c Error reading Image from IDE device
3024 51 common/cmd_ide.c reading Image from IDE device OK
3025 52 common/cmd_nand.c before loading a Image from a NAND device
3026 -53 common/cmd_nand.c Bad usage of "nand" command
3027 53 common/cmd_nand.c correct usage of "nand" command
3028 -54 common/cmd_nand.c No boot device
3029 54 common/cmd_nand.c boot device found
3030 -55 common/cmd_nand.c Unknown Chip ID on boot device
3031 55 common/cmd_nand.c correct chip ID found, device available
3032 -56 common/cmd_nand.c Error reading Image Header on boot device
3033 56 common/cmd_nand.c reading Image Header from NAND device OK
3034 -57 common/cmd_nand.c Image header has bad magic number
3035 57 common/cmd_nand.c Image header has correct magic number
3036 -58 common/cmd_nand.c Error reading Image from NAND device
3037 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003038
Heiko Schocher566a4942007-06-22 19:11:54 +02003039 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003040
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003041 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003042 -64 net/eth.c no Ethernet found.
3043 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003044
Heiko Schocher566a4942007-06-22 19:11:54 +02003045 -80 common/cmd_net.c usage wrong
3046 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003047 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003048 81 common/cmd_net.c NetLoop() back without error
3049 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3050 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003051 83 common/cmd_net.c running "source" command
3052 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003053 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003054
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003055FIT uImage format:
3056
3057 Arg Where When
3058 100 common/cmd_bootm.c Kernel FIT Image has correct format
3059 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3060 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3061 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3062 102 common/cmd_bootm.c Kernel unit name specified
3063 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003064 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003065 104 common/cmd_bootm.c Got kernel subimage node offset
3066 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3067 105 common/cmd_bootm.c Kernel subimage hash verification OK
3068 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3069 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003070 -106 common/cmd_bootm.c Kernel subimage has wrong type
3071 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003072 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3073 108 common/cmd_bootm.c Got kernel subimage data/size
3074 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3075 -109 common/cmd_bootm.c Can't get kernel subimage type
3076 -110 common/cmd_bootm.c Can't get kernel subimage comp
3077 -111 common/cmd_bootm.c Can't get kernel subimage os
3078 -112 common/cmd_bootm.c Can't get kernel subimage load address
3079 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3080
3081 120 common/image.c Start initial ramdisk verification
3082 -120 common/image.c Ramdisk FIT image has incorrect format
3083 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003084 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003085 -122 common/image.c Can't get configuration for ramdisk subimage
3086 123 common/image.c Ramdisk unit name specified
3087 -124 common/image.c Can't get ramdisk subimage node offset
3088 125 common/image.c Got ramdisk subimage node offset
3089 -125 common/image.c Ramdisk subimage hash verification failed
3090 126 common/image.c Ramdisk subimage hash verification OK
3091 -126 common/image.c Ramdisk subimage for unsupported architecture
3092 127 common/image.c Architecture check OK
3093 -127 common/image.c Can't get ramdisk subimage data/size
3094 128 common/image.c Got ramdisk subimage data/size
3095 129 common/image.c Can't get ramdisk load address
3096 -129 common/image.c Got ramdisk load address
3097
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003098 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003099 131 common/cmd_doc.c FIT image format OK
3100
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003101 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003102 141 common/cmd_ide.c FIT image format OK
3103
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003104 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003105 151 common/cmd_nand.c FIT image format OK
3106
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003107- FIT image support:
3108 CONFIG_FIT
3109 Enable support for the FIT uImage format.
3110
3111 CONFIG_FIT_BEST_MATCH
3112 When no configuration is explicitly selected, default to the
3113 one whose fdt's compatibility field best matches that of
3114 U-Boot itself. A match is considered "best" if it matches the
3115 most specific compatibility entry of U-Boot's fdt's root node.
3116 The order of entries in the configuration's fdt is ignored.
3117
Simon Glass3e569a62013-06-13 15:10:00 -07003118 CONFIG_FIT_SIGNATURE
3119 This option enables signature verification of FIT uImages,
3120 using a hash signed and verified using RSA. See
3121 doc/uImage.FIT/signature.txt for more details.
3122
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003123- Standalone program support:
3124 CONFIG_STANDALONE_LOAD_ADDR
3125
Wolfgang Denk6feff892011-10-09 21:06:34 +02003126 This option defines a board specific value for the
3127 address where standalone program gets loaded, thus
3128 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003129 settings.
3130
3131- Frame Buffer Address:
3132 CONFIG_FB_ADDR
3133
3134 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003135 address for frame buffer. This is typically the case
3136 when using a graphics controller has separate video
3137 memory. U-Boot will then place the frame buffer at
3138 the given address instead of dynamically reserving it
3139 in system RAM by calling lcd_setmem(), which grabs
3140 the memory for the frame buffer depending on the
3141 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003142
3143 Please see board_init_f function.
3144
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003145- Automatic software updates via TFTP server
3146 CONFIG_UPDATE_TFTP
3147 CONFIG_UPDATE_TFTP_CNT_MAX
3148 CONFIG_UPDATE_TFTP_MSEC_MAX
3149
3150 These options enable and control the auto-update feature;
3151 for a more detailed description refer to doc/README.update.
3152
3153- MTD Support (mtdparts command, UBI support)
3154 CONFIG_MTD_DEVICE
3155
3156 Adds the MTD device infrastructure from the Linux kernel.
3157 Needed for mtdparts command support.
3158
3159 CONFIG_MTD_PARTITIONS
3160
3161 Adds the MTD partitioning infrastructure from the Linux
3162 kernel. Needed for UBI support.
3163
Joe Hershberger70c219c2013-04-08 10:32:48 +00003164- UBI support
3165 CONFIG_CMD_UBI
3166
3167 Adds commands for interacting with MTD partitions formatted
3168 with the UBI flash translation layer
3169
3170 Requires also defining CONFIG_RBTREE
3171
Joe Hershberger147162d2013-04-08 10:32:49 +00003172 CONFIG_UBI_SILENCE_MSG
3173
3174 Make the verbose messages from UBI stop printing. This leaves
3175 warnings and errors enabled.
3176
Joe Hershberger70c219c2013-04-08 10:32:48 +00003177- UBIFS support
3178 CONFIG_CMD_UBIFS
3179
3180 Adds commands for interacting with UBI volumes formatted as
3181 UBIFS. UBIFS is read-only in u-boot.
3182
3183 Requires UBI support as well as CONFIG_LZO
3184
Joe Hershberger147162d2013-04-08 10:32:49 +00003185 CONFIG_UBIFS_SILENCE_MSG
3186
3187 Make the verbose messages from UBIFS stop printing. This leaves
3188 warnings and errors enabled.
3189
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003190- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003191 CONFIG_SPL
3192 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003193
Tom Rini95579792012-02-14 07:29:40 +00003194 CONFIG_SPL_LDSCRIPT
3195 LDSCRIPT for linking the SPL binary.
3196
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003197 CONFIG_SPL_MAX_FOOTPRINT
3198 Maximum size in memory allocated to the SPL, BSS included.
3199 When defined, the linker checks that the actual memory
3200 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003201 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003202 must not be both defined at the same time.
3203
Tom Rini95579792012-02-14 07:29:40 +00003204 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003205 Maximum size of the SPL image (text, data, rodata, and
3206 linker lists sections), BSS excluded.
3207 When defined, the linker checks that the actual size does
3208 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003209
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003210 CONFIG_SPL_TEXT_BASE
3211 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003212
Scott Wood94a45bb2012-09-20 19:05:12 -05003213 CONFIG_SPL_RELOC_TEXT_BASE
3214 Address to relocate to. If unspecified, this is equal to
3215 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3216
Tom Rini95579792012-02-14 07:29:40 +00003217 CONFIG_SPL_BSS_START_ADDR
3218 Link address for the BSS within the SPL binary.
3219
3220 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003221 Maximum size in memory allocated to the SPL BSS.
3222 When defined, the linker checks that the actual memory used
3223 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003224 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003225 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003226
3227 CONFIG_SPL_STACK
3228 Adress of the start of the stack SPL will use
3229
Scott Wood94a45bb2012-09-20 19:05:12 -05003230 CONFIG_SPL_RELOC_STACK
3231 Adress of the start of the stack SPL will use after
3232 relocation. If unspecified, this is equal to
3233 CONFIG_SPL_STACK.
3234
Tom Rini95579792012-02-14 07:29:40 +00003235 CONFIG_SYS_SPL_MALLOC_START
3236 Starting address of the malloc pool used in SPL.
3237
3238 CONFIG_SYS_SPL_MALLOC_SIZE
3239 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003240
Tom Rini47f7bca2012-08-13 12:03:19 -07003241 CONFIG_SPL_FRAMEWORK
3242 Enable the SPL framework under common/. This framework
3243 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3244 NAND loading of the Linux Kernel.
3245
Tom Rini861a86f2012-08-13 11:37:56 -07003246 CONFIG_SPL_DISPLAY_PRINT
3247 For ARM, enable an optional function to print more information
3248 about the running system.
3249
Scott Wood4b919722012-09-20 16:35:21 -05003250 CONFIG_SPL_INIT_MINIMAL
3251 Arch init code should be built for a very small image
3252
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003253 CONFIG_SPL_LIBCOMMON_SUPPORT
3254 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003255
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003256 CONFIG_SPL_LIBDISK_SUPPORT
3257 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003258
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003259 CONFIG_SPL_I2C_SUPPORT
3260 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003261
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003262 CONFIG_SPL_GPIO_SUPPORT
3263 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003264
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003265 CONFIG_SPL_MMC_SUPPORT
3266 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003267
Tom Rini95579792012-02-14 07:29:40 +00003268 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3269 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3270 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3271 Address, size and partition on the MMC to load U-Boot from
3272 when the MMC is being used in raw mode.
3273
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003274 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3275 Sector to load kernel uImage from when MMC is being
3276 used in raw mode (for Falcon mode)
3277
3278 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3279 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3280 Sector and number of sectors to load kernel argument
3281 parameters from when MMC is being used in raw mode
3282 (for falcon mode)
3283
Tom Rini95579792012-02-14 07:29:40 +00003284 CONFIG_SPL_FAT_SUPPORT
3285 Support for fs/fat/libfat.o in SPL binary
3286
3287 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3288 Filename to read to load U-Boot when reading from FAT
3289
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003290 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3291 Filename to read to load kernel uImage when reading
3292 from FAT (for Falcon mode)
3293
3294 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3295 Filename to read to load kernel argument parameters
3296 when reading from FAT (for Falcon mode)
3297
Scott Wood06f60ae2012-12-06 13:33:17 +00003298 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3299 Set this for NAND SPL on PPC mpc83xx targets, so that
3300 start.S waits for the rest of the SPL to load before
3301 continuing (the hardware starts execution after just
3302 loading the first page rather than the full 4K).
3303
Scott Wood6f2f01b2012-09-20 19:09:07 -05003304 CONFIG_SPL_NAND_BASE
3305 Include nand_base.c in the SPL. Requires
3306 CONFIG_SPL_NAND_DRIVERS.
3307
3308 CONFIG_SPL_NAND_DRIVERS
3309 SPL uses normal NAND drivers, not minimal drivers.
3310
3311 CONFIG_SPL_NAND_ECC
3312 Include standard software ECC in the SPL
3313
Tom Rini95579792012-02-14 07:29:40 +00003314 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003315 Support for NAND boot using simple NAND drivers that
3316 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003317
Ying Zhangbb0dc102013-08-16 15:16:11 +08003318 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3319 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003320 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003321
Ying Zhang7c8eea52013-08-16 15:16:12 +08003322 CONFIG_SPL_COMMON_INIT_DDR
3323 Set for common ddr init with serial presence detect in
3324 SPL binary.
3325
Tom Rini95579792012-02-14 07:29:40 +00003326 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3327 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3328 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3329 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3330 CONFIG_SYS_NAND_ECCBYTES
3331 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003332 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003333
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303334 CONFIG_SPL_NAND_BOOT
3335 Add support NAND boot
3336
Tom Rini95579792012-02-14 07:29:40 +00003337 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003338 Location in NAND to read U-Boot from
3339
3340 CONFIG_SYS_NAND_U_BOOT_DST
3341 Location in memory to load U-Boot to
3342
3343 CONFIG_SYS_NAND_U_BOOT_SIZE
3344 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003345
3346 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003347 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003348
3349 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3350 Define this if you need to first read the OOB and then the
3351 data. This is used for example on davinci plattforms.
3352
3353 CONFIG_SPL_OMAP3_ID_NAND
3354 Support for an OMAP3-specific set of functions to return the
3355 ID and MFR of the first attached NAND chip, if present.
3356
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003357 CONFIG_SPL_SERIAL_SUPPORT
3358 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003359
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003360 CONFIG_SPL_SPI_FLASH_SUPPORT
3361 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003362
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003363 CONFIG_SPL_SPI_SUPPORT
3364 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003365
Pavel Machekc57b9532012-08-30 22:42:11 +02003366 CONFIG_SPL_RAM_DEVICE
3367 Support for running image already present in ram, in SPL binary
3368
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003369 CONFIG_SPL_LIBGENERIC_SUPPORT
3370 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003371
Ying Zhangba1bee42013-05-20 14:07:25 +08003372 CONFIG_SPL_ENV_SUPPORT
3373 Support for the environment operating in SPL binary
3374
3375 CONFIG_SPL_NET_SUPPORT
3376 Support for the net/libnet.o in SPL binary.
3377 It conflicts with SPL env from storage medium specified by
3378 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3379
Scott Wood74752ba2012-12-06 13:33:16 +00003380 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003381 Image offset to which the SPL should be padded before appending
3382 the SPL payload. By default, this is defined as
3383 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3384 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3385 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003386
Scott Woodca2fca22012-09-21 16:27:32 -05003387 CONFIG_SPL_TARGET
3388 Final target image containing SPL and payload. Some SPLs
3389 use an arch-specific makefile fragment instead, for
3390 example if more than one image needs to be produced.
3391
Simon Glass87ebee32013-05-08 08:05:59 +00003392 CONFIG_FIT_SPL_PRINT
3393 Printing information about a FIT image adds quite a bit of
3394 code to SPL. So this is normally disabled in SPL. Use this
3395 option to re-enable it. This will affect the output of the
3396 bootm command when booting a FIT image.
3397
Ying Zhang3aa29de2013-08-16 15:16:15 +08003398- TPL framework
3399 CONFIG_TPL
3400 Enable building of TPL globally.
3401
3402 CONFIG_TPL_PAD_TO
3403 Image offset to which the TPL should be padded before appending
3404 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003405 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3406 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3407 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003408
wdenkc6097192002-11-03 00:24:07 +00003409Modem Support:
3410--------------
3411
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003412[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003413
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003414- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003415 CONFIG_MODEM_SUPPORT
3416
3417- RTS/CTS Flow control enable:
3418 CONFIG_HWFLOW
3419
3420- Modem debug support:
3421 CONFIG_MODEM_SUPPORT_DEBUG
3422
wdenk43d96162003-03-06 00:02:04 +00003423 Enables debugging stuff (char screen[1024], dbg())
3424 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003425
wdenka8c7c702003-12-06 19:49:23 +00003426- Interrupt support (PPC):
3427
wdenkd4ca31c2004-01-02 14:00:00 +00003428 There are common interrupt_init() and timer_interrupt()
3429 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003430 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003431 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003432 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003433 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003434 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003435 specific handling. If board has watchdog / status_led
3436 / other_activity_monitor it works automatically from
3437 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003438
wdenkc6097192002-11-03 00:24:07 +00003439- General:
3440
wdenk43d96162003-03-06 00:02:04 +00003441 In the target system modem support is enabled when a
3442 specific key (key combination) is pressed during
3443 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003444 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003445 board_init(). Currently key_pressed() is a dummy
3446 function, returning 1 and thus enabling modem
3447 initialization.
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk43d96162003-03-06 00:02:04 +00003449 If there are no modem init strings in the
3450 environment, U-Boot proceed to autoboot; the
3451 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003452 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003453
3454 See also: doc/README.Modem
3455
Helmut Raiger9660e442011-10-20 04:19:47 +00003456Board initialization settings:
3457------------------------------
3458
3459During Initialization u-boot calls a number of board specific functions
3460to allow the preparation of board specific prerequisites, e.g. pin setup
3461before drivers are initialized. To enable these callbacks the
3462following configuration macros have to be defined. Currently this is
3463architecture specific, so please check arch/your_architecture/lib/board.c
3464typically in board_init_f() and board_init_r().
3465
3466- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3467- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3468- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3469- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003470
wdenkc6097192002-11-03 00:24:07 +00003471Configuration Settings:
3472-----------------------
3473
York Sun4d1fd7f2014-02-26 17:03:19 -08003474- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3475 Optionally it can be defined to support 64-bit memory commands.
3476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003477- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003478 undefine this when you're short of memory.
3479
Peter Tyser2fb26042009-01-27 18:03:12 -06003480- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3481 width of the commands listed in the 'help' command output.
3482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003483- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003484 prompt for user input.
3485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003486- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003487
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003488- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003490- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003491
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003492- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003493 the application (usually a Linux kernel) when it is
3494 booted
3495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003496- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003497 List of legal baudrate settings for this board.
3498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003500 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003503 If the board specific function
3504 extern int overwrite_console (void);
3505 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003506 serial port, else the settings in the environment are used.
3507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003508- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003509 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003510
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003511- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003512 Enable overwrite of previous console environment settings.
3513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003514- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003515 Begin and End addresses of the area used by the
3516 simple memory test.
3517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003519 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003520
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003521- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003522 Scratch address used by the alternate memory test
3523 You only need to set this if address zero isn't writeable
3524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003525- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3526 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003527 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003528 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003529 fixing up gd->ram_size the Linux kernel should gets passed
3530 the now "corrected" memory size and won't touch it either.
3531 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003532 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003533 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003534 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003535
3536 This option can be used as a workaround for the 440EPx/GRx
3537 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3538 be touched.
3539
3540 WARNING: Please make sure that this value is a multiple of
3541 the Linux page size (normally 4k). If this is not the case,
3542 then the end address of the Linux memory will be located at a
3543 non page size aligned address and this could cause major
3544 problems.
3545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003546- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003547 Enable temporary baudrate change while serial download
3548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003549- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003550 Physical start address of SDRAM. _Must_ be 0 here.
3551
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003552- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003553 Physical start address of Motherboard I/O (if using a
3554 Cogent motherboard)
3555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003557 Physical start address of Flash memory.
3558
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003559- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003560 Physical start address of boot monitor code (set by
3561 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003562 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003563 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003565- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003566 Size of memory reserved for monitor code, used to
3567 determine _at_compile_time_ (!) if the environment is
3568 embedded within the U-Boot image, or in a separate
3569 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003571- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003572 Size of DRAM reserved for malloc() use.
3573
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003574- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003575 Normally compressed uImages are limited to an
3576 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003577 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003578 to adjust this setting to your needs.
3579
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003580- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003581 Maximum size of memory mapped by the startup code of
3582 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003583 the Linux kernel (bd_info, boot arguments, FDT blob if
3584 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003585 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003586 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003587 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003588 variable "bootm_mapsize" will override the value of
3589 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3590 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003591
John Rigbyfca43cc2010-10-13 13:57:35 -06003592- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3593 Enable initrd_high functionality. If defined then the
3594 initrd_high feature is enabled and the bootm ramdisk subcommand
3595 is enabled.
3596
3597- CONFIG_SYS_BOOT_GET_CMDLINE:
3598 Enables allocating and saving kernel cmdline in space between
3599 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3600
3601- CONFIG_SYS_BOOT_GET_KBD:
3602 Enables allocating and saving a kernel copy of the bd_info in
3603 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003605- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003606 Max number of Flash memory banks
3607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003608- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003609 Max number of sectors on a Flash chip
3610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003611- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003612 Timeout for Flash erase operations (in ms)
3613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003614- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003615 Timeout for Flash write operations (in ms)
3616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003617- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003618 Timeout for Flash set sector lock bit operation (in ms)
3619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003620- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003621 Timeout for Flash clear lock bits operation (in ms)
3622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003623- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003624 If defined, hardware flash sectors protection is used
3625 instead of U-Boot software protection.
3626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003627- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003628
3629 Enable TFTP transfers directly to flash memory;
3630 without this option such a download has to be
3631 performed in two steps: (1) download to RAM, and (2)
3632 copy from RAM to flash.
3633
3634 The two-step approach is usually more reliable, since
3635 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003636 the flash, but in some situations (when system RAM is
3637 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003638 downloaded image) this option may be very useful.
3639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003640- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003641 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003642 common flash structure for storing flash geometry.
3643
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003644- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003645 This option also enables the building of the cfi_flash driver
3646 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003647
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003648- CONFIG_FLASH_CFI_MTD
3649 This option enables the building of the cfi_mtd driver
3650 in the drivers directory. The driver exports CFI flash
3651 to the MTD layer.
3652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003653- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003654 Use buffered writes to flash.
3655
3656- CONFIG_FLASH_SPANSION_S29WS_N
3657 s29ws-n MirrorBit flash has non-standard addresses for buffered
3658 write commands.
3659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003660- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003661 If this option is defined, the common CFI flash doesn't
3662 print it's warning upon not recognized FLASH banks. This
3663 is useful, if some of the configured banks are only
3664 optionally available.
3665
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003666- CONFIG_FLASH_SHOW_PROGRESS
3667 If defined (must be an integer), print out countdown
3668 digits and dots. Recommended value: 45 (9..1) for 80
3669 column displays, 15 (3..1) for 40 column displays.
3670
Stefan Roese352ef3f2013-04-04 15:53:14 +02003671- CONFIG_FLASH_VERIFY
3672 If defined, the content of the flash (destination) is compared
3673 against the source after the write operation. An error message
3674 will be printed when the contents are not identical.
3675 Please note that this option is useless in nearly all cases,
3676 since such flash programming errors usually are detected earlier
3677 while unprotecting/erasing/programming. Please only enable
3678 this option if you really know what you are doing.
3679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003680- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003681 Defines the number of Ethernet receive buffers. On some
3682 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003683 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3684 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003685 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003686 Defaults to 4 if not defined.
3687
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003688- CONFIG_ENV_MAX_ENTRIES
3689
Wolfgang Denk071bc922010-10-27 22:48:30 +02003690 Maximum number of entries in the hash table that is used
3691 internally to store the environment settings. The default
3692 setting is supposed to be generous and should work in most
3693 cases. This setting can be used to tune behaviour; see
3694 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003695
Joe Hershberger25980902012-12-11 22:16:31 -06003696- CONFIG_ENV_FLAGS_LIST_DEFAULT
3697- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003698 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003699 calling env set. Variables can be restricted to only decimal,
3700 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3701 the variables can also be restricted to IP address or MAC address.
3702
3703 The format of the list is:
3704 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003705 access_atribute = [a|r|o|c]
3706 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003707 entry = variable_name[:attributes]
3708 list = entry[,list]
3709
3710 The type attributes are:
3711 s - String (default)
3712 d - Decimal
3713 x - Hexadecimal
3714 b - Boolean ([1yYtT|0nNfF])
3715 i - IP address
3716 m - MAC address
3717
Joe Hershberger267541f2012-12-11 22:16:34 -06003718 The access attributes are:
3719 a - Any (default)
3720 r - Read-only
3721 o - Write-once
3722 c - Change-default
3723
Joe Hershberger25980902012-12-11 22:16:31 -06003724 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3725 Define this to a list (string) to define the ".flags"
3726 envirnoment variable in the default or embedded environment.
3727
3728 - CONFIG_ENV_FLAGS_LIST_STATIC
3729 Define this to a list (string) to define validation that
3730 should be done if an entry is not found in the ".flags"
3731 environment variable. To override a setting in the static
3732 list, simply add an entry for the same variable name to the
3733 ".flags" variable.
3734
Joe Hershberger267541f2012-12-11 22:16:34 -06003735- CONFIG_ENV_ACCESS_IGNORE_FORCE
3736 If defined, don't allow the -f switch to env set override variable
3737 access flags.
3738
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003739- CONFIG_SYS_GENERIC_BOARD
3740 This selects the architecture-generic board system instead of the
3741 architecture-specific board files. It is intended to move boards
3742 to this new framework over time. Defining this will disable the
3743 arch/foo/lib/board.c file and use common/board_f.c and
3744 common/board_r.c instead. To use this option your architecture
3745 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3746 its config.mk file). If you find problems enabling this option on
3747 your board please report the problem and send patches!
3748
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003749- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3750 This is set by OMAP boards for the max time that reset should
3751 be asserted. See doc/README.omap-reset-time for details on how
3752 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003753
wdenkc6097192002-11-03 00:24:07 +00003754The following definitions that deal with the placement and management
3755of environment data (variable area); in general, we support the
3756following configurations:
3757
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003758- CONFIG_BUILD_ENVCRC:
3759
3760 Builds up envcrc with the target environment so that external utils
3761 may easily extract it and embed it in final U-Boot images.
3762
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003763- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003764
3765 Define this if the environment is in flash memory.
3766
3767 a) The environment occupies one whole flash sector, which is
3768 "embedded" in the text segment with the U-Boot code. This
3769 happens usually with "bottom boot sector" or "top boot
3770 sector" type flash chips, which have several smaller
3771 sectors at the start or the end. For instance, such a
3772 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3773 such a case you would place the environment in one of the
3774 4 kB sectors - with U-Boot code before and after it. With
3775 "top boot sector" type flash chips, you would put the
3776 environment in one of the last sectors, leaving a gap
3777 between U-Boot and the environment.
3778
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003779 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003780
3781 Offset of environment data (variable area) to the
3782 beginning of flash memory; for instance, with bottom boot
3783 type flash chips the second sector can be used: the offset
3784 for this sector is given here.
3785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003786 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003787
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003788 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003789
3790 This is just another way to specify the start address of
3791 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003792 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003793
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003794 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003795
3796 Size of the sector containing the environment.
3797
3798
3799 b) Sometimes flash chips have few, equal sized, BIG sectors.
3800 In such a case you don't want to spend a whole sector for
3801 the environment.
3802
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003803 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003804
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003805 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003806 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003807 of this flash sector for the environment. This saves
3808 memory for the RAM copy of the environment.
3809
3810 It may also save flash memory if you decide to use this
3811 when your environment is "embedded" within U-Boot code,
3812 since then the remainder of the flash sector could be used
3813 for U-Boot code. It should be pointed out that this is
3814 STRONGLY DISCOURAGED from a robustness point of view:
3815 updating the environment in flash makes it always
3816 necessary to erase the WHOLE sector. If something goes
3817 wrong before the contents has been restored from a copy in
3818 RAM, your target system will be dead.
3819
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003820 - CONFIG_ENV_ADDR_REDUND
3821 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk43d96162003-03-06 00:02:04 +00003823 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003824 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003825 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003826 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003827
3828BE CAREFUL! Any changes to the flash layout, and some changes to the
3829source code will make it necessary to adapt <board>/u-boot.lds*
3830accordingly!
3831
3832
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003833- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003834
3835 Define this if you have some non-volatile memory device
3836 (NVRAM, battery buffered SRAM) which you want to use for the
3837 environment.
3838
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003839 - CONFIG_ENV_ADDR:
3840 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003841
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003842 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003843 want to use for environment. It is assumed that this memory
3844 can just be read and written to, without any special
3845 provision.
3846
3847BE CAREFUL! The first access to the environment happens quite early
3848in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003849console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003850U-Boot will hang.
3851
3852Please note that even with NVRAM we still use a copy of the
3853environment in RAM: we could work on NVRAM directly, but we want to
3854keep settings there always unmodified except somebody uses "saveenv"
3855to save the current settings.
3856
3857
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003858- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003859
3860 Use this if you have an EEPROM or similar serial access
3861 device and a driver for it.
3862
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003863 - CONFIG_ENV_OFFSET:
3864 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003865
3866 These two #defines specify the offset and size of the
3867 environment area within the total memory of your EEPROM.
3868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003869 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003870 If defined, specified the chip address of the EEPROM device.
3871 The default address is zero.
3872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003873 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003874 If defined, the number of bits used to address bytes in a
3875 single page in the EEPROM device. A 64 byte page, for example
3876 would require six bits.
3877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003878 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003879 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003880 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003881
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003882 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003883 The length in bytes of the EEPROM memory array address. Note
3884 that this is NOT the chip address length!
3885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003886 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003887 EEPROM chips that implement "address overflow" are ones
3888 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3889 address and the extra bits end up in the "chip address" bit
3890 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3891 byte chips.
3892
3893 Note that we consider the length of the address field to
3894 still be one byte because the extra address bits are hidden
3895 in the chip address.
3896
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003897 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003898 The size in bytes of the EEPROM device.
3899
Heiko Schocher548738b2010-01-07 08:55:40 +01003900 - CONFIG_ENV_EEPROM_IS_ON_I2C
3901 define this, if you have I2C and SPI activated, and your
3902 EEPROM, which holds the environment, is on the I2C bus.
3903
3904 - CONFIG_I2C_ENV_EEPROM_BUS
3905 if you have an Environment on an EEPROM reached over
3906 I2C muxes, you can define here, how to reach this
3907 EEPROM. For example:
3908
Heiko Schocherea818db2013-01-29 08:53:15 +01003909 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003910
3911 EEPROM which holds the environment, is reached over
3912 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003913
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003914- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003915
wdenkd4ca31c2004-01-02 14:00:00 +00003916 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003917 want to use for the environment.
3918
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003919 - CONFIG_ENV_OFFSET:
3920 - CONFIG_ENV_ADDR:
3921 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003922
3923 These three #defines specify the offset and size of the
3924 environment area within the total memory of your DataFlash placed
3925 at the specified address.
3926
Liu Gang0a85a9e2012-03-08 00:33:20 +00003927- CONFIG_ENV_IS_IN_REMOTE:
3928
3929 Define this if you have a remote memory space which you
3930 want to use for the local device's environment.
3931
3932 - CONFIG_ENV_ADDR:
3933 - CONFIG_ENV_SIZE:
3934
3935 These two #defines specify the address and size of the
3936 environment area within the remote memory space. The
3937 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003938 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003939
3940BE CAREFUL! For some special cases, the local device can not use
3941"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003942environment stored in a remote NOR flash by SRIO or PCIE link,
3943but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003944
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003945- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003946
3947 Define this if you have a NAND device which you want to use
3948 for the environment.
3949
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003950 - CONFIG_ENV_OFFSET:
3951 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003952
3953 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003954 area within the first NAND device. CONFIG_ENV_OFFSET must be
3955 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003956
Scott Woodfdd813d2010-09-17 14:38:37 -05003957 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003958
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003959 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003960 size used to hold a redundant copy of the environment data, so
3961 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003962 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003963 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003964
Scott Woodfdd813d2010-09-17 14:38:37 -05003965 - CONFIG_ENV_RANGE (optional):
3966
3967 Specifies the length of the region in which the environment
3968 can be written. This should be a multiple of the NAND device's
3969 block size. Specifying a range with more erase blocks than
3970 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3971 the range to be avoided.
3972
3973 - CONFIG_ENV_OFFSET_OOB (optional):
3974
3975 Enables support for dynamically retrieving the offset of the
3976 environment from block zero's out-of-band data. The
3977 "nand env.oob" command can be used to record this offset.
3978 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3979 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003980
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003981- CONFIG_NAND_ENV_DST
3982
3983 Defines address in RAM to which the nand_spl code should copy the
3984 environment. If redundant environment is used, it will be copied to
3985 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3986
Joe Hershberger2b744332013-04-08 10:32:51 +00003987- CONFIG_ENV_IS_IN_UBI:
3988
3989 Define this if you have an UBI volume that you want to use for the
3990 environment. This has the benefit of wear-leveling the environment
3991 accesses, which is important on NAND.
3992
3993 - CONFIG_ENV_UBI_PART:
3994
3995 Define this to a string that is the mtd partition containing the UBI.
3996
3997 - CONFIG_ENV_UBI_VOLUME:
3998
3999 Define this to the name of the volume that you want to store the
4000 environment in.
4001
Joe Hershberger785881f2013-04-08 10:32:52 +00004002 - CONFIG_ENV_UBI_VOLUME_REDUND:
4003
4004 Define this to the name of another volume to store a second copy of
4005 the environment in. This will enable redundant environments in UBI.
4006 It is assumed that both volumes are in the same MTD partition.
4007
Joe Hershberger2b744332013-04-08 10:32:51 +00004008 - CONFIG_UBI_SILENCE_MSG
4009 - CONFIG_UBIFS_SILENCE_MSG
4010
4011 You will probably want to define these to avoid a really noisy system
4012 when storing the env in UBI.
4013
Stephen Warren06e4ae52013-06-11 15:14:00 -06004014- CONFIG_ENV_IS_IN_MMC:
4015
4016 Define this if you have an MMC device which you want to use for the
4017 environment.
4018
4019 - CONFIG_SYS_MMC_ENV_DEV:
4020
4021 Specifies which MMC device the environment is stored in.
4022
4023 - CONFIG_SYS_MMC_ENV_PART (optional):
4024
4025 Specifies which MMC partition the environment is stored in. If not
4026 set, defaults to partition 0, the user area. Common values might be
4027 1 (first MMC boot partition), 2 (second MMC boot partition).
4028
4029 - CONFIG_ENV_OFFSET:
4030 - CONFIG_ENV_SIZE:
4031
4032 These two #defines specify the offset and size of the environment
4033 area within the specified MMC device.
4034
Stephen Warren5c088ee2013-06-11 15:14:02 -06004035 If offset is positive (the usual case), it is treated as relative to
4036 the start of the MMC partition. If offset is negative, it is treated
4037 as relative to the end of the MMC partition. This can be useful if
4038 your board may be fitted with different MMC devices, which have
4039 different sizes for the MMC partitions, and you always want the
4040 environment placed at the very end of the partition, to leave the
4041 maximum possible space before it, to store other data.
4042
Stephen Warren06e4ae52013-06-11 15:14:00 -06004043 These two values are in units of bytes, but must be aligned to an
4044 MMC sector boundary.
4045
4046 - CONFIG_ENV_OFFSET_REDUND (optional):
4047
4048 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4049 hold a redundant copy of the environment data. This provides a
4050 valid backup copy in case the other copy is corrupted, e.g. due
4051 to a power failure during a "saveenv" operation.
4052
Stephen Warren5c088ee2013-06-11 15:14:02 -06004053 This value may also be positive or negative; this is handled in the
4054 same way as CONFIG_ENV_OFFSET.
4055
Stephen Warren06e4ae52013-06-11 15:14:00 -06004056 This value is also in units of bytes, but must also be aligned to
4057 an MMC sector boundary.
4058
4059 - CONFIG_ENV_SIZE_REDUND (optional):
4060
4061 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4062 set. If this value is set, it must be set to the same value as
4063 CONFIG_ENV_SIZE.
4064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004065- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004066
4067 Defines offset to the initial SPI buffer area in DPRAM. The
4068 area is used at an early stage (ROM part) if the environment
4069 is configured to reside in the SPI EEPROM: We need a 520 byte
4070 scratch DPRAM area. It is used between the two initialization
4071 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4072 to be a good choice since it makes it far enough from the
4073 start of the data area as well as from the stack pointer.
4074
Bruce Adlere881cb52007-11-02 13:15:42 -07004075Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004076has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004077created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004078until then to read environment variables.
4079
wdenk85ec0bc2003-03-31 16:34:49 +00004080The environment is protected by a CRC32 checksum. Before the monitor
4081is relocated into RAM, as a result of a bad CRC you will be working
4082with the compiled-in default environment - *silently*!!! [This is
4083necessary, because the first environment variable we need is the
4084"baudrate" setting for the console - if we have a bad CRC, we don't
4085have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004086
4087Note: once the monitor has been relocated, then it will complain if
4088the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004089use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004091- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004092 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004093
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004094 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004095 also needs to be defined.
4096
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004097- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004098 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004099
Ron Madridf5675aa2009-02-18 14:30:44 -08004100- CONFIG_NS16550_MIN_FUNCTIONS:
4101 Define this if you desire to only have use of the NS16550_init
4102 and NS16550_putc functions for the serial driver located at
4103 drivers/serial/ns16550.c. This option is useful for saving
4104 space for already greatly restricted images, including but not
4105 limited to NAND_SPL configurations.
4106
Simon Glassb2b92f52012-11-30 13:01:18 +00004107- CONFIG_DISPLAY_BOARDINFO
4108 Display information about the board that U-Boot is running on
4109 when U-Boot starts up. The board function checkboard() is called
4110 to do this.
4111
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004112- CONFIG_DISPLAY_BOARDINFO_LATE
4113 Similar to the previous option, but display this information
4114 later, once stdio is running and output goes to the LCD, if
4115 present.
4116
wdenkc6097192002-11-03 00:24:07 +00004117Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004118---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004119
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004120- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004121 Cache Line Size of the CPU.
4122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004123- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004124 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004125
wdenk42d1f032003-10-15 23:53:47 +00004126 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4127 and RPXsuper) to be able to adjust the position of
4128 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004129
Timur Tabie46fedf2011-08-04 18:03:41 -05004130- CONFIG_SYS_CCSRBAR_DEFAULT:
4131 Default (power-on reset) physical address of CCSR on Freescale
4132 PowerPC SOCs.
4133
4134- CONFIG_SYS_CCSRBAR:
4135 Virtual address of CCSR. On a 32-bit build, this is typically
4136 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4137
4138 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4139 for cross-platform code that uses that macro instead.
4140
4141- CONFIG_SYS_CCSRBAR_PHYS:
4142 Physical address of CCSR. CCSR can be relocated to a new
4143 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004144 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004145 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4146 is typically relocated on 36-bit builds. It is recommended
4147 that this macro be defined via the _HIGH and _LOW macros:
4148
4149 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4150 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4151
4152- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004153 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4154 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004155 used in assembly code, so it must not contain typecasts or
4156 integer size suffixes (e.g. "ULL").
4157
4158- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4159 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4160 used in assembly code, so it must not contain typecasts or
4161 integer size suffixes (e.g. "ULL").
4162
4163- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4164 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4165 forced to a value that ensures that CCSR is not relocated.
4166
wdenk7f6c2cb2002-11-10 22:06:23 +00004167- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004168 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004169
4170 the default drive number (default value 0)
4171
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004172 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004173
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004174 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004175 (default value 1)
4176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004177 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004178
wdenk43d96162003-03-06 00:02:04 +00004179 defines the offset of register from address. It
4180 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004181 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004182
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004183 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4184 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004185 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004186
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004187 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004188 fdc_hw_init() is called at the beginning of the FDC
4189 setup. fdc_hw_init() must be provided by the board
4190 source code. It is used to make hardware dependant
4191 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004192
Macpaul Lin0abddf82011-04-11 20:45:32 +00004193- CONFIG_IDE_AHB:
4194 Most IDE controllers were designed to be connected with PCI
4195 interface. Only few of them were designed for AHB interface.
4196 When software is doing ATA command and data transfer to
4197 IDE devices through IDE-AHB controller, some additional
4198 registers accessing to these kind of IDE-AHB controller
4199 is requierd.
4200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004201- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004202 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004203 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004205- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk7152b1d2003-09-05 23:19:14 +00004207 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004208 initial data and stack; please note that this must be
4209 writable memory that is working WITHOUT special
4210 initialization, i. e. you CANNOT use normal RAM which
4211 will become available only after programming the
4212 memory controller and running certain initialization
4213 sequences.
4214
4215 U-Boot uses the following memory types:
4216 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4217 - MPC824X: data cache
4218 - PPC4xx: data cache
4219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004220- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004221
4222 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004223 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4224 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004225 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004226 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004227 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4228 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4229 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004230
4231 Note:
4232 On the MPC824X (or other systems that use the data
4233 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004234 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004235 point to an otherwise UNUSED address space between
4236 the top of RAM and the start of the PCI space.
4237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004238- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004240- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004241
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004242- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004244- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004246- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004247
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004248- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004250- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004251 SDRAM timing
4252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004253- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004254 periodic timer for refresh
4255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004256- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004258- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4259 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4260 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4261 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004262 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4263
4264- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004265 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4266 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004267 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004269- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4270 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004271 Machine Mode Register and Memory Periodic Timer
4272 Prescaler definitions (SDRAM timing)
4273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004274- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004275 enable I2C microcode relocation patch (MPC8xx);
4276 define relocation offset in DPRAM [DSP2]
4277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004278- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004279 enable SMC microcode relocation patch (MPC8xx);
4280 define relocation offset in DPRAM [SMC1]
4281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004282- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004283 enable SPI microcode relocation patch (MPC8xx);
4284 define relocation offset in DPRAM [SCC4]
4285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004286- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004287 Use OSCM clock mode on MBX8xx board. Be careful,
4288 wrong setting might damage your board. Read
4289 doc/README.MBX before setting this variable!
4290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004291- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004292 Offset of the bootmode word in DPRAM used by post
4293 (Power On Self Tests). This definition overrides
4294 #define'd default value in commproc.h resp.
4295 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004297- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4298 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4299 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4300 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4301 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4302 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4303 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4304 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004305 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004306
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004307- CONFIG_PCI_DISABLE_PCIE:
4308 Disable PCI-Express on systems where it is supported but not
4309 required.
4310
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004311- CONFIG_PCI_ENUM_ONLY
4312 Only scan through and get the devices on the busses.
4313 Don't do any setup work, presumably because someone or
4314 something has already done it, and we don't need to do it
4315 a second time. Useful for platforms that are pre-booted
4316 by coreboot or similar.
4317
Gabor Juhos842033e2013-05-30 07:06:12 +00004318- CONFIG_PCI_INDIRECT_BRIDGE:
4319 Enable support for indirect PCI bridges.
4320
Kumar Galaa09b9b62010-12-30 12:09:53 -06004321- CONFIG_SYS_SRIO:
4322 Chip has SRIO or not
4323
4324- CONFIG_SRIO1:
4325 Board has SRIO 1 port available
4326
4327- CONFIG_SRIO2:
4328 Board has SRIO 2 port available
4329
Liu Gangc8b28152013-05-07 16:30:46 +08004330- CONFIG_SRIO_PCIE_BOOT_MASTER
4331 Board can support master function for Boot from SRIO and PCIE
4332
Kumar Galaa09b9b62010-12-30 12:09:53 -06004333- CONFIG_SYS_SRIOn_MEM_VIRT:
4334 Virtual Address of SRIO port 'n' memory region
4335
4336- CONFIG_SYS_SRIOn_MEM_PHYS:
4337 Physical Address of SRIO port 'n' memory region
4338
4339- CONFIG_SYS_SRIOn_MEM_SIZE:
4340 Size of SRIO port 'n' memory region
4341
Fabio Estevam66bd1842013-04-11 09:35:34 +00004342- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4343 Defined to tell the NAND controller that the NAND chip is using
4344 a 16 bit bus.
4345 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004346 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004347 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004348 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004349
4350- CONFIG_SYS_NDFC_EBC0_CFG
4351 Sets the EBC0_CFG register for the NDFC. If not defined
4352 a default value will be used.
4353
Ben Warrenbb99ad62006-09-07 16:50:54 -04004354- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004355 Get DDR timing information from an I2C EEPROM. Common
4356 with pluggable memory modules such as SODIMMs
4357
Ben Warrenbb99ad62006-09-07 16:50:54 -04004358 SPD_EEPROM_ADDRESS
4359 I2C address of the SPD EEPROM
4360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004361- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004362 If SPD EEPROM is on an I2C bus other than the first
4363 one, specify here. Note that the value must resolve
4364 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004365
York Sun1b3e3c42011-06-07 09:42:16 +08004366- CONFIG_SYS_DDR_RAW_TIMING
4367 Get DDR timing information from other than SPD. Common with
4368 soldered DDR chips onboard without SPD. DDR raw timing
4369 parameters are extracted from datasheet and hard-coded into
4370 header files or board specific files.
4371
York Sun6f5e1dc2011-09-16 13:21:35 -07004372- CONFIG_FSL_DDR_INTERACTIVE
4373 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004375- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004376 Only for 83xx systems. If specified, then DDR should
4377 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004378
wdenkc26e4542004-04-18 10:13:26 +00004379- CONFIG_ETHER_ON_FEC[12]
4380 Define to enable FEC[12] on a 8xx series processor.
4381
4382- CONFIG_FEC[12]_PHY
4383 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004384 to the given FEC; i. e.
4385 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004386 means that the PHY with address 4 is connected to FEC1
4387
4388 When set to -1, means to probe for first available.
4389
4390- CONFIG_FEC[12]_PHY_NORXERR
4391 The PHY does not have a RXERR line (RMII only).
4392 (so program the FEC to ignore it).
4393
4394- CONFIG_RMII
4395 Enable RMII mode for all FECs.
4396 Note that this is a global option, we can't
4397 have one FEC in standard MII mode and another in RMII mode.
4398
wdenk5cf91d62004-04-23 20:32:05 +00004399- CONFIG_CRC32_VERIFY
4400 Add a verify option to the crc32 command.
4401 The syntax is:
4402
4403 => crc32 -v <address> <count> <crc32>
4404
4405 Where address/count indicate a memory area
4406 and crc32 is the correct crc32 which the
4407 area should have.
4408
wdenk56523f12004-07-11 17:40:54 +00004409- CONFIG_LOOPW
4410 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004411 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004412
stroese7b466642004-12-16 18:46:55 +00004413- CONFIG_MX_CYCLIC
4414 Add the "mdc" and "mwc" memory commands. These are cyclic
4415 "md/mw" commands.
4416 Examples:
4417
wdenkefe2a4d2004-12-16 21:44:03 +00004418 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004419 This command will print 4 bytes (10,11,12,13) each 500 ms.
4420
wdenkefe2a4d2004-12-16 21:44:03 +00004421 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004422 This command will write 12345678 to address 100 all 10 ms.
4423
wdenkefe2a4d2004-12-16 21:44:03 +00004424 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004425 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004426
wdenk8aa1a2d2005-04-04 12:44:11 +00004427- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004428 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004429 low level initializations (like setting up the memory
4430 controller) are omitted and/or U-Boot does not
4431 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004432
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004433 Normally this variable MUST NOT be defined. The only
4434 exception is when U-Boot is loaded (to RAM) by some
4435 other boot loader or by a debugger which performs
4436 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004437
Aneesh V401bb302011-07-13 05:11:07 +00004438- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004439 Modifies the behaviour of start.S when compiling a loader
4440 that is executed before the actual U-Boot. E.g. when
4441 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004442
Ying Zhang3aa29de2013-08-16 15:16:15 +08004443- CONFIG_TPL_BUILD
4444 Modifies the behaviour of start.S when compiling a loader
4445 that is executed after the SPL and before the actual U-Boot.
4446 It is loaded by the SPL.
4447
Ying Zhang5df572f2013-05-20 14:07:23 +08004448- CONFIG_SYS_MPC85XX_NO_RESETVEC
4449 Only for 85xx systems. If this variable is specified, the section
4450 .resetvec is not kept and the section .bootpg is placed in the
4451 previous 4k of the .text section.
4452
Simon Glass4213fc22013-02-24 17:33:14 +00004453- CONFIG_ARCH_MAP_SYSMEM
4454 Generally U-Boot (and in particular the md command) uses
4455 effective address. It is therefore not necessary to regard
4456 U-Boot address as virtual addresses that need to be translated
4457 to physical addresses. However, sandbox requires this, since
4458 it maintains its own little RAM buffer which contains all
4459 addressable memory. This option causes some memory accesses
4460 to be mapped through map_sysmem() / unmap_sysmem().
4461
Matthias Weisserd8834a12011-03-10 21:36:32 +00004462- CONFIG_USE_ARCH_MEMCPY
4463 CONFIG_USE_ARCH_MEMSET
4464 If these options are used a optimized version of memcpy/memset will
4465 be used if available. These functions may be faster under some
4466 conditions but may increase the binary size.
4467
Simon Glass588a13f2013-02-14 04:18:54 +00004468- CONFIG_X86_RESET_VECTOR
4469 If defined, the x86 reset vector code is included. This is not
4470 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004471
Mark Jacksonfc337052013-03-04 01:27:20 +00004472- CONFIG_SYS_MPUCLK
4473 Defines the MPU clock speed (in MHz).
4474
4475 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004476
Heiko Schocher16678eb2013-11-04 14:05:00 +01004477- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4478 Enables the RTC32K OSC on AM33xx based plattforms
4479
Timur Tabif2717b42011-11-22 09:21:25 -06004480Freescale QE/FMAN Firmware Support:
4481-----------------------------------
4482
4483The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4484loading of "firmware", which is encoded in the QE firmware binary format.
4485This firmware often needs to be loaded during U-Boot booting, so macros
4486are used to identify the storage device (NOR flash, SPI, etc) and the address
4487within that device.
4488
4489- CONFIG_SYS_QE_FMAN_FW_ADDR
4490 The address in the storage device where the firmware is located. The
4491 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4492 is also specified.
4493
4494- CONFIG_SYS_QE_FMAN_FW_LENGTH
4495 The maximum possible size of the firmware. The firmware binary format
4496 has a field that specifies the actual size of the firmware, but it
4497 might not be possible to read any part of the firmware unless some
4498 local storage is allocated to hold the entire firmware first.
4499
4500- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4501 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4502 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4503 virtual address in NOR flash.
4504
4505- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4506 Specifies that QE/FMAN firmware is located in NAND flash.
4507 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4508
4509- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4510 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4511 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4512
4513- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4514 Specifies that QE/FMAN firmware is located on the primary SPI
4515 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4516
Liu Gang292dc6c2012-03-08 00:33:18 +00004517- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4518 Specifies that QE/FMAN firmware is located in the remote (master)
4519 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004520 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4521 window->master inbound window->master LAW->the ucode address in
4522 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004523
wdenkc6097192002-11-03 00:24:07 +00004524Building the Software:
4525======================
4526
Wolfgang Denk218ca722008-03-26 10:40:12 +01004527Building U-Boot has been tested in several native build environments
4528and in many different cross environments. Of course we cannot support
4529all possibly existing versions of cross development tools in all
4530(potentially obsolete) versions. In case of tool chain problems we
4531recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4532which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004533
Wolfgang Denk218ca722008-03-26 10:40:12 +01004534If you are not using a native environment, it is assumed that you
4535have GNU cross compiling tools available in your path. In this case,
4536you must set the environment variable CROSS_COMPILE in your shell.
4537Note that no changes to the Makefile or any other source files are
4538necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004539
Wolfgang Denk218ca722008-03-26 10:40:12 +01004540 $ CROSS_COMPILE=ppc_4xx-
4541 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004542
Peter Tyser2f8d3962009-03-13 18:54:51 -05004543Note: If you wish to generate Windows versions of the utilities in
4544 the tools directory you can use the MinGW toolchain
4545 (http://www.mingw.org). Set your HOST tools to the MinGW
4546 toolchain and execute 'make tools'. For example:
4547
4548 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4549
4550 Binaries such as tools/mkimage.exe will be created which can
4551 be executed on computers running Windows.
4552
Wolfgang Denk218ca722008-03-26 10:40:12 +01004553U-Boot is intended to be simple to build. After installing the
4554sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004555is done by typing:
4556
4557 make NAME_config
4558
Wolfgang Denk218ca722008-03-26 10:40:12 +01004559where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004560rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004561
wdenk2729af92004-05-03 20:45:30 +00004562Note: for some board special configuration names may exist; check if
4563 additional information is available from the board vendor; for
4564 instance, the TQM823L systems are available without (standard)
4565 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004566 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk2729af92004-05-03 20:45:30 +00004568 make TQM823L_config
4569 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004570
wdenk2729af92004-05-03 20:45:30 +00004571 make TQM823L_LCD_config
4572 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 etc.
wdenkc6097192002-11-03 00:24:07 +00004575
wdenkc6097192002-11-03 00:24:07 +00004576
wdenk2729af92004-05-03 20:45:30 +00004577Finally, type "make all", and you should get some working U-Boot
4578images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580- "u-boot.bin" is a raw binary image
4581- "u-boot" is an image in ELF binary format
4582- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004583
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004584By default the build is performed locally and the objects are saved
4585in the source directory. One of the two methods can be used to change
4586this behavior and build U-Boot to some external directory:
4587
45881. Add O= to the make command line invocations:
4589
4590 make O=/tmp/build distclean
4591 make O=/tmp/build NAME_config
4592 make O=/tmp/build all
4593
45942. Set environment variable BUILD_DIR to point to the desired location:
4595
4596 export BUILD_DIR=/tmp/build
4597 make distclean
4598 make NAME_config
4599 make all
4600
4601Note that the command line "O=" setting overrides the BUILD_DIR environment
4602variable.
4603
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk2729af92004-05-03 20:45:30 +00004605Please be aware that the Makefiles assume you are using GNU make, so
4606for instance on NetBSD you might need to use "gmake" instead of
4607native "make".
wdenkc6097192002-11-03 00:24:07 +00004608
wdenkc6097192002-11-03 00:24:07 +00004609
wdenk2729af92004-05-03 20:45:30 +00004610If the system board that you have is not listed, then you will need
4611to port U-Boot to your hardware platform. To do this, follow these
4612steps:
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk2729af92004-05-03 20:45:30 +000046141. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004615 "boards.cfg" file, using the existing entries as examples.
4616 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000046172. Create a new directory to hold your board specific code. Add any
4618 files you need. In your board directory, you will need at least
4619 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
46203. Create a new configuration file "include/configs/<board>.h" for
4621 your board
46223. If you're porting U-Boot to a new CPU, then also create a new
4623 directory to hold your CPU specific code. Add any files you need.
46244. Run "make <board>_config" with your new name.
46255. Type "make", and you should get a working "u-boot.srec" file
4626 to be installed on your target system.
46276. Debug and solve any problems that might arise.
4628 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004629
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk2729af92004-05-03 20:45:30 +00004631Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4632==============================================================
wdenkc6097192002-11-03 00:24:07 +00004633
Wolfgang Denk218ca722008-03-26 10:40:12 +01004634If you have modified U-Boot sources (for instance added a new board
4635or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004636provide feedback to the other developers. The feedback normally takes
4637the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004638official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004639
Wolfgang Denk218ca722008-03-26 10:40:12 +01004640But before you submit such a patch, please verify that your modifi-
4641cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004642the supported boards compile WITHOUT ANY compiler warnings. To do so,
4643just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004644for ALL supported system. Be warned, this will take a while. You can
4645select which (cross) compiler to use by passing a `CROSS_COMPILE'
4646environment variable to the script, i. e. to use the ELDK cross tools
4647you can type
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk2729af92004-05-03 20:45:30 +00004649 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004650
wdenk2729af92004-05-03 20:45:30 +00004651or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004652
wdenk2729af92004-05-03 20:45:30 +00004653 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004654
Wolfgang Denk218ca722008-03-26 10:40:12 +01004655When using the MAKEALL script, the default behaviour is to build
4656U-Boot in the source directory. This location can be changed by
4657setting the BUILD_DIR environment variable. Also, for each target
4658built, the MAKEALL script saves two log files (<target>.ERR and
4659<target>.MAKEALL) in the <source dir>/LOG directory. This default
4660location can be changed by setting the MAKEALL_LOGDIR environment
4661variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004662
4663 export BUILD_DIR=/tmp/build
4664 export MAKEALL_LOGDIR=/tmp/log
4665 CROSS_COMPILE=ppc_8xx- MAKEALL
4666
Wolfgang Denk218ca722008-03-26 10:40:12 +01004667With the above settings build objects are saved in the /tmp/build,
4668log files are saved in the /tmp/log and the source tree remains clean
4669during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004670
4671
wdenk2729af92004-05-03 20:45:30 +00004672See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004673
wdenkc6097192002-11-03 00:24:07 +00004674
wdenk2729af92004-05-03 20:45:30 +00004675Monitor Commands - Overview:
4676============================
wdenkc6097192002-11-03 00:24:07 +00004677
wdenk2729af92004-05-03 20:45:30 +00004678go - start application at address 'addr'
4679run - run commands in an environment variable
4680bootm - boot application image from memory
4681bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004682bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004683tftpboot- boot image via network using TFTP protocol
4684 and env variables "ipaddr" and "serverip"
4685 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004686tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004687rarpboot- boot image via network using RARP/TFTP protocol
4688diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4689loads - load S-Record file over serial line
4690loadb - load binary file over serial line (kermit mode)
4691md - memory display
4692mm - memory modify (auto-incrementing)
4693nm - memory modify (constant address)
4694mw - memory write (fill)
4695cp - memory copy
4696cmp - memory compare
4697crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004698i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004699sspi - SPI utility commands
4700base - print or set address offset
4701printenv- print environment variables
4702setenv - set environment variables
4703saveenv - save environment variables to persistent storage
4704protect - enable or disable FLASH write protection
4705erase - erase FLASH memory
4706flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004707nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004708bdinfo - print Board Info structure
4709iminfo - print header information for application image
4710coninfo - print console devices and informations
4711ide - IDE sub-system
4712loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004713loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004714mtest - simple RAM test
4715icache - enable or disable instruction cache
4716dcache - enable or disable data cache
4717reset - Perform RESET of the CPU
4718echo - echo args to console
4719version - print monitor version
4720help - print online help
4721? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004722
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk2729af92004-05-03 20:45:30 +00004724Monitor Commands - Detailed Description:
4725========================================
wdenkc6097192002-11-03 00:24:07 +00004726
wdenk2729af92004-05-03 20:45:30 +00004727TODO.
wdenkc6097192002-11-03 00:24:07 +00004728
wdenk2729af92004-05-03 20:45:30 +00004729For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004730
4731
wdenk2729af92004-05-03 20:45:30 +00004732Environment Variables:
4733======================
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735U-Boot supports user configuration using Environment Variables which
4736can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738Environment Variables are set using "setenv", printed using
4739"printenv", and saved to Flash using "saveenv". Using "setenv"
4740without a value can be used to delete a variable from the
4741environment. As long as you don't save the environment you are
4742working with an in-memory copy. In case the Flash area containing the
4743environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004744
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004745Some configuration options can be set using Environment Variables.
4746
4747List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk2729af92004-05-03 20:45:30 +00004749 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk2729af92004-05-03 20:45:30 +00004753 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk2729af92004-05-03 20:45:30 +00004757 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004758
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004759 bootm_low - Memory range available for image processing in the bootm
4760 command can be restricted. This variable is given as
4761 a hexadecimal number and defines lowest address allowed
4762 for use by the bootm command. See also "bootm_size"
4763 environment variable. Address defined by "bootm_low" is
4764 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004765 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4766 bootm_mapsize.
4767
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004768 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004769 This variable is given as a hexadecimal number and it
4770 defines the size of the memory region starting at base
4771 address bootm_low that is accessible by the Linux kernel
4772 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4773 as the default value if it is defined, and bootm_size is
4774 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004775
4776 bootm_size - Memory range available for image processing in the bootm
4777 command can be restricted. This variable is given as
4778 a hexadecimal number and defines the size of the region
4779 allowed for use by the bootm command. See also "bootm_low"
4780 environment variable.
4781
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004782 updatefile - Location of the software update file on a TFTP server, used
4783 by the automatic software update feature. Please refer to
4784 documentation in doc/README.update for more details.
4785
wdenk2729af92004-05-03 20:45:30 +00004786 autoload - if set to "no" (any string beginning with 'n'),
4787 "bootp" will just load perform a lookup of the
4788 configuration from the BOOTP server, but not try to
4789 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004790
wdenk2729af92004-05-03 20:45:30 +00004791 autostart - if set to "yes", an image loaded using the "bootp",
4792 "rarpboot", "tftpboot" or "diskboot" commands will
4793 be automatically started (by internally calling
4794 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk2729af92004-05-03 20:45:30 +00004796 If set to "no", a standalone image passed to the
4797 "bootm" command will be copied to the load address
4798 (and eventually uncompressed), but NOT be started.
4799 This can be used to load and uncompress arbitrary
4800 data.
wdenkc6097192002-11-03 00:24:07 +00004801
David A. Longa28afca2011-07-09 16:40:19 -04004802 fdt_high - if set this restricts the maximum address that the
4803 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004804 For example, if you have a system with 1 GB memory
4805 at physical address 0x10000000, while Linux kernel
4806 only recognizes the first 704 MB as low memory, you
4807 may need to set fdt_high as 0x3C000000 to have the
4808 device tree blob be copied to the maximum address
4809 of the 704 MB low memory, so that Linux kernel can
4810 access it during the boot procedure.
4811
David A. Longa28afca2011-07-09 16:40:19 -04004812 If this is set to the special value 0xFFFFFFFF then
4813 the fdt will not be copied at all on boot. For this
4814 to work it must reside in writable memory, have
4815 sufficient padding on the end of it for u-boot to
4816 add the information it needs into it, and the memory
4817 must be accessible by the kernel.
4818
Simon Glasseea63e02011-10-24 19:15:34 +00004819 fdtcontroladdr- if set this is the address of the control flattened
4820 device tree used by U-Boot when CONFIG_OF_CONTROL is
4821 defined.
4822
wdenk17ea1172004-06-06 21:51:03 +00004823 i2cfast - (PPC405GP|PPC405EP only)
4824 if set to 'y' configures Linux I2C driver for fast
4825 mode (400kHZ). This environment variable is used in
4826 initialization code. So, for changes to be effective
4827 it must be saved and board must be reset.
4828
wdenk2729af92004-05-03 20:45:30 +00004829 initrd_high - restrict positioning of initrd images:
4830 If this variable is not set, initrd images will be
4831 copied to the highest possible address in RAM; this
4832 is usually what you want since it allows for
4833 maximum initrd size. If for some reason you want to
4834 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004835 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004836 variable to a value of "no" or "off" or "0".
4837 Alternatively, you can set it to a maximum upper
4838 address to use (U-Boot will still check that it
4839 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841 For instance, when you have a system with 16 MB
4842 RAM, and want to reserve 4 MB from use by Linux,
4843 you can do this by adding "mem=12M" to the value of
4844 the "bootargs" variable. However, now you must make
4845 sure that the initrd image is placed in the first
4846 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk2729af92004-05-03 20:45:30 +00004850 If you set initrd_high to 0xFFFFFFFF, this is an
4851 indication to U-Boot that all addresses are legal
4852 for the Linux kernel, including addresses in flash
4853 memory. In this case U-Boot will NOT COPY the
4854 ramdisk at all. This may be useful to reduce the
4855 boot time on your system, but requires that this
4856 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004857
wdenk2729af92004-05-03 20:45:30 +00004858 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk2729af92004-05-03 20:45:30 +00004860 loadaddr - Default load address for commands like "bootp",
4861 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk2729af92004-05-03 20:45:30 +00004865 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004866
wdenk2729af92004-05-03 20:45:30 +00004867 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk2729af92004-05-03 20:45:30 +00004871 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004872
Mike Frysingere2a53452011-10-02 10:01:27 +00004873 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004874
Mike Frysingere2a53452011-10-02 10:01:27 +00004875 ethact - controls which interface is currently active.
4876 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004877
Heiko Schocher48690d82010-07-20 17:45:02 +02004878 => setenv ethact FEC
4879 => ping 192.168.0.1 # traffic sent on FEC
4880 => setenv ethact SCC
4881 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004882
Matthias Fuchse1692572008-01-17 07:45:05 +01004883 ethrotate - When set to "no" U-Boot does not go through all
4884 available network interfaces.
4885 It just stays at the currently selected interface.
4886
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004887 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004888 either succeed or fail without retrying.
4889 When set to "once" the network operation will
4890 fail when all the available network interfaces
4891 are tried once without success.
4892 Useful on scripts which control the retry operation
4893 themselves.
wdenkc6097192002-11-03 00:24:07 +00004894
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004895 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004896
Simon Glass8d51aac2013-07-16 20:10:00 -07004897 silent_linux - If set then linux will be told to boot silently, by
4898 changing the console to be empty. If "yes" it will be
4899 made silent. If "no" it will not be made silent. If
4900 unset, then it will be made silent if the U-Boot console
4901 is silent.
4902
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004903 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004904 UDP source port.
4905
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004906 tftpdstport - If this is set, the value is used for TFTP's UDP
4907 destination port instead of the Well Know Port 69.
4908
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004909 tftpblocksize - Block size to use for TFTP transfers; if not set,
4910 we use the TFTP server's default block size
4911
4912 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4913 seconds, minimum value is 1000 = 1 second). Defines
4914 when a packet is considered to be lost so it has to
4915 be retransmitted. The default is 5000 = 5 seconds.
4916 Lowering this value may make downloads succeed
4917 faster in networks with high packet loss rates or
4918 with unreliable TFTP servers.
4919
4920 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004921 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004922 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004923
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004924The following image location variables contain the location of images
4925used in booting. The "Image" column gives the role of the image and is
4926not an environment variable name. The other columns are environment
4927variable names. "File Name" gives the name of the file on a TFTP
4928server, "RAM Address" gives the location in RAM the image will be
4929loaded to, and "Flash Location" gives the image's address in NOR
4930flash or offset in NAND flash.
4931
4932*Note* - these variables don't have to be defined for all boards, some
4933boards currenlty use other variables for these purposes, and some
4934boards use these variables for other purposes.
4935
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004936Image File Name RAM Address Flash Location
4937----- --------- ----------- --------------
4938u-boot u-boot u-boot_addr_r u-boot_addr
4939Linux kernel bootfile kernel_addr_r kernel_addr
4940device tree blob fdtfile fdt_addr_r fdt_addr
4941ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004942
wdenk2729af92004-05-03 20:45:30 +00004943The following environment variables may be used and automatically
4944updated by the network boot commands ("bootp" and "rarpboot"),
4945depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004946
wdenk2729af92004-05-03 20:45:30 +00004947 bootfile - see above
4948 dnsip - IP address of your Domain Name Server
4949 dnsip2 - IP address of your secondary Domain Name Server
4950 gatewayip - IP address of the Gateway (Router) to use
4951 hostname - Target hostname
4952 ipaddr - see above
4953 netmask - Subnet Mask
4954 rootpath - Pathname of the root filesystem on the NFS server
4955 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004956
wdenka3d991b2004-04-15 21:48:45 +00004957
wdenk2729af92004-05-03 20:45:30 +00004958There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk2729af92004-05-03 20:45:30 +00004960 serial# - contains hardware identification information such
4961 as type string and/or serial number
4962 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004963
wdenk2729af92004-05-03 20:45:30 +00004964These variables can be set only once (usually during manufacturing of
4965the board). U-Boot refuses to delete or overwrite these variables
4966once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004967
4968
wdenk2729af92004-05-03 20:45:30 +00004969Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk2729af92004-05-03 20:45:30 +00004971 ver - Contains the U-Boot version string as printed
4972 with the "version" command. This variable is
4973 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004974
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk2729af92004-05-03 20:45:30 +00004976Please note that changes to some configuration parameters may take
4977only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004978
stroesec1551ea2003-04-04 15:53:41 +00004979
Joe Hershberger170ab112012-12-11 22:16:24 -06004980Callback functions for environment variables:
4981---------------------------------------------
4982
4983For some environment variables, the behavior of u-boot needs to change
4984when their values are changed. This functionailty allows functions to
4985be associated with arbitrary variables. On creation, overwrite, or
4986deletion, the callback will provide the opportunity for some side
4987effect to happen or for the change to be rejected.
4988
4989The callbacks are named and associated with a function using the
4990U_BOOT_ENV_CALLBACK macro in your board or driver code.
4991
4992These callbacks are associated with variables in one of two ways. The
4993static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4994in the board configuration to a string that defines a list of
4995associations. The list must be in the following format:
4996
4997 entry = variable_name[:callback_name]
4998 list = entry[,list]
4999
5000If the callback name is not specified, then the callback is deleted.
5001Spaces are also allowed anywhere in the list.
5002
5003Callbacks can also be associated by defining the ".callbacks" variable
5004with the same list format above. Any association in ".callbacks" will
5005override any association in the static list. You can define
5006CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5007".callbacks" envirnoment variable in the default or embedded environment.
5008
5009
wdenk2729af92004-05-03 20:45:30 +00005010Command Line Parsing:
5011=====================
stroesec1551ea2003-04-04 15:53:41 +00005012
wdenk2729af92004-05-03 20:45:30 +00005013There are two different command line parsers available with U-Boot:
5014the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005015
wdenk2729af92004-05-03 20:45:30 +00005016Old, simple command line parser:
5017--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk2729af92004-05-03 20:45:30 +00005019- supports environment variables (through setenv / saveenv commands)
5020- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005021- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005022- special characters ('$', ';') can be escaped by prefixing with '\',
5023 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005024 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005025- You can also escape text by enclosing in single apostrophes, for example:
5026 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028Hush shell:
5029-----------
wdenkf07771c2003-05-28 08:06:31 +00005030
wdenk2729af92004-05-03 20:45:30 +00005031- similar to Bourne shell, with control structures like
5032 if...then...else...fi, for...do...done; while...do...done,
5033 until...do...done, ...
5034- supports environment ("global") variables (through setenv / saveenv
5035 commands) and local shell variables (through standard shell syntax
5036 "name=value"); only environment variables can be used with "run"
5037 command
wdenkf07771c2003-05-28 08:06:31 +00005038
wdenk2729af92004-05-03 20:45:30 +00005039General rules:
5040--------------
wdenkf07771c2003-05-28 08:06:31 +00005041
wdenk2729af92004-05-03 20:45:30 +00005042(1) If a command line (or an environment variable executed by a "run"
5043 command) contains several commands separated by semicolon, and
5044 one of these commands fails, then the remaining commands will be
5045 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005048 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005049 command will cause "run" to terminate, i. e. the remaining
5050 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005051
wdenk2729af92004-05-03 20:45:30 +00005052Note for Redundant Ethernet Interfaces:
5053=======================================
wdenkf07771c2003-05-28 08:06:31 +00005054
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005055Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005056such configurations and is capable of automatic selection of a
5057"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005058
wdenk2729af92004-05-03 20:45:30 +00005059Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5060MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5061"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063If the network interface stores some valid MAC address (for instance
5064in SROM), this is used as default address if there is NO correspon-
5065ding setting in the environment; if the corresponding environment
5066variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005067
wdenk2729af92004-05-03 20:45:30 +00005068o If the SROM has a valid MAC address, and there is no address in the
5069 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005070
wdenk2729af92004-05-03 20:45:30 +00005071o If there is no valid address in the SROM, and a definition in the
5072 environment exists, then the value from the environment variable is
5073 used.
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk2729af92004-05-03 20:45:30 +00005075o If both the SROM and the environment contain a MAC address, and
5076 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005077
wdenk2729af92004-05-03 20:45:30 +00005078o If both the SROM and the environment contain a MAC address, and the
5079 addresses differ, the value from the environment is used and a
5080 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082o If neither SROM nor the environment contain a MAC address, an error
5083 is raised.
wdenkc6097192002-11-03 00:24:07 +00005084
Ben Warrenecee9322010-04-26 11:11:46 -07005085If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005086will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005087may be skipped by setting the appropriate 'ethmacskip' environment variable.
5088The naming convention is as follows:
5089"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk2729af92004-05-03 20:45:30 +00005091Image Formats:
5092==============
wdenkc6097192002-11-03 00:24:07 +00005093
Marian Balakowicz3310c542008-03-12 12:13:13 +01005094U-Boot is capable of booting (and performing other auxiliary operations on)
5095images in two formats:
5096
5097New uImage format (FIT)
5098-----------------------
5099
5100Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5101to Flattened Device Tree). It allows the use of images with multiple
5102components (several kernels, ramdisks, etc.), with contents protected by
5103SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5104
5105
5106Old uImage format
5107-----------------
5108
5109Old image format is based on binary files which can be basically anything,
5110preceded by a special header; see the definitions in include/image.h for
5111details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5114 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005115 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5116 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5117 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005118* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005119 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5120 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005121* Compression Type (uncompressed, gzip, bzip2)
5122* Load Address
5123* Entry Point
5124* Image Name
5125* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk2729af92004-05-03 20:45:30 +00005127The header is marked by a special Magic Number, and both the header
5128and the data portions of the image are secured against corruption by
5129CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005130
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk2729af92004-05-03 20:45:30 +00005132Linux Support:
5133==============
wdenkc6097192002-11-03 00:24:07 +00005134
wdenk2729af92004-05-03 20:45:30 +00005135Although U-Boot should support any OS or standalone application
5136easily, the main focus has always been on Linux during the design of
5137U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk2729af92004-05-03 20:45:30 +00005139U-Boot includes many features that so far have been part of some
5140special "boot loader" code within the Linux kernel. Also, any
5141"initrd" images to be used are no longer part of one big Linux image;
5142instead, kernel and "initrd" are separate images. This implementation
5143serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145- the same features can be used for other OS or standalone
5146 applications (for instance: using compressed images to reduce the
5147 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149- it becomes much easier to port new Linux kernel versions because
5150 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk2729af92004-05-03 20:45:30 +00005152- the same Linux kernel image can now be used with different "initrd"
5153 images; of course this also means that different kernel images can
5154 be run with the same "initrd". This makes testing easier (you don't
5155 have to build a new "zImage.initrd" Linux image when you just
5156 change a file in your "initrd"). Also, a field-upgrade of the
5157 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005158
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk2729af92004-05-03 20:45:30 +00005160Linux HOWTO:
5161============
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk2729af92004-05-03 20:45:30 +00005163Porting Linux to U-Boot based systems:
5164---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk2729af92004-05-03 20:45:30 +00005166U-Boot cannot save you from doing all the necessary modifications to
5167configure the Linux device drivers for use with your target hardware
5168(no, we don't intend to provide a full virtual machine interface to
5169Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005170
Stefan Roesea47a12b2010-04-15 16:07:28 +02005171But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173Just make sure your machine specific header file (for instance
5174include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005175Information structure as we define in include/asm-<arch>/u-boot.h,
5176and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005177as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005178
wdenkc6097192002-11-03 00:24:07 +00005179
wdenk2729af92004-05-03 20:45:30 +00005180Configuring the Linux kernel:
5181-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005182
wdenk2729af92004-05-03 20:45:30 +00005183No specific requirements for U-Boot. Make sure you have some root
5184device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005185
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187Building a Linux Image:
5188-----------------------
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk2729af92004-05-03 20:45:30 +00005190With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5191not used. If you use recent kernel source, a new build target
5192"uImage" will exist which automatically builds an image usable by
5193U-Boot. Most older kernels also have support for a "pImage" target,
5194which was introduced for our predecessor project PPCBoot and uses a
5195100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk2729af92004-05-03 20:45:30 +00005197Example:
wdenkc6097192002-11-03 00:24:07 +00005198
wdenk2729af92004-05-03 20:45:30 +00005199 make TQM850L_config
5200 make oldconfig
5201 make dep
5202 make uImage
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204The "uImage" build target uses a special tool (in 'tools/mkimage') to
5205encapsulate a compressed Linux kernel image with header information,
5206CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk2729af92004-05-03 20:45:30 +00005208* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk2729af92004-05-03 20:45:30 +00005210* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk2729af92004-05-03 20:45:30 +00005212 ${CROSS_COMPILE}-objcopy -O binary \
5213 -R .note -R .comment \
5214 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk2729af92004-05-03 20:45:30 +00005216* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk2729af92004-05-03 20:45:30 +00005218 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk2729af92004-05-03 20:45:30 +00005220* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005221
wdenk2729af92004-05-03 20:45:30 +00005222 mkimage -A ppc -O linux -T kernel -C gzip \
5223 -a 0 -e 0 -n "Linux Kernel Image" \
5224 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005225
wdenk24ee89b2002-11-03 17:56:27 +00005226
wdenk2729af92004-05-03 20:45:30 +00005227The "mkimage" tool can also be used to create ramdisk images for use
5228with U-Boot, either separated from the Linux kernel image, or
5229combined into one file. "mkimage" encapsulates the images with a 64
5230byte header containing information about target architecture,
5231operating system, image type, compression method, entry points, time
5232stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234"mkimage" can be called in two ways: to verify existing images and
5235print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005236
wdenk2729af92004-05-03 20:45:30 +00005237In the first form (with "-l" option) mkimage lists the information
5238contained in the header of an existing U-Boot image; this includes
5239checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241 tools/mkimage -l image
5242 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244The second form (with "-d" option) is used to build a U-Boot image
5245from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005246
wdenk2729af92004-05-03 20:45:30 +00005247 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5248 -n name -d data_file image
5249 -A ==> set architecture to 'arch'
5250 -O ==> set operating system to 'os'
5251 -T ==> set image type to 'type'
5252 -C ==> set compression type 'comp'
5253 -a ==> set load address to 'addr' (hex)
5254 -e ==> set entry point to 'ep' (hex)
5255 -n ==> set image name to 'name'
5256 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005257
wdenk69459792004-05-29 16:53:29 +00005258Right now, all Linux kernels for PowerPC systems use the same load
5259address (0x00000000), but the entry point address depends on the
5260kernel version:
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262- 2.2.x kernels have the entry point at 0x0000000C,
5263- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk2729af92004-05-03 20:45:30 +00005265So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk2729af92004-05-03 20:45:30 +00005267 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5268 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005269 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005270 > examples/uImage.TQM850L
5271 Image Name: 2.4.4 kernel for TQM850L
5272 Created: Wed Jul 19 02:34:59 2000
5273 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5274 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5275 Load Address: 0x00000000
5276 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005277
wdenk2729af92004-05-03 20:45:30 +00005278To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk2729af92004-05-03 20:45:30 +00005280 -> tools/mkimage -l examples/uImage.TQM850L
5281 Image Name: 2.4.4 kernel for TQM850L
5282 Created: Wed Jul 19 02:34:59 2000
5283 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5284 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5285 Load Address: 0x00000000
5286 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288NOTE: for embedded systems where boot time is critical you can trade
5289speed for memory and install an UNCOMPRESSED image instead: this
5290needs more space in Flash, but boots much faster since it does not
5291need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005292
Stefan Roesea47a12b2010-04-15 16:07:28 +02005293 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005294 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5295 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005296 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005297 > examples/uImage.TQM850L-uncompressed
5298 Image Name: 2.4.4 kernel for TQM850L
5299 Created: Wed Jul 19 02:34:59 2000
5300 Image Type: PowerPC Linux Kernel Image (uncompressed)
5301 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5302 Load Address: 0x00000000
5303 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005304
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk2729af92004-05-03 20:45:30 +00005306Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5307when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005308
wdenk2729af92004-05-03 20:45:30 +00005309 -> tools/mkimage -n 'Simple Ramdisk Image' \
5310 > -A ppc -O linux -T ramdisk -C gzip \
5311 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5312 Image Name: Simple Ramdisk Image
5313 Created: Wed Jan 12 14:01:50 2000
5314 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5315 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5316 Load Address: 0x00000000
5317 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005318
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005319The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5320option performs the converse operation of the mkimage's second form (the "-d"
5321option). Given an image built by mkimage, the dumpimage extracts a "data file"
5322from the image:
5323
5324 tools/dumpimage -i image -p position data_file
5325 -i ==> extract from the 'image' a specific 'data_file', \
5326 indexed by 'position'
5327
wdenkdb01a2e2004-04-15 23:14:49 +00005328
wdenk2729af92004-05-03 20:45:30 +00005329Installing a Linux Image:
5330-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005331
wdenk2729af92004-05-03 20:45:30 +00005332To downloading a U-Boot image over the serial (console) interface,
5333you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005334
wdenk2729af92004-05-03 20:45:30 +00005335 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005336
wdenk2729af92004-05-03 20:45:30 +00005337The 'objcopy' does not understand the information in the U-Boot
5338image header, so the resulting S-Record file will be relative to
5339address 0x00000000. To load it to a given address, you need to
5340specify the target address as 'offset' parameter with the 'loads'
5341command.
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk2729af92004-05-03 20:45:30 +00005343Example: install the image to address 0x40100000 (which on the
5344TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk2729af92004-05-03 20:45:30 +00005346 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348 .......... done
5349 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351 => loads 40100000
5352 ## Ready for S-Record download ...
5353 ~>examples/image.srec
5354 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5355 ...
5356 15989 15990 15991 15992
5357 [file transfer complete]
5358 [connected]
5359 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005360
5361
wdenk2729af92004-05-03 20:45:30 +00005362You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005363this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005364corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005365
wdenk2729af92004-05-03 20:45:30 +00005366 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk2729af92004-05-03 20:45:30 +00005368 ## Checking Image at 40100000 ...
5369 Image Name: 2.2.13 for initrd on TQM850L
5370 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5371 Data Size: 335725 Bytes = 327 kB = 0 MB
5372 Load Address: 00000000
5373 Entry Point: 0000000c
5374 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005375
5376
wdenk2729af92004-05-03 20:45:30 +00005377Boot Linux:
5378-----------
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380The "bootm" command is used to boot an application that is stored in
5381memory (RAM or Flash). In case of a Linux kernel image, the contents
5382of the "bootargs" environment variable is passed to the kernel as
5383parameters. You can check and modify this variable using the
5384"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005385
5386
wdenk2729af92004-05-03 20:45:30 +00005387 => printenv bootargs
5388 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk2729af92004-05-03 20:45:30 +00005390 => 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 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392 => printenv bootargs
5393 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 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395 => bootm 40020000
5396 ## Booting Linux kernel at 40020000 ...
5397 Image Name: 2.2.13 for NFS on TQM850L
5398 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5399 Data Size: 381681 Bytes = 372 kB = 0 MB
5400 Load Address: 00000000
5401 Entry Point: 0000000c
5402 Verifying Checksum ... OK
5403 Uncompressing Kernel Image ... OK
5404 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
5405 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5406 time_init: decrementer frequency = 187500000/60
5407 Calibrating delay loop... 49.77 BogoMIPS
5408 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5409 ...
wdenkc6097192002-11-03 00:24:07 +00005410
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005411If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005412the memory addresses of both the kernel and the initrd image (PPBCOOT
5413format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk2729af92004-05-03 20:45:30 +00005415 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk2729af92004-05-03 20:45:30 +00005417 ## Checking Image at 40100000 ...
5418 Image Name: 2.2.13 for initrd on TQM850L
5419 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5420 Data Size: 335725 Bytes = 327 kB = 0 MB
5421 Load Address: 00000000
5422 Entry Point: 0000000c
5423 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005424
wdenk2729af92004-05-03 20:45:30 +00005425 ## Checking Image at 40200000 ...
5426 Image Name: Simple Ramdisk Image
5427 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5428 Data Size: 566530 Bytes = 553 kB = 0 MB
5429 Load Address: 00000000
5430 Entry Point: 00000000
5431 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433 => bootm 40100000 40200000
5434 ## Booting Linux kernel at 40100000 ...
5435 Image Name: 2.2.13 for initrd on TQM850L
5436 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5437 Data Size: 335725 Bytes = 327 kB = 0 MB
5438 Load Address: 00000000
5439 Entry Point: 0000000c
5440 Verifying Checksum ... OK
5441 Uncompressing Kernel Image ... OK
5442 ## Loading RAMDisk Image at 40200000 ...
5443 Image Name: Simple Ramdisk Image
5444 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5445 Data Size: 566530 Bytes = 553 kB = 0 MB
5446 Load Address: 00000000
5447 Entry Point: 00000000
5448 Verifying Checksum ... OK
5449 Loading Ramdisk ... OK
5450 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
5451 Boot arguments: root=/dev/ram
5452 time_init: decrementer frequency = 187500000/60
5453 Calibrating delay loop... 49.77 BogoMIPS
5454 ...
5455 RAMDISK: Compressed image found at block 0
5456 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk2729af92004-05-03 20:45:30 +00005458 bash#
wdenkc6097192002-11-03 00:24:07 +00005459
Matthew McClintock02677682006-06-28 10:41:37 -05005460Boot Linux and pass a flat device tree:
5461-----------
5462
5463First, U-Boot must be compiled with the appropriate defines. See the section
5464titled "Linux Kernel Interface" above for a more in depth explanation. The
5465following is an example of how to start a kernel and pass an updated
5466flat device tree:
5467
5468=> print oftaddr
5469oftaddr=0x300000
5470=> print oft
5471oft=oftrees/mpc8540ads.dtb
5472=> tftp $oftaddr $oft
5473Speed: 1000, full duplex
5474Using TSEC0 device
5475TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5476Filename 'oftrees/mpc8540ads.dtb'.
5477Load address: 0x300000
5478Loading: #
5479done
5480Bytes transferred = 4106 (100a hex)
5481=> tftp $loadaddr $bootfile
5482Speed: 1000, full duplex
5483Using TSEC0 device
5484TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5485Filename 'uImage'.
5486Load address: 0x200000
5487Loading:############
5488done
5489Bytes transferred = 1029407 (fb51f hex)
5490=> print loadaddr
5491loadaddr=200000
5492=> print oftaddr
5493oftaddr=0x300000
5494=> bootm $loadaddr - $oftaddr
5495## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005496 Image Name: Linux-2.6.17-dirty
5497 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5498 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005499 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005500 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005501 Verifying Checksum ... OK
5502 Uncompressing Kernel Image ... OK
5503Booting using flat device tree at 0x300000
5504Using MPC85xx ADS machine description
5505Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5506[snip]
5507
5508
wdenk2729af92004-05-03 20:45:30 +00005509More About U-Boot Image Types:
5510------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005511
wdenk2729af92004-05-03 20:45:30 +00005512U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005513
wdenk2729af92004-05-03 20:45:30 +00005514 "Standalone Programs" are directly runnable in the environment
5515 provided by U-Boot; it is expected that (if they behave
5516 well) you can continue to work in U-Boot after return from
5517 the Standalone Program.
5518 "OS Kernel Images" are usually images of some Embedded OS which
5519 will take over control completely. Usually these programs
5520 will install their own set of exception handlers, device
5521 drivers, set up the MMU, etc. - this means, that you cannot
5522 expect to re-enter U-Boot except by resetting the CPU.
5523 "RAMDisk Images" are more or less just data blocks, and their
5524 parameters (address, size) are passed to an OS kernel that is
5525 being started.
5526 "Multi-File Images" contain several images, typically an OS
5527 (Linux) kernel image and one or more data images like
5528 RAMDisks. This construct is useful for instance when you want
5529 to boot over the network using BOOTP etc., where the boot
5530 server provides just a single image file, but you want to get
5531 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005532
wdenk2729af92004-05-03 20:45:30 +00005533 "Multi-File Images" start with a list of image sizes, each
5534 image size (in bytes) specified by an "uint32_t" in network
5535 byte order. This list is terminated by an "(uint32_t)0".
5536 Immediately after the terminating 0 follow the images, one by
5537 one, all aligned on "uint32_t" boundaries (size rounded up to
5538 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005539
wdenk2729af92004-05-03 20:45:30 +00005540 "Firmware Images" are binary images containing firmware (like
5541 U-Boot or FPGA images) which usually will be programmed to
5542 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544 "Script files" are command sequences that will be executed by
5545 U-Boot's command interpreter; this feature is especially
5546 useful when you configure U-Boot to use a real shell (hush)
5547 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005548
Marek Vasut44f074c2012-03-14 21:52:45 +00005549Booting the Linux zImage:
5550-------------------------
5551
5552On some platforms, it's possible to boot Linux zImage. This is done
5553using the "bootz" command. The syntax of "bootz" command is the same
5554as the syntax of "bootm" command.
5555
Tom Rini8ac28562013-05-16 11:40:11 -04005556Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005557kernel with raw initrd images. The syntax is slightly different, the
5558address of the initrd must be augmented by it's size, in the following
5559format: "<initrd addres>:<initrd size>".
5560
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk2729af92004-05-03 20:45:30 +00005562Standalone HOWTO:
5563=================
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk2729af92004-05-03 20:45:30 +00005565One of the features of U-Boot is that you can dynamically load and
5566run "standalone" applications, which can use some resources of
5567U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571"Hello World" Demo:
5572-------------------
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk2729af92004-05-03 20:45:30 +00005574'examples/hello_world.c' contains a small "Hello World" Demo
5575application; it is automatically compiled when you build U-Boot.
5576It's configured to run at address 0x00040004, so you can play with it
5577like that:
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk2729af92004-05-03 20:45:30 +00005579 => loads
5580 ## Ready for S-Record download ...
5581 ~>examples/hello_world.srec
5582 1 2 3 4 5 6 7 8 9 10 11 ...
5583 [file transfer complete]
5584 [connected]
5585 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005586
wdenk2729af92004-05-03 20:45:30 +00005587 => go 40004 Hello World! This is a test.
5588 ## Starting application at 0x00040004 ...
5589 Hello World
5590 argc = 7
5591 argv[0] = "40004"
5592 argv[1] = "Hello"
5593 argv[2] = "World!"
5594 argv[3] = "This"
5595 argv[4] = "is"
5596 argv[5] = "a"
5597 argv[6] = "test."
5598 argv[7] = "<NULL>"
5599 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk2729af92004-05-03 20:45:30 +00005603Another example, which demonstrates how to register a CPM interrupt
5604handler with the U-Boot code, can be found in 'examples/timer.c'.
5605Here, a CPM timer is set up to generate an interrupt every second.
5606The interrupt service routine is trivial, just printing a '.'
5607character, but this is just a demo program. The application can be
5608controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk2729af92004-05-03 20:45:30 +00005610 ? - print current values og the CPM Timer registers
5611 b - enable interrupts and start timer
5612 e - stop timer and disable interrupts
5613 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk2729af92004-05-03 20:45:30 +00005615 => loads
5616 ## Ready for S-Record download ...
5617 ~>examples/timer.srec
5618 1 2 3 4 5 6 7 8 9 10 11 ...
5619 [file transfer complete]
5620 [connected]
5621 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk2729af92004-05-03 20:45:30 +00005623 => go 40004
5624 ## Starting application at 0x00040004 ...
5625 TIMERS=0xfff00980
5626 Using timer 1
5627 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk2729af92004-05-03 20:45:30 +00005629Hit 'b':
5630 [q, b, e, ?] Set interval 1000000 us
5631 Enabling timer
5632Hit '?':
5633 [q, b, e, ?] ........
5634 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5635Hit '?':
5636 [q, b, e, ?] .
5637 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5638Hit '?':
5639 [q, b, e, ?] .
5640 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5641Hit '?':
5642 [q, b, e, ?] .
5643 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5644Hit 'e':
5645 [q, b, e, ?] ...Stopping timer
5646Hit 'q':
5647 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005648
5649
wdenk2729af92004-05-03 20:45:30 +00005650Minicom warning:
5651================
wdenk85ec0bc2003-03-31 16:34:49 +00005652
wdenk2729af92004-05-03 20:45:30 +00005653Over time, many people have reported problems when trying to use the
5654"minicom" terminal emulation program for serial download. I (wd)
5655consider minicom to be broken, and recommend not to use it. Under
5656Unix, I recommend to use C-Kermit for general purpose use (and
5657especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005658use "cu" for S-Record download ("loads" command). See
5659http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5660for help with kermit.
5661
wdenk85ec0bc2003-03-31 16:34:49 +00005662
wdenk2729af92004-05-03 20:45:30 +00005663Nevertheless, if you absolutely want to use it try adding this
5664configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005665
wdenk2729af92004-05-03 20:45:30 +00005666 Name Program Name U/D FullScr IO-Red. Multi
5667 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5668 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005669
5670
wdenk2729af92004-05-03 20:45:30 +00005671NetBSD Notes:
5672=============
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk2729af92004-05-03 20:45:30 +00005674Starting at version 0.9.2, U-Boot supports NetBSD both as host
5675(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk2729af92004-05-03 20:45:30 +00005677Building requires a cross environment; it is known to work on
5678NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5679need gmake since the Makefiles are not compatible with BSD make).
5680Note that the cross-powerpc package does not install include files;
5681attempting to build U-Boot will fail because <machine/ansi.h> is
5682missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684 # cd /usr/pkg/cross/powerpc-netbsd/include
5685 # mkdir powerpc
5686 # ln -s powerpc machine
5687 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5688 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005689
wdenk2729af92004-05-03 20:45:30 +00005690Native builds *don't* work due to incompatibilities between native
5691and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk2729af92004-05-03 20:45:30 +00005693Booting assumes that (the first part of) the image booted is a
5694stage-2 loader which in turn loads and then invokes the kernel
5695proper. Loader sources will eventually appear in the NetBSD source
5696tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005697meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005698
5699
wdenk2729af92004-05-03 20:45:30 +00005700Implementation Internals:
5701=========================
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703The following is not intended to be a complete description of every
5704implementation detail. However, it should help to understand the
5705inner workings of U-Boot and make it easier to port it to custom
5706hardware.
wdenkc6097192002-11-03 00:24:07 +00005707
5708
wdenk2729af92004-05-03 20:45:30 +00005709Initial Stack, Global Data:
5710---------------------------
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk2729af92004-05-03 20:45:30 +00005712The implementation of U-Boot is complicated by the fact that U-Boot
5713starts running out of ROM (flash memory), usually without access to
5714system RAM (because the memory controller is not initialized yet).
5715This means that we don't have writable Data or BSS segments, and BSS
5716is not initialized as zero. To be able to get a C environment working
5717at all, we have to allocate at least a minimal stack. Implementation
5718options for this are defined and restricted by the CPU used: Some CPU
5719models provide on-chip memory (like the IMMR area on MPC8xx and
5720MPC826x processors), on others (parts of) the data cache can be
5721locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005722
Wolfgang Denk218ca722008-03-26 10:40:12 +01005723 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005724 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005725
wdenk2729af92004-05-03 20:45:30 +00005726 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5727 From: "Chris Hallinan" <clh@net1plus.com>
5728 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5729 ...
wdenk43d96162003-03-06 00:02:04 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731 Correct me if I'm wrong, folks, but the way I understand it
5732 is this: Using DCACHE as initial RAM for Stack, etc, does not
5733 require any physical RAM backing up the cache. The cleverness
5734 is that the cache is being used as a temporary supply of
5735 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005736 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005737 can see how this works by studying the cache architecture and
5738 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5741 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005742 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005743 option should work for you. Using CS 4 should be fine if your
5744 board designers haven't used it for something that would
5745 cause you grief during the initial boot! It is frequently not
5746 used.
wdenk43d96162003-03-06 00:02:04 +00005747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005748 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005749 with your processor/board/system design. The default value
5750 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005751 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005752 than your SDRAM module. If you have a 64MB SDRAM module, set
5753 it above 400_0000. Just make sure your board has no resources
5754 that are supposed to respond to that address! That code in
5755 start.S has been around a while and should work as is when
5756 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005757
wdenk2729af92004-05-03 20:45:30 +00005758 -Chris Hallinan
5759 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005760
wdenk2729af92004-05-03 20:45:30 +00005761It is essential to remember this, since it has some impact on the C
5762code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764* Initialized global data (data segment) is read-only. Do not attempt
5765 to write it.
wdenkc6097192002-11-03 00:24:07 +00005766
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005767* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005768 as zero data - BSS segment) at all - this is undefined, initiali-
5769 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005770
wdenk2729af92004-05-03 20:45:30 +00005771* Stack space is very limited. Avoid big data buffers or things like
5772 that.
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk2729af92004-05-03 20:45:30 +00005774Having only the stack as writable memory limits means we cannot use
5775normal global data to share information beween the code. But it
5776turned out that the implementation of U-Boot can be greatly
5777simplified by making a global data structure (gd_t) available to all
5778functions. We could pass a pointer to this data as argument to _all_
5779functions, but this would bloat the code. Instead we use a feature of
5780the GCC compiler (Global Register Variables) to share the data: we
5781place a pointer (gd) to the global data into a register which we
5782reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk2729af92004-05-03 20:45:30 +00005784When choosing a register for such a purpose we are restricted by the
5785relevant (E)ABI specifications for the current architecture, and by
5786GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk2729af92004-05-03 20:45:30 +00005788For PowerPC, the following registers have specific use:
5789 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005790 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005791 R3-R4: parameter passing and return values
5792 R5-R10: parameter passing
5793 R13: small data area pointer
5794 R30: GOT pointer
5795 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005796
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005797 (U-Boot also uses R12 as internal GOT pointer. r12
5798 is a volatile register so r12 needs to be reset when
5799 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005800
Wolfgang Denke7670f62008-02-14 22:43:22 +01005801 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803 Note: on PPC, we could use a static initializer (since the
5804 address of the global data structure is known at compile time),
5805 but it turned out that reserving a register results in somewhat
5806 smaller code - although the code savings are not that big (on
5807 average for all boards 752 bytes for the whole U-Boot image,
5808 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005809
Robin Getzc4db3352009-08-17 15:23:02 +00005810On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005811 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5812
Robin Getzc4db3352009-08-17 15:23:02 +00005813 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005814
wdenk2729af92004-05-03 20:45:30 +00005815On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk2729af92004-05-03 20:45:30 +00005817 R0: function argument word/integer result
5818 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005819 R9: platform specific
5820 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005821 R11: argument (frame) pointer
5822 R12: temporary workspace
5823 R13: stack pointer
5824 R14: link register
5825 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005826
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005827 ==> U-Boot will use R9 to hold a pointer to the global data
5828
5829 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005830
Thomas Chou0df01fd2010-05-21 11:08:03 +08005831On Nios II, the ABI is documented here:
5832 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5833
5834 ==> U-Boot will use gp to hold a pointer to the global data
5835
5836 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5837 to access small data sections, so gp is free.
5838
Macpaul Linafc1ce82011-10-19 20:41:11 +00005839On NDS32, the following registers are used:
5840
5841 R0-R1: argument/return
5842 R2-R5: argument
5843 R15: temporary register for assembler
5844 R16: trampoline register
5845 R28: frame pointer (FP)
5846 R29: global pointer (GP)
5847 R30: link register (LP)
5848 R31: stack pointer (SP)
5849 PC: program counter (PC)
5850
5851 ==> U-Boot will use R10 to hold a pointer to the global data
5852
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005853NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5854or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk2729af92004-05-03 20:45:30 +00005856Memory Management:
5857------------------
wdenkc6097192002-11-03 00:24:07 +00005858
wdenk2729af92004-05-03 20:45:30 +00005859U-Boot runs in system state and uses physical addresses, i.e. the
5860MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862The available memory is mapped to fixed addresses using the memory
5863controller. In this process, a contiguous block is formed for each
5864memory type (Flash, SDRAM, SRAM), even when it consists of several
5865physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk2729af92004-05-03 20:45:30 +00005867U-Boot is installed in the first 128 kB of the first Flash bank (on
5868TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5869booting and sizing and initializing DRAM, the code relocates itself
5870to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005871memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005872configuration setting]. Below that, a structure with global Board
5873Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005874
wdenk2729af92004-05-03 20:45:30 +00005875Additionally, some exception handler code is copied to the low 8 kB
5876of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk2729af92004-05-03 20:45:30 +00005878So a typical memory configuration with 16 MB of DRAM could look like
5879this:
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk2729af92004-05-03 20:45:30 +00005881 0x0000 0000 Exception Vector code
5882 :
5883 0x0000 1FFF
5884 0x0000 2000 Free for Application Use
5885 :
5886 :
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888 :
5889 :
5890 0x00FB FF20 Monitor Stack (Growing downward)
5891 0x00FB FFAC Board Info Data and permanent copy of global data
5892 0x00FC 0000 Malloc Arena
5893 :
5894 0x00FD FFFF
5895 0x00FE 0000 RAM Copy of Monitor Code
5896 ... eventually: LCD or video framebuffer
5897 ... eventually: pRAM (Protected RAM - unchanged by reset)
5898 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005899
5900
wdenk2729af92004-05-03 20:45:30 +00005901System Initialization:
5902----------------------
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk2729af92004-05-03 20:45:30 +00005904In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005905(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005906configuration for CS0# this is a mirror of the onboard Flash memory.
5907To be able to re-map memory U-Boot then jumps to its link address.
5908To be able to implement the initialization code in C, a (small!)
5909initial stack is set up in the internal Dual Ported RAM (in case CPUs
5910which provide such a feature like MPC8xx or MPC8260), or in a locked
5911part of the data cache. After that, U-Boot initializes the CPU core,
5912the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk2729af92004-05-03 20:45:30 +00005914Next, all (potentially) available memory banks are mapped using a
5915preliminary mapping. For example, we put them on 512 MB boundaries
5916(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5917on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5918programmed for SDRAM access. Using the temporary configuration, a
5919simple memory test is run that determines the size of the SDRAM
5920banks.
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk2729af92004-05-03 20:45:30 +00005922When there is more than one SDRAM bank, and the banks are of
5923different size, the largest is mapped first. For equal size, the first
5924bank (CS2#) is mapped first. The first mapping is always for address
59250x00000000, with any additional banks following immediately to create
5926contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005927
wdenk2729af92004-05-03 20:45:30 +00005928Then, the monitor installs itself at the upper end of the SDRAM area
5929and allocates memory for use by malloc() and for the global Board
5930Info data; also, the exception vector code is copied to the low RAM
5931pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk2729af92004-05-03 20:45:30 +00005933Only after this relocation will you have a "normal" C environment;
5934until that you are restricted in several ways, mostly because you are
5935running from ROM, and because the code will have to be relocated to a
5936new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005937
5938
wdenk2729af92004-05-03 20:45:30 +00005939U-Boot Porting Guide:
5940----------------------
wdenkc6097192002-11-03 00:24:07 +00005941
wdenk2729af92004-05-03 20:45:30 +00005942[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5943list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005944
5945
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005946int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005947{
5948 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005949
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005950 signal(SIGALRM, no_more_time);
5951 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005952
wdenk2729af92004-05-03 20:45:30 +00005953 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005954 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005955 return 0;
5956 }
5957
wdenk2729af92004-05-03 20:45:30 +00005958 Download latest U-Boot source;
5959
Wolfgang Denk06682362008-12-30 22:56:11 +01005960 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005961
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005962 if (clueless)
5963 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005964
wdenk2729af92004-05-03 20:45:30 +00005965 while (learning) {
5966 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005967 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5968 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005969 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005970 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005971 }
wdenkc6097192002-11-03 00:24:07 +00005972
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005973 if (available_money > toLocalCurrency ($2500))
5974 Buy a BDI3000;
5975 else
wdenk2729af92004-05-03 20:45:30 +00005976 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005977
5978 if (a similar board exists) { /* hopefully... */
5979 cp -a board/<similar> board/<myboard>
5980 cp include/configs/<similar>.h include/configs/<myboard>.h
5981 } else {
5982 Create your own board support subdirectory;
5983 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005984 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005985 Edit new board/<myboard> files
5986 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005987
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005988 while (!accepted) {
5989 while (!running) {
5990 do {
5991 Add / modify source code;
5992 } until (compiles);
5993 Debug;
5994 if (clueless)
5995 email("Hi, I am having problems...");
5996 }
5997 Send patch file to the U-Boot email list;
5998 if (reasonable critiques)
5999 Incorporate improvements from email list code review;
6000 else
6001 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006002 }
wdenkc6097192002-11-03 00:24:07 +00006003
wdenk2729af92004-05-03 20:45:30 +00006004 return 0;
6005}
6006
6007void no_more_time (int sig)
6008{
6009 hire_a_guru();
6010}
wdenkc6097192002-11-03 00:24:07 +00006011
6012
wdenk2729af92004-05-03 20:45:30 +00006013Coding Standards:
6014-----------------
wdenkc6097192002-11-03 00:24:07 +00006015
wdenk2729af92004-05-03 20:45:30 +00006016All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006017coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006018"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006019
Detlev Zundel2c051652006-09-01 15:39:02 +02006020Source files originating from a different project (for example the
6021MTD subsystem) are generally exempt from these guidelines and are not
6022reformated to ease subsequent migration to newer versions of those
6023sources.
6024
6025Please note that U-Boot is implemented in C (and to some small parts in
6026Assembler); no C++ is used, so please do not use C++ style comments (//)
6027in your code.
wdenk2729af92004-05-03 20:45:30 +00006028
6029Please also stick to the following formatting rules:
6030- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006031- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006032- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006033- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006034- do not add trailing empty lines to source files
6035
6036Submissions which do not conform to the standards may be returned
6037with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006038
6039
wdenk2729af92004-05-03 20:45:30 +00006040Submitting Patches:
6041-------------------
wdenkc6097192002-11-03 00:24:07 +00006042
wdenk2729af92004-05-03 20:45:30 +00006043Since the number of patches for U-Boot is growing, we need to
6044establish some rules. Submissions which do not conform to these rules
6045may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006046
Magnus Lilja0d28f342008-08-06 19:32:33 +02006047Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006048
Wolfgang Denk06682362008-12-30 22:56:11 +01006049Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6050see http://lists.denx.de/mailman/listinfo/u-boot
6051
wdenk2729af92004-05-03 20:45:30 +00006052When you send a patch, please include the following information with
6053it:
wdenkc6097192002-11-03 00:24:07 +00006054
wdenk2729af92004-05-03 20:45:30 +00006055* For bug fixes: a description of the bug and how your patch fixes
6056 this bug. Please try to include a way of demonstrating that the
6057 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006058
wdenk2729af92004-05-03 20:45:30 +00006059* For new features: a description of the feature and your
6060 implementation.
wdenkc6097192002-11-03 00:24:07 +00006061
wdenk2729af92004-05-03 20:45:30 +00006062* A CHANGELOG entry as plaintext (separate from the patch)
6063
6064* For major contributions, your entry to the CREDITS file
6065
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006066* When you add support for a new board, don't forget to add a
6067 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006068
6069* If your patch adds new configuration options, don't forget to
6070 document these in the README file.
6071
Wolfgang Denk218ca722008-03-26 10:40:12 +01006072* The patch itself. If you are using git (which is *strongly*
6073 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006074 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006075 the U-Boot mailing list, you will avoid most of the common problems
6076 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006077
Wolfgang Denk218ca722008-03-26 10:40:12 +01006078 If you cannot use git, use "diff -purN OLD NEW". If your version of
6079 diff does not support these options, then get the latest version of
6080 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006081
Wolfgang Denk218ca722008-03-26 10:40:12 +01006082 The current directory when running this command shall be the parent
6083 directory of the U-Boot source tree (i. e. please make sure that
6084 your patch includes sufficient directory information for the
6085 affected files).
6086
6087 We prefer patches as plain text. MIME attachments are discouraged,
6088 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006089
6090* If one logical set of modifications affects or creates several
6091 files, all these changes shall be submitted in a SINGLE patch file.
6092
6093* Changesets that contain different, unrelated modifications shall be
6094 submitted as SEPARATE patches, one patch per changeset.
6095
6096
6097Notes:
6098
6099* Before sending the patch, run the MAKEALL script on your patched
6100 source tree and make sure that no errors or warnings are reported
6101 for any of the boards.
6102
6103* Keep your modifications to the necessary minimum: A patch
6104 containing several unrelated changes or arbitrary reformats will be
6105 returned with a request to re-formatting / split it.
6106
6107* If you modify existing code, make sure that your new code does not
6108 add to the memory footprint of the code ;-) Small is beautiful!
6109 When adding new features, these should compile conditionally only
6110 (using #ifdef), and the resulting code with the new feature
6111 disabled must not need more memory than the old code without your
6112 modification.
wdenk90dc6702005-05-03 14:12:25 +00006113
Wolfgang Denk06682362008-12-30 22:56:11 +01006114* Remember that there is a size limit of 100 kB per message on the
6115 u-boot mailing list. Bigger patches will be moderated. If they are
6116 reasonable and not too big, they will be acknowledged. But patches
6117 bigger than the size limit should be avoided.