blob: 6cdf355446f57423045ba605d6b760a183eec1de [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
144 /ixp Files specific to Intel XScale IXP CPUs
145 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
147 /lib Architecture specific library files
148 /avr32 Files generic to AVR32 architecture
149 /cpu CPU specific files
150 /lib Architecture specific library files
151 /blackfin Files generic to Analog Devices Blackfin architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500154 /m68k Files generic to m68k architecture
155 /cpu CPU specific files
156 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
157 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
158 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
159 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
160 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
161 /lib Architecture specific library files
162 /microblaze Files generic to microblaze architecture
163 /cpu CPU specific files
164 /lib Architecture specific library files
165 /mips Files generic to MIPS architecture
166 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200167 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800168 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500169 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000170 /nds32 Files generic to NDS32 architecture
171 /cpu CPU specific files
172 /n1213 Files specific to Andes Technology N1213 CPUs
173 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500174 /nios2 Files generic to Altera NIOS2 architecture
175 /cpu CPU specific files
176 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400177 /openrisc Files generic to OpenRISC architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200180 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500181 /cpu CPU specific files
182 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
183 /mpc5xx Files specific to Freescale MPC5xx CPUs
184 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
185 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500186 /mpc824x Files specific to Freescale MPC824x CPUs
187 /mpc8260 Files specific to Freescale MPC8260 CPUs
188 /mpc85xx Files specific to Freescale MPC85xx CPUs
189 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
190 /lib Architecture specific library files
191 /sh Files generic to SH architecture
192 /cpu CPU specific files
193 /sh2 Files specific to sh2 CPUs
194 /sh3 Files specific to sh3 CPUs
195 /sh4 Files specific to sh4 CPUs
196 /lib Architecture specific library files
197 /sparc Files generic to SPARC architecture
198 /cpu CPU specific files
199 /leon2 Files specific to Gaisler LEON2 SPARC CPU
200 /leon3 Files specific to Gaisler LEON3 SPARC CPU
201 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400202 /x86 Files generic to x86 architecture
203 /cpu CPU specific files
204 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500205/api Machine/arch independent API for external apps
206/board Board dependent files
207/common Misc architecture independent functions
208/disk Code for disk drive partition handling
209/doc Documentation (don't expect too much)
210/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400211/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500212/examples Example code for standalone applications, etc.
213/fs Filesystem code (cramfs, ext2, jffs2, etc.)
214/include Header Files
215/lib Files generic to all architectures
216 /libfdt Library files to support flattened device trees
217 /lzma Library files to support LZMA decompression
218 /lzo Library files to support LZO decompression
219/net Networking code
220/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400221/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500222/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000223
wdenkc6097192002-11-03 00:24:07 +0000224Software Configuration:
225=======================
226
227Configuration is usually done using C preprocessor defines; the
228rationale behind that is to avoid dead code whenever possible.
229
230There are two classes of configuration variables:
231
232* Configuration _OPTIONS_:
233 These are selectable by the user and have names beginning with
234 "CONFIG_".
235
236* Configuration _SETTINGS_:
237 These depend on the hardware etc. and should not be meddled with if
238 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200239 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000240
241Later we will add a configuration tool - probably similar to or even
242identical to what's used for the Linux kernel. Right now, we have to
243do the configuration by hand, which means creating some symbolic
244links and editing some configuration files. We use the TQM8xxL boards
245as an example here.
246
247
248Selection of Processor Architecture and Board Type:
249---------------------------------------------------
250
251For all supported boards there are ready-to-use default
252configurations available; just type "make <board_name>_config".
253
254Example: For a TQM823L module type:
255
256 cd u-boot
257 make TQM823L_config
258
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200259For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000260e.g. "make cogent_mpc8xx_config". And also configure the cogent
261directory according to the instructions in cogent/README.
262
263
264Configuration Options:
265----------------------
266
267Configuration depends on the combination of board and CPU type; all
268such information is kept in a configuration file
269"include/configs/<board_name>.h".
270
271Example: For a TQM823L module, all configuration settings are in
272"include/configs/TQM823L.h".
273
274
wdenk7f6c2cb2002-11-10 22:06:23 +0000275Many of the options are named exactly as the corresponding Linux
276kernel configuration options. The intention is to make it easier to
277build a config tool - later.
278
279
wdenkc6097192002-11-03 00:24:07 +0000280The following options need to be configured:
281
Kim Phillips26281142007-08-10 13:28:25 -0500282- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000283
Kim Phillips26281142007-08-10 13:28:25 -0500284- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200285
286- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100287 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000288
289- CPU Module Type: (if CONFIG_COGENT is defined)
290 Define exactly one of
291 CONFIG_CMA286_60_OLD
292--- FIXME --- not tested yet:
293 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294 CONFIG_CMA287_23, CONFIG_CMA287_50
295
296- Motherboard Type: (if CONFIG_COGENT is defined)
297 Define exactly one of
298 CONFIG_CMA101, CONFIG_CMA102
299
300- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301 Define one or more of
302 CONFIG_CMA302
303
304- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305 Define one or more of
306 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200307 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000308 a "rotator" |\-/|\-/
309
wdenk2535d602003-07-17 23:16:40 +0000310- Board flavour: (if CONFIG_MPC8260ADS is defined)
311 CONFIG_ADSTYPE
312 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200313 CONFIG_SYS_8260ADS - original MPC8260ADS
314 CONFIG_SYS_8266ADS - MPC8266ADS
315 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
316 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000317
Lei Wencf946c62011-02-09 18:06:58 +0530318- Marvell Family Member
319 CONFIG_SYS_MVFS - define it if you want to enable
320 multiple fs option at one time
321 for marvell soc family
322
wdenkc6097192002-11-03 00:24:07 +0000323- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000324 Define exactly one of
325 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
333 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000334
wdenk66ca92a2004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000342
wdenkba56f622004-02-06 23:19:44 +0000343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000349
Heiko Schocher506f3912009-03-12 07:37:15 +0100350 CONFIG_SYS_DELAYED_ICACHE
351
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
354
Kumar Gala66412c62011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000356 CONFIG_SYS_PPC64
357
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
361
Kumar Gala66412c62011-02-18 05:40:54 -0600362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala8f290842011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000373 CONFIG_SYS_PPC_E500_DEBUG_TLB
374
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
380 purpose.
381
Scott Wood33eee332012-08-14 10:14:53 +0000382 CONFIG_SYS_FSL_ERRATUM_A004510
383
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
387
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
390
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
393
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
398
399 See Freescale App Note 4493 for more information about
400 this erratum.
401
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
404 requred during NOR boot.
405
Scott Wood33eee332012-08-14 10:14:53 +0000406 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
407
408 This is the value to write into CCSR offset 0x18600
409 according to the A004510 workaround.
410
Priyanka Jain64501c62013-07-02 09:21:04 +0530411 CONFIG_SYS_FSL_DSP_DDR_ADDR
412 This value denotes start offset of DDR memory which is
413 connected exclusively to the DSP cores.
414
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530415 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416 This value denotes start offset of M2 memory
417 which is directly connected to the DSP core.
418
Priyanka Jain64501c62013-07-02 09:21:04 +0530419 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
420 This value denotes start offset of M3 memory which is directly
421 connected to the DSP core.
422
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530423 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424 This value denotes start offset of DSP CCSR space.
425
Priyanka Jainb1359912013-12-17 14:25:52 +0530426 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
427 Single Source Clock is clocking mode present in some of FSL SoC's.
428 In this mode, a single differential clock is used to supply
429 clocks to the sysclock, ddrclock and usbclock.
430
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000431- Generic CPU options:
432 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
433
434 Defines the endianess of the CPU. Implementation of those
435 values is arch specific.
436
York Sun5614e712013-09-30 09:22:09 -0700437 CONFIG_SYS_FSL_DDR
438 Freescale DDR driver in use. This type of DDR controller is
439 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
440 SoCs.
441
442 CONFIG_SYS_FSL_DDR_ADDR
443 Freescale DDR memory-mapped register base.
444
445 CONFIG_SYS_FSL_DDR_EMU
446 Specify emulator support for DDR. Some DDR features such as
447 deskew training are not available.
448
449 CONFIG_SYS_FSL_DDRC_GEN1
450 Freescale DDR1 controller.
451
452 CONFIG_SYS_FSL_DDRC_GEN2
453 Freescale DDR2 controller.
454
455 CONFIG_SYS_FSL_DDRC_GEN3
456 Freescale DDR3 controller.
457
York Sun9ac4ffb2013-09-30 14:20:51 -0700458 CONFIG_SYS_FSL_DDRC_ARM_GEN3
459 Freescale DDR3 controller for ARM-based SoCs.
460
York Sun5614e712013-09-30 09:22:09 -0700461 CONFIG_SYS_FSL_DDR1
462 Board config to use DDR1. It can be enabled for SoCs with
463 Freescale DDR1 or DDR2 controllers, depending on the board
464 implemetation.
465
466 CONFIG_SYS_FSL_DDR2
467 Board config to use DDR2. It can be eanbeld for SoCs with
468 Freescale DDR2 or DDR3 controllers, depending on the board
469 implementation.
470
471 CONFIG_SYS_FSL_DDR3
472 Board config to use DDR3. It can be enabled for SoCs with
473 Freescale DDR3 controllers.
474
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
477
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
480
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530481 CONFIG_SYS_FSL_PBL_PBI
482 It enables addition of RCW (Power on reset configuration) in built image.
483 Please refer doc/README.pblimage for more details
484
485 CONFIG_SYS_FSL_PBL_RCW
486 It adds PBI(pre-boot instructions) commands in u-boot build image.
487 PBI commands can be used to configure SoC before it starts the execution.
488 Please refer doc/README.pblimage for more details
489
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100490- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200491 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100492
493 Defines the Monahans run mode to oscillator
494 ratio. Valid values are 8, 16, 24, 31. The core
495 frequency is this value multiplied by 13 MHz.
496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200497 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200498
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100499 Defines the Monahans turbo mode to oscillator
500 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200501 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100502 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200503
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200504- MIPS CPU options:
505 CONFIG_SYS_INIT_SP_OFFSET
506
507 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
508 pointer. This is needed for the temporary stack before
509 relocation.
510
511 CONFIG_SYS_MIPS_CACHE_MODE
512
513 Cache operation mode for the MIPS CPU.
514 See also arch/mips/include/asm/mipsregs.h.
515 Possible values are:
516 CONF_CM_CACHABLE_NO_WA
517 CONF_CM_CACHABLE_WA
518 CONF_CM_UNCACHED
519 CONF_CM_CACHABLE_NONCOHERENT
520 CONF_CM_CACHABLE_CE
521 CONF_CM_CACHABLE_COW
522 CONF_CM_CACHABLE_CUW
523 CONF_CM_CACHABLE_ACCELERATED
524
525 CONFIG_SYS_XWAY_EBU_BOOTCFG
526
527 Special option for Lantiq XWAY SoCs for booting from NOR flash.
528 See also arch/mips/cpu/mips32/start.S.
529
530 CONFIG_XWAY_SWAP_BYTES
531
532 Enable compilation of tools/xway-swap-bytes needed for Lantiq
533 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
534 be swapped if a flash programmer is used.
535
Christian Rieschb67d8812012-02-02 00:44:39 +0000536- ARM options:
537 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
538
539 Select high exception vectors of the ARM core, e.g., do not
540 clear the V bit of the c1 register of CP15.
541
Aneesh V5356f542012-03-08 07:20:19 +0000542 CONFIG_SYS_THUMB_BUILD
543
544 Use this flag to build U-Boot using the Thumb instruction
545 set for ARM architectures. Thumb instruction set provides
546 better code density. For ARM architectures that support
547 Thumb2 this flag will result in Thumb2 code generated by
548 GCC.
549
Stephen Warrenc5d47522013-03-04 13:29:40 +0000550 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000551 CONFIG_ARM_ERRATA_742230
552 CONFIG_ARM_ERRATA_743622
553 CONFIG_ARM_ERRATA_751472
554
555 If set, the workarounds for these ARM errata are applied early
556 during U-Boot startup. Note that these options force the
557 workarounds to be applied; no CPU-type/version detection
558 exists, unlike the similar options in the Linux kernel. Do not
559 set these options unless they apply!
560
Stephen Warren795659d2013-03-27 17:06:41 +0000561- CPU timer options:
562 CONFIG_SYS_HZ
563
564 The frequency of the timer returned by get_timer().
565 get_timer() must operate in milliseconds and this CONFIG
566 option must be set to 1000.
567
wdenk5da627a2003-10-09 20:09:04 +0000568- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000569 CONFIG_CLOCKS_IN_MHZ
570
571 U-Boot stores all clock information in Hz
572 internally. For binary compatibility with older Linux
573 kernels (which expect the clocks passed in the
574 bd_info data to be in MHz) the environment variable
575 "clocks_in_mhz" can be defined so that U-Boot
576 converts clock data to MHZ before passing it to the
577 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000578 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100579 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000580 default environment.
581
wdenk5da627a2003-10-09 20:09:04 +0000582 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
583
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200584 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000585 expect it to be in bytes, others in MB.
586 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
587
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400588 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200589
590 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400591 passed using flattened device trees (based on open firmware
592 concepts).
593
594 CONFIG_OF_LIBFDT
595 * New libfdt-based support
596 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500597 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400598
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200599 OF_CPU - The proper name of the cpus node (only required for
600 MPC512X and MPC5xxx based boards).
601 OF_SOC - The proper name of the soc node (only required for
602 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200603 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600604 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200605
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200606 boards with QUICC Engines require OF_QE to set UCC MAC
607 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500608
Kumar Gala4e253132006-01-11 13:54:17 -0600609 CONFIG_OF_BOARD_SETUP
610
611 Board code has addition modification that it wants to make
612 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000613
Matthew McClintock02677682006-06-28 10:41:37 -0500614 CONFIG_OF_BOOT_CPU
615
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200616 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500617 param header, the default value is zero if undefined.
618
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200619 CONFIG_OF_IDE_FIXUP
620
621 U-Boot can detect if an IDE device is present or not.
622 If not, and this new config option is activated, U-Boot
623 removes the ATA node from the DTS before booting Linux,
624 so the Linux IDE driver does not probe the device and
625 crash. This is needed for buggy hardware (uc101) where
626 no pull down resistor is connected to the signal IDE5V_DD7.
627
Igor Grinberg7eb29392011-07-14 05:45:07 +0000628 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
629
630 This setting is mandatory for all boards that have only one
631 machine type and must be used to specify the machine type
632 number as it appears in the ARM machine registry
633 (see http://www.arm.linux.org.uk/developer/machines/).
634 Only boards that have multiple machine types supported
635 in a single configuration file and the machine type is
636 runtime discoverable, do not have to use this setting.
637
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100638- vxWorks boot parameters:
639
640 bootvx constructs a valid bootline using the following
641 environments variables: bootfile, ipaddr, serverip, hostname.
642 It loads the vxWorks image pointed bootfile.
643
644 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
645 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
646 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
647 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
648
649 CONFIG_SYS_VXWORKS_ADD_PARAMS
650
651 Add it at the end of the bootline. E.g "u=username pw=secret"
652
653 Note: If a "bootargs" environment is defined, it will overwride
654 the defaults discussed just above.
655
Aneesh V2c451f72011-06-16 23:30:47 +0000656- Cache Configuration:
657 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
658 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
659 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
660
Aneesh V93bc2192011-06-16 23:30:51 +0000661- Cache Configuration for ARM:
662 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
663 controller
664 CONFIG_SYS_PL310_BASE - Physical base address of PL310
665 controller register space
666
wdenk6705d812004-08-02 23:22:59 +0000667- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200668 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000669
670 Define this if you want support for Amba PrimeCell PL010 UARTs.
671
Andreas Engel48d01922008-09-08 14:30:53 +0200672 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000673
674 Define this if you want support for Amba PrimeCell PL011 UARTs.
675
676 CONFIG_PL011_CLOCK
677
678 If you have Amba PrimeCell PL011 UARTs, set this variable to
679 the clock speed of the UARTs.
680
681 CONFIG_PL01x_PORTS
682
683 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
684 define this to a list of base addresses for each (supported)
685 port. See e.g. include/configs/versatile.h
686
John Rigby910f1ae2011-04-19 10:42:39 +0000687 CONFIG_PL011_SERIAL_RLCR
688
689 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
690 have separate receive and transmit line control registers. Set
691 this variable to initialize the extra register.
692
693 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
694
695 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
696 boot loader that has already initialized the UART. Define this
697 variable to flush the UART at init time.
698
wdenk6705d812004-08-02 23:22:59 +0000699
wdenkc6097192002-11-03 00:24:07 +0000700- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000701 Depending on board, define exactly one serial port
702 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
703 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
704 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000705
706 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
707 port routines must be defined elsewhere
708 (i.e. serial_init(), serial_getc(), ...)
709
710 CONFIG_CFB_CONSOLE
711 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000712 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000713 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
714 (default big endian)
715 VIDEO_HW_RECTFILL graphic chip supports
716 rectangle fill
717 (cf. smiLynxEM)
718 VIDEO_HW_BITBLT graphic chip supports
719 bit-blit (cf. smiLynxEM)
720 VIDEO_VISIBLE_COLS visible pixel columns
721 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000722 VIDEO_VISIBLE_ROWS visible pixel rows
723 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000724 VIDEO_DATA_FORMAT graphic data format
725 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000726 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000727 VIDEO_KBD_INIT_FCT keyboard int fct
728 (i.e. i8042_kbd_init())
729 VIDEO_TSTC_FCT test char fct
730 (i.e. i8042_tstc)
731 VIDEO_GETC_FCT get char fct
732 (i.e. i8042_getc)
733 CONFIG_CONSOLE_CURSOR cursor drawing on/off
734 (requires blink timer
735 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200736 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000737 CONFIG_CONSOLE_TIME display time/date info in
738 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000740 CONFIG_VIDEO_LOGO display Linux logo in
741 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000742 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
743 linux_logo.h for logo.
744 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200746 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000747 the logo
748
Pali Rohár33a35bb2012-10-19 13:30:09 +0000749 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
750 a limited number of ANSI escape sequences (cursor control,
751 erase functions and limited graphics rendition control).
752
wdenk43d96162003-03-06 00:02:04 +0000753 When CONFIG_CFB_CONSOLE is defined, video console is
754 default i/o. Serial console can be forced with
755 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000756
wdenkd4ca31c2004-01-02 14:00:00 +0000757 When CONFIG_SILENT_CONSOLE is defined, all console
758 messages (by U-Boot and Linux!) can be silenced with
759 the "silent" environment variable. See
760 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000761
Heiko Schocher45ae2542013-10-22 11:06:06 +0200762 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
763 is 0x00.
764 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
765 is 0xa0.
766
wdenkc6097192002-11-03 00:24:07 +0000767- Console Baudrate:
768 CONFIG_BAUDRATE - in bps
769 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200770 CONFIG_SYS_BAUDRATE_TABLE, see below.
771 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000772
Heiko Schocherc92fac92009-01-30 12:55:38 +0100773- Console Rx buffer length
774 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
775 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100776 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100777 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
778 must be defined, to setup the maximum idle timeout for
779 the SMC.
780
Graeme Russ9558b482011-09-01 00:48:27 +0000781- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200782 Prior to the console being initialised (i.e. serial UART
783 initialised etc) all console output is silently discarded.
784 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
785 buffer any console messages prior to the console being
786 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
787 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
788 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200789 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200790 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000791
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200792 'Sane' compilers will generate smaller code if
793 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000794
Sonny Rao046a37b2011-11-02 09:52:08 +0000795- Safe printf() functions
796 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
797 the printf() functions. These are defined in
798 include/vsprintf.h and include snprintf(), vsnprintf() and
799 so on. Code size increase is approximately 300-500 bytes.
800 If this option is not given then these functions will
801 silently discard their buffer size argument - this means
802 you are not getting any overflow checking in this case.
803
wdenkc6097192002-11-03 00:24:07 +0000804- Boot Delay: CONFIG_BOOTDELAY - in seconds
805 Delay before automatically booting the default image;
806 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000807 set to -2 to autoboot with no delay and not check for abort
808 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000809
810 See doc/README.autoboot for these options that
811 work with CONFIG_BOOTDELAY. None are required.
812 CONFIG_BOOT_RETRY_TIME
813 CONFIG_BOOT_RETRY_MIN
814 CONFIG_AUTOBOOT_KEYED
815 CONFIG_AUTOBOOT_PROMPT
816 CONFIG_AUTOBOOT_DELAY_STR
817 CONFIG_AUTOBOOT_STOP_STR
818 CONFIG_AUTOBOOT_DELAY_STR2
819 CONFIG_AUTOBOOT_STOP_STR2
820 CONFIG_ZERO_BOOTDELAY_CHECK
821 CONFIG_RESET_TO_RETRY
822
823- Autoboot Command:
824 CONFIG_BOOTCOMMAND
825 Only needed when CONFIG_BOOTDELAY is enabled;
826 define a command string that is automatically executed
827 when no character is read on the console interface
828 within "Boot Delay" after reset.
829
830 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000831 This can be used to pass arguments to the bootm
832 command. The value of CONFIG_BOOTARGS goes into the
833 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000834
835 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000836 The value of these goes into the environment as
837 "ramboot" and "nfsboot" respectively, and can be used
838 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200839 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000840
Heiko Schochereda0ba32013-11-04 14:04:59 +0100841- Bootcount:
842 CONFIG_BOOTCOUNT_LIMIT
843 Implements a mechanism for detecting a repeating reboot
844 cycle, see:
845 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
846
847 CONFIG_BOOTCOUNT_ENV
848 If no softreset save registers are found on the hardware
849 "bootcount" is stored in the environment. To prevent a
850 saveenv on all reboots, the environment variable
851 "upgrade_available" is used. If "upgrade_available" is
852 0, "bootcount" is always 0, if "upgrade_available" is
853 1 "bootcount" is incremented in the environment.
854 So the Userspace Applikation must set the "upgrade_available"
855 and "bootcount" variable to 0, if a boot was successfully.
856
wdenkc6097192002-11-03 00:24:07 +0000857- Pre-Boot Commands:
858 CONFIG_PREBOOT
859
860 When this option is #defined, the existence of the
861 environment variable "preboot" will be checked
862 immediately before starting the CONFIG_BOOTDELAY
863 countdown and/or running the auto-boot command resp.
864 entering interactive mode.
865
866 This feature is especially useful when "preboot" is
867 automatically generated or modified. For an example
868 see the LWMON board specific code: here "preboot" is
869 modified when the user holds down a certain
870 combination of keys on the (special) keyboard when
871 booting the systems
872
873- Serial Download Echo Mode:
874 CONFIG_LOADS_ECHO
875 If defined to 1, all characters received during a
876 serial download (using the "loads" command) are
877 echoed back. This might be needed by some terminal
878 emulations (like "cu"), but may as well just take
879 time on others. This setting #define's the initial
880 value of the "loads_echo" environment variable.
881
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000883 CONFIG_KGDB_BAUDRATE
884 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200885 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000886
887- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500888 Monitor commands can be included or excluded
889 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000890 <config_cmd_all.h> and #undef'ing unwanted
891 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 and augmenting with additional #define's
893 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000894
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500895 The default command configuration includes all commands
896 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000897
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500898 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500899 CONFIG_CMD_BDI bdinfo
900 CONFIG_CMD_BEDBUG * Include BedBug Debugger
901 CONFIG_CMD_BMP * BMP support
902 CONFIG_CMD_BSP * Board specific commands
903 CONFIG_CMD_BOOTD bootd
904 CONFIG_CMD_CACHE * icache, dcache
905 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500906 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500907 CONFIG_CMD_DATE * support for RTC, date/time...
908 CONFIG_CMD_DHCP * DHCP support
909 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600910 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
911 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
912 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
913 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500914 CONFIG_CMD_DTT * Digital Therm and Thermostat
915 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500916 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500917 CONFIG_CMD_EEPROM * EEPROM read/write support
918 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600919 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600920 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500921 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500922 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000923 CONFIG_CMD_EXT2 * ext2 command support
924 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500925 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500926 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000927 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500928 CONFIG_CMD_FDOS * Dos diskette Support
929 CONFIG_CMD_FLASH flinfo, erase, protect
930 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200931 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000932 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500933 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000934 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000935 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500936 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
937 CONFIG_CMD_I2C * I2C serial bus support
938 CONFIG_CMD_IDE * IDE harddisk support
939 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000940 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200941 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500942 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500943 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000944 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 CONFIG_CMD_IRQ * irqinfo
946 CONFIG_CMD_ITEST Integer/string test of 2 values
947 CONFIG_CMD_JFFS2 * JFFS2 Support
948 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200949 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000950 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
951 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952 CONFIG_CMD_LOADB loadb
953 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200954 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400955 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000956 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500957 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000958 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200959 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500960 CONFIG_CMD_MISC Misc functions like sleep etc
961 CONFIG_CMD_MMC * MMC memory mapped support
962 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100963 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500964 CONFIG_CMD_NAND * NAND support
965 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200966 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600967 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000968 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500969 CONFIG_CMD_PCI * pciinfo
970 CONFIG_CMD_PCMCIA * PCMCIA support
971 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
972 host
973 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000974 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500975 CONFIG_CMD_REGINFO * Register dump
976 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000977 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500978 CONFIG_CMD_SAVES * save S record dump
979 CONFIG_CMD_SCSI * SCSI Support
980 CONFIG_CMD_SDRAM * print SDRAM configuration information
981 (requires CONFIG_CMD_I2C)
982 CONFIG_CMD_SETGETDCR Support for DCR Register access
983 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700984 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200985 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400986 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800987 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200988 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000990 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000991 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000992 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
993 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500994 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500995 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000996 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200997 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000998
wdenkc6097192002-11-03 00:24:07 +0000999
1000 EXAMPLE: If you want all functions except of network
1001 support you can write:
1002
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001003 #include "config_cmd_all.h"
1004 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001005
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001006 Other Commands:
1007 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001008
1009 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001010 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001011 what you (and your U-Boot users) are doing. Data
1012 cache cannot be enabled on systems like the 8xx or
1013 8260 (where accesses to the IMMR region must be
1014 uncached), and it cannot be disabled on all other
1015 systems where we (mis-) use the data cache to hold an
1016 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001017
1018
1019 XXX - this list needs to get updated!
1020
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001021- Regular expression support:
1022 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001023 If this variable is defined, U-Boot is linked against
1024 the SLRE (Super Light Regular Expression) library,
1025 which adds regex support to some commands, as for
1026 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001027
Simon Glass45ba8072011-10-15 05:48:20 +00001028- Device tree:
1029 CONFIG_OF_CONTROL
1030 If this variable is defined, U-Boot will use a device tree
1031 to configure its devices, instead of relying on statically
1032 compiled #defines in the board file. This option is
1033 experimental and only available on a few boards. The device
1034 tree is available in the global data as gd->fdt_blob.
1035
Simon Glass2c0f79e2011-10-24 19:15:31 +00001036 U-Boot needs to get its device tree from somewhere. This can
1037 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001038
1039 CONFIG_OF_EMBED
1040 If this variable is defined, U-Boot will embed a device tree
1041 binary in its image. This device tree file should be in the
1042 board directory and called <soc>-<board>.dts. The binary file
1043 is then picked up in board_init_f() and made available through
1044 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001045
Simon Glass2c0f79e2011-10-24 19:15:31 +00001046 CONFIG_OF_SEPARATE
1047 If this variable is defined, U-Boot will build a device tree
1048 binary. It will be called u-boot.dtb. Architecture-specific
1049 code will locate it at run-time. Generally this works by:
1050
1051 cat u-boot.bin u-boot.dtb >image.bin
1052
1053 and in fact, U-Boot does this for you, creating a file called
1054 u-boot-dtb.bin which is useful in the common case. You can
1055 still use the individual files if you need something more
1056 exotic.
1057
wdenkc6097192002-11-03 00:24:07 +00001058- Watchdog:
1059 CONFIG_WATCHDOG
1060 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001061 support for the SoC. There must be support in the SoC
1062 specific code for a watchdog. For the 8xx and 8260
1063 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1064 register. When supported for a specific SoC is
1065 available, then no further board specific code should
1066 be needed to use it.
1067
1068 CONFIG_HW_WATCHDOG
1069 When using a watchdog circuitry external to the used
1070 SoC, then define this variable and provide board
1071 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001072
stroesec1551ea2003-04-04 15:53:41 +00001073- U-Boot Version:
1074 CONFIG_VERSION_VARIABLE
1075 If this variable is defined, an environment variable
1076 named "ver" is created by U-Boot showing the U-Boot
1077 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001078 Any change to this variable will be reverted at the
1079 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001080
wdenkc6097192002-11-03 00:24:07 +00001081- Real-Time Clock:
1082
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001083 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001084 has to be selected, too. Define exactly one of the
1085 following options:
1086
1087 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1088 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001089 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001090 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001091 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001092 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001093 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001094 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001095 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001096 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001097 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001098 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1099 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001100
wdenkb37c7e52003-06-30 16:24:52 +00001101 Note that if the RTC uses I2C, then the I2C interface
1102 must also be configured. See I2C Support, below.
1103
Peter Tysere92739d2008-12-17 16:36:21 -06001104- GPIO Support:
1105 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001106
Chris Packham5dec49c2010-12-19 10:12:13 +00001107 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1108 chip-ngpio pairs that tell the PCA953X driver the number of
1109 pins supported by a particular chip.
1110
Peter Tysere92739d2008-12-17 16:36:21 -06001111 Note that if the GPIO device uses I2C, then the I2C interface
1112 must also be configured. See I2C Support, below.
1113
wdenkc6097192002-11-03 00:24:07 +00001114- Timestamp Support:
1115
wdenk43d96162003-03-06 00:02:04 +00001116 When CONFIG_TIMESTAMP is selected, the timestamp
1117 (date and time) of an image is printed by image
1118 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001119 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001120
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001121- Partition Labels (disklabels) Supported:
1122 Zero or more of the following:
1123 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1124 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1125 Intel architecture, USB sticks, etc.
1126 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1127 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1128 bootloader. Note 2TB partition limit; see
1129 disk/part_efi.c
1130 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001131
Wolfgang Denk218ca722008-03-26 10:40:12 +01001132 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1133 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001134 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001135
1136- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001137 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1138 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001139
wdenk4d13cba2004-03-14 14:09:05 +00001140 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1141 be performed by calling the function
1142 ide_set_reset(int reset)
1143 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001144
1145- ATAPI Support:
1146 CONFIG_ATAPI
1147
1148 Set this to enable ATAPI support.
1149
wdenkc40b2952004-03-13 23:29:43 +00001150- LBA48 Support
1151 CONFIG_LBA48
1152
1153 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001154 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001155 Whithout these , LBA48 support uses 32bit variables and will 'only'
1156 support disks up to 2.1TB.
1157
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001158 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001159 When enabled, makes the IDE subsystem use 64bit sector addresses.
1160 Default is 32bit.
1161
wdenkc6097192002-11-03 00:24:07 +00001162- SCSI Support:
1163 At the moment only there is only support for the
1164 SYM53C8XX SCSI controller; define
1165 CONFIG_SCSI_SYM53C8XX to enable it.
1166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001167 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1168 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1169 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001170 maximum numbers of LUNs, SCSI ID's and target
1171 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001172 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001173
Wolfgang Denk93e14592013-10-04 17:43:24 +02001174 The environment variable 'scsidevs' is set to the number of
1175 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001176
wdenkc6097192002-11-03 00:24:07 +00001177- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001178 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001179 Support for Intel 8254x/8257x gigabit chips.
1180
1181 CONFIG_E1000_SPI
1182 Utility code for direct access to the SPI bus on Intel 8257x.
1183 This does not do anything useful unless you set at least one
1184 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1185
1186 CONFIG_E1000_SPI_GENERIC
1187 Allow generic access to the SPI bus on the Intel 8257x, for
1188 example with the "sspi" command.
1189
1190 CONFIG_CMD_E1000
1191 Management command for E1000 devices. When used on devices
1192 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001193
Andre Schwarzac3315c2008-03-06 16:45:44 +01001194 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001195 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001196
wdenkc6097192002-11-03 00:24:07 +00001197 CONFIG_EEPRO100
1198 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001199 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001200 write routine for first time initialisation.
1201
1202 CONFIG_TULIP
1203 Support for Digital 2114x chips.
1204 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1205 modem chip initialisation (KS8761/QS6611).
1206
1207 CONFIG_NATSEMI
1208 Support for National dp83815 chips.
1209
1210 CONFIG_NS8382X
1211 Support for National dp8382[01] gigabit chips.
1212
wdenk45219c42003-05-12 21:50:16 +00001213- NETWORK Support (other):
1214
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001215 CONFIG_DRIVER_AT91EMAC
1216 Support for AT91RM9200 EMAC.
1217
1218 CONFIG_RMII
1219 Define this to use reduced MII inteface
1220
1221 CONFIG_DRIVER_AT91EMAC_QUIET
1222 If this defined, the driver is quiet.
1223 The driver doen't show link status messages.
1224
Rob Herringefdd7312011-12-15 11:15:49 +00001225 CONFIG_CALXEDA_XGMAC
1226 Support for the Calxeda XGMAC device
1227
Ashok3bb46d22012-10-15 06:20:47 +00001228 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001229 Support for SMSC's LAN91C96 chips.
1230
1231 CONFIG_LAN91C96_BASE
1232 Define this to hold the physical address
1233 of the LAN91C96's I/O space
1234
1235 CONFIG_LAN91C96_USE_32_BIT
1236 Define this to enable 32 bit addressing
1237
Ashok3bb46d22012-10-15 06:20:47 +00001238 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001239 Support for SMSC's LAN91C111 chip
1240
1241 CONFIG_SMC91111_BASE
1242 Define this to hold the physical address
1243 of the device (I/O space)
1244
1245 CONFIG_SMC_USE_32_BIT
1246 Define this if data bus is 32 bits
1247
1248 CONFIG_SMC_USE_IOFUNCS
1249 Define this to use i/o functions instead of macros
1250 (some hardware wont work with macros)
1251
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001252 CONFIG_DRIVER_TI_EMAC
1253 Support for davinci emac
1254
1255 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1256 Define this if you have more then 3 PHYs.
1257
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001258 CONFIG_FTGMAC100
1259 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1260
1261 CONFIG_FTGMAC100_EGIGA
1262 Define this to use GE link update with gigabit PHY.
1263 Define this if FTGMAC100 is connected to gigabit PHY.
1264 If your system has 10/100 PHY only, it might not occur
1265 wrong behavior. Because PHY usually return timeout or
1266 useless data when polling gigabit status and gigabit
1267 control registers. This behavior won't affect the
1268 correctnessof 10/100 link speed update.
1269
Mike Rapoportc2fff332009-11-11 10:03:03 +02001270 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001271 Support for SMSC's LAN911x and LAN921x chips
1272
Mike Rapoportc2fff332009-11-11 10:03:03 +02001273 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001274 Define this to hold the physical address
1275 of the device (I/O space)
1276
Mike Rapoportc2fff332009-11-11 10:03:03 +02001277 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001278 Define this if data bus is 32 bits
1279
Mike Rapoportc2fff332009-11-11 10:03:03 +02001280 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001281 Define this if data bus is 16 bits. If your processor
1282 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001283 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001284
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001285 CONFIG_SH_ETHER
1286 Support for Renesas on-chip Ethernet controller
1287
1288 CONFIG_SH_ETHER_USE_PORT
1289 Define the number of ports to be used
1290
1291 CONFIG_SH_ETHER_PHY_ADDR
1292 Define the ETH PHY's address
1293
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001294 CONFIG_SH_ETHER_CACHE_WRITEBACK
1295 If this option is set, the driver enables cache flush.
1296
Vadim Bendebury5e124722011-10-17 08:36:14 +00001297- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001298 CONFIG_TPM
1299 Support TPM devices.
1300
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001301 CONFIG_TPM_TIS_I2C
1302 Support for i2c bus TPM devices. Only one device
1303 per system is supported at this time.
1304
1305 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1306 Define the the i2c bus number for the TPM device
1307
1308 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1309 Define the TPM's address on the i2c bus
1310
1311 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1312 Define the burst count bytes upper limit
1313
Dirk Eibachc01939c2013-06-26 15:55:15 +02001314 CONFIG_TPM_ATMEL_TWI
1315 Support for Atmel TWI TPM device. Requires I2C support.
1316
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001317 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001318 Support for generic parallel port TPM devices. Only one device
1319 per system is supported at this time.
1320
1321 CONFIG_TPM_TIS_BASE_ADDRESS
1322 Base address where the generic TPM device is mapped
1323 to. Contemporary x86 systems usually map it at
1324 0xfed40000.
1325
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001326 CONFIG_CMD_TPM
1327 Add tpm monitor functions.
1328 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1329 provides monitor access to authorized functions.
1330
1331 CONFIG_TPM
1332 Define this to enable the TPM support library which provides
1333 functional interfaces to some TPM commands.
1334 Requires support for a TPM device.
1335
1336 CONFIG_TPM_AUTH_SESSIONS
1337 Define this to enable authorized functions in the TPM library.
1338 Requires CONFIG_TPM and CONFIG_SHA1.
1339
wdenkc6097192002-11-03 00:24:07 +00001340- USB Support:
1341 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001342 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001343 CONFIG_USB_UHCI to enable it.
1344 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001345 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001346 storage devices.
1347 Note:
1348 Supported are USB Keyboards and USB Floppy drives
1349 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001350 MPC5200 USB requires additional defines:
1351 CONFIG_USB_CLOCK
1352 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001353 CONFIG_PSC3_USB
1354 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001355 CONFIG_USB_CONFIG
1356 for differential drivers: 0x00001000
1357 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001358 for differential drivers on PSC3: 0x00000100
1359 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001360 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001361 May be defined to allow interrupt polling
1362 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001363
Simon Glass9ab4ce22012-02-27 10:52:47 +00001364 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1365 txfilltuning field in the EHCI controller on reset.
1366
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001367 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1368 interval for usb hub power-on delay.(minimum 100msec)
1369
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001370- USB Device:
1371 Define the below if you wish to use the USB console.
1372 Once firmware is rebuilt from a serial console issue the
1373 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001374 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001375 it has found a new device. The environment variable usbtty
1376 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001377 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001378 Common Device Class Abstract Control Model serial device.
1379 If you select usbtty = gserial you should be able to enumerate
1380 a Linux host by
1381 # modprobe usbserial vendor=0xVendorID product=0xProductID
1382 else if using cdc_acm, simply setting the environment
1383 variable usbtty to be cdc_acm should suffice. The following
1384 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001385
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001386 CONFIG_USB_DEVICE
1387 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001388
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001389 CONFIG_USB_TTY
1390 Define this to have a tty type of device available to
1391 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001392
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301393 CONFIG_USBD_HS
1394 Define this to enable the high speed support for usb
1395 device and usbtty. If this feature is enabled, a routine
1396 int is_usbd_high_speed(void)
1397 also needs to be defined by the driver to dynamically poll
1398 whether the enumeration has succeded at high speed or full
1399 speed.
1400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001401 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001402 Define this if you want stdin, stdout &/or stderr to
1403 be set to usbtty.
1404
1405 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001406 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001407 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001408 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001410 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001411 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001412 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001413
Wolfgang Denk386eda02006-06-14 18:14:56 +02001414 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001415 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001416 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001417 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1418 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1419 should pretend to be a Linux device to it's target host.
1420
1421 CONFIG_USBD_MANUFACTURER
1422 Define this string as the name of your company for
1423 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001424
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001425 CONFIG_USBD_PRODUCT_NAME
1426 Define this string as the name of your product
1427 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1428
1429 CONFIG_USBD_VENDORID
1430 Define this as your assigned Vendor ID from the USB
1431 Implementors Forum. This *must* be a genuine Vendor ID
1432 to avoid polluting the USB namespace.
1433 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001434
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001435 CONFIG_USBD_PRODUCTID
1436 Define this as the unique Product ID
1437 for your device
1438 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001439
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001440 Some USB device drivers may need to check USB cable attachment.
1441 In this case you can enable following config in BoardName.h:
1442 CONFIG_USB_CABLE_CHECK
1443 This enables function definition:
1444 - usb_cable_connected() in include/usb.h
1445 Implementation of this function is board-specific.
1446
Igor Grinbergd70a5602011-12-12 12:08:35 +02001447- ULPI Layer Support:
1448 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1449 the generic ULPI layer. The generic layer accesses the ULPI PHY
1450 via the platform viewport, so you need both the genric layer and
1451 the viewport enabled. Currently only Chipidea/ARC based
1452 viewport is supported.
1453 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1454 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001455 If your ULPI phy needs a different reference clock than the
1456 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1457 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001458
1459- MMC Support:
1460 The MMC controller on the Intel PXA is supported. To
1461 enable this define CONFIG_MMC. The MMC can be
1462 accessed from the boot prompt by mapping the device
1463 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001464 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1465 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001466
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001467 CONFIG_SH_MMCIF
1468 Support for Renesas on-chip MMCIF controller
1469
1470 CONFIG_SH_MMCIF_ADDR
1471 Define the base address of MMCIF registers
1472
1473 CONFIG_SH_MMCIF_CLK
1474 Define the clock frequency for MMCIF
1475
Tom Rinib3ba6e92013-03-14 05:32:47 +00001476- USB Device Firmware Update (DFU) class support:
1477 CONFIG_DFU_FUNCTION
1478 This enables the USB portion of the DFU USB class
1479
1480 CONFIG_CMD_DFU
1481 This enables the command "dfu" which is used to have
1482 U-Boot create a DFU class device via USB. This command
1483 requires that the "dfu_alt_info" environment variable be
1484 set and define the alt settings to expose to the host.
1485
1486 CONFIG_DFU_MMC
1487 This enables support for exposing (e)MMC devices via DFU.
1488
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001489 CONFIG_DFU_NAND
1490 This enables support for exposing NAND devices via DFU.
1491
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301492 CONFIG_DFU_RAM
1493 This enables support for exposing RAM via DFU.
1494 Note: DFU spec refer to non-volatile memory usage, but
1495 allow usages beyond the scope of spec - here RAM usage,
1496 one that would help mostly the developer.
1497
Heiko Schochere7e75c72013-06-12 06:05:51 +02001498 CONFIG_SYS_DFU_DATA_BUF_SIZE
1499 Dfu transfer uses a buffer before writing data to the
1500 raw storage device. Make the size (in bytes) of this buffer
1501 configurable. The size of this buffer is also configurable
1502 through the "dfu_bufsiz" environment variable.
1503
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001504 CONFIG_SYS_DFU_MAX_FILE_SIZE
1505 When updating files rather than the raw storage device,
1506 we use a static buffer to copy the file into and then write
1507 the buffer once we've been given the whole file. Define
1508 this to the maximum filesize (in bytes) for the buffer.
1509 Default is 4 MiB if undefined.
1510
wdenk6705d812004-08-02 23:22:59 +00001511- Journaling Flash filesystem support:
1512 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1513 CONFIG_JFFS2_NAND_DEV
1514 Define these for a default partition on a NAND device
1515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001516 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1517 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001518 Define these for a default partition on a NOR device
1519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001520 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001521 Define this to create an own partition. You have to provide a
1522 function struct part_info* jffs2_part_info(int part_num)
1523
1524 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001525 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001526 to disable the command chpart. This is the default when you
1527 have not defined a custom partition
1528
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001529- FAT(File Allocation Table) filesystem write function support:
1530 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001531
1532 Define this to enable support for saving memory data as a
1533 file in FAT formatted partition.
1534
1535 This will also enable the command "fatwrite" enabling the
1536 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001537
Gabe Black84cd9322012-10-12 14:26:11 +00001538CBFS (Coreboot Filesystem) support
1539 CONFIG_CMD_CBFS
1540
1541 Define this to enable support for reading from a Coreboot
1542 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1543 and cbfsload.
1544
wdenkc6097192002-11-03 00:24:07 +00001545- Keyboard Support:
1546 CONFIG_ISA_KEYBOARD
1547
1548 Define this to enable standard (PC-Style) keyboard
1549 support
1550
1551 CONFIG_I8042_KBD
1552 Standard PC keyboard driver with US (is default) and
1553 GERMAN key layout (switch via environment 'keymap=de') support.
1554 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1555 for cfb_console. Supports cursor blinking.
1556
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001557 CONFIG_CROS_EC_KEYB
1558 Enables a Chrome OS keyboard using the CROS_EC interface.
1559 This uses CROS_EC to communicate with a second microcontroller
1560 which provides key scans on request.
1561
wdenkc6097192002-11-03 00:24:07 +00001562- Video support:
1563 CONFIG_VIDEO
1564
1565 Define this to enable video support (for output to
1566 video).
1567
1568 CONFIG_VIDEO_CT69000
1569
1570 Enable Chips & Technologies 69000 Video chip
1571
1572 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001573 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001574 video output is selected via environment 'videoout'
1575 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1576 assumed.
wdenkc6097192002-11-03 00:24:07 +00001577
wdenkb79a11c2004-03-25 15:14:43 +00001578 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001579 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001580 are possible:
1581 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001582 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001583
1584 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1585 -------------+---------------------------------------------
1586 8 bits | 0x301* 0x303 0x305 0x161 0x307
1587 15 bits | 0x310 0x313 0x316 0x162 0x319
1588 16 bits | 0x311 0x314 0x317 0x163 0x31A
1589 24 bits | 0x312 0x315 0x318 ? 0x31B
1590 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001591 (i.e. setenv videomode 317; saveenv; reset;)
1592
wdenkb79a11c2004-03-25 15:14:43 +00001593 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001594 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001595
1596
stroesec1551ea2003-04-04 15:53:41 +00001597 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001598 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001599 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1600 or CONFIG_VIDEO_SED13806_16BPP
1601
Timur Tabi7d3053f2011-02-15 17:09:19 -06001602 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001603 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001604 SOCs that have a DIU should define this macro to enable DIU
1605 support, and should also define these other macros:
1606
1607 CONFIG_SYS_DIU_ADDR
1608 CONFIG_VIDEO
1609 CONFIG_CMD_BMP
1610 CONFIG_CFB_CONSOLE
1611 CONFIG_VIDEO_SW_CURSOR
1612 CONFIG_VGA_AS_SINGLE_DEVICE
1613 CONFIG_VIDEO_LOGO
1614 CONFIG_VIDEO_BMP_LOGO
1615
Timur Tabiba8e76b2011-04-11 14:18:22 -05001616 The DIU driver will look for the 'video-mode' environment
1617 variable, and if defined, enable the DIU as a console during
1618 boot. See the documentation file README.video for a
1619 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001620
Simon Glass058d59b2012-12-03 13:59:47 +00001621 CONFIG_VIDEO_VGA
1622
1623 Enable the VGA video / BIOS for x86. The alternative if you
1624 are using coreboot is to use the coreboot frame buffer
1625 driver.
1626
1627
wdenk682011f2003-06-03 23:54:09 +00001628- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001629 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001630
wdenk8bde7f72003-06-27 21:31:46 +00001631 Define this to enable a custom keyboard support.
1632 This simply calls drv_keyboard_init() which must be
1633 defined in your board-specific files.
1634 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001635
wdenkc6097192002-11-03 00:24:07 +00001636- LCD Support: CONFIG_LCD
1637
1638 Define this to enable LCD support (for output to LCD
1639 display); also select one of the supported displays
1640 by defining one of these:
1641
Stelian Pop39cf4802008-05-09 21:57:18 +02001642 CONFIG_ATMEL_LCD:
1643
1644 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1645
wdenkfd3103b2003-11-25 16:55:19 +00001646 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001647
wdenkfd3103b2003-11-25 16:55:19 +00001648 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001649
wdenkfd3103b2003-11-25 16:55:19 +00001650 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001651
wdenkfd3103b2003-11-25 16:55:19 +00001652 NEC NL6448BC20-08. 6.5", 640x480.
1653 Active, color, single scan.
1654
1655 CONFIG_NEC_NL6448BC33_54
1656
1657 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001658 Active, color, single scan.
1659
1660 CONFIG_SHARP_16x9
1661
1662 Sharp 320x240. Active, color, single scan.
1663 It isn't 16x9, and I am not sure what it is.
1664
1665 CONFIG_SHARP_LQ64D341
1666
1667 Sharp LQ64D341 display, 640x480.
1668 Active, color, single scan.
1669
1670 CONFIG_HLD1045
1671
1672 HLD1045 display, 640x480.
1673 Active, color, single scan.
1674
1675 CONFIG_OPTREX_BW
1676
1677 Optrex CBL50840-2 NF-FW 99 22 M5
1678 or
1679 Hitachi LMG6912RPFC-00T
1680 or
1681 Hitachi SP14Q002
1682
1683 320x240. Black & white.
1684
1685 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001686 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001687
Simon Glass676d3192012-10-17 13:24:54 +00001688 CONFIG_LCD_ALIGNMENT
1689
1690 Normally the LCD is page-aligned (tyically 4KB). If this is
1691 defined then the LCD will be aligned to this value instead.
1692 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1693 here, since it is cheaper to change data cache settings on
1694 a per-section basis.
1695
Simon Glass0d89efe2012-10-17 13:24:59 +00001696 CONFIG_CONSOLE_SCROLL_LINES
1697
1698 When the console need to be scrolled, this is the number of
1699 lines to scroll by. It defaults to 1. Increasing this makes
1700 the console jump but can help speed up operation when scrolling
1701 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001702
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001703 CONFIG_LCD_BMP_RLE8
1704
1705 Support drawing of RLE8-compressed bitmaps on the LCD.
1706
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001707 CONFIG_I2C_EDID
1708
1709 Enables an 'i2c edid' command which can read EDID
1710 information over I2C from an attached LCD display.
1711
wdenk7152b1d2003-09-05 23:19:14 +00001712- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001713
wdenk8bde7f72003-06-27 21:31:46 +00001714 If this option is set, the environment is checked for
1715 a variable "splashimage". If found, the usual display
1716 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001717 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001718 specified in "splashimage" is loaded instead. The
1719 console is redirected to the "nulldev", too. This
1720 allows for a "silent" boot where a splash screen is
1721 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001722
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001723 CONFIG_SPLASHIMAGE_GUARD
1724
1725 If this option is set, then U-Boot will prevent the environment
1726 variable "splashimage" from being set to a problematic address
1727 (see README.displaying-bmps and README.arm-unaligned-accesses).
1728 This option is useful for targets where, due to alignment
1729 restrictions, an improperly aligned BMP image will cause a data
1730 abort. If you think you will not have problems with unaligned
1731 accesses (for example because your toolchain prevents them)
1732 there is no need to set this option.
1733
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001734 CONFIG_SPLASH_SCREEN_ALIGN
1735
1736 If this option is set the splash image can be freely positioned
1737 on the screen. Environment variable "splashpos" specifies the
1738 position as "x,y". If a positive number is given it is used as
1739 number of pixel from left/top. If a negative number is given it
1740 is used as number of pixel from right/bottom. You can also
1741 specify 'm' for centering the image.
1742
1743 Example:
1744 setenv splashpos m,m
1745 => image at center of screen
1746
1747 setenv splashpos 30,20
1748 => image at x = 30 and y = 20
1749
1750 setenv splashpos -10,m
1751 => vertically centered image
1752 at x = dspWidth - bmpWidth - 9
1753
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001754- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1755
1756 If this option is set, additionally to standard BMP
1757 images, gzipped BMP images can be displayed via the
1758 splashscreen support or the bmp command.
1759
Anatolij Gustschind5011762010-03-15 14:50:25 +01001760- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1761
1762 If this option is set, 8-bit RLE compressed BMP images
1763 can be displayed via the splashscreen support or the
1764 bmp command.
1765
Lei Wenf2b96df2012-09-28 04:26:47 +00001766- Do compresssing for memory range:
1767 CONFIG_CMD_ZIP
1768
1769 If this option is set, it would use zlib deflate method
1770 to compress the specified memory at its best effort.
1771
wdenkc29fdfc2003-08-29 20:57:53 +00001772- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001773 CONFIG_GZIP
1774
1775 Enabled by default to support gzip compressed images.
1776
wdenkc29fdfc2003-08-29 20:57:53 +00001777 CONFIG_BZIP2
1778
1779 If this option is set, support for bzip2 compressed
1780 images is included. If not, only uncompressed and gzip
1781 compressed images are supported.
1782
wdenk42d1f032003-10-15 23:53:47 +00001783 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001784 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001785 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001786
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001787 CONFIG_LZMA
1788
1789 If this option is set, support for lzma compressed
1790 images is included.
1791
1792 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1793 requires an amount of dynamic memory that is given by the
1794 formula:
1795
1796 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1797
1798 Where lc and lp stand for, respectively, Literal context bits
1799 and Literal pos bits.
1800
1801 This value is upper-bounded by 14MB in the worst case. Anyway,
1802 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1803 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1804 a very small buffer.
1805
1806 Use the lzmainfo tool to determinate the lc and lp values and
1807 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001808 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001809
Kees Cook8ef70472013-08-16 07:59:12 -07001810 CONFIG_LZO
1811
1812 If this option is set, support for LZO compressed images
1813 is included.
1814
wdenk17ea1172004-06-06 21:51:03 +00001815- MII/PHY support:
1816 CONFIG_PHY_ADDR
1817
1818 The address of PHY on MII bus.
1819
1820 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1821
1822 The clock frequency of the MII bus
1823
1824 CONFIG_PHY_GIGE
1825
1826 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001827 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001828
1829 CONFIG_PHY_RESET_DELAY
1830
1831 Some PHY like Intel LXT971A need extra delay after
1832 reset before any MII register access is possible.
1833 For such PHY, set this option to the usec delay
1834 required. (minimum 300usec for LXT971A)
1835
1836 CONFIG_PHY_CMD_DELAY (ppc4xx)
1837
1838 Some PHY like Intel LXT971A need extra delay after
1839 command issued before MII status register can be read
1840
wdenkc6097192002-11-03 00:24:07 +00001841- Ethernet address:
1842 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001843 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001844 CONFIG_ETH2ADDR
1845 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001846 CONFIG_ETH4ADDR
1847 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001848
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001849 Define a default value for Ethernet address to use
1850 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001851 is not determined automatically.
1852
1853- IP address:
1854 CONFIG_IPADDR
1855
1856 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001857 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001858 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001859 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001860
1861- Server IP address:
1862 CONFIG_SERVERIP
1863
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001864 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001865 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001866 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001867
Robin Getz97cfe862009-07-21 12:15:28 -04001868 CONFIG_KEEP_SERVERADDR
1869
1870 Keeps the server's MAC address, in the env 'serveraddr'
1871 for passing to bootargs (like Linux's netconsole option)
1872
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001873- Gateway IP address:
1874 CONFIG_GATEWAYIP
1875
1876 Defines a default value for the IP address of the
1877 default router where packets to other networks are
1878 sent to.
1879 (Environment variable "gatewayip")
1880
1881- Subnet mask:
1882 CONFIG_NETMASK
1883
1884 Defines a default value for the subnet mask (or
1885 routing prefix) which is used to determine if an IP
1886 address belongs to the local subnet or needs to be
1887 forwarded through a router.
1888 (Environment variable "netmask")
1889
David Updegraff53a5c422007-06-11 10:41:07 -05001890- Multicast TFTP Mode:
1891 CONFIG_MCAST_TFTP
1892
1893 Defines whether you want to support multicast TFTP as per
1894 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001895 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001896 driver in use must provide a function: mcast() to join/leave a
1897 multicast group.
1898
wdenkc6097192002-11-03 00:24:07 +00001899- BOOTP Recovery Mode:
1900 CONFIG_BOOTP_RANDOM_DELAY
1901
1902 If you have many targets in a network that try to
1903 boot using BOOTP, you may want to avoid that all
1904 systems send out BOOTP requests at precisely the same
1905 moment (which would happen for instance at recovery
1906 from a power failure, when all systems will try to
1907 boot, thus flooding the BOOTP server. Defining
1908 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1909 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001910 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001911
1912 1st BOOTP request: delay 0 ... 1 sec
1913 2nd BOOTP request: delay 0 ... 2 sec
1914 3rd BOOTP request: delay 0 ... 4 sec
1915 4th and following
1916 BOOTP requests: delay 0 ... 8 sec
1917
stroesefe389a82003-08-28 14:17:32 +00001918- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001919 You can fine tune the DHCP functionality by defining
1920 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001921
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001922 CONFIG_BOOTP_SUBNETMASK
1923 CONFIG_BOOTP_GATEWAY
1924 CONFIG_BOOTP_HOSTNAME
1925 CONFIG_BOOTP_NISDOMAIN
1926 CONFIG_BOOTP_BOOTPATH
1927 CONFIG_BOOTP_BOOTFILESIZE
1928 CONFIG_BOOTP_DNS
1929 CONFIG_BOOTP_DNS2
1930 CONFIG_BOOTP_SEND_HOSTNAME
1931 CONFIG_BOOTP_NTPSERVER
1932 CONFIG_BOOTP_TIMEOFFSET
1933 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001934 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001935
Wilson Callan5d110f02007-07-28 10:56:13 -04001936 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1937 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001938
Joe Hershberger2c00e092012-05-23 07:59:19 +00001939 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1940 after the configured retry count, the call will fail
1941 instead of starting over. This can be used to fail over
1942 to Link-local IP address configuration if the DHCP server
1943 is not available.
1944
stroesefe389a82003-08-28 14:17:32 +00001945 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1946 serverip from a DHCP server, it is possible that more
1947 than one DNS serverip is offered to the client.
1948 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1949 serverip will be stored in the additional environment
1950 variable "dnsip2". The first DNS serverip is always
1951 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001952 is defined.
stroesefe389a82003-08-28 14:17:32 +00001953
1954 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1955 to do a dynamic update of a DNS server. To do this, they
1956 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001957 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001958 of the "hostname" environment variable is passed as
1959 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001960
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001961 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1962
1963 A 32bit value in microseconds for a delay between
1964 receiving a "DHCP Offer" and sending the "DHCP Request".
1965 This fixes a problem with certain DHCP servers that don't
1966 respond 100% of the time to a "DHCP request". E.g. On an
1967 AT91RM9200 processor running at 180MHz, this delay needed
1968 to be *at least* 15,000 usec before a Windows Server 2003
1969 DHCP server would reply 100% of the time. I recommend at
1970 least 50,000 usec to be safe. The alternative is to hope
1971 that one of the retries will be successful but note that
1972 the DHCP timeout and retry process takes a longer than
1973 this delay.
1974
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001975 - Link-local IP address negotiation:
1976 Negotiate with other link-local clients on the local network
1977 for an address that doesn't require explicit configuration.
1978 This is especially useful if a DHCP server cannot be guaranteed
1979 to exist in all environments that the device must operate.
1980
1981 See doc/README.link-local for more information.
1982
wdenka3d991b2004-04-15 21:48:45 +00001983 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001984 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001985
1986 The device id used in CDP trigger frames.
1987
1988 CONFIG_CDP_DEVICE_ID_PREFIX
1989
1990 A two character string which is prefixed to the MAC address
1991 of the device.
1992
1993 CONFIG_CDP_PORT_ID
1994
1995 A printf format string which contains the ascii name of
1996 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001997 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001998
1999 CONFIG_CDP_CAPABILITIES
2000
2001 A 32bit integer which indicates the device capabilities;
2002 0x00000010 for a normal host which does not forwards.
2003
2004 CONFIG_CDP_VERSION
2005
2006 An ascii string containing the version of the software.
2007
2008 CONFIG_CDP_PLATFORM
2009
2010 An ascii string containing the name of the platform.
2011
2012 CONFIG_CDP_TRIGGER
2013
2014 A 32bit integer sent on the trigger.
2015
2016 CONFIG_CDP_POWER_CONSUMPTION
2017
2018 A 16bit integer containing the power consumption of the
2019 device in .1 of milliwatts.
2020
2021 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2022
2023 A byte containing the id of the VLAN.
2024
wdenkc6097192002-11-03 00:24:07 +00002025- Status LED: CONFIG_STATUS_LED
2026
2027 Several configurations allow to display the current
2028 status using a LED. For instance, the LED will blink
2029 fast while running U-Boot code, stop blinking as
2030 soon as a reply to a BOOTP request was received, and
2031 start blinking slow once the Linux kernel is running
2032 (supported by a status LED driver in the Linux
2033 kernel). Defining CONFIG_STATUS_LED enables this
2034 feature in U-Boot.
2035
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002036 Additional options:
2037
2038 CONFIG_GPIO_LED
2039 The status LED can be connected to a GPIO pin.
2040 In such cases, the gpio_led driver can be used as a
2041 status LED backend implementation. Define CONFIG_GPIO_LED
2042 to include the gpio_led driver in the U-Boot binary.
2043
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002044 CONFIG_GPIO_LED_INVERTED_TABLE
2045 Some GPIO connected LEDs may have inverted polarity in which
2046 case the GPIO high value corresponds to LED off state and
2047 GPIO low value corresponds to LED on state.
2048 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2049 with a list of GPIO LEDs that have inverted polarity.
2050
wdenkc6097192002-11-03 00:24:07 +00002051- CAN Support: CONFIG_CAN_DRIVER
2052
2053 Defining CONFIG_CAN_DRIVER enables CAN driver support
2054 on those systems that support this (optional)
2055 feature, like the TQM8xxL modules.
2056
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002057- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002058
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002059 This enable the NEW i2c subsystem, and will allow you to use
2060 i2c commands at the u-boot command line (as long as you set
2061 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2062 based realtime clock chips or other i2c devices. See
2063 common/cmd_i2c.c for a description of the command line
2064 interface.
2065
2066 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002067 - drivers/i2c/soft_i2c.c:
2068 - activate first bus with CONFIG_SYS_I2C_SOFT define
2069 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2070 for defining speed and slave address
2071 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2072 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2073 for defining speed and slave address
2074 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2075 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2076 for defining speed and slave address
2077 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2078 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2079 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002080
Heiko Schocher00f792e2012-10-24 13:48:22 +02002081 - drivers/i2c/fsl_i2c.c:
2082 - activate i2c driver with CONFIG_SYS_I2C_FSL
2083 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2084 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2085 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2086 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002087 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002088 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2089 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2090 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2091 second bus.
2092
Simon Glass1f2ba722012-10-30 07:28:53 +00002093 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002094 - activate this driver with CONFIG_SYS_I2C_TEGRA
2095 - This driver adds 4 i2c buses with a fix speed from
2096 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002097
Dirk Eibach880540d2013-04-25 02:40:01 +00002098 - drivers/i2c/ppc4xx_i2c.c
2099 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2100 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2101 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2102
tremfac96402013-09-21 18:13:35 +02002103 - drivers/i2c/i2c_mxc.c
2104 - activate this driver with CONFIG_SYS_I2C_MXC
2105 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2106 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2107 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2108 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2109 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2110 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2111 If thoses defines are not set, default value is 100000
2112 for speed, and 0 for slave.
2113
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002114 - drivers/i2c/rcar_i2c.c:
2115 - activate this driver with CONFIG_SYS_I2C_RCAR
2116 - This driver adds 4 i2c buses
2117
2118 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2119 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2120 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2121 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2122 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2123 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2124 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2125 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2126 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2127
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002128 - drivers/i2c/sh_i2c.c:
2129 - activate this driver with CONFIG_SYS_I2C_SH
2130 - This driver adds from 2 to 5 i2c buses
2131
2132 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2133 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2134 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2135 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2136 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2137 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2138 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2139 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2140 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2141 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2142 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2143 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2144 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2145
Heiko Schocher6789e842013-10-22 11:03:18 +02002146 - drivers/i2c/omap24xx_i2c.c
2147 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2148 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2149 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2150 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2151 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2152 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2153 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2154 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2155 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2156 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2157 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2158
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002159 - drivers/i2c/zynq_i2c.c
2160 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2161 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2162 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2163
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302164 - drivers/i2c/s3c24x0_i2c.c:
2165 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2166 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2167 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2168 with a fix speed from 100000 and the slave addr 0!
2169
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002170 additional defines:
2171
2172 CONFIG_SYS_NUM_I2C_BUSES
2173 Hold the number of i2c busses you want to use. If you
2174 don't use/have i2c muxes on your i2c bus, this
2175 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2176 omit this define.
2177
2178 CONFIG_SYS_I2C_DIRECT_BUS
2179 define this, if you don't use i2c muxes on your hardware.
2180 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2181 omit this define.
2182
2183 CONFIG_SYS_I2C_MAX_HOPS
2184 define how many muxes are maximal consecutively connected
2185 on one i2c bus. If you not use i2c muxes, omit this
2186 define.
2187
2188 CONFIG_SYS_I2C_BUSES
2189 hold a list of busses you want to use, only used if
2190 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2191 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2192 CONFIG_SYS_NUM_I2C_BUSES = 9:
2193
2194 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2195 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2196 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2197 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2198 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2199 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2200 {1, {I2C_NULL_HOP}}, \
2201 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2202 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2203 }
2204
2205 which defines
2206 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002207 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2208 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2209 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2210 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2211 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002212 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002213 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2214 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002215
2216 If you do not have i2c muxes on your board, omit this define.
2217
Heiko Schocherea818db2013-01-29 08:53:15 +01002218- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002219
2220 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2221 provides the following compelling advantages:
2222
2223 - more than one i2c adapter is usable
2224 - approved multibus support
2225 - better i2c mux support
2226
2227 ** Please consider updating your I2C driver now. **
2228
Heiko Schocherea818db2013-01-29 08:53:15 +01002229 These enable legacy I2C serial bus commands. Defining
2230 CONFIG_HARD_I2C will include the appropriate I2C driver
2231 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002232
wdenk945af8d2003-07-16 21:53:01 +00002233 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002234 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002235 CONFIG_COMMANDS) and communicate with i2c based realtime
2236 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002237 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002238
Ben Warrenbb99ad62006-09-07 16:50:54 -04002239 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002240
wdenk945af8d2003-07-16 21:53:01 +00002241 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002242 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002244 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002245 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002246 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002247 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002248
Peter Tyser8d321b82010-04-12 22:28:21 -05002249 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002250 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002251 and so its address should therefore be cleared to 0 (See,
2252 eg, MPC823e User's Manual p.16-473). So, set
2253 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002254
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002255 CONFIG_SYS_I2C_INIT_MPC5XXX
2256
2257 When a board is reset during an i2c bus transfer
2258 chips might think that the current transfer is still
2259 in progress. Reset the slave devices by sending start
2260 commands until the slave device responds.
2261
wdenk945af8d2003-07-16 21:53:01 +00002262 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002263
Heiko Schocherea818db2013-01-29 08:53:15 +01002264 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002265 then the following macros need to be defined (examples are
2266 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002267
2268 I2C_INIT
2269
wdenkb37c7e52003-06-30 16:24:52 +00002270 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002271 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002272
wdenkba56f622004-02-06 23:19:44 +00002273 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002274
wdenkc6097192002-11-03 00:24:07 +00002275 I2C_PORT
2276
wdenk43d96162003-03-06 00:02:04 +00002277 (Only for MPC8260 CPU). The I/O port to use (the code
2278 assumes both bits are on the same port). Valid values
2279 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002280
2281 I2C_ACTIVE
2282
2283 The code necessary to make the I2C data line active
2284 (driven). If the data line is open collector, this
2285 define can be null.
2286
wdenkb37c7e52003-06-30 16:24:52 +00002287 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2288
wdenkc6097192002-11-03 00:24:07 +00002289 I2C_TRISTATE
2290
2291 The code necessary to make the I2C data line tri-stated
2292 (inactive). If the data line is open collector, this
2293 define can be null.
2294
wdenkb37c7e52003-06-30 16:24:52 +00002295 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2296
wdenkc6097192002-11-03 00:24:07 +00002297 I2C_READ
2298
York Sun472d5462013-04-01 11:29:11 -07002299 Code that returns true if the I2C data line is high,
2300 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002301
wdenkb37c7e52003-06-30 16:24:52 +00002302 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2303
wdenkc6097192002-11-03 00:24:07 +00002304 I2C_SDA(bit)
2305
York Sun472d5462013-04-01 11:29:11 -07002306 If <bit> is true, sets the I2C data line high. If it
2307 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002308
wdenkb37c7e52003-06-30 16:24:52 +00002309 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002310 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002311 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002312
wdenkc6097192002-11-03 00:24:07 +00002313 I2C_SCL(bit)
2314
York Sun472d5462013-04-01 11:29:11 -07002315 If <bit> is true, sets the I2C clock line high. If it
2316 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002317
wdenkb37c7e52003-06-30 16:24:52 +00002318 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002319 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002320 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002321
wdenkc6097192002-11-03 00:24:07 +00002322 I2C_DELAY
2323
2324 This delay is invoked four times per clock cycle so this
2325 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002326 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002327 like:
2328
wdenkb37c7e52003-06-30 16:24:52 +00002329 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002330
Mike Frysinger793b5722010-07-21 13:38:02 -04002331 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2332
2333 If your arch supports the generic GPIO framework (asm/gpio.h),
2334 then you may alternatively define the two GPIOs that are to be
2335 used as SCL / SDA. Any of the previous I2C_xxx macros will
2336 have GPIO-based defaults assigned to them as appropriate.
2337
2338 You should define these to the GPIO value as given directly to
2339 the generic GPIO functions.
2340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002342
wdenk8bde7f72003-06-27 21:31:46 +00002343 When a board is reset during an i2c bus transfer
2344 chips might think that the current transfer is still
2345 in progress. On some boards it is possible to access
2346 the i2c SCLK line directly, either by using the
2347 processor pin as a GPIO or by having a second pin
2348 connected to the bus. If this option is defined a
2349 custom i2c_init_board() routine in boards/xxx/board.c
2350 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002351
Richard Retanubun26a33502010-04-12 15:08:17 -04002352 CONFIG_SYS_I2C_BOARD_LATE_INIT
2353
2354 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2355 defined a custom i2c_board_late_init() routine in
2356 boards/xxx/board.c is run AFTER the operations in i2c_init()
2357 is completed. This callpoint can be used to unreset i2c bus
2358 using CPU i2c controller register accesses for CPUs whose i2c
2359 controller provide such a method. It is called at the end of
2360 i2c_init() to allow i2c_init operations to setup the i2c bus
2361 controller on the CPU (e.g. setting bus speed & slave address).
2362
wdenk17ea1172004-06-06 21:51:03 +00002363 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2364
2365 This option enables configuration of bi_iic_fast[] flags
2366 in u-boot bd_info structure based on u-boot environment
2367 variable "i2cfast". (see also i2cfast)
2368
Ben Warrenbb99ad62006-09-07 16:50:54 -04002369 CONFIG_I2C_MULTI_BUS
2370
2371 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002372 must have a controller. At any point in time, only one bus is
2373 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002374 Note that bus numbering is zero-based.
2375
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002376 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002377
2378 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002379 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002380 is set, specify a list of bus-device pairs. Otherwise, specify
2381 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002382
2383 e.g.
2384 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002385 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002386
2387 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2388
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002389 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002390 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002391
2392 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002395
2396 If defined, then this indicates the I2C bus number for DDR SPD.
2397 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2398
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002399 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002400
2401 If defined, then this indicates the I2C bus number for the RTC.
2402 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002405
2406 If defined, then this indicates the I2C bus number for the DTT.
2407 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002410
2411 If defined, specifies the I2C address of the DTT device.
2412 If not defined, then U-Boot uses predefined value for
2413 specified DTT device.
2414
Andrew Dyer2ac69852008-12-29 17:36:01 -06002415 CONFIG_SOFT_I2C_READ_REPEATED_START
2416
2417 defining this will force the i2c_read() function in
2418 the soft_i2c driver to perform an I2C repeated start
2419 between writing the address pointer and reading the
2420 data. If this define is omitted the default behaviour
2421 of doing a stop-start sequence will be used. Most I2C
2422 devices can use either method, but some require one or
2423 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002424
wdenkc6097192002-11-03 00:24:07 +00002425- SPI Support: CONFIG_SPI
2426
2427 Enables SPI driver (so far only tested with
2428 SPI EEPROM, also an instance works with Crystal A/D and
2429 D/As on the SACSng board)
2430
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002431 CONFIG_SH_SPI
2432
2433 Enables the driver for SPI controller on SuperH. Currently
2434 only SH7757 is supported.
2435
wdenkc6097192002-11-03 00:24:07 +00002436 CONFIG_SPI_X
2437
2438 Enables extended (16-bit) SPI EEPROM addressing.
2439 (symmetrical to CONFIG_I2C_X)
2440
2441 CONFIG_SOFT_SPI
2442
wdenk43d96162003-03-06 00:02:04 +00002443 Enables a software (bit-bang) SPI driver rather than
2444 using hardware support. This is a general purpose
2445 driver that only requires three general I/O port pins
2446 (two outputs, one input) to function. If this is
2447 defined, the board configuration must define several
2448 SPI configuration items (port pins to use, etc). For
2449 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002450
Ben Warren04a9e112008-01-16 22:37:35 -05002451 CONFIG_HARD_SPI
2452
2453 Enables a hardware SPI driver for general-purpose reads
2454 and writes. As with CONFIG_SOFT_SPI, the board configuration
2455 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002456 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002457 example, see include/configs/mpc8349emds.h.
2458
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002459 CONFIG_MXC_SPI
2460
2461 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002462 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002463
Matthias Fuchs01335022007-12-27 17:12:34 +01002464- FPGA Support: CONFIG_FPGA
2465
2466 Enables FPGA subsystem.
2467
2468 CONFIG_FPGA_<vendor>
2469
2470 Enables support for specific chip vendors.
2471 (ALTERA, XILINX)
2472
2473 CONFIG_FPGA_<family>
2474
2475 Enables support for FPGA family.
2476 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2477
2478 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002479
wdenk43d96162003-03-06 00:02:04 +00002480 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002482 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002483
wdenk8bde7f72003-06-27 21:31:46 +00002484 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002486 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002487
wdenk43d96162003-03-06 00:02:04 +00002488 Enable checks on FPGA configuration interface busy
2489 status by the configuration function. This option
2490 will require a board or device specific function to
2491 be written.
wdenkc6097192002-11-03 00:24:07 +00002492
2493 CONFIG_FPGA_DELAY
2494
2495 If defined, a function that provides delays in the FPGA
2496 configuration driver.
2497
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002498 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002499 Allow Control-C to interrupt FPGA configuration
2500
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002501 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002502
wdenk43d96162003-03-06 00:02:04 +00002503 Check for configuration errors during FPGA bitfile
2504 loading. For example, abort during Virtex II
2505 configuration if the INIT_B line goes low (which
2506 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002508 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002509
wdenk43d96162003-03-06 00:02:04 +00002510 Maximum time to wait for the INIT_B line to deassert
2511 after PROB_B has been deasserted during a Virtex II
2512 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002513 ms.
wdenkc6097192002-11-03 00:24:07 +00002514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002516
wdenk43d96162003-03-06 00:02:04 +00002517 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002518 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002520 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002521
wdenk43d96162003-03-06 00:02:04 +00002522 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002523 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002524
2525- Configuration Management:
2526 CONFIG_IDENT_STRING
2527
wdenk43d96162003-03-06 00:02:04 +00002528 If defined, this string will be added to the U-Boot
2529 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002530
2531- Vendor Parameter Protection:
2532
wdenk43d96162003-03-06 00:02:04 +00002533 U-Boot considers the values of the environment
2534 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002535 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002536 are set once by the board vendor / manufacturer, and
2537 protects these variables from casual modification by
2538 the user. Once set, these variables are read-only,
2539 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002540 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002541
2542 If CONFIG_ENV_OVERWRITE is #defined in your config
2543 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002544 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002545 these parameters.
2546
2547 Alternatively, if you #define _both_ CONFIG_ETHADDR
2548 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002549 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002550 which can be changed exactly ONCE by the user. [The
2551 serial# is unaffected by this, i. e. it remains
2552 read-only.]
2553
Joe Hershberger25980902012-12-11 22:16:31 -06002554 The same can be accomplished in a more flexible way
2555 for any variable by configuring the type of access
2556 to allow for those variables in the ".flags" variable
2557 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2558
wdenkc6097192002-11-03 00:24:07 +00002559- Protected RAM:
2560 CONFIG_PRAM
2561
2562 Define this variable to enable the reservation of
2563 "protected RAM", i. e. RAM which is not overwritten
2564 by U-Boot. Define CONFIG_PRAM to hold the number of
2565 kB you want to reserve for pRAM. You can overwrite
2566 this default value by defining an environment
2567 variable "pram" to the number of kB you want to
2568 reserve. Note that the board info structure will
2569 still show the full amount of RAM. If pRAM is
2570 reserved, a new environment variable "mem" will
2571 automatically be defined to hold the amount of
2572 remaining RAM in a form that can be passed as boot
2573 argument to Linux, for instance like that:
2574
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002575 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002576 saveenv
2577
2578 This way you can tell Linux not to use this memory,
2579 either, which results in a memory region that will
2580 not be affected by reboots.
2581
2582 *WARNING* If your board configuration uses automatic
2583 detection of the RAM size, you must make sure that
2584 this memory test is non-destructive. So far, the
2585 following board configurations are known to be
2586 "pRAM-clean":
2587
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002588 IVMS8, IVML24, SPD8xx, TQM8xxL,
2589 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002590 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002591
Gabe Black40fef042012-12-02 04:55:18 +00002592- Access to physical memory region (> 4GB)
2593 Some basic support is provided for operations on memory not
2594 normally accessible to U-Boot - e.g. some architectures
2595 support access to more than 4GB of memory on 32-bit
2596 machines using physical address extension or similar.
2597 Define CONFIG_PHYSMEM to access this basic support, which
2598 currently only supports clearing the memory.
2599
wdenkc6097192002-11-03 00:24:07 +00002600- Error Recovery:
2601 CONFIG_PANIC_HANG
2602
2603 Define this variable to stop the system in case of a
2604 fatal error, so that you have to reset it manually.
2605 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002606 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002607 automatically as fast as possible, but it may be
2608 useful during development since you can try to debug
2609 the conditions that lead to the situation.
2610
2611 CONFIG_NET_RETRY_COUNT
2612
wdenk43d96162003-03-06 00:02:04 +00002613 This variable defines the number of retries for
2614 network operations like ARP, RARP, TFTP, or BOOTP
2615 before giving up the operation. If not defined, a
2616 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002617
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002618 CONFIG_ARP_TIMEOUT
2619
2620 Timeout waiting for an ARP reply in milliseconds.
2621
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002622 CONFIG_NFS_TIMEOUT
2623
2624 Timeout in milliseconds used in NFS protocol.
2625 If you encounter "ERROR: Cannot umount" in nfs command,
2626 try longer timeout such as
2627 #define CONFIG_NFS_TIMEOUT 10000UL
2628
wdenkc6097192002-11-03 00:24:07 +00002629- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002630 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002631
2632 Enable auto completion of commands using TAB.
2633
Wolfgang Denka9398e02006-11-27 15:32:42 +01002634 Note that this feature has NOT been implemented yet
2635 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002636
2637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002638 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002639
2640 Define this variable to enable the "hush" shell (from
2641 Busybox) as command line interpreter, thus enabling
2642 powerful command line syntax like
2643 if...then...else...fi conditionals or `&&' and '||'
2644 constructs ("shell scripts").
2645
2646 If undefined, you get the old, much simpler behaviour
2647 with a somewhat smaller memory footprint.
2648
2649
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002650 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002651
2652 This defines the secondary prompt string, which is
2653 printed when the command interpreter needs more input
2654 to complete a command. Usually "> ".
2655
2656 Note:
2657
wdenk8bde7f72003-06-27 21:31:46 +00002658 In the current implementation, the local variables
2659 space and global environment variables space are
2660 separated. Local variables are those you define by
2661 simply typing `name=value'. To access a local
2662 variable later on, you have write `$name' or
2663 `${name}'; to execute the contents of a variable
2664 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002665
wdenk43d96162003-03-06 00:02:04 +00002666 Global environment variables are those you use
2667 setenv/printenv to work with. To run a command stored
2668 in such a variable, you need to use the run command,
2669 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002670
2671 To store commands and special characters in a
2672 variable, please use double quotation marks
2673 surrounding the whole text of the variable, instead
2674 of the backslashes before semicolons and special
2675 symbols.
2676
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002677- Commandline Editing and History:
2678 CONFIG_CMDLINE_EDITING
2679
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002680 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002681 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002682
wdenka8c7c702003-12-06 19:49:23 +00002683- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002684 CONFIG_EXTRA_ENV_SETTINGS
2685
wdenk43d96162003-03-06 00:02:04 +00002686 Define this to contain any number of null terminated
2687 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002688 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002689
wdenk43d96162003-03-06 00:02:04 +00002690 For example, place something like this in your
2691 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002692
2693 #define CONFIG_EXTRA_ENV_SETTINGS \
2694 "myvar1=value1\0" \
2695 "myvar2=value2\0"
2696
wdenk43d96162003-03-06 00:02:04 +00002697 Warning: This method is based on knowledge about the
2698 internal format how the environment is stored by the
2699 U-Boot code. This is NOT an official, exported
2700 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002701 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002702 You better know what you are doing here.
2703
wdenk43d96162003-03-06 00:02:04 +00002704 Note: overly (ab)use of the default environment is
2705 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002706 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002707 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002708
Stephen Warren5e724ca2012-05-22 09:21:54 +00002709 CONFIG_ENV_VARS_UBOOT_CONFIG
2710
2711 Define this in order to add variables describing the
2712 U-Boot build configuration to the default environment.
2713 These will be named arch, cpu, board, vendor, and soc.
2714
2715 Enabling this option will cause the following to be defined:
2716
2717 - CONFIG_SYS_ARCH
2718 - CONFIG_SYS_CPU
2719 - CONFIG_SYS_BOARD
2720 - CONFIG_SYS_VENDOR
2721 - CONFIG_SYS_SOC
2722
Tom Rini7e27f892012-10-24 07:28:16 +00002723 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2724
2725 Define this in order to add variables describing certain
2726 run-time determined information about the hardware to the
2727 environment. These will be named board_name, board_rev.
2728
Simon Glass06fd8532012-11-30 13:01:17 +00002729 CONFIG_DELAY_ENVIRONMENT
2730
2731 Normally the environment is loaded when the board is
2732 intialised so that it is available to U-Boot. This inhibits
2733 that so that the environment is not available until
2734 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2735 this is instead controlled by the value of
2736 /config/load-environment.
2737
wdenka8c7c702003-12-06 19:49:23 +00002738- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002739 CONFIG_HAS_DATAFLASH
2740
wdenk8bde7f72003-06-27 21:31:46 +00002741 Defining this option enables DataFlash features and
2742 allows to read/write in Dataflash via the standard
2743 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002744
Eric Nelsonf61ec452012-01-31 10:52:08 -07002745- Serial Flash support
2746 CONFIG_CMD_SF
2747
2748 Defining this option enables SPI flash commands
2749 'sf probe/read/write/erase/update'.
2750
2751 Usage requires an initial 'probe' to define the serial
2752 flash parameters, followed by read/write/erase/update
2753 commands.
2754
2755 The following defaults may be provided by the platform
2756 to handle the common case when only a single serial
2757 flash is present on the system.
2758
2759 CONFIG_SF_DEFAULT_BUS Bus identifier
2760 CONFIG_SF_DEFAULT_CS Chip-select
2761 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2762 CONFIG_SF_DEFAULT_SPEED in Hz
2763
Simon Glass24007272012-10-08 13:16:02 +00002764 CONFIG_CMD_SF_TEST
2765
2766 Define this option to include a destructive SPI flash
2767 test ('sf test').
2768
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302769 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2770
2771 Define this option to use the Bank addr/Extended addr
2772 support on SPI flashes which has size > 16Mbytes.
2773
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302774 CONFIG_SF_DUAL_FLASH Dual flash memories
2775
2776 Define this option to use dual flash support where two flash
2777 memories can be connected with a given cs line.
2778 currently Xilinx Zynq qspi support these type of connections.
2779
wdenk3f85ce22004-02-23 16:11:30 +00002780- SystemACE Support:
2781 CONFIG_SYSTEMACE
2782
2783 Adding this option adds support for Xilinx SystemACE
2784 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002785 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002786 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002787
2788 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002789 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002790
2791 When SystemACE support is added, the "ace" device type
2792 becomes available to the fat commands, i.e. fatls.
2793
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002794- TFTP Fixed UDP Port:
2795 CONFIG_TFTP_PORT
2796
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002797 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002798 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002799 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002800 number generator is used.
2801
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002802 Also, the environment variable tftpdstp is used to supply
2803 the TFTP UDP destination port value. If tftpdstp isn't
2804 defined, the normal port 69 is used.
2805
2806 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002807 blindly start the TFTP transfer using the pre-configured
2808 target IP address and UDP port. This has the effect of
2809 "punching through" the (Windows XP) firewall, allowing
2810 the remainder of the TFTP transfer to proceed normally.
2811 A better solution is to properly configure the firewall,
2812 but sometimes that is not allowed.
2813
Simon Glassbf36c5d2012-12-05 14:46:38 +00002814- Hashing support:
2815 CONFIG_CMD_HASH
2816
2817 This enables a generic 'hash' command which can produce
2818 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2819
2820 CONFIG_HASH_VERIFY
2821
2822 Enable the hash verify command (hash -v). This adds to code
2823 size a little.
2824
2825 CONFIG_SHA1 - support SHA1 hashing
2826 CONFIG_SHA256 - support SHA256 hashing
2827
2828 Note: There is also a sha1sum command, which should perhaps
2829 be deprecated in favour of 'hash sha1'.
2830
Robert Winklera11f1872013-07-24 17:57:06 -07002831- Freescale i.MX specific commands:
2832 CONFIG_CMD_HDMIDETECT
2833 This enables 'hdmidet' command which returns true if an
2834 HDMI monitor is detected. This command is i.MX 6 specific.
2835
2836 CONFIG_CMD_BMODE
2837 This enables the 'bmode' (bootmode) command for forcing
2838 a boot from specific media.
2839
2840 This is useful for forcing the ROM's usb downloader to
2841 activate upon a watchdog reset which is nice when iterating
2842 on U-Boot. Using the reset button or running bmode normal
2843 will set it back to normal. This command currently
2844 supports i.MX53 and i.MX6.
2845
Simon Glass19c402a2013-06-13 15:10:02 -07002846- Signing support:
2847 CONFIG_RSA
2848
2849 This enables the RSA algorithm used for FIT image verification
2850 in U-Boot. See doc/uImage/signature for more information.
2851
2852 The signing part is build into mkimage regardless of this
2853 option.
2854
2855
wdenka8c7c702003-12-06 19:49:23 +00002856- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002857 CONFIG_SHOW_BOOT_PROGRESS
2858
wdenk43d96162003-03-06 00:02:04 +00002859 Defining this option allows to add some board-
2860 specific code (calling a user-provided function
2861 "show_boot_progress(int)") that enables you to show
2862 the system's boot progress on some display (for
2863 example, some LED's) on your board. At the moment,
2864 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002865
Simon Glass3a608ca2012-02-13 13:51:19 +00002866- Detailed boot stage timing
2867 CONFIG_BOOTSTAGE
2868 Define this option to get detailed timing of each stage
2869 of the boot process.
2870
2871 CONFIG_BOOTSTAGE_USER_COUNT
2872 This is the number of available user bootstage records.
2873 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2874 a new ID will be allocated from this stash. If you exceed
2875 the limit, recording will stop.
2876
2877 CONFIG_BOOTSTAGE_REPORT
2878 Define this to print a report before boot, similar to this:
2879
2880 Timer summary in microseconds:
2881 Mark Elapsed Stage
2882 0 0 reset
2883 3,575,678 3,575,678 board_init_f start
2884 3,575,695 17 arch_cpu_init A9
2885 3,575,777 82 arch_cpu_init done
2886 3,659,598 83,821 board_init_r start
2887 3,910,375 250,777 main_loop
2888 29,916,167 26,005,792 bootm_start
2889 30,361,327 445,160 start_kernel
2890
Simon Glass2eba38c2012-09-28 08:56:39 +00002891 CONFIG_CMD_BOOTSTAGE
2892 Add a 'bootstage' command which supports printing a report
2893 and un/stashing of bootstage data.
2894
Simon Glass94fd1312012-09-28 08:56:37 +00002895 CONFIG_BOOTSTAGE_FDT
2896 Stash the bootstage information in the FDT. A root 'bootstage'
2897 node is created with each bootstage id as a child. Each child
2898 has a 'name' property and either 'mark' containing the
2899 mark time in microsecond, or 'accum' containing the
2900 accumulated time for that bootstage id in microseconds.
2901 For example:
2902
2903 bootstage {
2904 154 {
2905 name = "board_init_f";
2906 mark = <3575678>;
2907 };
2908 170 {
2909 name = "lcd";
2910 accum = <33482>;
2911 };
2912 };
2913
2914 Code in the Linux kernel can find this in /proc/devicetree.
2915
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002916Legacy uImage format:
2917
wdenkc6097192002-11-03 00:24:07 +00002918 Arg Where When
2919 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002920 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002921 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002922 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002923 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002924 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002925 4 common/cmd_bootm.c Image data has correct checksum
2926 -4 common/cmd_bootm.c Image is for unsupported architecture
2927 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002928 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002929 6 common/cmd_bootm.c Image Type check OK
2930 -6 common/cmd_bootm.c gunzip uncompression error
2931 -7 common/cmd_bootm.c Unimplemented compression type
2932 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002933 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002934 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002935
2936 9 common/image.c Start initial ramdisk verification
2937 -10 common/image.c Ramdisk header has bad magic number
2938 -11 common/image.c Ramdisk header has bad checksum
2939 10 common/image.c Ramdisk header is OK
2940 -12 common/image.c Ramdisk data has bad checksum
2941 11 common/image.c Ramdisk data has correct checksum
2942 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002943 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002944 13 common/image.c Start multifile image verification
2945 14 common/image.c No initial ramdisk, no multifile, continue.
2946
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002947 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002948
Stefan Roesea47a12b2010-04-15 16:07:28 +02002949 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002950 -31 post/post.c POST test failed, detected by post_output_backlog()
2951 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002952
Heiko Schocher566a4942007-06-22 19:11:54 +02002953 34 common/cmd_doc.c before loading a Image from a DOC device
2954 -35 common/cmd_doc.c Bad usage of "doc" command
2955 35 common/cmd_doc.c correct usage of "doc" command
2956 -36 common/cmd_doc.c No boot device
2957 36 common/cmd_doc.c correct boot device
2958 -37 common/cmd_doc.c Unknown Chip ID on boot device
2959 37 common/cmd_doc.c correct chip ID found, device available
2960 -38 common/cmd_doc.c Read Error on boot device
2961 38 common/cmd_doc.c reading Image header from DOC device OK
2962 -39 common/cmd_doc.c Image header has bad magic number
2963 39 common/cmd_doc.c Image header has correct magic number
2964 -40 common/cmd_doc.c Error reading Image from DOC device
2965 40 common/cmd_doc.c Image header has correct magic number
2966 41 common/cmd_ide.c before loading a Image from a IDE device
2967 -42 common/cmd_ide.c Bad usage of "ide" command
2968 42 common/cmd_ide.c correct usage of "ide" command
2969 -43 common/cmd_ide.c No boot device
2970 43 common/cmd_ide.c boot device found
2971 -44 common/cmd_ide.c Device not available
2972 44 common/cmd_ide.c Device available
2973 -45 common/cmd_ide.c wrong partition selected
2974 45 common/cmd_ide.c partition selected
2975 -46 common/cmd_ide.c Unknown partition table
2976 46 common/cmd_ide.c valid partition table found
2977 -47 common/cmd_ide.c Invalid partition type
2978 47 common/cmd_ide.c correct partition type
2979 -48 common/cmd_ide.c Error reading Image Header on boot device
2980 48 common/cmd_ide.c reading Image Header from IDE device OK
2981 -49 common/cmd_ide.c Image header has bad magic number
2982 49 common/cmd_ide.c Image header has correct magic number
2983 -50 common/cmd_ide.c Image header has bad checksum
2984 50 common/cmd_ide.c Image header has correct checksum
2985 -51 common/cmd_ide.c Error reading Image from IDE device
2986 51 common/cmd_ide.c reading Image from IDE device OK
2987 52 common/cmd_nand.c before loading a Image from a NAND device
2988 -53 common/cmd_nand.c Bad usage of "nand" command
2989 53 common/cmd_nand.c correct usage of "nand" command
2990 -54 common/cmd_nand.c No boot device
2991 54 common/cmd_nand.c boot device found
2992 -55 common/cmd_nand.c Unknown Chip ID on boot device
2993 55 common/cmd_nand.c correct chip ID found, device available
2994 -56 common/cmd_nand.c Error reading Image Header on boot device
2995 56 common/cmd_nand.c reading Image Header from NAND device OK
2996 -57 common/cmd_nand.c Image header has bad magic number
2997 57 common/cmd_nand.c Image header has correct magic number
2998 -58 common/cmd_nand.c Error reading Image from NAND device
2999 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003000
Heiko Schocher566a4942007-06-22 19:11:54 +02003001 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003002
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003003 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003004 -64 net/eth.c no Ethernet found.
3005 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003006
Heiko Schocher566a4942007-06-22 19:11:54 +02003007 -80 common/cmd_net.c usage wrong
3008 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003009 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003010 81 common/cmd_net.c NetLoop() back without error
3011 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3012 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003013 83 common/cmd_net.c running "source" command
3014 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003015 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003016
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003017FIT uImage format:
3018
3019 Arg Where When
3020 100 common/cmd_bootm.c Kernel FIT Image has correct format
3021 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3022 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3023 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3024 102 common/cmd_bootm.c Kernel unit name specified
3025 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003026 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003027 104 common/cmd_bootm.c Got kernel subimage node offset
3028 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3029 105 common/cmd_bootm.c Kernel subimage hash verification OK
3030 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3031 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003032 -106 common/cmd_bootm.c Kernel subimage has wrong type
3033 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003034 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3035 108 common/cmd_bootm.c Got kernel subimage data/size
3036 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3037 -109 common/cmd_bootm.c Can't get kernel subimage type
3038 -110 common/cmd_bootm.c Can't get kernel subimage comp
3039 -111 common/cmd_bootm.c Can't get kernel subimage os
3040 -112 common/cmd_bootm.c Can't get kernel subimage load address
3041 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3042
3043 120 common/image.c Start initial ramdisk verification
3044 -120 common/image.c Ramdisk FIT image has incorrect format
3045 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003046 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003047 -122 common/image.c Can't get configuration for ramdisk subimage
3048 123 common/image.c Ramdisk unit name specified
3049 -124 common/image.c Can't get ramdisk subimage node offset
3050 125 common/image.c Got ramdisk subimage node offset
3051 -125 common/image.c Ramdisk subimage hash verification failed
3052 126 common/image.c Ramdisk subimage hash verification OK
3053 -126 common/image.c Ramdisk subimage for unsupported architecture
3054 127 common/image.c Architecture check OK
3055 -127 common/image.c Can't get ramdisk subimage data/size
3056 128 common/image.c Got ramdisk subimage data/size
3057 129 common/image.c Can't get ramdisk load address
3058 -129 common/image.c Got ramdisk load address
3059
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003060 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003061 131 common/cmd_doc.c FIT image format OK
3062
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003063 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003064 141 common/cmd_ide.c FIT image format OK
3065
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003066 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003067 151 common/cmd_nand.c FIT image format OK
3068
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003069- FIT image support:
3070 CONFIG_FIT
3071 Enable support for the FIT uImage format.
3072
3073 CONFIG_FIT_BEST_MATCH
3074 When no configuration is explicitly selected, default to the
3075 one whose fdt's compatibility field best matches that of
3076 U-Boot itself. A match is considered "best" if it matches the
3077 most specific compatibility entry of U-Boot's fdt's root node.
3078 The order of entries in the configuration's fdt is ignored.
3079
Simon Glass3e569a62013-06-13 15:10:00 -07003080 CONFIG_FIT_SIGNATURE
3081 This option enables signature verification of FIT uImages,
3082 using a hash signed and verified using RSA. See
3083 doc/uImage.FIT/signature.txt for more details.
3084
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003085- Standalone program support:
3086 CONFIG_STANDALONE_LOAD_ADDR
3087
Wolfgang Denk6feff892011-10-09 21:06:34 +02003088 This option defines a board specific value for the
3089 address where standalone program gets loaded, thus
3090 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003091 settings.
3092
3093- Frame Buffer Address:
3094 CONFIG_FB_ADDR
3095
3096 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003097 address for frame buffer. This is typically the case
3098 when using a graphics controller has separate video
3099 memory. U-Boot will then place the frame buffer at
3100 the given address instead of dynamically reserving it
3101 in system RAM by calling lcd_setmem(), which grabs
3102 the memory for the frame buffer depending on the
3103 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003104
3105 Please see board_init_f function.
3106
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003107- Automatic software updates via TFTP server
3108 CONFIG_UPDATE_TFTP
3109 CONFIG_UPDATE_TFTP_CNT_MAX
3110 CONFIG_UPDATE_TFTP_MSEC_MAX
3111
3112 These options enable and control the auto-update feature;
3113 for a more detailed description refer to doc/README.update.
3114
3115- MTD Support (mtdparts command, UBI support)
3116 CONFIG_MTD_DEVICE
3117
3118 Adds the MTD device infrastructure from the Linux kernel.
3119 Needed for mtdparts command support.
3120
3121 CONFIG_MTD_PARTITIONS
3122
3123 Adds the MTD partitioning infrastructure from the Linux
3124 kernel. Needed for UBI support.
3125
Joe Hershberger70c219c2013-04-08 10:32:48 +00003126- UBI support
3127 CONFIG_CMD_UBI
3128
3129 Adds commands for interacting with MTD partitions formatted
3130 with the UBI flash translation layer
3131
3132 Requires also defining CONFIG_RBTREE
3133
Joe Hershberger147162d2013-04-08 10:32:49 +00003134 CONFIG_UBI_SILENCE_MSG
3135
3136 Make the verbose messages from UBI stop printing. This leaves
3137 warnings and errors enabled.
3138
Joe Hershberger70c219c2013-04-08 10:32:48 +00003139- UBIFS support
3140 CONFIG_CMD_UBIFS
3141
3142 Adds commands for interacting with UBI volumes formatted as
3143 UBIFS. UBIFS is read-only in u-boot.
3144
3145 Requires UBI support as well as CONFIG_LZO
3146
Joe Hershberger147162d2013-04-08 10:32:49 +00003147 CONFIG_UBIFS_SILENCE_MSG
3148
3149 Make the verbose messages from UBIFS stop printing. This leaves
3150 warnings and errors enabled.
3151
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003152- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003153 CONFIG_SPL
3154 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003155
Tom Rini95579792012-02-14 07:29:40 +00003156 CONFIG_SPL_LDSCRIPT
3157 LDSCRIPT for linking the SPL binary.
3158
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003159 CONFIG_SPL_MAX_FOOTPRINT
3160 Maximum size in memory allocated to the SPL, BSS included.
3161 When defined, the linker checks that the actual memory
3162 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003163 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003164 must not be both defined at the same time.
3165
Tom Rini95579792012-02-14 07:29:40 +00003166 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003167 Maximum size of the SPL image (text, data, rodata, and
3168 linker lists sections), BSS excluded.
3169 When defined, the linker checks that the actual size does
3170 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003171
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003172 CONFIG_SPL_TEXT_BASE
3173 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003174
Scott Wood94a45bb2012-09-20 19:05:12 -05003175 CONFIG_SPL_RELOC_TEXT_BASE
3176 Address to relocate to. If unspecified, this is equal to
3177 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3178
Tom Rini95579792012-02-14 07:29:40 +00003179 CONFIG_SPL_BSS_START_ADDR
3180 Link address for the BSS within the SPL binary.
3181
3182 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003183 Maximum size in memory allocated to the SPL BSS.
3184 When defined, the linker checks that the actual memory used
3185 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003186 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003187 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003188
3189 CONFIG_SPL_STACK
3190 Adress of the start of the stack SPL will use
3191
Scott Wood94a45bb2012-09-20 19:05:12 -05003192 CONFIG_SPL_RELOC_STACK
3193 Adress of the start of the stack SPL will use after
3194 relocation. If unspecified, this is equal to
3195 CONFIG_SPL_STACK.
3196
Tom Rini95579792012-02-14 07:29:40 +00003197 CONFIG_SYS_SPL_MALLOC_START
3198 Starting address of the malloc pool used in SPL.
3199
3200 CONFIG_SYS_SPL_MALLOC_SIZE
3201 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003202
Tom Rini47f7bca2012-08-13 12:03:19 -07003203 CONFIG_SPL_FRAMEWORK
3204 Enable the SPL framework under common/. This framework
3205 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3206 NAND loading of the Linux Kernel.
3207
Tom Rini861a86f2012-08-13 11:37:56 -07003208 CONFIG_SPL_DISPLAY_PRINT
3209 For ARM, enable an optional function to print more information
3210 about the running system.
3211
Scott Wood4b919722012-09-20 16:35:21 -05003212 CONFIG_SPL_INIT_MINIMAL
3213 Arch init code should be built for a very small image
3214
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003215 CONFIG_SPL_LIBCOMMON_SUPPORT
3216 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003217
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003218 CONFIG_SPL_LIBDISK_SUPPORT
3219 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003220
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003221 CONFIG_SPL_I2C_SUPPORT
3222 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003223
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003224 CONFIG_SPL_GPIO_SUPPORT
3225 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003226
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003227 CONFIG_SPL_MMC_SUPPORT
3228 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003229
Tom Rini95579792012-02-14 07:29:40 +00003230 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3231 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3232 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3233 Address, size and partition on the MMC to load U-Boot from
3234 when the MMC is being used in raw mode.
3235
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003236 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3237 Sector to load kernel uImage from when MMC is being
3238 used in raw mode (for Falcon mode)
3239
3240 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3241 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3242 Sector and number of sectors to load kernel argument
3243 parameters from when MMC is being used in raw mode
3244 (for falcon mode)
3245
Tom Rini95579792012-02-14 07:29:40 +00003246 CONFIG_SPL_FAT_SUPPORT
3247 Support for fs/fat/libfat.o in SPL binary
3248
3249 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3250 Filename to read to load U-Boot when reading from FAT
3251
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003252 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3253 Filename to read to load kernel uImage when reading
3254 from FAT (for Falcon mode)
3255
3256 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3257 Filename to read to load kernel argument parameters
3258 when reading from FAT (for Falcon mode)
3259
Scott Wood06f60ae2012-12-06 13:33:17 +00003260 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3261 Set this for NAND SPL on PPC mpc83xx targets, so that
3262 start.S waits for the rest of the SPL to load before
3263 continuing (the hardware starts execution after just
3264 loading the first page rather than the full 4K).
3265
Scott Wood6f2f01b2012-09-20 19:09:07 -05003266 CONFIG_SPL_NAND_BASE
3267 Include nand_base.c in the SPL. Requires
3268 CONFIG_SPL_NAND_DRIVERS.
3269
3270 CONFIG_SPL_NAND_DRIVERS
3271 SPL uses normal NAND drivers, not minimal drivers.
3272
3273 CONFIG_SPL_NAND_ECC
3274 Include standard software ECC in the SPL
3275
Tom Rini95579792012-02-14 07:29:40 +00003276 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003277 Support for NAND boot using simple NAND drivers that
3278 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003279
Ying Zhangbb0dc102013-08-16 15:16:11 +08003280 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3281 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003282 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003283
Ying Zhang7c8eea52013-08-16 15:16:12 +08003284 CONFIG_SPL_COMMON_INIT_DDR
3285 Set for common ddr init with serial presence detect in
3286 SPL binary.
3287
Tom Rini95579792012-02-14 07:29:40 +00003288 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3289 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3290 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3291 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3292 CONFIG_SYS_NAND_ECCBYTES
3293 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003294 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003295
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303296 CONFIG_SPL_NAND_BOOT
3297 Add support NAND boot
3298
Tom Rini95579792012-02-14 07:29:40 +00003299 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003300 Location in NAND to read U-Boot from
3301
3302 CONFIG_SYS_NAND_U_BOOT_DST
3303 Location in memory to load U-Boot to
3304
3305 CONFIG_SYS_NAND_U_BOOT_SIZE
3306 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003307
3308 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003309 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003310
3311 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3312 Define this if you need to first read the OOB and then the
3313 data. This is used for example on davinci plattforms.
3314
3315 CONFIG_SPL_OMAP3_ID_NAND
3316 Support for an OMAP3-specific set of functions to return the
3317 ID and MFR of the first attached NAND chip, if present.
3318
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003319 CONFIG_SPL_SERIAL_SUPPORT
3320 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003321
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003322 CONFIG_SPL_SPI_FLASH_SUPPORT
3323 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003324
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003325 CONFIG_SPL_SPI_SUPPORT
3326 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003327
Pavel Machekc57b9532012-08-30 22:42:11 +02003328 CONFIG_SPL_RAM_DEVICE
3329 Support for running image already present in ram, in SPL binary
3330
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003331 CONFIG_SPL_LIBGENERIC_SUPPORT
3332 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003333
Ying Zhangba1bee42013-05-20 14:07:25 +08003334 CONFIG_SPL_ENV_SUPPORT
3335 Support for the environment operating in SPL binary
3336
3337 CONFIG_SPL_NET_SUPPORT
3338 Support for the net/libnet.o in SPL binary.
3339 It conflicts with SPL env from storage medium specified by
3340 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3341
Scott Wood74752ba2012-12-06 13:33:16 +00003342 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003343 Image offset to which the SPL should be padded before appending
3344 the SPL payload. By default, this is defined as
3345 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3346 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3347 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003348
Scott Woodca2fca22012-09-21 16:27:32 -05003349 CONFIG_SPL_TARGET
3350 Final target image containing SPL and payload. Some SPLs
3351 use an arch-specific makefile fragment instead, for
3352 example if more than one image needs to be produced.
3353
Simon Glass87ebee32013-05-08 08:05:59 +00003354 CONFIG_FIT_SPL_PRINT
3355 Printing information about a FIT image adds quite a bit of
3356 code to SPL. So this is normally disabled in SPL. Use this
3357 option to re-enable it. This will affect the output of the
3358 bootm command when booting a FIT image.
3359
Ying Zhang3aa29de2013-08-16 15:16:15 +08003360- TPL framework
3361 CONFIG_TPL
3362 Enable building of TPL globally.
3363
3364 CONFIG_TPL_PAD_TO
3365 Image offset to which the TPL should be padded before appending
3366 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003367 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3368 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3369 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003370
wdenkc6097192002-11-03 00:24:07 +00003371Modem Support:
3372--------------
3373
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003374[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003376- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003377 CONFIG_MODEM_SUPPORT
3378
3379- RTS/CTS Flow control enable:
3380 CONFIG_HWFLOW
3381
3382- Modem debug support:
3383 CONFIG_MODEM_SUPPORT_DEBUG
3384
wdenk43d96162003-03-06 00:02:04 +00003385 Enables debugging stuff (char screen[1024], dbg())
3386 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003387
wdenka8c7c702003-12-06 19:49:23 +00003388- Interrupt support (PPC):
3389
wdenkd4ca31c2004-01-02 14:00:00 +00003390 There are common interrupt_init() and timer_interrupt()
3391 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003392 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003393 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003394 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003395 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003396 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003397 specific handling. If board has watchdog / status_led
3398 / other_activity_monitor it works automatically from
3399 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003400
wdenkc6097192002-11-03 00:24:07 +00003401- General:
3402
wdenk43d96162003-03-06 00:02:04 +00003403 In the target system modem support is enabled when a
3404 specific key (key combination) is pressed during
3405 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003406 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003407 board_init(). Currently key_pressed() is a dummy
3408 function, returning 1 and thus enabling modem
3409 initialization.
wdenkc6097192002-11-03 00:24:07 +00003410
wdenk43d96162003-03-06 00:02:04 +00003411 If there are no modem init strings in the
3412 environment, U-Boot proceed to autoboot; the
3413 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003414 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003415
3416 See also: doc/README.Modem
3417
Helmut Raiger9660e442011-10-20 04:19:47 +00003418Board initialization settings:
3419------------------------------
3420
3421During Initialization u-boot calls a number of board specific functions
3422to allow the preparation of board specific prerequisites, e.g. pin setup
3423before drivers are initialized. To enable these callbacks the
3424following configuration macros have to be defined. Currently this is
3425architecture specific, so please check arch/your_architecture/lib/board.c
3426typically in board_init_f() and board_init_r().
3427
3428- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3429- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3430- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3431- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003432
wdenkc6097192002-11-03 00:24:07 +00003433Configuration Settings:
3434-----------------------
3435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003436- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003437 undefine this when you're short of memory.
3438
Peter Tyser2fb26042009-01-27 18:03:12 -06003439- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3440 width of the commands listed in the 'help' command output.
3441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003442- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003443 prompt for user input.
3444
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003445- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003447- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003449- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003450
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003451- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003452 the application (usually a Linux kernel) when it is
3453 booted
3454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003456 List of legal baudrate settings for this board.
3457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003458- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003459 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003461- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003462 If the board specific function
3463 extern int overwrite_console (void);
3464 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003465 serial port, else the settings in the environment are used.
3466
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003467- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003468 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003470- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003471 Enable overwrite of previous console environment settings.
3472
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003473- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003474 Begin and End addresses of the area used by the
3475 simple memory test.
3476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003477- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003478 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003479
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003480- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003481 Scratch address used by the alternate memory test
3482 You only need to set this if address zero isn't writeable
3483
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003484- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3485 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003486 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003487 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003488 fixing up gd->ram_size the Linux kernel should gets passed
3489 the now "corrected" memory size and won't touch it either.
3490 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003491 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003492 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003493 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003494
3495 This option can be used as a workaround for the 440EPx/GRx
3496 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3497 be touched.
3498
3499 WARNING: Please make sure that this value is a multiple of
3500 the Linux page size (normally 4k). If this is not the case,
3501 then the end address of the Linux memory will be located at a
3502 non page size aligned address and this could cause major
3503 problems.
3504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003505- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003506 Enable temporary baudrate change while serial download
3507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003508- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003509 Physical start address of SDRAM. _Must_ be 0 here.
3510
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003511- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003512 Physical start address of Motherboard I/O (if using a
3513 Cogent motherboard)
3514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003515- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003516 Physical start address of Flash memory.
3517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003519 Physical start address of boot monitor code (set by
3520 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003521 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003522 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003525 Size of memory reserved for monitor code, used to
3526 determine _at_compile_time_ (!) if the environment is
3527 embedded within the U-Boot image, or in a separate
3528 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003531 Size of DRAM reserved for malloc() use.
3532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003533- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003534 Normally compressed uImages are limited to an
3535 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003536 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003537 to adjust this setting to your needs.
3538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003539- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003540 Maximum size of memory mapped by the startup code of
3541 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003542 the Linux kernel (bd_info, boot arguments, FDT blob if
3543 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003544 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003545 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003546 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003547 variable "bootm_mapsize" will override the value of
3548 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3549 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003550
John Rigbyfca43cc2010-10-13 13:57:35 -06003551- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3552 Enable initrd_high functionality. If defined then the
3553 initrd_high feature is enabled and the bootm ramdisk subcommand
3554 is enabled.
3555
3556- CONFIG_SYS_BOOT_GET_CMDLINE:
3557 Enables allocating and saving kernel cmdline in space between
3558 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3559
3560- CONFIG_SYS_BOOT_GET_KBD:
3561 Enables allocating and saving a kernel copy of the bd_info in
3562 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003564- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003565 Max number of Flash memory banks
3566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003567- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003568 Max number of sectors on a Flash chip
3569
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003570- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003571 Timeout for Flash erase operations (in ms)
3572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003573- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003574 Timeout for Flash write operations (in ms)
3575
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003576- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003577 Timeout for Flash set sector lock bit operation (in ms)
3578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003579- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003580 Timeout for Flash clear lock bits operation (in ms)
3581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003582- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003583 If defined, hardware flash sectors protection is used
3584 instead of U-Boot software protection.
3585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003586- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003587
3588 Enable TFTP transfers directly to flash memory;
3589 without this option such a download has to be
3590 performed in two steps: (1) download to RAM, and (2)
3591 copy from RAM to flash.
3592
3593 The two-step approach is usually more reliable, since
3594 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003595 the flash, but in some situations (when system RAM is
3596 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003597 downloaded image) this option may be very useful.
3598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003599- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003600 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003601 common flash structure for storing flash geometry.
3602
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003603- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003604 This option also enables the building of the cfi_flash driver
3605 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003606
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003607- CONFIG_FLASH_CFI_MTD
3608 This option enables the building of the cfi_mtd driver
3609 in the drivers directory. The driver exports CFI flash
3610 to the MTD layer.
3611
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003612- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003613 Use buffered writes to flash.
3614
3615- CONFIG_FLASH_SPANSION_S29WS_N
3616 s29ws-n MirrorBit flash has non-standard addresses for buffered
3617 write commands.
3618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003619- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003620 If this option is defined, the common CFI flash doesn't
3621 print it's warning upon not recognized FLASH banks. This
3622 is useful, if some of the configured banks are only
3623 optionally available.
3624
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003625- CONFIG_FLASH_SHOW_PROGRESS
3626 If defined (must be an integer), print out countdown
3627 digits and dots. Recommended value: 45 (9..1) for 80
3628 column displays, 15 (3..1) for 40 column displays.
3629
Stefan Roese352ef3f2013-04-04 15:53:14 +02003630- CONFIG_FLASH_VERIFY
3631 If defined, the content of the flash (destination) is compared
3632 against the source after the write operation. An error message
3633 will be printed when the contents are not identical.
3634 Please note that this option is useless in nearly all cases,
3635 since such flash programming errors usually are detected earlier
3636 while unprotecting/erasing/programming. Please only enable
3637 this option if you really know what you are doing.
3638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003639- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003640 Defines the number of Ethernet receive buffers. On some
3641 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003642 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3643 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003644 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003645 Defaults to 4 if not defined.
3646
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003647- CONFIG_ENV_MAX_ENTRIES
3648
Wolfgang Denk071bc922010-10-27 22:48:30 +02003649 Maximum number of entries in the hash table that is used
3650 internally to store the environment settings. The default
3651 setting is supposed to be generous and should work in most
3652 cases. This setting can be used to tune behaviour; see
3653 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003654
Joe Hershberger25980902012-12-11 22:16:31 -06003655- CONFIG_ENV_FLAGS_LIST_DEFAULT
3656- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003657 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003658 calling env set. Variables can be restricted to only decimal,
3659 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3660 the variables can also be restricted to IP address or MAC address.
3661
3662 The format of the list is:
3663 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003664 access_atribute = [a|r|o|c]
3665 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003666 entry = variable_name[:attributes]
3667 list = entry[,list]
3668
3669 The type attributes are:
3670 s - String (default)
3671 d - Decimal
3672 x - Hexadecimal
3673 b - Boolean ([1yYtT|0nNfF])
3674 i - IP address
3675 m - MAC address
3676
Joe Hershberger267541f2012-12-11 22:16:34 -06003677 The access attributes are:
3678 a - Any (default)
3679 r - Read-only
3680 o - Write-once
3681 c - Change-default
3682
Joe Hershberger25980902012-12-11 22:16:31 -06003683 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3684 Define this to a list (string) to define the ".flags"
3685 envirnoment variable in the default or embedded environment.
3686
3687 - CONFIG_ENV_FLAGS_LIST_STATIC
3688 Define this to a list (string) to define validation that
3689 should be done if an entry is not found in the ".flags"
3690 environment variable. To override a setting in the static
3691 list, simply add an entry for the same variable name to the
3692 ".flags" variable.
3693
Joe Hershberger267541f2012-12-11 22:16:34 -06003694- CONFIG_ENV_ACCESS_IGNORE_FORCE
3695 If defined, don't allow the -f switch to env set override variable
3696 access flags.
3697
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003698- CONFIG_SYS_GENERIC_BOARD
3699 This selects the architecture-generic board system instead of the
3700 architecture-specific board files. It is intended to move boards
3701 to this new framework over time. Defining this will disable the
3702 arch/foo/lib/board.c file and use common/board_f.c and
3703 common/board_r.c instead. To use this option your architecture
3704 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3705 its config.mk file). If you find problems enabling this option on
3706 your board please report the problem and send patches!
3707
Simon Glass632efa72013-03-11 07:06:48 +00003708- CONFIG_SYS_SYM_OFFSETS
3709 This is set by architectures that use offsets for link symbols
3710 instead of absolute values. So bss_start is obtained using an
3711 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3712 directly. You should not need to touch this setting.
3713
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003714- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3715 This is set by OMAP boards for the max time that reset should
3716 be asserted. See doc/README.omap-reset-time for details on how
3717 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003718
wdenkc6097192002-11-03 00:24:07 +00003719The following definitions that deal with the placement and management
3720of environment data (variable area); in general, we support the
3721following configurations:
3722
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003723- CONFIG_BUILD_ENVCRC:
3724
3725 Builds up envcrc with the target environment so that external utils
3726 may easily extract it and embed it in final U-Boot images.
3727
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003728- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003729
3730 Define this if the environment is in flash memory.
3731
3732 a) The environment occupies one whole flash sector, which is
3733 "embedded" in the text segment with the U-Boot code. This
3734 happens usually with "bottom boot sector" or "top boot
3735 sector" type flash chips, which have several smaller
3736 sectors at the start or the end. For instance, such a
3737 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3738 such a case you would place the environment in one of the
3739 4 kB sectors - with U-Boot code before and after it. With
3740 "top boot sector" type flash chips, you would put the
3741 environment in one of the last sectors, leaving a gap
3742 between U-Boot and the environment.
3743
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003744 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003745
3746 Offset of environment data (variable area) to the
3747 beginning of flash memory; for instance, with bottom boot
3748 type flash chips the second sector can be used: the offset
3749 for this sector is given here.
3750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003751 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003752
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003753 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003754
3755 This is just another way to specify the start address of
3756 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003757 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003758
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003759 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003760
3761 Size of the sector containing the environment.
3762
3763
3764 b) Sometimes flash chips have few, equal sized, BIG sectors.
3765 In such a case you don't want to spend a whole sector for
3766 the environment.
3767
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003768 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003769
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003770 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003771 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003772 of this flash sector for the environment. This saves
3773 memory for the RAM copy of the environment.
3774
3775 It may also save flash memory if you decide to use this
3776 when your environment is "embedded" within U-Boot code,
3777 since then the remainder of the flash sector could be used
3778 for U-Boot code. It should be pointed out that this is
3779 STRONGLY DISCOURAGED from a robustness point of view:
3780 updating the environment in flash makes it always
3781 necessary to erase the WHOLE sector. If something goes
3782 wrong before the contents has been restored from a copy in
3783 RAM, your target system will be dead.
3784
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003785 - CONFIG_ENV_ADDR_REDUND
3786 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk43d96162003-03-06 00:02:04 +00003788 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003789 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003790 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003791 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003792
3793BE CAREFUL! Any changes to the flash layout, and some changes to the
3794source code will make it necessary to adapt <board>/u-boot.lds*
3795accordingly!
3796
3797
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003798- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003799
3800 Define this if you have some non-volatile memory device
3801 (NVRAM, battery buffered SRAM) which you want to use for the
3802 environment.
3803
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003804 - CONFIG_ENV_ADDR:
3805 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003806
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003807 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003808 want to use for environment. It is assumed that this memory
3809 can just be read and written to, without any special
3810 provision.
3811
3812BE CAREFUL! The first access to the environment happens quite early
3813in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003814console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003815U-Boot will hang.
3816
3817Please note that even with NVRAM we still use a copy of the
3818environment in RAM: we could work on NVRAM directly, but we want to
3819keep settings there always unmodified except somebody uses "saveenv"
3820to save the current settings.
3821
3822
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003823- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003824
3825 Use this if you have an EEPROM or similar serial access
3826 device and a driver for it.
3827
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003828 - CONFIG_ENV_OFFSET:
3829 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003830
3831 These two #defines specify the offset and size of the
3832 environment area within the total memory of your EEPROM.
3833
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003834 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003835 If defined, specified the chip address of the EEPROM device.
3836 The default address is zero.
3837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003838 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003839 If defined, the number of bits used to address bytes in a
3840 single page in the EEPROM device. A 64 byte page, for example
3841 would require six bits.
3842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003843 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003844 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003845 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003847 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003848 The length in bytes of the EEPROM memory array address. Note
3849 that this is NOT the chip address length!
3850
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003851 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003852 EEPROM chips that implement "address overflow" are ones
3853 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3854 address and the extra bits end up in the "chip address" bit
3855 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3856 byte chips.
3857
3858 Note that we consider the length of the address field to
3859 still be one byte because the extra address bits are hidden
3860 in the chip address.
3861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003862 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003863 The size in bytes of the EEPROM device.
3864
Heiko Schocher548738b2010-01-07 08:55:40 +01003865 - CONFIG_ENV_EEPROM_IS_ON_I2C
3866 define this, if you have I2C and SPI activated, and your
3867 EEPROM, which holds the environment, is on the I2C bus.
3868
3869 - CONFIG_I2C_ENV_EEPROM_BUS
3870 if you have an Environment on an EEPROM reached over
3871 I2C muxes, you can define here, how to reach this
3872 EEPROM. For example:
3873
Heiko Schocherea818db2013-01-29 08:53:15 +01003874 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003875
3876 EEPROM which holds the environment, is reached over
3877 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003878
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003879- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003880
wdenkd4ca31c2004-01-02 14:00:00 +00003881 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003882 want to use for the environment.
3883
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003884 - CONFIG_ENV_OFFSET:
3885 - CONFIG_ENV_ADDR:
3886 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003887
3888 These three #defines specify the offset and size of the
3889 environment area within the total memory of your DataFlash placed
3890 at the specified address.
3891
Liu Gang0a85a9e2012-03-08 00:33:20 +00003892- CONFIG_ENV_IS_IN_REMOTE:
3893
3894 Define this if you have a remote memory space which you
3895 want to use for the local device's environment.
3896
3897 - CONFIG_ENV_ADDR:
3898 - CONFIG_ENV_SIZE:
3899
3900 These two #defines specify the address and size of the
3901 environment area within the remote memory space. The
3902 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003903 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003904
3905BE CAREFUL! For some special cases, the local device can not use
3906"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003907environment stored in a remote NOR flash by SRIO or PCIE link,
3908but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003909
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003910- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003911
3912 Define this if you have a NAND device which you want to use
3913 for the environment.
3914
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003915 - CONFIG_ENV_OFFSET:
3916 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003917
3918 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003919 area within the first NAND device. CONFIG_ENV_OFFSET must be
3920 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003921
Scott Woodfdd813d2010-09-17 14:38:37 -05003922 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003923
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003924 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003925 size used to hold a redundant copy of the environment data, so
3926 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003927 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003928 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003929
Scott Woodfdd813d2010-09-17 14:38:37 -05003930 - CONFIG_ENV_RANGE (optional):
3931
3932 Specifies the length of the region in which the environment
3933 can be written. This should be a multiple of the NAND device's
3934 block size. Specifying a range with more erase blocks than
3935 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3936 the range to be avoided.
3937
3938 - CONFIG_ENV_OFFSET_OOB (optional):
3939
3940 Enables support for dynamically retrieving the offset of the
3941 environment from block zero's out-of-band data. The
3942 "nand env.oob" command can be used to record this offset.
3943 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3944 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003945
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003946- CONFIG_NAND_ENV_DST
3947
3948 Defines address in RAM to which the nand_spl code should copy the
3949 environment. If redundant environment is used, it will be copied to
3950 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3951
Joe Hershberger2b744332013-04-08 10:32:51 +00003952- CONFIG_ENV_IS_IN_UBI:
3953
3954 Define this if you have an UBI volume that you want to use for the
3955 environment. This has the benefit of wear-leveling the environment
3956 accesses, which is important on NAND.
3957
3958 - CONFIG_ENV_UBI_PART:
3959
3960 Define this to a string that is the mtd partition containing the UBI.
3961
3962 - CONFIG_ENV_UBI_VOLUME:
3963
3964 Define this to the name of the volume that you want to store the
3965 environment in.
3966
Joe Hershberger785881f2013-04-08 10:32:52 +00003967 - CONFIG_ENV_UBI_VOLUME_REDUND:
3968
3969 Define this to the name of another volume to store a second copy of
3970 the environment in. This will enable redundant environments in UBI.
3971 It is assumed that both volumes are in the same MTD partition.
3972
Joe Hershberger2b744332013-04-08 10:32:51 +00003973 - CONFIG_UBI_SILENCE_MSG
3974 - CONFIG_UBIFS_SILENCE_MSG
3975
3976 You will probably want to define these to avoid a really noisy system
3977 when storing the env in UBI.
3978
Stephen Warren06e4ae52013-06-11 15:14:00 -06003979- CONFIG_ENV_IS_IN_MMC:
3980
3981 Define this if you have an MMC device which you want to use for the
3982 environment.
3983
3984 - CONFIG_SYS_MMC_ENV_DEV:
3985
3986 Specifies which MMC device the environment is stored in.
3987
3988 - CONFIG_SYS_MMC_ENV_PART (optional):
3989
3990 Specifies which MMC partition the environment is stored in. If not
3991 set, defaults to partition 0, the user area. Common values might be
3992 1 (first MMC boot partition), 2 (second MMC boot partition).
3993
3994 - CONFIG_ENV_OFFSET:
3995 - CONFIG_ENV_SIZE:
3996
3997 These two #defines specify the offset and size of the environment
3998 area within the specified MMC device.
3999
Stephen Warren5c088ee2013-06-11 15:14:02 -06004000 If offset is positive (the usual case), it is treated as relative to
4001 the start of the MMC partition. If offset is negative, it is treated
4002 as relative to the end of the MMC partition. This can be useful if
4003 your board may be fitted with different MMC devices, which have
4004 different sizes for the MMC partitions, and you always want the
4005 environment placed at the very end of the partition, to leave the
4006 maximum possible space before it, to store other data.
4007
Stephen Warren06e4ae52013-06-11 15:14:00 -06004008 These two values are in units of bytes, but must be aligned to an
4009 MMC sector boundary.
4010
4011 - CONFIG_ENV_OFFSET_REDUND (optional):
4012
4013 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4014 hold a redundant copy of the environment data. This provides a
4015 valid backup copy in case the other copy is corrupted, e.g. due
4016 to a power failure during a "saveenv" operation.
4017
Stephen Warren5c088ee2013-06-11 15:14:02 -06004018 This value may also be positive or negative; this is handled in the
4019 same way as CONFIG_ENV_OFFSET.
4020
Stephen Warren06e4ae52013-06-11 15:14:00 -06004021 This value is also in units of bytes, but must also be aligned to
4022 an MMC sector boundary.
4023
4024 - CONFIG_ENV_SIZE_REDUND (optional):
4025
4026 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4027 set. If this value is set, it must be set to the same value as
4028 CONFIG_ENV_SIZE.
4029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004030- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004031
4032 Defines offset to the initial SPI buffer area in DPRAM. The
4033 area is used at an early stage (ROM part) if the environment
4034 is configured to reside in the SPI EEPROM: We need a 520 byte
4035 scratch DPRAM area. It is used between the two initialization
4036 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4037 to be a good choice since it makes it far enough from the
4038 start of the data area as well as from the stack pointer.
4039
Bruce Adlere881cb52007-11-02 13:15:42 -07004040Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004041has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004042created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004043until then to read environment variables.
4044
wdenk85ec0bc2003-03-31 16:34:49 +00004045The environment is protected by a CRC32 checksum. Before the monitor
4046is relocated into RAM, as a result of a bad CRC you will be working
4047with the compiled-in default environment - *silently*!!! [This is
4048necessary, because the first environment variable we need is the
4049"baudrate" setting for the console - if we have a bad CRC, we don't
4050have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004051
4052Note: once the monitor has been relocated, then it will complain if
4053the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004054use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004056- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004057 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004059 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004060 also needs to be defined.
4061
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004062- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004063 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004064
Ron Madridf5675aa2009-02-18 14:30:44 -08004065- CONFIG_NS16550_MIN_FUNCTIONS:
4066 Define this if you desire to only have use of the NS16550_init
4067 and NS16550_putc functions for the serial driver located at
4068 drivers/serial/ns16550.c. This option is useful for saving
4069 space for already greatly restricted images, including but not
4070 limited to NAND_SPL configurations.
4071
Simon Glassb2b92f52012-11-30 13:01:18 +00004072- CONFIG_DISPLAY_BOARDINFO
4073 Display information about the board that U-Boot is running on
4074 when U-Boot starts up. The board function checkboard() is called
4075 to do this.
4076
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004077- CONFIG_DISPLAY_BOARDINFO_LATE
4078 Similar to the previous option, but display this information
4079 later, once stdio is running and output goes to the LCD, if
4080 present.
4081
wdenkc6097192002-11-03 00:24:07 +00004082Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004083---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004085- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004086 Cache Line Size of the CPU.
4087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004088- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004089 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004090
wdenk42d1f032003-10-15 23:53:47 +00004091 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4092 and RPXsuper) to be able to adjust the position of
4093 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004094
Timur Tabie46fedf2011-08-04 18:03:41 -05004095- CONFIG_SYS_CCSRBAR_DEFAULT:
4096 Default (power-on reset) physical address of CCSR on Freescale
4097 PowerPC SOCs.
4098
4099- CONFIG_SYS_CCSRBAR:
4100 Virtual address of CCSR. On a 32-bit build, this is typically
4101 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4102
4103 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4104 for cross-platform code that uses that macro instead.
4105
4106- CONFIG_SYS_CCSRBAR_PHYS:
4107 Physical address of CCSR. CCSR can be relocated to a new
4108 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004109 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004110 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4111 is typically relocated on 36-bit builds. It is recommended
4112 that this macro be defined via the _HIGH and _LOW macros:
4113
4114 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4115 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4116
4117- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004118 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4119 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004120 used in assembly code, so it must not contain typecasts or
4121 integer size suffixes (e.g. "ULL").
4122
4123- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4124 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4125 used in assembly code, so it must not contain typecasts or
4126 integer size suffixes (e.g. "ULL").
4127
4128- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4129 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4130 forced to a value that ensures that CCSR is not relocated.
4131
wdenk7f6c2cb2002-11-10 22:06:23 +00004132- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004133 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004134
4135 the default drive number (default value 0)
4136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004137 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004138
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004139 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004140 (default value 1)
4141
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004142 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004143
wdenk43d96162003-03-06 00:02:04 +00004144 defines the offset of register from address. It
4145 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004146 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004147
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004148 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4149 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004150 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004152 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004153 fdc_hw_init() is called at the beginning of the FDC
4154 setup. fdc_hw_init() must be provided by the board
4155 source code. It is used to make hardware dependant
4156 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004157
Macpaul Lin0abddf82011-04-11 20:45:32 +00004158- CONFIG_IDE_AHB:
4159 Most IDE controllers were designed to be connected with PCI
4160 interface. Only few of them were designed for AHB interface.
4161 When software is doing ATA command and data transfer to
4162 IDE devices through IDE-AHB controller, some additional
4163 registers accessing to these kind of IDE-AHB controller
4164 is requierd.
4165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004166- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004167 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004168 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004169
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004170- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk7152b1d2003-09-05 23:19:14 +00004172 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004173 initial data and stack; please note that this must be
4174 writable memory that is working WITHOUT special
4175 initialization, i. e. you CANNOT use normal RAM which
4176 will become available only after programming the
4177 memory controller and running certain initialization
4178 sequences.
4179
4180 U-Boot uses the following memory types:
4181 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4182 - MPC824X: data cache
4183 - PPC4xx: data cache
4184
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004185- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004186
4187 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004188 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4189 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004190 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004191 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004192 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4193 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4194 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004195
4196 Note:
4197 On the MPC824X (or other systems that use the data
4198 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004199 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004200 point to an otherwise UNUSED address space between
4201 the top of RAM and the start of the PCI space.
4202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004203- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004205- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004207- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004208
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004209- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004211- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004213- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004215- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004216 SDRAM timing
4217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004218- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004219 periodic timer for refresh
4220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004221- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004223- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4224 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4225 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4226 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004227 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4228
4229- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004230 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4231 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004232 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004234- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4235 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004236 Machine Mode Register and Memory Periodic Timer
4237 Prescaler definitions (SDRAM timing)
4238
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004239- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004240 enable I2C microcode relocation patch (MPC8xx);
4241 define relocation offset in DPRAM [DSP2]
4242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004243- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004244 enable SMC microcode relocation patch (MPC8xx);
4245 define relocation offset in DPRAM [SMC1]
4246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004247- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004248 enable SPI microcode relocation patch (MPC8xx);
4249 define relocation offset in DPRAM [SCC4]
4250
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004251- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004252 Use OSCM clock mode on MBX8xx board. Be careful,
4253 wrong setting might damage your board. Read
4254 doc/README.MBX before setting this variable!
4255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004256- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004257 Offset of the bootmode word in DPRAM used by post
4258 (Power On Self Tests). This definition overrides
4259 #define'd default value in commproc.h resp.
4260 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004262- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4263 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4264 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4265 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4266 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4267 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4268 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4269 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004270 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004271
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004272- CONFIG_PCI_DISABLE_PCIE:
4273 Disable PCI-Express on systems where it is supported but not
4274 required.
4275
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004276- CONFIG_PCI_ENUM_ONLY
4277 Only scan through and get the devices on the busses.
4278 Don't do any setup work, presumably because someone or
4279 something has already done it, and we don't need to do it
4280 a second time. Useful for platforms that are pre-booted
4281 by coreboot or similar.
4282
Gabor Juhos842033e2013-05-30 07:06:12 +00004283- CONFIG_PCI_INDIRECT_BRIDGE:
4284 Enable support for indirect PCI bridges.
4285
Kumar Galaa09b9b62010-12-30 12:09:53 -06004286- CONFIG_SYS_SRIO:
4287 Chip has SRIO or not
4288
4289- CONFIG_SRIO1:
4290 Board has SRIO 1 port available
4291
4292- CONFIG_SRIO2:
4293 Board has SRIO 2 port available
4294
Liu Gangc8b28152013-05-07 16:30:46 +08004295- CONFIG_SRIO_PCIE_BOOT_MASTER
4296 Board can support master function for Boot from SRIO and PCIE
4297
Kumar Galaa09b9b62010-12-30 12:09:53 -06004298- CONFIG_SYS_SRIOn_MEM_VIRT:
4299 Virtual Address of SRIO port 'n' memory region
4300
4301- CONFIG_SYS_SRIOn_MEM_PHYS:
4302 Physical Address of SRIO port 'n' memory region
4303
4304- CONFIG_SYS_SRIOn_MEM_SIZE:
4305 Size of SRIO port 'n' memory region
4306
Fabio Estevam66bd1842013-04-11 09:35:34 +00004307- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4308 Defined to tell the NAND controller that the NAND chip is using
4309 a 16 bit bus.
4310 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004311 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004312 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004313 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004314
4315- CONFIG_SYS_NDFC_EBC0_CFG
4316 Sets the EBC0_CFG register for the NDFC. If not defined
4317 a default value will be used.
4318
Ben Warrenbb99ad62006-09-07 16:50:54 -04004319- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004320 Get DDR timing information from an I2C EEPROM. Common
4321 with pluggable memory modules such as SODIMMs
4322
Ben Warrenbb99ad62006-09-07 16:50:54 -04004323 SPD_EEPROM_ADDRESS
4324 I2C address of the SPD EEPROM
4325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004326- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004327 If SPD EEPROM is on an I2C bus other than the first
4328 one, specify here. Note that the value must resolve
4329 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004330
York Sun1b3e3c42011-06-07 09:42:16 +08004331- CONFIG_SYS_DDR_RAW_TIMING
4332 Get DDR timing information from other than SPD. Common with
4333 soldered DDR chips onboard without SPD. DDR raw timing
4334 parameters are extracted from datasheet and hard-coded into
4335 header files or board specific files.
4336
York Sun6f5e1dc2011-09-16 13:21:35 -07004337- CONFIG_FSL_DDR_INTERACTIVE
4338 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004340- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004341 Only for 83xx systems. If specified, then DDR should
4342 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004343
wdenkc26e4542004-04-18 10:13:26 +00004344- CONFIG_ETHER_ON_FEC[12]
4345 Define to enable FEC[12] on a 8xx series processor.
4346
4347- CONFIG_FEC[12]_PHY
4348 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004349 to the given FEC; i. e.
4350 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004351 means that the PHY with address 4 is connected to FEC1
4352
4353 When set to -1, means to probe for first available.
4354
4355- CONFIG_FEC[12]_PHY_NORXERR
4356 The PHY does not have a RXERR line (RMII only).
4357 (so program the FEC to ignore it).
4358
4359- CONFIG_RMII
4360 Enable RMII mode for all FECs.
4361 Note that this is a global option, we can't
4362 have one FEC in standard MII mode and another in RMII mode.
4363
wdenk5cf91d62004-04-23 20:32:05 +00004364- CONFIG_CRC32_VERIFY
4365 Add a verify option to the crc32 command.
4366 The syntax is:
4367
4368 => crc32 -v <address> <count> <crc32>
4369
4370 Where address/count indicate a memory area
4371 and crc32 is the correct crc32 which the
4372 area should have.
4373
wdenk56523f12004-07-11 17:40:54 +00004374- CONFIG_LOOPW
4375 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004376 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004377
stroese7b466642004-12-16 18:46:55 +00004378- CONFIG_MX_CYCLIC
4379 Add the "mdc" and "mwc" memory commands. These are cyclic
4380 "md/mw" commands.
4381 Examples:
4382
wdenkefe2a4d2004-12-16 21:44:03 +00004383 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004384 This command will print 4 bytes (10,11,12,13) each 500 ms.
4385
wdenkefe2a4d2004-12-16 21:44:03 +00004386 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004387 This command will write 12345678 to address 100 all 10 ms.
4388
wdenkefe2a4d2004-12-16 21:44:03 +00004389 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004390 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004391
wdenk8aa1a2d2005-04-04 12:44:11 +00004392- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004393 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004394 low level initializations (like setting up the memory
4395 controller) are omitted and/or U-Boot does not
4396 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004397
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004398 Normally this variable MUST NOT be defined. The only
4399 exception is when U-Boot is loaded (to RAM) by some
4400 other boot loader or by a debugger which performs
4401 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004402
Aneesh V401bb302011-07-13 05:11:07 +00004403- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004404 Modifies the behaviour of start.S when compiling a loader
4405 that is executed before the actual U-Boot. E.g. when
4406 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004407
Ying Zhang3aa29de2013-08-16 15:16:15 +08004408- CONFIG_TPL_BUILD
4409 Modifies the behaviour of start.S when compiling a loader
4410 that is executed after the SPL and before the actual U-Boot.
4411 It is loaded by the SPL.
4412
Ying Zhang5df572f2013-05-20 14:07:23 +08004413- CONFIG_SYS_MPC85XX_NO_RESETVEC
4414 Only for 85xx systems. If this variable is specified, the section
4415 .resetvec is not kept and the section .bootpg is placed in the
4416 previous 4k of the .text section.
4417
Simon Glass4213fc22013-02-24 17:33:14 +00004418- CONFIG_ARCH_MAP_SYSMEM
4419 Generally U-Boot (and in particular the md command) uses
4420 effective address. It is therefore not necessary to regard
4421 U-Boot address as virtual addresses that need to be translated
4422 to physical addresses. However, sandbox requires this, since
4423 it maintains its own little RAM buffer which contains all
4424 addressable memory. This option causes some memory accesses
4425 to be mapped through map_sysmem() / unmap_sysmem().
4426
Matthias Weisserd8834a12011-03-10 21:36:32 +00004427- CONFIG_USE_ARCH_MEMCPY
4428 CONFIG_USE_ARCH_MEMSET
4429 If these options are used a optimized version of memcpy/memset will
4430 be used if available. These functions may be faster under some
4431 conditions but may increase the binary size.
4432
Simon Glass588a13f2013-02-14 04:18:54 +00004433- CONFIG_X86_RESET_VECTOR
4434 If defined, the x86 reset vector code is included. This is not
4435 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004436
Mark Jacksonfc337052013-03-04 01:27:20 +00004437- CONFIG_SYS_MPUCLK
4438 Defines the MPU clock speed (in MHz).
4439
4440 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004441
Heiko Schocher16678eb2013-11-04 14:05:00 +01004442- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4443 Enables the RTC32K OSC on AM33xx based plattforms
4444
Timur Tabif2717b42011-11-22 09:21:25 -06004445Freescale QE/FMAN Firmware Support:
4446-----------------------------------
4447
4448The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4449loading of "firmware", which is encoded in the QE firmware binary format.
4450This firmware often needs to be loaded during U-Boot booting, so macros
4451are used to identify the storage device (NOR flash, SPI, etc) and the address
4452within that device.
4453
4454- CONFIG_SYS_QE_FMAN_FW_ADDR
4455 The address in the storage device where the firmware is located. The
4456 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4457 is also specified.
4458
4459- CONFIG_SYS_QE_FMAN_FW_LENGTH
4460 The maximum possible size of the firmware. The firmware binary format
4461 has a field that specifies the actual size of the firmware, but it
4462 might not be possible to read any part of the firmware unless some
4463 local storage is allocated to hold the entire firmware first.
4464
4465- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4466 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4467 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4468 virtual address in NOR flash.
4469
4470- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4471 Specifies that QE/FMAN firmware is located in NAND flash.
4472 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4473
4474- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4475 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4476 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4477
4478- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4479 Specifies that QE/FMAN firmware is located on the primary SPI
4480 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4481
Liu Gang292dc6c2012-03-08 00:33:18 +00004482- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4483 Specifies that QE/FMAN firmware is located in the remote (master)
4484 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004485 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4486 window->master inbound window->master LAW->the ucode address in
4487 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004488
wdenkc6097192002-11-03 00:24:07 +00004489Building the Software:
4490======================
4491
Wolfgang Denk218ca722008-03-26 10:40:12 +01004492Building U-Boot has been tested in several native build environments
4493and in many different cross environments. Of course we cannot support
4494all possibly existing versions of cross development tools in all
4495(potentially obsolete) versions. In case of tool chain problems we
4496recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4497which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004498
Wolfgang Denk218ca722008-03-26 10:40:12 +01004499If you are not using a native environment, it is assumed that you
4500have GNU cross compiling tools available in your path. In this case,
4501you must set the environment variable CROSS_COMPILE in your shell.
4502Note that no changes to the Makefile or any other source files are
4503necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004504
Wolfgang Denk218ca722008-03-26 10:40:12 +01004505 $ CROSS_COMPILE=ppc_4xx-
4506 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004507
Peter Tyser2f8d3962009-03-13 18:54:51 -05004508Note: If you wish to generate Windows versions of the utilities in
4509 the tools directory you can use the MinGW toolchain
4510 (http://www.mingw.org). Set your HOST tools to the MinGW
4511 toolchain and execute 'make tools'. For example:
4512
4513 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4514
4515 Binaries such as tools/mkimage.exe will be created which can
4516 be executed on computers running Windows.
4517
Wolfgang Denk218ca722008-03-26 10:40:12 +01004518U-Boot is intended to be simple to build. After installing the
4519sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004520is done by typing:
4521
4522 make NAME_config
4523
Wolfgang Denk218ca722008-03-26 10:40:12 +01004524where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004525rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004526
wdenk2729af92004-05-03 20:45:30 +00004527Note: for some board special configuration names may exist; check if
4528 additional information is available from the board vendor; for
4529 instance, the TQM823L systems are available without (standard)
4530 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004531 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533 make TQM823L_config
4534 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536 make TQM823L_LCD_config
4537 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539 etc.
wdenkc6097192002-11-03 00:24:07 +00004540
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk2729af92004-05-03 20:45:30 +00004542Finally, type "make all", and you should get some working U-Boot
4543images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk2729af92004-05-03 20:45:30 +00004545- "u-boot.bin" is a raw binary image
4546- "u-boot" is an image in ELF binary format
4547- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004548
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004549By default the build is performed locally and the objects are saved
4550in the source directory. One of the two methods can be used to change
4551this behavior and build U-Boot to some external directory:
4552
45531. Add O= to the make command line invocations:
4554
4555 make O=/tmp/build distclean
4556 make O=/tmp/build NAME_config
4557 make O=/tmp/build all
4558
45592. Set environment variable BUILD_DIR to point to the desired location:
4560
4561 export BUILD_DIR=/tmp/build
4562 make distclean
4563 make NAME_config
4564 make all
4565
4566Note that the command line "O=" setting overrides the BUILD_DIR environment
4567variable.
4568
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk2729af92004-05-03 20:45:30 +00004570Please be aware that the Makefiles assume you are using GNU make, so
4571for instance on NetBSD you might need to use "gmake" instead of
4572native "make".
wdenkc6097192002-11-03 00:24:07 +00004573
wdenkc6097192002-11-03 00:24:07 +00004574
wdenk2729af92004-05-03 20:45:30 +00004575If the system board that you have is not listed, then you will need
4576to port U-Boot to your hardware platform. To do this, follow these
4577steps:
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk2729af92004-05-03 20:45:30 +000045791. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004580 "boards.cfg" file, using the existing entries as examples.
4581 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000045822. Create a new directory to hold your board specific code. Add any
4583 files you need. In your board directory, you will need at least
4584 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
45853. Create a new configuration file "include/configs/<board>.h" for
4586 your board
45873. If you're porting U-Boot to a new CPU, then also create a new
4588 directory to hold your CPU specific code. Add any files you need.
45894. Run "make <board>_config" with your new name.
45905. Type "make", and you should get a working "u-boot.srec" file
4591 to be installed on your target system.
45926. Debug and solve any problems that might arise.
4593 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004594
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4597==============================================================
wdenkc6097192002-11-03 00:24:07 +00004598
Wolfgang Denk218ca722008-03-26 10:40:12 +01004599If you have modified U-Boot sources (for instance added a new board
4600or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004601provide feedback to the other developers. The feedback normally takes
4602the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004603official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004604
Wolfgang Denk218ca722008-03-26 10:40:12 +01004605But before you submit such a patch, please verify that your modifi-
4606cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004607the supported boards compile WITHOUT ANY compiler warnings. To do so,
4608just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004609for ALL supported system. Be warned, this will take a while. You can
4610select which (cross) compiler to use by passing a `CROSS_COMPILE'
4611environment variable to the script, i. e. to use the ELDK cross tools
4612you can type
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk2729af92004-05-03 20:45:30 +00004614 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk2729af92004-05-03 20:45:30 +00004616or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk2729af92004-05-03 20:45:30 +00004618 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004619
Wolfgang Denk218ca722008-03-26 10:40:12 +01004620When using the MAKEALL script, the default behaviour is to build
4621U-Boot in the source directory. This location can be changed by
4622setting the BUILD_DIR environment variable. Also, for each target
4623built, the MAKEALL script saves two log files (<target>.ERR and
4624<target>.MAKEALL) in the <source dir>/LOG directory. This default
4625location can be changed by setting the MAKEALL_LOGDIR environment
4626variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004627
4628 export BUILD_DIR=/tmp/build
4629 export MAKEALL_LOGDIR=/tmp/log
4630 CROSS_COMPILE=ppc_8xx- MAKEALL
4631
Wolfgang Denk218ca722008-03-26 10:40:12 +01004632With the above settings build objects are saved in the /tmp/build,
4633log files are saved in the /tmp/log and the source tree remains clean
4634during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004635
4636
wdenk2729af92004-05-03 20:45:30 +00004637See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004638
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk2729af92004-05-03 20:45:30 +00004640Monitor Commands - Overview:
4641============================
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643go - start application at address 'addr'
4644run - run commands in an environment variable
4645bootm - boot application image from memory
4646bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004647bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004648tftpboot- boot image via network using TFTP protocol
4649 and env variables "ipaddr" and "serverip"
4650 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004651tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004652rarpboot- boot image via network using RARP/TFTP protocol
4653diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4654loads - load S-Record file over serial line
4655loadb - load binary file over serial line (kermit mode)
4656md - memory display
4657mm - memory modify (auto-incrementing)
4658nm - memory modify (constant address)
4659mw - memory write (fill)
4660cp - memory copy
4661cmp - memory compare
4662crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004663i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004664sspi - SPI utility commands
4665base - print or set address offset
4666printenv- print environment variables
4667setenv - set environment variables
4668saveenv - save environment variables to persistent storage
4669protect - enable or disable FLASH write protection
4670erase - erase FLASH memory
4671flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004672nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004673bdinfo - print Board Info structure
4674iminfo - print header information for application image
4675coninfo - print console devices and informations
4676ide - IDE sub-system
4677loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004678loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004679mtest - simple RAM test
4680icache - enable or disable instruction cache
4681dcache - enable or disable data cache
4682reset - Perform RESET of the CPU
4683echo - echo args to console
4684version - print monitor version
4685help - print online help
4686? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004687
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689Monitor Commands - Detailed Description:
4690========================================
wdenkc6097192002-11-03 00:24:07 +00004691
wdenk2729af92004-05-03 20:45:30 +00004692TODO.
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004695
4696
wdenk2729af92004-05-03 20:45:30 +00004697Environment Variables:
4698======================
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk2729af92004-05-03 20:45:30 +00004700U-Boot supports user configuration using Environment Variables which
4701can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703Environment Variables are set using "setenv", printed using
4704"printenv", and saved to Flash using "saveenv". Using "setenv"
4705without a value can be used to delete a variable from the
4706environment. As long as you don't save the environment you are
4707working with an in-memory copy. In case the Flash area containing the
4708environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004709
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004710Some configuration options can be set using Environment Variables.
4711
4712List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk2729af92004-05-03 20:45:30 +00004720 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004723
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004724 bootm_low - Memory range available for image processing in the bootm
4725 command can be restricted. This variable is given as
4726 a hexadecimal number and defines lowest address allowed
4727 for use by the bootm command. See also "bootm_size"
4728 environment variable. Address defined by "bootm_low" is
4729 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004730 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4731 bootm_mapsize.
4732
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004733 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004734 This variable is given as a hexadecimal number and it
4735 defines the size of the memory region starting at base
4736 address bootm_low that is accessible by the Linux kernel
4737 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4738 as the default value if it is defined, and bootm_size is
4739 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004740
4741 bootm_size - Memory range available for image processing in the bootm
4742 command can be restricted. This variable is given as
4743 a hexadecimal number and defines the size of the region
4744 allowed for use by the bootm command. See also "bootm_low"
4745 environment variable.
4746
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004747 updatefile - Location of the software update file on a TFTP server, used
4748 by the automatic software update feature. Please refer to
4749 documentation in doc/README.update for more details.
4750
wdenk2729af92004-05-03 20:45:30 +00004751 autoload - if set to "no" (any string beginning with 'n'),
4752 "bootp" will just load perform a lookup of the
4753 configuration from the BOOTP server, but not try to
4754 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk2729af92004-05-03 20:45:30 +00004756 autostart - if set to "yes", an image loaded using the "bootp",
4757 "rarpboot", "tftpboot" or "diskboot" commands will
4758 be automatically started (by internally calling
4759 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761 If set to "no", a standalone image passed to the
4762 "bootm" command will be copied to the load address
4763 (and eventually uncompressed), but NOT be started.
4764 This can be used to load and uncompress arbitrary
4765 data.
wdenkc6097192002-11-03 00:24:07 +00004766
David A. Longa28afca2011-07-09 16:40:19 -04004767 fdt_high - if set this restricts the maximum address that the
4768 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004769 For example, if you have a system with 1 GB memory
4770 at physical address 0x10000000, while Linux kernel
4771 only recognizes the first 704 MB as low memory, you
4772 may need to set fdt_high as 0x3C000000 to have the
4773 device tree blob be copied to the maximum address
4774 of the 704 MB low memory, so that Linux kernel can
4775 access it during the boot procedure.
4776
David A. Longa28afca2011-07-09 16:40:19 -04004777 If this is set to the special value 0xFFFFFFFF then
4778 the fdt will not be copied at all on boot. For this
4779 to work it must reside in writable memory, have
4780 sufficient padding on the end of it for u-boot to
4781 add the information it needs into it, and the memory
4782 must be accessible by the kernel.
4783
Simon Glasseea63e02011-10-24 19:15:34 +00004784 fdtcontroladdr- if set this is the address of the control flattened
4785 device tree used by U-Boot when CONFIG_OF_CONTROL is
4786 defined.
4787
wdenk17ea1172004-06-06 21:51:03 +00004788 i2cfast - (PPC405GP|PPC405EP only)
4789 if set to 'y' configures Linux I2C driver for fast
4790 mode (400kHZ). This environment variable is used in
4791 initialization code. So, for changes to be effective
4792 it must be saved and board must be reset.
4793
wdenk2729af92004-05-03 20:45:30 +00004794 initrd_high - restrict positioning of initrd images:
4795 If this variable is not set, initrd images will be
4796 copied to the highest possible address in RAM; this
4797 is usually what you want since it allows for
4798 maximum initrd size. If for some reason you want to
4799 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004800 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004801 variable to a value of "no" or "off" or "0".
4802 Alternatively, you can set it to a maximum upper
4803 address to use (U-Boot will still check that it
4804 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk2729af92004-05-03 20:45:30 +00004806 For instance, when you have a system with 16 MB
4807 RAM, and want to reserve 4 MB from use by Linux,
4808 you can do this by adding "mem=12M" to the value of
4809 the "bootargs" variable. However, now you must make
4810 sure that the initrd image is placed in the first
4811 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004812
wdenk2729af92004-05-03 20:45:30 +00004813 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004814
wdenk2729af92004-05-03 20:45:30 +00004815 If you set initrd_high to 0xFFFFFFFF, this is an
4816 indication to U-Boot that all addresses are legal
4817 for the Linux kernel, including addresses in flash
4818 memory. In this case U-Boot will NOT COPY the
4819 ramdisk at all. This may be useful to reduce the
4820 boot time on your system, but requires that this
4821 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004822
wdenk2729af92004-05-03 20:45:30 +00004823 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004824
wdenk2729af92004-05-03 20:45:30 +00004825 loadaddr - Default load address for commands like "bootp",
4826 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004831
wdenk2729af92004-05-03 20:45:30 +00004832 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004837
Mike Frysingere2a53452011-10-02 10:01:27 +00004838 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004839
Mike Frysingere2a53452011-10-02 10:01:27 +00004840 ethact - controls which interface is currently active.
4841 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004842
Heiko Schocher48690d82010-07-20 17:45:02 +02004843 => setenv ethact FEC
4844 => ping 192.168.0.1 # traffic sent on FEC
4845 => setenv ethact SCC
4846 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004847
Matthias Fuchse1692572008-01-17 07:45:05 +01004848 ethrotate - When set to "no" U-Boot does not go through all
4849 available network interfaces.
4850 It just stays at the currently selected interface.
4851
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004852 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004853 either succeed or fail without retrying.
4854 When set to "once" the network operation will
4855 fail when all the available network interfaces
4856 are tried once without success.
4857 Useful on scripts which control the retry operation
4858 themselves.
wdenkc6097192002-11-03 00:24:07 +00004859
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004860 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004861
Simon Glass8d51aac2013-07-16 20:10:00 -07004862 silent_linux - If set then linux will be told to boot silently, by
4863 changing the console to be empty. If "yes" it will be
4864 made silent. If "no" it will not be made silent. If
4865 unset, then it will be made silent if the U-Boot console
4866 is silent.
4867
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004868 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004869 UDP source port.
4870
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004871 tftpdstport - If this is set, the value is used for TFTP's UDP
4872 destination port instead of the Well Know Port 69.
4873
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004874 tftpblocksize - Block size to use for TFTP transfers; if not set,
4875 we use the TFTP server's default block size
4876
4877 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4878 seconds, minimum value is 1000 = 1 second). Defines
4879 when a packet is considered to be lost so it has to
4880 be retransmitted. The default is 5000 = 5 seconds.
4881 Lowering this value may make downloads succeed
4882 faster in networks with high packet loss rates or
4883 with unreliable TFTP servers.
4884
4885 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004886 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004887 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004888
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004889The following image location variables contain the location of images
4890used in booting. The "Image" column gives the role of the image and is
4891not an environment variable name. The other columns are environment
4892variable names. "File Name" gives the name of the file on a TFTP
4893server, "RAM Address" gives the location in RAM the image will be
4894loaded to, and "Flash Location" gives the image's address in NOR
4895flash or offset in NAND flash.
4896
4897*Note* - these variables don't have to be defined for all boards, some
4898boards currenlty use other variables for these purposes, and some
4899boards use these variables for other purposes.
4900
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004901Image File Name RAM Address Flash Location
4902----- --------- ----------- --------------
4903u-boot u-boot u-boot_addr_r u-boot_addr
4904Linux kernel bootfile kernel_addr_r kernel_addr
4905device tree blob fdtfile fdt_addr_r fdt_addr
4906ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004907
wdenk2729af92004-05-03 20:45:30 +00004908The following environment variables may be used and automatically
4909updated by the network boot commands ("bootp" and "rarpboot"),
4910depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004911
wdenk2729af92004-05-03 20:45:30 +00004912 bootfile - see above
4913 dnsip - IP address of your Domain Name Server
4914 dnsip2 - IP address of your secondary Domain Name Server
4915 gatewayip - IP address of the Gateway (Router) to use
4916 hostname - Target hostname
4917 ipaddr - see above
4918 netmask - Subnet Mask
4919 rootpath - Pathname of the root filesystem on the NFS server
4920 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004921
wdenka3d991b2004-04-15 21:48:45 +00004922
wdenk2729af92004-05-03 20:45:30 +00004923There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk2729af92004-05-03 20:45:30 +00004925 serial# - contains hardware identification information such
4926 as type string and/or serial number
4927 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk2729af92004-05-03 20:45:30 +00004929These variables can be set only once (usually during manufacturing of
4930the board). U-Boot refuses to delete or overwrite these variables
4931once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004932
4933
wdenk2729af92004-05-03 20:45:30 +00004934Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936 ver - Contains the U-Boot version string as printed
4937 with the "version" command. This variable is
4938 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004939
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk2729af92004-05-03 20:45:30 +00004941Please note that changes to some configuration parameters may take
4942only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004943
stroesec1551ea2003-04-04 15:53:41 +00004944
Joe Hershberger170ab112012-12-11 22:16:24 -06004945Callback functions for environment variables:
4946---------------------------------------------
4947
4948For some environment variables, the behavior of u-boot needs to change
4949when their values are changed. This functionailty allows functions to
4950be associated with arbitrary variables. On creation, overwrite, or
4951deletion, the callback will provide the opportunity for some side
4952effect to happen or for the change to be rejected.
4953
4954The callbacks are named and associated with a function using the
4955U_BOOT_ENV_CALLBACK macro in your board or driver code.
4956
4957These callbacks are associated with variables in one of two ways. The
4958static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4959in the board configuration to a string that defines a list of
4960associations. The list must be in the following format:
4961
4962 entry = variable_name[:callback_name]
4963 list = entry[,list]
4964
4965If the callback name is not specified, then the callback is deleted.
4966Spaces are also allowed anywhere in the list.
4967
4968Callbacks can also be associated by defining the ".callbacks" variable
4969with the same list format above. Any association in ".callbacks" will
4970override any association in the static list. You can define
4971CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4972".callbacks" envirnoment variable in the default or embedded environment.
4973
4974
wdenk2729af92004-05-03 20:45:30 +00004975Command Line Parsing:
4976=====================
stroesec1551ea2003-04-04 15:53:41 +00004977
wdenk2729af92004-05-03 20:45:30 +00004978There are two different command line parsers available with U-Boot:
4979the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981Old, simple command line parser:
4982--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984- supports environment variables (through setenv / saveenv commands)
4985- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004986- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004987- special characters ('$', ';') can be escaped by prefixing with '\',
4988 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004989 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004990- You can also escape text by enclosing in single apostrophes, for example:
4991 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk2729af92004-05-03 20:45:30 +00004993Hush shell:
4994-----------
wdenkf07771c2003-05-28 08:06:31 +00004995
wdenk2729af92004-05-03 20:45:30 +00004996- similar to Bourne shell, with control structures like
4997 if...then...else...fi, for...do...done; while...do...done,
4998 until...do...done, ...
4999- supports environment ("global") variables (through setenv / saveenv
5000 commands) and local shell variables (through standard shell syntax
5001 "name=value"); only environment variables can be used with "run"
5002 command
wdenkf07771c2003-05-28 08:06:31 +00005003
wdenk2729af92004-05-03 20:45:30 +00005004General rules:
5005--------------
wdenkf07771c2003-05-28 08:06:31 +00005006
wdenk2729af92004-05-03 20:45:30 +00005007(1) If a command line (or an environment variable executed by a "run"
5008 command) contains several commands separated by semicolon, and
5009 one of these commands fails, then the remaining commands will be
5010 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005011
wdenk2729af92004-05-03 20:45:30 +00005012(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005013 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005014 command will cause "run" to terminate, i. e. the remaining
5015 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005016
wdenk2729af92004-05-03 20:45:30 +00005017Note for Redundant Ethernet Interfaces:
5018=======================================
wdenkf07771c2003-05-28 08:06:31 +00005019
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005020Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005021such configurations and is capable of automatic selection of a
5022"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005023
wdenk2729af92004-05-03 20:45:30 +00005024Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5025MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5026"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028If the network interface stores some valid MAC address (for instance
5029in SROM), this is used as default address if there is NO correspon-
5030ding setting in the environment; if the corresponding environment
5031variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033o If the SROM has a valid MAC address, and there is no address in the
5034 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036o If there is no valid address in the SROM, and a definition in the
5037 environment exists, then the value from the environment variable is
5038 used.
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk2729af92004-05-03 20:45:30 +00005040o If both the SROM and the environment contain a MAC address, and
5041 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk2729af92004-05-03 20:45:30 +00005043o If both the SROM and the environment contain a MAC address, and the
5044 addresses differ, the value from the environment is used and a
5045 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk2729af92004-05-03 20:45:30 +00005047o If neither SROM nor the environment contain a MAC address, an error
5048 is raised.
wdenkc6097192002-11-03 00:24:07 +00005049
Ben Warrenecee9322010-04-26 11:11:46 -07005050If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005051will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005052may be skipped by setting the appropriate 'ethmacskip' environment variable.
5053The naming convention is as follows:
5054"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk2729af92004-05-03 20:45:30 +00005056Image Formats:
5057==============
wdenkc6097192002-11-03 00:24:07 +00005058
Marian Balakowicz3310c542008-03-12 12:13:13 +01005059U-Boot is capable of booting (and performing other auxiliary operations on)
5060images in two formats:
5061
5062New uImage format (FIT)
5063-----------------------
5064
5065Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5066to Flattened Device Tree). It allows the use of images with multiple
5067components (several kernels, ramdisks, etc.), with contents protected by
5068SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5069
5070
5071Old uImage format
5072-----------------
5073
5074Old image format is based on binary files which can be basically anything,
5075preceded by a special header; see the definitions in include/image.h for
5076details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005077
wdenk2729af92004-05-03 20:45:30 +00005078* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5079 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005080 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5081 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5082 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005083* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005084 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5085 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005086* Compression Type (uncompressed, gzip, bzip2)
5087* Load Address
5088* Entry Point
5089* Image Name
5090* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092The header is marked by a special Magic Number, and both the header
5093and the data portions of the image are secured against corruption by
5094CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk2729af92004-05-03 20:45:30 +00005097Linux Support:
5098==============
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk2729af92004-05-03 20:45:30 +00005100Although U-Boot should support any OS or standalone application
5101easily, the main focus has always been on Linux during the design of
5102U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk2729af92004-05-03 20:45:30 +00005104U-Boot includes many features that so far have been part of some
5105special "boot loader" code within the Linux kernel. Also, any
5106"initrd" images to be used are no longer part of one big Linux image;
5107instead, kernel and "initrd" are separate images. This implementation
5108serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110- the same features can be used for other OS or standalone
5111 applications (for instance: using compressed images to reduce the
5112 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk2729af92004-05-03 20:45:30 +00005114- it becomes much easier to port new Linux kernel versions because
5115 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk2729af92004-05-03 20:45:30 +00005117- the same Linux kernel image can now be used with different "initrd"
5118 images; of course this also means that different kernel images can
5119 be run with the same "initrd". This makes testing easier (you don't
5120 have to build a new "zImage.initrd" Linux image when you just
5121 change a file in your "initrd"). Also, a field-upgrade of the
5122 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005123
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125Linux HOWTO:
5126============
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk2729af92004-05-03 20:45:30 +00005128Porting Linux to U-Boot based systems:
5129---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131U-Boot cannot save you from doing all the necessary modifications to
5132configure the Linux device drivers for use with your target hardware
5133(no, we don't intend to provide a full virtual machine interface to
5134Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005135
Stefan Roesea47a12b2010-04-15 16:07:28 +02005136But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk2729af92004-05-03 20:45:30 +00005138Just make sure your machine specific header file (for instance
5139include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005140Information structure as we define in include/asm-<arch>/u-boot.h,
5141and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005142as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005143
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145Configuring the Linux kernel:
5146-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148No specific requirements for U-Boot. Make sure you have some root
5149device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005150
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk2729af92004-05-03 20:45:30 +00005152Building a Linux Image:
5153-----------------------
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk2729af92004-05-03 20:45:30 +00005155With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5156not used. If you use recent kernel source, a new build target
5157"uImage" will exist which automatically builds an image usable by
5158U-Boot. Most older kernels also have support for a "pImage" target,
5159which was introduced for our predecessor project PPCBoot and uses a
5160100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk2729af92004-05-03 20:45:30 +00005162Example:
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164 make TQM850L_config
5165 make oldconfig
5166 make dep
5167 make uImage
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk2729af92004-05-03 20:45:30 +00005169The "uImage" build target uses a special tool (in 'tools/mkimage') to
5170encapsulate a compressed Linux kernel image with header information,
5171CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177 ${CROSS_COMPILE}-objcopy -O binary \
5178 -R .note -R .comment \
5179 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk2729af92004-05-03 20:45:30 +00005181* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005182
wdenk2729af92004-05-03 20:45:30 +00005183 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187 mkimage -A ppc -O linux -T kernel -C gzip \
5188 -a 0 -e 0 -n "Linux Kernel Image" \
5189 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005190
wdenk24ee89b2002-11-03 17:56:27 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192The "mkimage" tool can also be used to create ramdisk images for use
5193with U-Boot, either separated from the Linux kernel image, or
5194combined into one file. "mkimage" encapsulates the images with a 64
5195byte header containing information about target architecture,
5196operating system, image type, compression method, entry points, time
5197stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005198
wdenk2729af92004-05-03 20:45:30 +00005199"mkimage" can be called in two ways: to verify existing images and
5200print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005201
wdenk2729af92004-05-03 20:45:30 +00005202In the first form (with "-l" option) mkimage lists the information
5203contained in the header of an existing U-Boot image; this includes
5204checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005205
wdenk2729af92004-05-03 20:45:30 +00005206 tools/mkimage -l image
5207 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005208
wdenk2729af92004-05-03 20:45:30 +00005209The second form (with "-d" option) is used to build a U-Boot image
5210from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005211
wdenk2729af92004-05-03 20:45:30 +00005212 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5213 -n name -d data_file image
5214 -A ==> set architecture to 'arch'
5215 -O ==> set operating system to 'os'
5216 -T ==> set image type to 'type'
5217 -C ==> set compression type 'comp'
5218 -a ==> set load address to 'addr' (hex)
5219 -e ==> set entry point to 'ep' (hex)
5220 -n ==> set image name to 'name'
5221 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005222
wdenk69459792004-05-29 16:53:29 +00005223Right now, all Linux kernels for PowerPC systems use the same load
5224address (0x00000000), but the entry point address depends on the
5225kernel version:
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk2729af92004-05-03 20:45:30 +00005227- 2.2.x kernels have the entry point at 0x0000000C,
5228- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk2729af92004-05-03 20:45:30 +00005230So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk2729af92004-05-03 20:45:30 +00005232 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5233 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005234 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005235 > examples/uImage.TQM850L
5236 Image Name: 2.4.4 kernel for TQM850L
5237 Created: Wed Jul 19 02:34:59 2000
5238 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5239 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5240 Load Address: 0x00000000
5241 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005242
wdenk2729af92004-05-03 20:45:30 +00005243To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk2729af92004-05-03 20:45:30 +00005245 -> tools/mkimage -l examples/uImage.TQM850L
5246 Image Name: 2.4.4 kernel for TQM850L
5247 Created: Wed Jul 19 02:34:59 2000
5248 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5249 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5250 Load Address: 0x00000000
5251 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk2729af92004-05-03 20:45:30 +00005253NOTE: for embedded systems where boot time is critical you can trade
5254speed for memory and install an UNCOMPRESSED image instead: this
5255needs more space in Flash, but boots much faster since it does not
5256need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005257
Stefan Roesea47a12b2010-04-15 16:07:28 +02005258 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005259 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5260 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005261 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005262 > examples/uImage.TQM850L-uncompressed
5263 Image Name: 2.4.4 kernel for TQM850L
5264 Created: Wed Jul 19 02:34:59 2000
5265 Image Type: PowerPC Linux Kernel Image (uncompressed)
5266 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5267 Load Address: 0x00000000
5268 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005269
wdenkc6097192002-11-03 00:24:07 +00005270
wdenk2729af92004-05-03 20:45:30 +00005271Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5272when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005273
wdenk2729af92004-05-03 20:45:30 +00005274 -> tools/mkimage -n 'Simple Ramdisk Image' \
5275 > -A ppc -O linux -T ramdisk -C gzip \
5276 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5277 Image Name: Simple Ramdisk Image
5278 Created: Wed Jan 12 14:01:50 2000
5279 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5280 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5281 Load Address: 0x00000000
5282 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005283
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005284The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5285option performs the converse operation of the mkimage's second form (the "-d"
5286option). Given an image built by mkimage, the dumpimage extracts a "data file"
5287from the image:
5288
5289 tools/dumpimage -i image -p position data_file
5290 -i ==> extract from the 'image' a specific 'data_file', \
5291 indexed by 'position'
5292
wdenkdb01a2e2004-04-15 23:14:49 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294Installing a Linux Image:
5295-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297To downloading a U-Boot image over the serial (console) interface,
5298you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005301
wdenk2729af92004-05-03 20:45:30 +00005302The 'objcopy' does not understand the information in the U-Boot
5303image header, so the resulting S-Record file will be relative to
5304address 0x00000000. To load it to a given address, you need to
5305specify the target address as 'offset' parameter with the 'loads'
5306command.
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308Example: install the image to address 0x40100000 (which on the
5309TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk2729af92004-05-03 20:45:30 +00005311 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313 .......... done
5314 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk2729af92004-05-03 20:45:30 +00005316 => loads 40100000
5317 ## Ready for S-Record download ...
5318 ~>examples/image.srec
5319 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5320 ...
5321 15989 15990 15991 15992
5322 [file transfer complete]
5323 [connected]
5324 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005325
5326
wdenk2729af92004-05-03 20:45:30 +00005327You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005328this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005329corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk2729af92004-05-03 20:45:30 +00005331 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk2729af92004-05-03 20:45:30 +00005333 ## Checking Image at 40100000 ...
5334 Image Name: 2.2.13 for initrd on TQM850L
5335 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5336 Data Size: 335725 Bytes = 327 kB = 0 MB
5337 Load Address: 00000000
5338 Entry Point: 0000000c
5339 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005340
5341
wdenk2729af92004-05-03 20:45:30 +00005342Boot Linux:
5343-----------
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk2729af92004-05-03 20:45:30 +00005345The "bootm" command is used to boot an application that is stored in
5346memory (RAM or Flash). In case of a Linux kernel image, the contents
5347of the "bootargs" environment variable is passed to the kernel as
5348parameters. You can check and modify this variable using the
5349"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005350
5351
wdenk2729af92004-05-03 20:45:30 +00005352 => printenv bootargs
5353 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005354
wdenk2729af92004-05-03 20:45:30 +00005355 => 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 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357 => printenv bootargs
5358 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 +00005359
wdenk2729af92004-05-03 20:45:30 +00005360 => bootm 40020000
5361 ## Booting Linux kernel at 40020000 ...
5362 Image Name: 2.2.13 for NFS on TQM850L
5363 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5364 Data Size: 381681 Bytes = 372 kB = 0 MB
5365 Load Address: 00000000
5366 Entry Point: 0000000c
5367 Verifying Checksum ... OK
5368 Uncompressing Kernel Image ... OK
5369 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
5370 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5371 time_init: decrementer frequency = 187500000/60
5372 Calibrating delay loop... 49.77 BogoMIPS
5373 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5374 ...
wdenkc6097192002-11-03 00:24:07 +00005375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005376If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005377the memory addresses of both the kernel and the initrd image (PPBCOOT
5378format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk2729af92004-05-03 20:45:30 +00005382 ## Checking Image at 40100000 ...
5383 Image Name: 2.2.13 for initrd on TQM850L
5384 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5385 Data Size: 335725 Bytes = 327 kB = 0 MB
5386 Load Address: 00000000
5387 Entry Point: 0000000c
5388 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk2729af92004-05-03 20:45:30 +00005390 ## Checking Image at 40200000 ...
5391 Image Name: Simple Ramdisk Image
5392 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5393 Data Size: 566530 Bytes = 553 kB = 0 MB
5394 Load Address: 00000000
5395 Entry Point: 00000000
5396 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk2729af92004-05-03 20:45:30 +00005398 => bootm 40100000 40200000
5399 ## Booting Linux kernel at 40100000 ...
5400 Image Name: 2.2.13 for initrd on TQM850L
5401 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5402 Data Size: 335725 Bytes = 327 kB = 0 MB
5403 Load Address: 00000000
5404 Entry Point: 0000000c
5405 Verifying Checksum ... OK
5406 Uncompressing Kernel Image ... OK
5407 ## Loading RAMDisk Image at 40200000 ...
5408 Image Name: Simple Ramdisk Image
5409 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5410 Data Size: 566530 Bytes = 553 kB = 0 MB
5411 Load Address: 00000000
5412 Entry Point: 00000000
5413 Verifying Checksum ... OK
5414 Loading Ramdisk ... OK
5415 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
5416 Boot arguments: root=/dev/ram
5417 time_init: decrementer frequency = 187500000/60
5418 Calibrating delay loop... 49.77 BogoMIPS
5419 ...
5420 RAMDISK: Compressed image found at block 0
5421 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423 bash#
wdenkc6097192002-11-03 00:24:07 +00005424
Matthew McClintock02677682006-06-28 10:41:37 -05005425Boot Linux and pass a flat device tree:
5426-----------
5427
5428First, U-Boot must be compiled with the appropriate defines. See the section
5429titled "Linux Kernel Interface" above for a more in depth explanation. The
5430following is an example of how to start a kernel and pass an updated
5431flat device tree:
5432
5433=> print oftaddr
5434oftaddr=0x300000
5435=> print oft
5436oft=oftrees/mpc8540ads.dtb
5437=> tftp $oftaddr $oft
5438Speed: 1000, full duplex
5439Using TSEC0 device
5440TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5441Filename 'oftrees/mpc8540ads.dtb'.
5442Load address: 0x300000
5443Loading: #
5444done
5445Bytes transferred = 4106 (100a hex)
5446=> tftp $loadaddr $bootfile
5447Speed: 1000, full duplex
5448Using TSEC0 device
5449TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5450Filename 'uImage'.
5451Load address: 0x200000
5452Loading:############
5453done
5454Bytes transferred = 1029407 (fb51f hex)
5455=> print loadaddr
5456loadaddr=200000
5457=> print oftaddr
5458oftaddr=0x300000
5459=> bootm $loadaddr - $oftaddr
5460## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005461 Image Name: Linux-2.6.17-dirty
5462 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5463 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005464 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005465 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005466 Verifying Checksum ... OK
5467 Uncompressing Kernel Image ... OK
5468Booting using flat device tree at 0x300000
5469Using MPC85xx ADS machine description
5470Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5471[snip]
5472
5473
wdenk2729af92004-05-03 20:45:30 +00005474More About U-Boot Image Types:
5475------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005476
wdenk2729af92004-05-03 20:45:30 +00005477U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005478
wdenk2729af92004-05-03 20:45:30 +00005479 "Standalone Programs" are directly runnable in the environment
5480 provided by U-Boot; it is expected that (if they behave
5481 well) you can continue to work in U-Boot after return from
5482 the Standalone Program.
5483 "OS Kernel Images" are usually images of some Embedded OS which
5484 will take over control completely. Usually these programs
5485 will install their own set of exception handlers, device
5486 drivers, set up the MMU, etc. - this means, that you cannot
5487 expect to re-enter U-Boot except by resetting the CPU.
5488 "RAMDisk Images" are more or less just data blocks, and their
5489 parameters (address, size) are passed to an OS kernel that is
5490 being started.
5491 "Multi-File Images" contain several images, typically an OS
5492 (Linux) kernel image and one or more data images like
5493 RAMDisks. This construct is useful for instance when you want
5494 to boot over the network using BOOTP etc., where the boot
5495 server provides just a single image file, but you want to get
5496 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005497
wdenk2729af92004-05-03 20:45:30 +00005498 "Multi-File Images" start with a list of image sizes, each
5499 image size (in bytes) specified by an "uint32_t" in network
5500 byte order. This list is terminated by an "(uint32_t)0".
5501 Immediately after the terminating 0 follow the images, one by
5502 one, all aligned on "uint32_t" boundaries (size rounded up to
5503 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005504
wdenk2729af92004-05-03 20:45:30 +00005505 "Firmware Images" are binary images containing firmware (like
5506 U-Boot or FPGA images) which usually will be programmed to
5507 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005508
wdenk2729af92004-05-03 20:45:30 +00005509 "Script files" are command sequences that will be executed by
5510 U-Boot's command interpreter; this feature is especially
5511 useful when you configure U-Boot to use a real shell (hush)
5512 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005513
Marek Vasut44f074c2012-03-14 21:52:45 +00005514Booting the Linux zImage:
5515-------------------------
5516
5517On some platforms, it's possible to boot Linux zImage. This is done
5518using the "bootz" command. The syntax of "bootz" command is the same
5519as the syntax of "bootm" command.
5520
Tom Rini8ac28562013-05-16 11:40:11 -04005521Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005522kernel with raw initrd images. The syntax is slightly different, the
5523address of the initrd must be augmented by it's size, in the following
5524format: "<initrd addres>:<initrd size>".
5525
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk2729af92004-05-03 20:45:30 +00005527Standalone HOWTO:
5528=================
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk2729af92004-05-03 20:45:30 +00005530One of the features of U-Boot is that you can dynamically load and
5531run "standalone" applications, which can use some resources of
5532U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk2729af92004-05-03 20:45:30 +00005534Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk2729af92004-05-03 20:45:30 +00005536"Hello World" Demo:
5537-------------------
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539'examples/hello_world.c' contains a small "Hello World" Demo
5540application; it is automatically compiled when you build U-Boot.
5541It's configured to run at address 0x00040004, so you can play with it
5542like that:
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544 => loads
5545 ## Ready for S-Record download ...
5546 ~>examples/hello_world.srec
5547 1 2 3 4 5 6 7 8 9 10 11 ...
5548 [file transfer complete]
5549 [connected]
5550 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk2729af92004-05-03 20:45:30 +00005552 => go 40004 Hello World! This is a test.
5553 ## Starting application at 0x00040004 ...
5554 Hello World
5555 argc = 7
5556 argv[0] = "40004"
5557 argv[1] = "Hello"
5558 argv[2] = "World!"
5559 argv[3] = "This"
5560 argv[4] = "is"
5561 argv[5] = "a"
5562 argv[6] = "test."
5563 argv[7] = "<NULL>"
5564 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005565
wdenk2729af92004-05-03 20:45:30 +00005566 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk2729af92004-05-03 20:45:30 +00005568Another example, which demonstrates how to register a CPM interrupt
5569handler with the U-Boot code, can be found in 'examples/timer.c'.
5570Here, a CPM timer is set up to generate an interrupt every second.
5571The interrupt service routine is trivial, just printing a '.'
5572character, but this is just a demo program. The application can be
5573controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk2729af92004-05-03 20:45:30 +00005575 ? - print current values og the CPM Timer registers
5576 b - enable interrupts and start timer
5577 e - stop timer and disable interrupts
5578 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk2729af92004-05-03 20:45:30 +00005580 => loads
5581 ## Ready for S-Record download ...
5582 ~>examples/timer.srec
5583 1 2 3 4 5 6 7 8 9 10 11 ...
5584 [file transfer complete]
5585 [connected]
5586 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005587
wdenk2729af92004-05-03 20:45:30 +00005588 => go 40004
5589 ## Starting application at 0x00040004 ...
5590 TIMERS=0xfff00980
5591 Using timer 1
5592 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594Hit 'b':
5595 [q, b, e, ?] Set interval 1000000 us
5596 Enabling timer
5597Hit '?':
5598 [q, b, e, ?] ........
5599 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5600Hit '?':
5601 [q, b, e, ?] .
5602 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5603Hit '?':
5604 [q, b, e, ?] .
5605 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5606Hit '?':
5607 [q, b, e, ?] .
5608 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5609Hit 'e':
5610 [q, b, e, ?] ...Stopping timer
5611Hit 'q':
5612 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005613
5614
wdenk2729af92004-05-03 20:45:30 +00005615Minicom warning:
5616================
wdenk85ec0bc2003-03-31 16:34:49 +00005617
wdenk2729af92004-05-03 20:45:30 +00005618Over time, many people have reported problems when trying to use the
5619"minicom" terminal emulation program for serial download. I (wd)
5620consider minicom to be broken, and recommend not to use it. Under
5621Unix, I recommend to use C-Kermit for general purpose use (and
5622especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005623use "cu" for S-Record download ("loads" command). See
5624http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5625for help with kermit.
5626
wdenk85ec0bc2003-03-31 16:34:49 +00005627
wdenk2729af92004-05-03 20:45:30 +00005628Nevertheless, if you absolutely want to use it try adding this
5629configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631 Name Program Name U/D FullScr IO-Red. Multi
5632 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5633 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005634
5635
wdenk2729af92004-05-03 20:45:30 +00005636NetBSD Notes:
5637=============
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk2729af92004-05-03 20:45:30 +00005639Starting at version 0.9.2, U-Boot supports NetBSD both as host
5640(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642Building requires a cross environment; it is known to work on
5643NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5644need gmake since the Makefiles are not compatible with BSD make).
5645Note that the cross-powerpc package does not install include files;
5646attempting to build U-Boot will fail because <machine/ansi.h> is
5647missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649 # cd /usr/pkg/cross/powerpc-netbsd/include
5650 # mkdir powerpc
5651 # ln -s powerpc machine
5652 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5653 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655Native builds *don't* work due to incompatibilities between native
5656and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk2729af92004-05-03 20:45:30 +00005658Booting assumes that (the first part of) the image booted is a
5659stage-2 loader which in turn loads and then invokes the kernel
5660proper. Loader sources will eventually appear in the NetBSD source
5661tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005662meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005663
5664
wdenk2729af92004-05-03 20:45:30 +00005665Implementation Internals:
5666=========================
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk2729af92004-05-03 20:45:30 +00005668The following is not intended to be a complete description of every
5669implementation detail. However, it should help to understand the
5670inner workings of U-Boot and make it easier to port it to custom
5671hardware.
wdenkc6097192002-11-03 00:24:07 +00005672
5673
wdenk2729af92004-05-03 20:45:30 +00005674Initial Stack, Global Data:
5675---------------------------
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk2729af92004-05-03 20:45:30 +00005677The implementation of U-Boot is complicated by the fact that U-Boot
5678starts running out of ROM (flash memory), usually without access to
5679system RAM (because the memory controller is not initialized yet).
5680This means that we don't have writable Data or BSS segments, and BSS
5681is not initialized as zero. To be able to get a C environment working
5682at all, we have to allocate at least a minimal stack. Implementation
5683options for this are defined and restricted by the CPU used: Some CPU
5684models provide on-chip memory (like the IMMR area on MPC8xx and
5685MPC826x processors), on others (parts of) the data cache can be
5686locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005687
Wolfgang Denk218ca722008-03-26 10:40:12 +01005688 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005689 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005690
wdenk2729af92004-05-03 20:45:30 +00005691 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5692 From: "Chris Hallinan" <clh@net1plus.com>
5693 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5694 ...
wdenk43d96162003-03-06 00:02:04 +00005695
wdenk2729af92004-05-03 20:45:30 +00005696 Correct me if I'm wrong, folks, but the way I understand it
5697 is this: Using DCACHE as initial RAM for Stack, etc, does not
5698 require any physical RAM backing up the cache. The cleverness
5699 is that the cache is being used as a temporary supply of
5700 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005701 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005702 can see how this works by studying the cache architecture and
5703 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5706 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005707 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005708 option should work for you. Using CS 4 should be fine if your
5709 board designers haven't used it for something that would
5710 cause you grief during the initial boot! It is frequently not
5711 used.
wdenk43d96162003-03-06 00:02:04 +00005712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005713 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005714 with your processor/board/system design. The default value
5715 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005716 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005717 than your SDRAM module. If you have a 64MB SDRAM module, set
5718 it above 400_0000. Just make sure your board has no resources
5719 that are supposed to respond to that address! That code in
5720 start.S has been around a while and should work as is when
5721 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723 -Chris Hallinan
5724 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005725
wdenk2729af92004-05-03 20:45:30 +00005726It is essential to remember this, since it has some impact on the C
5727code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk2729af92004-05-03 20:45:30 +00005729* Initialized global data (data segment) is read-only. Do not attempt
5730 to write it.
wdenkc6097192002-11-03 00:24:07 +00005731
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005732* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005733 as zero data - BSS segment) at all - this is undefined, initiali-
5734 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736* Stack space is very limited. Avoid big data buffers or things like
5737 that.
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739Having only the stack as writable memory limits means we cannot use
5740normal global data to share information beween the code. But it
5741turned out that the implementation of U-Boot can be greatly
5742simplified by making a global data structure (gd_t) available to all
5743functions. We could pass a pointer to this data as argument to _all_
5744functions, but this would bloat the code. Instead we use a feature of
5745the GCC compiler (Global Register Variables) to share the data: we
5746place a pointer (gd) to the global data into a register which we
5747reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005748
wdenk2729af92004-05-03 20:45:30 +00005749When choosing a register for such a purpose we are restricted by the
5750relevant (E)ABI specifications for the current architecture, and by
5751GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk2729af92004-05-03 20:45:30 +00005753For PowerPC, the following registers have specific use:
5754 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005755 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005756 R3-R4: parameter passing and return values
5757 R5-R10: parameter passing
5758 R13: small data area pointer
5759 R30: GOT pointer
5760 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005761
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005762 (U-Boot also uses R12 as internal GOT pointer. r12
5763 is a volatile register so r12 needs to be reset when
5764 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005765
Wolfgang Denke7670f62008-02-14 22:43:22 +01005766 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768 Note: on PPC, we could use a static initializer (since the
5769 address of the global data structure is known at compile time),
5770 but it turned out that reserving a register results in somewhat
5771 smaller code - although the code savings are not that big (on
5772 average for all boards 752 bytes for the whole U-Boot image,
5773 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005774
Robin Getzc4db3352009-08-17 15:23:02 +00005775On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005776 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5777
Robin Getzc4db3352009-08-17 15:23:02 +00005778 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005779
wdenk2729af92004-05-03 20:45:30 +00005780On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk2729af92004-05-03 20:45:30 +00005782 R0: function argument word/integer result
5783 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005784 R9: platform specific
5785 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005786 R11: argument (frame) pointer
5787 R12: temporary workspace
5788 R13: stack pointer
5789 R14: link register
5790 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005791
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005792 ==> U-Boot will use R9 to hold a pointer to the global data
5793
5794 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005795
Thomas Chou0df01fd2010-05-21 11:08:03 +08005796On Nios II, the ABI is documented here:
5797 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5798
5799 ==> U-Boot will use gp to hold a pointer to the global data
5800
5801 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5802 to access small data sections, so gp is free.
5803
Macpaul Linafc1ce82011-10-19 20:41:11 +00005804On NDS32, the following registers are used:
5805
5806 R0-R1: argument/return
5807 R2-R5: argument
5808 R15: temporary register for assembler
5809 R16: trampoline register
5810 R28: frame pointer (FP)
5811 R29: global pointer (GP)
5812 R30: link register (LP)
5813 R31: stack pointer (SP)
5814 PC: program counter (PC)
5815
5816 ==> U-Boot will use R10 to hold a pointer to the global data
5817
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005818NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5819or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005820
wdenk2729af92004-05-03 20:45:30 +00005821Memory Management:
5822------------------
wdenkc6097192002-11-03 00:24:07 +00005823
wdenk2729af92004-05-03 20:45:30 +00005824U-Boot runs in system state and uses physical addresses, i.e. the
5825MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk2729af92004-05-03 20:45:30 +00005827The available memory is mapped to fixed addresses using the memory
5828controller. In this process, a contiguous block is formed for each
5829memory type (Flash, SDRAM, SRAM), even when it consists of several
5830physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk2729af92004-05-03 20:45:30 +00005832U-Boot is installed in the first 128 kB of the first Flash bank (on
5833TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5834booting and sizing and initializing DRAM, the code relocates itself
5835to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005836memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005837configuration setting]. Below that, a structure with global Board
5838Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk2729af92004-05-03 20:45:30 +00005840Additionally, some exception handler code is copied to the low 8 kB
5841of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk2729af92004-05-03 20:45:30 +00005843So a typical memory configuration with 16 MB of DRAM could look like
5844this:
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk2729af92004-05-03 20:45:30 +00005846 0x0000 0000 Exception Vector code
5847 :
5848 0x0000 1FFF
5849 0x0000 2000 Free for Application Use
5850 :
5851 :
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk2729af92004-05-03 20:45:30 +00005853 :
5854 :
5855 0x00FB FF20 Monitor Stack (Growing downward)
5856 0x00FB FFAC Board Info Data and permanent copy of global data
5857 0x00FC 0000 Malloc Arena
5858 :
5859 0x00FD FFFF
5860 0x00FE 0000 RAM Copy of Monitor Code
5861 ... eventually: LCD or video framebuffer
5862 ... eventually: pRAM (Protected RAM - unchanged by reset)
5863 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005864
5865
wdenk2729af92004-05-03 20:45:30 +00005866System Initialization:
5867----------------------
wdenkc6097192002-11-03 00:24:07 +00005868
wdenk2729af92004-05-03 20:45:30 +00005869In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005870(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005871configuration for CS0# this is a mirror of the onboard Flash memory.
5872To be able to re-map memory U-Boot then jumps to its link address.
5873To be able to implement the initialization code in C, a (small!)
5874initial stack is set up in the internal Dual Ported RAM (in case CPUs
5875which provide such a feature like MPC8xx or MPC8260), or in a locked
5876part of the data cache. After that, U-Boot initializes the CPU core,
5877the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk2729af92004-05-03 20:45:30 +00005879Next, all (potentially) available memory banks are mapped using a
5880preliminary mapping. For example, we put them on 512 MB boundaries
5881(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5882on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5883programmed for SDRAM access. Using the temporary configuration, a
5884simple memory test is run that determines the size of the SDRAM
5885banks.
wdenkc6097192002-11-03 00:24:07 +00005886
wdenk2729af92004-05-03 20:45:30 +00005887When there is more than one SDRAM bank, and the banks are of
5888different size, the largest is mapped first. For equal size, the first
5889bank (CS2#) is mapped first. The first mapping is always for address
58900x00000000, with any additional banks following immediately to create
5891contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893Then, the monitor installs itself at the upper end of the SDRAM area
5894and allocates memory for use by malloc() and for the global Board
5895Info data; also, the exception vector code is copied to the low RAM
5896pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk2729af92004-05-03 20:45:30 +00005898Only after this relocation will you have a "normal" C environment;
5899until that you are restricted in several ways, mostly because you are
5900running from ROM, and because the code will have to be relocated to a
5901new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005902
5903
wdenk2729af92004-05-03 20:45:30 +00005904U-Boot Porting Guide:
5905----------------------
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk2729af92004-05-03 20:45:30 +00005907[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5908list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005909
5910
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005911int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005912{
5913 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005914
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005915 signal(SIGALRM, no_more_time);
5916 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005917
wdenk2729af92004-05-03 20:45:30 +00005918 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005919 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005920 return 0;
5921 }
5922
wdenk2729af92004-05-03 20:45:30 +00005923 Download latest U-Boot source;
5924
Wolfgang Denk06682362008-12-30 22:56:11 +01005925 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005926
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005927 if (clueless)
5928 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005929
wdenk2729af92004-05-03 20:45:30 +00005930 while (learning) {
5931 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005932 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5933 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005934 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005935 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005936 }
wdenkc6097192002-11-03 00:24:07 +00005937
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005938 if (available_money > toLocalCurrency ($2500))
5939 Buy a BDI3000;
5940 else
wdenk2729af92004-05-03 20:45:30 +00005941 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005942
5943 if (a similar board exists) { /* hopefully... */
5944 cp -a board/<similar> board/<myboard>
5945 cp include/configs/<similar>.h include/configs/<myboard>.h
5946 } else {
5947 Create your own board support subdirectory;
5948 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005949 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005950 Edit new board/<myboard> files
5951 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005952
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005953 while (!accepted) {
5954 while (!running) {
5955 do {
5956 Add / modify source code;
5957 } until (compiles);
5958 Debug;
5959 if (clueless)
5960 email("Hi, I am having problems...");
5961 }
5962 Send patch file to the U-Boot email list;
5963 if (reasonable critiques)
5964 Incorporate improvements from email list code review;
5965 else
5966 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005967 }
wdenkc6097192002-11-03 00:24:07 +00005968
wdenk2729af92004-05-03 20:45:30 +00005969 return 0;
5970}
5971
5972void no_more_time (int sig)
5973{
5974 hire_a_guru();
5975}
wdenkc6097192002-11-03 00:24:07 +00005976
5977
wdenk2729af92004-05-03 20:45:30 +00005978Coding Standards:
5979-----------------
wdenkc6097192002-11-03 00:24:07 +00005980
wdenk2729af92004-05-03 20:45:30 +00005981All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005982coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005983"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005984
Detlev Zundel2c051652006-09-01 15:39:02 +02005985Source files originating from a different project (for example the
5986MTD subsystem) are generally exempt from these guidelines and are not
5987reformated to ease subsequent migration to newer versions of those
5988sources.
5989
5990Please note that U-Boot is implemented in C (and to some small parts in
5991Assembler); no C++ is used, so please do not use C++ style comments (//)
5992in your code.
wdenk2729af92004-05-03 20:45:30 +00005993
5994Please also stick to the following formatting rules:
5995- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005996- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005997- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005998- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005999- do not add trailing empty lines to source files
6000
6001Submissions which do not conform to the standards may be returned
6002with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006003
6004
wdenk2729af92004-05-03 20:45:30 +00006005Submitting Patches:
6006-------------------
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk2729af92004-05-03 20:45:30 +00006008Since the number of patches for U-Boot is growing, we need to
6009establish some rules. Submissions which do not conform to these rules
6010may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006011
Magnus Lilja0d28f342008-08-06 19:32:33 +02006012Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006013
Wolfgang Denk06682362008-12-30 22:56:11 +01006014Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6015see http://lists.denx.de/mailman/listinfo/u-boot
6016
wdenk2729af92004-05-03 20:45:30 +00006017When you send a patch, please include the following information with
6018it:
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk2729af92004-05-03 20:45:30 +00006020* For bug fixes: a description of the bug and how your patch fixes
6021 this bug. Please try to include a way of demonstrating that the
6022 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006023
wdenk2729af92004-05-03 20:45:30 +00006024* For new features: a description of the feature and your
6025 implementation.
wdenkc6097192002-11-03 00:24:07 +00006026
wdenk2729af92004-05-03 20:45:30 +00006027* A CHANGELOG entry as plaintext (separate from the patch)
6028
6029* For major contributions, your entry to the CREDITS file
6030
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006031* When you add support for a new board, don't forget to add a
6032 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006033
6034* If your patch adds new configuration options, don't forget to
6035 document these in the README file.
6036
Wolfgang Denk218ca722008-03-26 10:40:12 +01006037* The patch itself. If you are using git (which is *strongly*
6038 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006039 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006040 the U-Boot mailing list, you will avoid most of the common problems
6041 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006042
Wolfgang Denk218ca722008-03-26 10:40:12 +01006043 If you cannot use git, use "diff -purN OLD NEW". If your version of
6044 diff does not support these options, then get the latest version of
6045 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006046
Wolfgang Denk218ca722008-03-26 10:40:12 +01006047 The current directory when running this command shall be the parent
6048 directory of the U-Boot source tree (i. e. please make sure that
6049 your patch includes sufficient directory information for the
6050 affected files).
6051
6052 We prefer patches as plain text. MIME attachments are discouraged,
6053 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006054
6055* If one logical set of modifications affects or creates several
6056 files, all these changes shall be submitted in a SINGLE patch file.
6057
6058* Changesets that contain different, unrelated modifications shall be
6059 submitted as SEPARATE patches, one patch per changeset.
6060
6061
6062Notes:
6063
6064* Before sending the patch, run the MAKEALL script on your patched
6065 source tree and make sure that no errors or warnings are reported
6066 for any of the boards.
6067
6068* Keep your modifications to the necessary minimum: A patch
6069 containing several unrelated changes or arbitrary reformats will be
6070 returned with a request to re-formatting / split it.
6071
6072* If you modify existing code, make sure that your new code does not
6073 add to the memory footprint of the code ;-) Small is beautiful!
6074 When adding new features, these should compile conditionally only
6075 (using #ifdef), and the resulting code with the new feature
6076 disabled must not need more memory than the old code without your
6077 modification.
wdenk90dc6702005-05-03 14:12:25 +00006078
Wolfgang Denk06682362008-12-30 22:56:11 +01006079* Remember that there is a size limit of 100 kB per message on the
6080 u-boot mailing list. Bigger patches will be moderated. If they are
6081 reasonable and not too big, they will be acknowledged. But patches
6082 bigger than the size limit should be avoided.