blob: 176de61a331c36582cd6f1c2791e36c5e74ec382 [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 Kushwaha690e4252014-01-13 11:28:04 +0530475 CONFIG_SYS_FSL_PBL_PBI
476 It enables addition of RCW (Power on reset configuration) in built image.
477 Please refer doc/README.pblimage for more details
478
479 CONFIG_SYS_FSL_PBL_RCW
480 It adds PBI(pre-boot instructions) commands in u-boot build image.
481 PBI commands can be used to configure SoC before it starts the execution.
482 Please refer doc/README.pblimage for more details
483
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100484- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200485 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100486
487 Defines the Monahans run mode to oscillator
488 ratio. Valid values are 8, 16, 24, 31. The core
489 frequency is this value multiplied by 13 MHz.
490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200491 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200492
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100493 Defines the Monahans turbo mode to oscillator
494 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200495 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100496 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200497
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200498- MIPS CPU options:
499 CONFIG_SYS_INIT_SP_OFFSET
500
501 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
502 pointer. This is needed for the temporary stack before
503 relocation.
504
505 CONFIG_SYS_MIPS_CACHE_MODE
506
507 Cache operation mode for the MIPS CPU.
508 See also arch/mips/include/asm/mipsregs.h.
509 Possible values are:
510 CONF_CM_CACHABLE_NO_WA
511 CONF_CM_CACHABLE_WA
512 CONF_CM_UNCACHED
513 CONF_CM_CACHABLE_NONCOHERENT
514 CONF_CM_CACHABLE_CE
515 CONF_CM_CACHABLE_COW
516 CONF_CM_CACHABLE_CUW
517 CONF_CM_CACHABLE_ACCELERATED
518
519 CONFIG_SYS_XWAY_EBU_BOOTCFG
520
521 Special option for Lantiq XWAY SoCs for booting from NOR flash.
522 See also arch/mips/cpu/mips32/start.S.
523
524 CONFIG_XWAY_SWAP_BYTES
525
526 Enable compilation of tools/xway-swap-bytes needed for Lantiq
527 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
528 be swapped if a flash programmer is used.
529
Christian Rieschb67d8812012-02-02 00:44:39 +0000530- ARM options:
531 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
532
533 Select high exception vectors of the ARM core, e.g., do not
534 clear the V bit of the c1 register of CP15.
535
Aneesh V5356f542012-03-08 07:20:19 +0000536 CONFIG_SYS_THUMB_BUILD
537
538 Use this flag to build U-Boot using the Thumb instruction
539 set for ARM architectures. Thumb instruction set provides
540 better code density. For ARM architectures that support
541 Thumb2 this flag will result in Thumb2 code generated by
542 GCC.
543
Stephen Warrenc5d47522013-03-04 13:29:40 +0000544 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000545 CONFIG_ARM_ERRATA_742230
546 CONFIG_ARM_ERRATA_743622
547 CONFIG_ARM_ERRATA_751472
548
549 If set, the workarounds for these ARM errata are applied early
550 during U-Boot startup. Note that these options force the
551 workarounds to be applied; no CPU-type/version detection
552 exists, unlike the similar options in the Linux kernel. Do not
553 set these options unless they apply!
554
Stephen Warren795659d2013-03-27 17:06:41 +0000555- CPU timer options:
556 CONFIG_SYS_HZ
557
558 The frequency of the timer returned by get_timer().
559 get_timer() must operate in milliseconds and this CONFIG
560 option must be set to 1000.
561
wdenk5da627a2003-10-09 20:09:04 +0000562- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000563 CONFIG_CLOCKS_IN_MHZ
564
565 U-Boot stores all clock information in Hz
566 internally. For binary compatibility with older Linux
567 kernels (which expect the clocks passed in the
568 bd_info data to be in MHz) the environment variable
569 "clocks_in_mhz" can be defined so that U-Boot
570 converts clock data to MHZ before passing it to the
571 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000572 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100573 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000574 default environment.
575
wdenk5da627a2003-10-09 20:09:04 +0000576 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
577
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200578 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000579 expect it to be in bytes, others in MB.
580 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
581
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400582 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200583
584 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400585 passed using flattened device trees (based on open firmware
586 concepts).
587
588 CONFIG_OF_LIBFDT
589 * New libfdt-based support
590 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500591 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400592
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200593 OF_CPU - The proper name of the cpus node (only required for
594 MPC512X and MPC5xxx based boards).
595 OF_SOC - The proper name of the soc node (only required for
596 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200597 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600598 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200599
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200600 boards with QUICC Engines require OF_QE to set UCC MAC
601 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500602
Kumar Gala4e253132006-01-11 13:54:17 -0600603 CONFIG_OF_BOARD_SETUP
604
605 Board code has addition modification that it wants to make
606 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000607
Matthew McClintock02677682006-06-28 10:41:37 -0500608 CONFIG_OF_BOOT_CPU
609
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200610 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500611 param header, the default value is zero if undefined.
612
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200613 CONFIG_OF_IDE_FIXUP
614
615 U-Boot can detect if an IDE device is present or not.
616 If not, and this new config option is activated, U-Boot
617 removes the ATA node from the DTS before booting Linux,
618 so the Linux IDE driver does not probe the device and
619 crash. This is needed for buggy hardware (uc101) where
620 no pull down resistor is connected to the signal IDE5V_DD7.
621
Igor Grinberg7eb29392011-07-14 05:45:07 +0000622 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
623
624 This setting is mandatory for all boards that have only one
625 machine type and must be used to specify the machine type
626 number as it appears in the ARM machine registry
627 (see http://www.arm.linux.org.uk/developer/machines/).
628 Only boards that have multiple machine types supported
629 in a single configuration file and the machine type is
630 runtime discoverable, do not have to use this setting.
631
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100632- vxWorks boot parameters:
633
634 bootvx constructs a valid bootline using the following
635 environments variables: bootfile, ipaddr, serverip, hostname.
636 It loads the vxWorks image pointed bootfile.
637
638 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
639 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
640 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
641 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
642
643 CONFIG_SYS_VXWORKS_ADD_PARAMS
644
645 Add it at the end of the bootline. E.g "u=username pw=secret"
646
647 Note: If a "bootargs" environment is defined, it will overwride
648 the defaults discussed just above.
649
Aneesh V2c451f72011-06-16 23:30:47 +0000650- Cache Configuration:
651 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
652 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
653 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
654
Aneesh V93bc2192011-06-16 23:30:51 +0000655- Cache Configuration for ARM:
656 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
657 controller
658 CONFIG_SYS_PL310_BASE - Physical base address of PL310
659 controller register space
660
wdenk6705d812004-08-02 23:22:59 +0000661- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200662 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000663
664 Define this if you want support for Amba PrimeCell PL010 UARTs.
665
Andreas Engel48d01922008-09-08 14:30:53 +0200666 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000667
668 Define this if you want support for Amba PrimeCell PL011 UARTs.
669
670 CONFIG_PL011_CLOCK
671
672 If you have Amba PrimeCell PL011 UARTs, set this variable to
673 the clock speed of the UARTs.
674
675 CONFIG_PL01x_PORTS
676
677 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
678 define this to a list of base addresses for each (supported)
679 port. See e.g. include/configs/versatile.h
680
John Rigby910f1ae2011-04-19 10:42:39 +0000681 CONFIG_PL011_SERIAL_RLCR
682
683 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
684 have separate receive and transmit line control registers. Set
685 this variable to initialize the extra register.
686
687 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
688
689 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
690 boot loader that has already initialized the UART. Define this
691 variable to flush the UART at init time.
692
wdenk6705d812004-08-02 23:22:59 +0000693
wdenkc6097192002-11-03 00:24:07 +0000694- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000695 Depending on board, define exactly one serial port
696 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
697 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
698 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000699
700 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
701 port routines must be defined elsewhere
702 (i.e. serial_init(), serial_getc(), ...)
703
704 CONFIG_CFB_CONSOLE
705 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000706 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000707 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
708 (default big endian)
709 VIDEO_HW_RECTFILL graphic chip supports
710 rectangle fill
711 (cf. smiLynxEM)
712 VIDEO_HW_BITBLT graphic chip supports
713 bit-blit (cf. smiLynxEM)
714 VIDEO_VISIBLE_COLS visible pixel columns
715 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000716 VIDEO_VISIBLE_ROWS visible pixel rows
717 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000718 VIDEO_DATA_FORMAT graphic data format
719 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000720 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000721 VIDEO_KBD_INIT_FCT keyboard int fct
722 (i.e. i8042_kbd_init())
723 VIDEO_TSTC_FCT test char fct
724 (i.e. i8042_tstc)
725 VIDEO_GETC_FCT get char fct
726 (i.e. i8042_getc)
727 CONFIG_CONSOLE_CURSOR cursor drawing on/off
728 (requires blink timer
729 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200730 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000731 CONFIG_CONSOLE_TIME display time/date info in
732 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000734 CONFIG_VIDEO_LOGO display Linux logo in
735 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000736 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
737 linux_logo.h for logo.
738 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000739 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200740 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000741 the logo
742
Pali Rohár33a35bb2012-10-19 13:30:09 +0000743 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
744 a limited number of ANSI escape sequences (cursor control,
745 erase functions and limited graphics rendition control).
746
wdenk43d96162003-03-06 00:02:04 +0000747 When CONFIG_CFB_CONSOLE is defined, video console is
748 default i/o. Serial console can be forced with
749 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000750
wdenkd4ca31c2004-01-02 14:00:00 +0000751 When CONFIG_SILENT_CONSOLE is defined, all console
752 messages (by U-Boot and Linux!) can be silenced with
753 the "silent" environment variable. See
754 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000755
Heiko Schocher45ae2542013-10-22 11:06:06 +0200756 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
757 is 0x00.
758 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
759 is 0xa0.
760
wdenkc6097192002-11-03 00:24:07 +0000761- Console Baudrate:
762 CONFIG_BAUDRATE - in bps
763 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200764 CONFIG_SYS_BAUDRATE_TABLE, see below.
765 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000766
Heiko Schocherc92fac92009-01-30 12:55:38 +0100767- Console Rx buffer length
768 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
769 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100770 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100771 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
772 must be defined, to setup the maximum idle timeout for
773 the SMC.
774
Graeme Russ9558b482011-09-01 00:48:27 +0000775- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200776 Prior to the console being initialised (i.e. serial UART
777 initialised etc) all console output is silently discarded.
778 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
779 buffer any console messages prior to the console being
780 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
781 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
782 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200783 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200784 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000785
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200786 'Sane' compilers will generate smaller code if
787 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000788
Sonny Rao046a37b2011-11-02 09:52:08 +0000789- Safe printf() functions
790 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
791 the printf() functions. These are defined in
792 include/vsprintf.h and include snprintf(), vsnprintf() and
793 so on. Code size increase is approximately 300-500 bytes.
794 If this option is not given then these functions will
795 silently discard their buffer size argument - this means
796 you are not getting any overflow checking in this case.
797
wdenkc6097192002-11-03 00:24:07 +0000798- Boot Delay: CONFIG_BOOTDELAY - in seconds
799 Delay before automatically booting the default image;
800 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000801 set to -2 to autoboot with no delay and not check for abort
802 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000803
804 See doc/README.autoboot for these options that
805 work with CONFIG_BOOTDELAY. None are required.
806 CONFIG_BOOT_RETRY_TIME
807 CONFIG_BOOT_RETRY_MIN
808 CONFIG_AUTOBOOT_KEYED
809 CONFIG_AUTOBOOT_PROMPT
810 CONFIG_AUTOBOOT_DELAY_STR
811 CONFIG_AUTOBOOT_STOP_STR
812 CONFIG_AUTOBOOT_DELAY_STR2
813 CONFIG_AUTOBOOT_STOP_STR2
814 CONFIG_ZERO_BOOTDELAY_CHECK
815 CONFIG_RESET_TO_RETRY
816
817- Autoboot Command:
818 CONFIG_BOOTCOMMAND
819 Only needed when CONFIG_BOOTDELAY is enabled;
820 define a command string that is automatically executed
821 when no character is read on the console interface
822 within "Boot Delay" after reset.
823
824 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000825 This can be used to pass arguments to the bootm
826 command. The value of CONFIG_BOOTARGS goes into the
827 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000828
829 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000830 The value of these goes into the environment as
831 "ramboot" and "nfsboot" respectively, and can be used
832 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200833 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000834
Heiko Schochereda0ba32013-11-04 14:04:59 +0100835- Bootcount:
836 CONFIG_BOOTCOUNT_LIMIT
837 Implements a mechanism for detecting a repeating reboot
838 cycle, see:
839 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
840
841 CONFIG_BOOTCOUNT_ENV
842 If no softreset save registers are found on the hardware
843 "bootcount" is stored in the environment. To prevent a
844 saveenv on all reboots, the environment variable
845 "upgrade_available" is used. If "upgrade_available" is
846 0, "bootcount" is always 0, if "upgrade_available" is
847 1 "bootcount" is incremented in the environment.
848 So the Userspace Applikation must set the "upgrade_available"
849 and "bootcount" variable to 0, if a boot was successfully.
850
wdenkc6097192002-11-03 00:24:07 +0000851- Pre-Boot Commands:
852 CONFIG_PREBOOT
853
854 When this option is #defined, the existence of the
855 environment variable "preboot" will be checked
856 immediately before starting the CONFIG_BOOTDELAY
857 countdown and/or running the auto-boot command resp.
858 entering interactive mode.
859
860 This feature is especially useful when "preboot" is
861 automatically generated or modified. For an example
862 see the LWMON board specific code: here "preboot" is
863 modified when the user holds down a certain
864 combination of keys on the (special) keyboard when
865 booting the systems
866
867- Serial Download Echo Mode:
868 CONFIG_LOADS_ECHO
869 If defined to 1, all characters received during a
870 serial download (using the "loads" command) are
871 echoed back. This might be needed by some terminal
872 emulations (like "cu"), but may as well just take
873 time on others. This setting #define's the initial
874 value of the "loads_echo" environment variable.
875
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500876- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000877 CONFIG_KGDB_BAUDRATE
878 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200879 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000880
881- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882 Monitor commands can be included or excluded
883 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000884 <config_cmd_all.h> and #undef'ing unwanted
885 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500886 and augmenting with additional #define's
887 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000888
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500889 The default command configuration includes all commands
890 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000891
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500893 CONFIG_CMD_BDI bdinfo
894 CONFIG_CMD_BEDBUG * Include BedBug Debugger
895 CONFIG_CMD_BMP * BMP support
896 CONFIG_CMD_BSP * Board specific commands
897 CONFIG_CMD_BOOTD bootd
898 CONFIG_CMD_CACHE * icache, dcache
899 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500900 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500901 CONFIG_CMD_DATE * support for RTC, date/time...
902 CONFIG_CMD_DHCP * DHCP support
903 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600904 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
905 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
906 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
907 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500908 CONFIG_CMD_DTT * Digital Therm and Thermostat
909 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500910 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500911 CONFIG_CMD_EEPROM * EEPROM read/write support
912 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600913 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600914 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500915 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500916 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000917 CONFIG_CMD_EXT2 * ext2 command support
918 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500919 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000921 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500922 CONFIG_CMD_FDOS * Dos diskette Support
923 CONFIG_CMD_FLASH flinfo, erase, protect
924 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200925 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000926 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500927 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000928 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000929 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500930 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
931 CONFIG_CMD_I2C * I2C serial bus support
932 CONFIG_CMD_IDE * IDE harddisk support
933 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000934 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200935 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500936 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500937 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000938 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500939 CONFIG_CMD_IRQ * irqinfo
940 CONFIG_CMD_ITEST Integer/string test of 2 values
941 CONFIG_CMD_JFFS2 * JFFS2 Support
942 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200943 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000944 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
945 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500946 CONFIG_CMD_LOADB loadb
947 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200948 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400949 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000950 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500951 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000952 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200953 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500954 CONFIG_CMD_MISC Misc functions like sleep etc
955 CONFIG_CMD_MMC * MMC memory mapped support
956 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100957 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500958 CONFIG_CMD_NAND * NAND support
959 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200960 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600961 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000962 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500963 CONFIG_CMD_PCI * pciinfo
964 CONFIG_CMD_PCMCIA * PCMCIA support
965 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
966 host
967 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000968 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500969 CONFIG_CMD_REGINFO * Register dump
970 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000971 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500972 CONFIG_CMD_SAVES * save S record dump
973 CONFIG_CMD_SCSI * SCSI Support
974 CONFIG_CMD_SDRAM * print SDRAM configuration information
975 (requires CONFIG_CMD_I2C)
976 CONFIG_CMD_SETGETDCR Support for DCR Register access
977 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700978 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200979 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400980 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800981 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200982 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500983 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000984 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000985 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000986 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
987 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500988 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000990 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200991 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000992
wdenkc6097192002-11-03 00:24:07 +0000993
994 EXAMPLE: If you want all functions except of network
995 support you can write:
996
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500997 #include "config_cmd_all.h"
998 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000999
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001000 Other Commands:
1001 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001002
1003 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001004 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001005 what you (and your U-Boot users) are doing. Data
1006 cache cannot be enabled on systems like the 8xx or
1007 8260 (where accesses to the IMMR region must be
1008 uncached), and it cannot be disabled on all other
1009 systems where we (mis-) use the data cache to hold an
1010 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001011
1012
1013 XXX - this list needs to get updated!
1014
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001015- Regular expression support:
1016 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001017 If this variable is defined, U-Boot is linked against
1018 the SLRE (Super Light Regular Expression) library,
1019 which adds regex support to some commands, as for
1020 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001021
Simon Glass45ba8072011-10-15 05:48:20 +00001022- Device tree:
1023 CONFIG_OF_CONTROL
1024 If this variable is defined, U-Boot will use a device tree
1025 to configure its devices, instead of relying on statically
1026 compiled #defines in the board file. This option is
1027 experimental and only available on a few boards. The device
1028 tree is available in the global data as gd->fdt_blob.
1029
Simon Glass2c0f79e2011-10-24 19:15:31 +00001030 U-Boot needs to get its device tree from somewhere. This can
1031 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001032
1033 CONFIG_OF_EMBED
1034 If this variable is defined, U-Boot will embed a device tree
1035 binary in its image. This device tree file should be in the
1036 board directory and called <soc>-<board>.dts. The binary file
1037 is then picked up in board_init_f() and made available through
1038 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001039
Simon Glass2c0f79e2011-10-24 19:15:31 +00001040 CONFIG_OF_SEPARATE
1041 If this variable is defined, U-Boot will build a device tree
1042 binary. It will be called u-boot.dtb. Architecture-specific
1043 code will locate it at run-time. Generally this works by:
1044
1045 cat u-boot.bin u-boot.dtb >image.bin
1046
1047 and in fact, U-Boot does this for you, creating a file called
1048 u-boot-dtb.bin which is useful in the common case. You can
1049 still use the individual files if you need something more
1050 exotic.
1051
wdenkc6097192002-11-03 00:24:07 +00001052- Watchdog:
1053 CONFIG_WATCHDOG
1054 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001055 support for the SoC. There must be support in the SoC
1056 specific code for a watchdog. For the 8xx and 8260
1057 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1058 register. When supported for a specific SoC is
1059 available, then no further board specific code should
1060 be needed to use it.
1061
1062 CONFIG_HW_WATCHDOG
1063 When using a watchdog circuitry external to the used
1064 SoC, then define this variable and provide board
1065 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001066
stroesec1551ea2003-04-04 15:53:41 +00001067- U-Boot Version:
1068 CONFIG_VERSION_VARIABLE
1069 If this variable is defined, an environment variable
1070 named "ver" is created by U-Boot showing the U-Boot
1071 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001072 Any change to this variable will be reverted at the
1073 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001074
wdenkc6097192002-11-03 00:24:07 +00001075- Real-Time Clock:
1076
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001077 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001078 has to be selected, too. Define exactly one of the
1079 following options:
1080
1081 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1082 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001083 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001084 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001085 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001086 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001087 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001088 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001089 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001090 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001091 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001092 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1093 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001094
wdenkb37c7e52003-06-30 16:24:52 +00001095 Note that if the RTC uses I2C, then the I2C interface
1096 must also be configured. See I2C Support, below.
1097
Peter Tysere92739d2008-12-17 16:36:21 -06001098- GPIO Support:
1099 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001100
Chris Packham5dec49c2010-12-19 10:12:13 +00001101 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1102 chip-ngpio pairs that tell the PCA953X driver the number of
1103 pins supported by a particular chip.
1104
Peter Tysere92739d2008-12-17 16:36:21 -06001105 Note that if the GPIO device uses I2C, then the I2C interface
1106 must also be configured. See I2C Support, below.
1107
wdenkc6097192002-11-03 00:24:07 +00001108- Timestamp Support:
1109
wdenk43d96162003-03-06 00:02:04 +00001110 When CONFIG_TIMESTAMP is selected, the timestamp
1111 (date and time) of an image is printed by image
1112 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001113 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001114
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001115- Partition Labels (disklabels) Supported:
1116 Zero or more of the following:
1117 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1118 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1119 Intel architecture, USB sticks, etc.
1120 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1121 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1122 bootloader. Note 2TB partition limit; see
1123 disk/part_efi.c
1124 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001125
Wolfgang Denk218ca722008-03-26 10:40:12 +01001126 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1127 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001128 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001129
1130- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001131 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1132 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001133
wdenk4d13cba2004-03-14 14:09:05 +00001134 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1135 be performed by calling the function
1136 ide_set_reset(int reset)
1137 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001138
1139- ATAPI Support:
1140 CONFIG_ATAPI
1141
1142 Set this to enable ATAPI support.
1143
wdenkc40b2952004-03-13 23:29:43 +00001144- LBA48 Support
1145 CONFIG_LBA48
1146
1147 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001148 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001149 Whithout these , LBA48 support uses 32bit variables and will 'only'
1150 support disks up to 2.1TB.
1151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001152 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001153 When enabled, makes the IDE subsystem use 64bit sector addresses.
1154 Default is 32bit.
1155
wdenkc6097192002-11-03 00:24:07 +00001156- SCSI Support:
1157 At the moment only there is only support for the
1158 SYM53C8XX SCSI controller; define
1159 CONFIG_SCSI_SYM53C8XX to enable it.
1160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001161 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1162 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1163 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001164 maximum numbers of LUNs, SCSI ID's and target
1165 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001166 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001167
Wolfgang Denk93e14592013-10-04 17:43:24 +02001168 The environment variable 'scsidevs' is set to the number of
1169 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001170
wdenkc6097192002-11-03 00:24:07 +00001171- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001172 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001173 Support for Intel 8254x/8257x gigabit chips.
1174
1175 CONFIG_E1000_SPI
1176 Utility code for direct access to the SPI bus on Intel 8257x.
1177 This does not do anything useful unless you set at least one
1178 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1179
1180 CONFIG_E1000_SPI_GENERIC
1181 Allow generic access to the SPI bus on the Intel 8257x, for
1182 example with the "sspi" command.
1183
1184 CONFIG_CMD_E1000
1185 Management command for E1000 devices. When used on devices
1186 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001187
Andre Schwarzac3315c2008-03-06 16:45:44 +01001188 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001189 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001190
wdenkc6097192002-11-03 00:24:07 +00001191 CONFIG_EEPRO100
1192 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001193 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001194 write routine for first time initialisation.
1195
1196 CONFIG_TULIP
1197 Support for Digital 2114x chips.
1198 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1199 modem chip initialisation (KS8761/QS6611).
1200
1201 CONFIG_NATSEMI
1202 Support for National dp83815 chips.
1203
1204 CONFIG_NS8382X
1205 Support for National dp8382[01] gigabit chips.
1206
wdenk45219c42003-05-12 21:50:16 +00001207- NETWORK Support (other):
1208
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001209 CONFIG_DRIVER_AT91EMAC
1210 Support for AT91RM9200 EMAC.
1211
1212 CONFIG_RMII
1213 Define this to use reduced MII inteface
1214
1215 CONFIG_DRIVER_AT91EMAC_QUIET
1216 If this defined, the driver is quiet.
1217 The driver doen't show link status messages.
1218
Rob Herringefdd7312011-12-15 11:15:49 +00001219 CONFIG_CALXEDA_XGMAC
1220 Support for the Calxeda XGMAC device
1221
Ashok3bb46d22012-10-15 06:20:47 +00001222 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001223 Support for SMSC's LAN91C96 chips.
1224
1225 CONFIG_LAN91C96_BASE
1226 Define this to hold the physical address
1227 of the LAN91C96's I/O space
1228
1229 CONFIG_LAN91C96_USE_32_BIT
1230 Define this to enable 32 bit addressing
1231
Ashok3bb46d22012-10-15 06:20:47 +00001232 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001233 Support for SMSC's LAN91C111 chip
1234
1235 CONFIG_SMC91111_BASE
1236 Define this to hold the physical address
1237 of the device (I/O space)
1238
1239 CONFIG_SMC_USE_32_BIT
1240 Define this if data bus is 32 bits
1241
1242 CONFIG_SMC_USE_IOFUNCS
1243 Define this to use i/o functions instead of macros
1244 (some hardware wont work with macros)
1245
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001246 CONFIG_DRIVER_TI_EMAC
1247 Support for davinci emac
1248
1249 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1250 Define this if you have more then 3 PHYs.
1251
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001252 CONFIG_FTGMAC100
1253 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1254
1255 CONFIG_FTGMAC100_EGIGA
1256 Define this to use GE link update with gigabit PHY.
1257 Define this if FTGMAC100 is connected to gigabit PHY.
1258 If your system has 10/100 PHY only, it might not occur
1259 wrong behavior. Because PHY usually return timeout or
1260 useless data when polling gigabit status and gigabit
1261 control registers. This behavior won't affect the
1262 correctnessof 10/100 link speed update.
1263
Mike Rapoportc2fff332009-11-11 10:03:03 +02001264 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001265 Support for SMSC's LAN911x and LAN921x chips
1266
Mike Rapoportc2fff332009-11-11 10:03:03 +02001267 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001268 Define this to hold the physical address
1269 of the device (I/O space)
1270
Mike Rapoportc2fff332009-11-11 10:03:03 +02001271 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001272 Define this if data bus is 32 bits
1273
Mike Rapoportc2fff332009-11-11 10:03:03 +02001274 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001275 Define this if data bus is 16 bits. If your processor
1276 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001277 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001278
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001279 CONFIG_SH_ETHER
1280 Support for Renesas on-chip Ethernet controller
1281
1282 CONFIG_SH_ETHER_USE_PORT
1283 Define the number of ports to be used
1284
1285 CONFIG_SH_ETHER_PHY_ADDR
1286 Define the ETH PHY's address
1287
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001288 CONFIG_SH_ETHER_CACHE_WRITEBACK
1289 If this option is set, the driver enables cache flush.
1290
Vadim Bendebury5e124722011-10-17 08:36:14 +00001291- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001292 CONFIG_TPM
1293 Support TPM devices.
1294
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001295 CONFIG_TPM_TIS_I2C
1296 Support for i2c bus TPM devices. Only one device
1297 per system is supported at this time.
1298
1299 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1300 Define the the i2c bus number for the TPM device
1301
1302 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1303 Define the TPM's address on the i2c bus
1304
1305 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1306 Define the burst count bytes upper limit
1307
Dirk Eibachc01939c2013-06-26 15:55:15 +02001308 CONFIG_TPM_ATMEL_TWI
1309 Support for Atmel TWI TPM device. Requires I2C support.
1310
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001311 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001312 Support for generic parallel port TPM devices. Only one device
1313 per system is supported at this time.
1314
1315 CONFIG_TPM_TIS_BASE_ADDRESS
1316 Base address where the generic TPM device is mapped
1317 to. Contemporary x86 systems usually map it at
1318 0xfed40000.
1319
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001320 CONFIG_CMD_TPM
1321 Add tpm monitor functions.
1322 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1323 provides monitor access to authorized functions.
1324
1325 CONFIG_TPM
1326 Define this to enable the TPM support library which provides
1327 functional interfaces to some TPM commands.
1328 Requires support for a TPM device.
1329
1330 CONFIG_TPM_AUTH_SESSIONS
1331 Define this to enable authorized functions in the TPM library.
1332 Requires CONFIG_TPM and CONFIG_SHA1.
1333
wdenkc6097192002-11-03 00:24:07 +00001334- USB Support:
1335 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001336 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001337 CONFIG_USB_UHCI to enable it.
1338 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001339 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001340 storage devices.
1341 Note:
1342 Supported are USB Keyboards and USB Floppy drives
1343 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001344 MPC5200 USB requires additional defines:
1345 CONFIG_USB_CLOCK
1346 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001347 CONFIG_PSC3_USB
1348 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001349 CONFIG_USB_CONFIG
1350 for differential drivers: 0x00001000
1351 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001352 for differential drivers on PSC3: 0x00000100
1353 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001354 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001355 May be defined to allow interrupt polling
1356 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001357
Simon Glass9ab4ce22012-02-27 10:52:47 +00001358 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1359 txfilltuning field in the EHCI controller on reset.
1360
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001361 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1362 interval for usb hub power-on delay.(minimum 100msec)
1363
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001364- USB Device:
1365 Define the below if you wish to use the USB console.
1366 Once firmware is rebuilt from a serial console issue the
1367 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001368 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001369 it has found a new device. The environment variable usbtty
1370 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001371 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001372 Common Device Class Abstract Control Model serial device.
1373 If you select usbtty = gserial you should be able to enumerate
1374 a Linux host by
1375 # modprobe usbserial vendor=0xVendorID product=0xProductID
1376 else if using cdc_acm, simply setting the environment
1377 variable usbtty to be cdc_acm should suffice. The following
1378 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001379
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001380 CONFIG_USB_DEVICE
1381 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001382
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001383 CONFIG_USB_TTY
1384 Define this to have a tty type of device available to
1385 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001386
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301387 CONFIG_USBD_HS
1388 Define this to enable the high speed support for usb
1389 device and usbtty. If this feature is enabled, a routine
1390 int is_usbd_high_speed(void)
1391 also needs to be defined by the driver to dynamically poll
1392 whether the enumeration has succeded at high speed or full
1393 speed.
1394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001395 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001396 Define this if you want stdin, stdout &/or stderr to
1397 be set to usbtty.
1398
1399 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001400 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001401 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001402 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001404 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001405 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001406 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001407
Wolfgang Denk386eda02006-06-14 18:14:56 +02001408 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001409 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001410 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001411 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1412 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1413 should pretend to be a Linux device to it's target host.
1414
1415 CONFIG_USBD_MANUFACTURER
1416 Define this string as the name of your company for
1417 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001418
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001419 CONFIG_USBD_PRODUCT_NAME
1420 Define this string as the name of your product
1421 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1422
1423 CONFIG_USBD_VENDORID
1424 Define this as your assigned Vendor ID from the USB
1425 Implementors Forum. This *must* be a genuine Vendor ID
1426 to avoid polluting the USB namespace.
1427 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001428
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001429 CONFIG_USBD_PRODUCTID
1430 Define this as the unique Product ID
1431 for your device
1432 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001433
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001434 Some USB device drivers may need to check USB cable attachment.
1435 In this case you can enable following config in BoardName.h:
1436 CONFIG_USB_CABLE_CHECK
1437 This enables function definition:
1438 - usb_cable_connected() in include/usb.h
1439 Implementation of this function is board-specific.
1440
Igor Grinbergd70a5602011-12-12 12:08:35 +02001441- ULPI Layer Support:
1442 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1443 the generic ULPI layer. The generic layer accesses the ULPI PHY
1444 via the platform viewport, so you need both the genric layer and
1445 the viewport enabled. Currently only Chipidea/ARC based
1446 viewport is supported.
1447 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1448 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001449 If your ULPI phy needs a different reference clock than the
1450 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1451 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001452
1453- MMC Support:
1454 The MMC controller on the Intel PXA is supported. To
1455 enable this define CONFIG_MMC. The MMC can be
1456 accessed from the boot prompt by mapping the device
1457 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001458 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1459 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001460
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001461 CONFIG_SH_MMCIF
1462 Support for Renesas on-chip MMCIF controller
1463
1464 CONFIG_SH_MMCIF_ADDR
1465 Define the base address of MMCIF registers
1466
1467 CONFIG_SH_MMCIF_CLK
1468 Define the clock frequency for MMCIF
1469
Tom Rinib3ba6e92013-03-14 05:32:47 +00001470- USB Device Firmware Update (DFU) class support:
1471 CONFIG_DFU_FUNCTION
1472 This enables the USB portion of the DFU USB class
1473
1474 CONFIG_CMD_DFU
1475 This enables the command "dfu" which is used to have
1476 U-Boot create a DFU class device via USB. This command
1477 requires that the "dfu_alt_info" environment variable be
1478 set and define the alt settings to expose to the host.
1479
1480 CONFIG_DFU_MMC
1481 This enables support for exposing (e)MMC devices via DFU.
1482
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001483 CONFIG_DFU_NAND
1484 This enables support for exposing NAND devices via DFU.
1485
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301486 CONFIG_DFU_RAM
1487 This enables support for exposing RAM via DFU.
1488 Note: DFU spec refer to non-volatile memory usage, but
1489 allow usages beyond the scope of spec - here RAM usage,
1490 one that would help mostly the developer.
1491
Heiko Schochere7e75c72013-06-12 06:05:51 +02001492 CONFIG_SYS_DFU_DATA_BUF_SIZE
1493 Dfu transfer uses a buffer before writing data to the
1494 raw storage device. Make the size (in bytes) of this buffer
1495 configurable. The size of this buffer is also configurable
1496 through the "dfu_bufsiz" environment variable.
1497
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001498 CONFIG_SYS_DFU_MAX_FILE_SIZE
1499 When updating files rather than the raw storage device,
1500 we use a static buffer to copy the file into and then write
1501 the buffer once we've been given the whole file. Define
1502 this to the maximum filesize (in bytes) for the buffer.
1503 Default is 4 MiB if undefined.
1504
wdenk6705d812004-08-02 23:22:59 +00001505- Journaling Flash filesystem support:
1506 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1507 CONFIG_JFFS2_NAND_DEV
1508 Define these for a default partition on a NAND device
1509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001510 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1511 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001512 Define these for a default partition on a NOR device
1513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001514 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001515 Define this to create an own partition. You have to provide a
1516 function struct part_info* jffs2_part_info(int part_num)
1517
1518 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001519 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001520 to disable the command chpart. This is the default when you
1521 have not defined a custom partition
1522
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001523- FAT(File Allocation Table) filesystem write function support:
1524 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001525
1526 Define this to enable support for saving memory data as a
1527 file in FAT formatted partition.
1528
1529 This will also enable the command "fatwrite" enabling the
1530 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001531
Gabe Black84cd9322012-10-12 14:26:11 +00001532CBFS (Coreboot Filesystem) support
1533 CONFIG_CMD_CBFS
1534
1535 Define this to enable support for reading from a Coreboot
1536 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1537 and cbfsload.
1538
wdenkc6097192002-11-03 00:24:07 +00001539- Keyboard Support:
1540 CONFIG_ISA_KEYBOARD
1541
1542 Define this to enable standard (PC-Style) keyboard
1543 support
1544
1545 CONFIG_I8042_KBD
1546 Standard PC keyboard driver with US (is default) and
1547 GERMAN key layout (switch via environment 'keymap=de') support.
1548 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1549 for cfb_console. Supports cursor blinking.
1550
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001551 CONFIG_CROS_EC_KEYB
1552 Enables a Chrome OS keyboard using the CROS_EC interface.
1553 This uses CROS_EC to communicate with a second microcontroller
1554 which provides key scans on request.
1555
wdenkc6097192002-11-03 00:24:07 +00001556- Video support:
1557 CONFIG_VIDEO
1558
1559 Define this to enable video support (for output to
1560 video).
1561
1562 CONFIG_VIDEO_CT69000
1563
1564 Enable Chips & Technologies 69000 Video chip
1565
1566 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001567 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001568 video output is selected via environment 'videoout'
1569 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1570 assumed.
wdenkc6097192002-11-03 00:24:07 +00001571
wdenkb79a11c2004-03-25 15:14:43 +00001572 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001573 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001574 are possible:
1575 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001576 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001577
1578 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1579 -------------+---------------------------------------------
1580 8 bits | 0x301* 0x303 0x305 0x161 0x307
1581 15 bits | 0x310 0x313 0x316 0x162 0x319
1582 16 bits | 0x311 0x314 0x317 0x163 0x31A
1583 24 bits | 0x312 0x315 0x318 ? 0x31B
1584 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001585 (i.e. setenv videomode 317; saveenv; reset;)
1586
wdenkb79a11c2004-03-25 15:14:43 +00001587 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001588 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001589
1590
stroesec1551ea2003-04-04 15:53:41 +00001591 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001592 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001593 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1594 or CONFIG_VIDEO_SED13806_16BPP
1595
Timur Tabi7d3053f2011-02-15 17:09:19 -06001596 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001597 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001598 SOCs that have a DIU should define this macro to enable DIU
1599 support, and should also define these other macros:
1600
1601 CONFIG_SYS_DIU_ADDR
1602 CONFIG_VIDEO
1603 CONFIG_CMD_BMP
1604 CONFIG_CFB_CONSOLE
1605 CONFIG_VIDEO_SW_CURSOR
1606 CONFIG_VGA_AS_SINGLE_DEVICE
1607 CONFIG_VIDEO_LOGO
1608 CONFIG_VIDEO_BMP_LOGO
1609
Timur Tabiba8e76b2011-04-11 14:18:22 -05001610 The DIU driver will look for the 'video-mode' environment
1611 variable, and if defined, enable the DIU as a console during
1612 boot. See the documentation file README.video for a
1613 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001614
Simon Glass058d59b2012-12-03 13:59:47 +00001615 CONFIG_VIDEO_VGA
1616
1617 Enable the VGA video / BIOS for x86. The alternative if you
1618 are using coreboot is to use the coreboot frame buffer
1619 driver.
1620
1621
wdenk682011f2003-06-03 23:54:09 +00001622- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001623 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001624
wdenk8bde7f72003-06-27 21:31:46 +00001625 Define this to enable a custom keyboard support.
1626 This simply calls drv_keyboard_init() which must be
1627 defined in your board-specific files.
1628 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001629
wdenkc6097192002-11-03 00:24:07 +00001630- LCD Support: CONFIG_LCD
1631
1632 Define this to enable LCD support (for output to LCD
1633 display); also select one of the supported displays
1634 by defining one of these:
1635
Stelian Pop39cf4802008-05-09 21:57:18 +02001636 CONFIG_ATMEL_LCD:
1637
1638 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1639
wdenkfd3103b2003-11-25 16:55:19 +00001640 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001641
wdenkfd3103b2003-11-25 16:55:19 +00001642 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001643
wdenkfd3103b2003-11-25 16:55:19 +00001644 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001645
wdenkfd3103b2003-11-25 16:55:19 +00001646 NEC NL6448BC20-08. 6.5", 640x480.
1647 Active, color, single scan.
1648
1649 CONFIG_NEC_NL6448BC33_54
1650
1651 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001652 Active, color, single scan.
1653
1654 CONFIG_SHARP_16x9
1655
1656 Sharp 320x240. Active, color, single scan.
1657 It isn't 16x9, and I am not sure what it is.
1658
1659 CONFIG_SHARP_LQ64D341
1660
1661 Sharp LQ64D341 display, 640x480.
1662 Active, color, single scan.
1663
1664 CONFIG_HLD1045
1665
1666 HLD1045 display, 640x480.
1667 Active, color, single scan.
1668
1669 CONFIG_OPTREX_BW
1670
1671 Optrex CBL50840-2 NF-FW 99 22 M5
1672 or
1673 Hitachi LMG6912RPFC-00T
1674 or
1675 Hitachi SP14Q002
1676
1677 320x240. Black & white.
1678
1679 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001680 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001681
Simon Glass676d3192012-10-17 13:24:54 +00001682 CONFIG_LCD_ALIGNMENT
1683
1684 Normally the LCD is page-aligned (tyically 4KB). If this is
1685 defined then the LCD will be aligned to this value instead.
1686 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1687 here, since it is cheaper to change data cache settings on
1688 a per-section basis.
1689
Simon Glass0d89efe2012-10-17 13:24:59 +00001690 CONFIG_CONSOLE_SCROLL_LINES
1691
1692 When the console need to be scrolled, this is the number of
1693 lines to scroll by. It defaults to 1. Increasing this makes
1694 the console jump but can help speed up operation when scrolling
1695 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001696
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001697 CONFIG_LCD_BMP_RLE8
1698
1699 Support drawing of RLE8-compressed bitmaps on the LCD.
1700
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001701 CONFIG_I2C_EDID
1702
1703 Enables an 'i2c edid' command which can read EDID
1704 information over I2C from an attached LCD display.
1705
wdenk7152b1d2003-09-05 23:19:14 +00001706- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001707
wdenk8bde7f72003-06-27 21:31:46 +00001708 If this option is set, the environment is checked for
1709 a variable "splashimage". If found, the usual display
1710 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001711 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001712 specified in "splashimage" is loaded instead. The
1713 console is redirected to the "nulldev", too. This
1714 allows for a "silent" boot where a splash screen is
1715 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001716
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001717 CONFIG_SPLASHIMAGE_GUARD
1718
1719 If this option is set, then U-Boot will prevent the environment
1720 variable "splashimage" from being set to a problematic address
1721 (see README.displaying-bmps and README.arm-unaligned-accesses).
1722 This option is useful for targets where, due to alignment
1723 restrictions, an improperly aligned BMP image will cause a data
1724 abort. If you think you will not have problems with unaligned
1725 accesses (for example because your toolchain prevents them)
1726 there is no need to set this option.
1727
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001728 CONFIG_SPLASH_SCREEN_ALIGN
1729
1730 If this option is set the splash image can be freely positioned
1731 on the screen. Environment variable "splashpos" specifies the
1732 position as "x,y". If a positive number is given it is used as
1733 number of pixel from left/top. If a negative number is given it
1734 is used as number of pixel from right/bottom. You can also
1735 specify 'm' for centering the image.
1736
1737 Example:
1738 setenv splashpos m,m
1739 => image at center of screen
1740
1741 setenv splashpos 30,20
1742 => image at x = 30 and y = 20
1743
1744 setenv splashpos -10,m
1745 => vertically centered image
1746 at x = dspWidth - bmpWidth - 9
1747
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001748- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1749
1750 If this option is set, additionally to standard BMP
1751 images, gzipped BMP images can be displayed via the
1752 splashscreen support or the bmp command.
1753
Anatolij Gustschind5011762010-03-15 14:50:25 +01001754- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1755
1756 If this option is set, 8-bit RLE compressed BMP images
1757 can be displayed via the splashscreen support or the
1758 bmp command.
1759
Lei Wenf2b96df2012-09-28 04:26:47 +00001760- Do compresssing for memory range:
1761 CONFIG_CMD_ZIP
1762
1763 If this option is set, it would use zlib deflate method
1764 to compress the specified memory at its best effort.
1765
wdenkc29fdfc2003-08-29 20:57:53 +00001766- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001767 CONFIG_GZIP
1768
1769 Enabled by default to support gzip compressed images.
1770
wdenkc29fdfc2003-08-29 20:57:53 +00001771 CONFIG_BZIP2
1772
1773 If this option is set, support for bzip2 compressed
1774 images is included. If not, only uncompressed and gzip
1775 compressed images are supported.
1776
wdenk42d1f032003-10-15 23:53:47 +00001777 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001778 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001779 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001780
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001781 CONFIG_LZMA
1782
1783 If this option is set, support for lzma compressed
1784 images is included.
1785
1786 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1787 requires an amount of dynamic memory that is given by the
1788 formula:
1789
1790 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1791
1792 Where lc and lp stand for, respectively, Literal context bits
1793 and Literal pos bits.
1794
1795 This value is upper-bounded by 14MB in the worst case. Anyway,
1796 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1797 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1798 a very small buffer.
1799
1800 Use the lzmainfo tool to determinate the lc and lp values and
1801 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001802 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001803
Kees Cook8ef70472013-08-16 07:59:12 -07001804 CONFIG_LZO
1805
1806 If this option is set, support for LZO compressed images
1807 is included.
1808
wdenk17ea1172004-06-06 21:51:03 +00001809- MII/PHY support:
1810 CONFIG_PHY_ADDR
1811
1812 The address of PHY on MII bus.
1813
1814 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1815
1816 The clock frequency of the MII bus
1817
1818 CONFIG_PHY_GIGE
1819
1820 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001821 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001822
1823 CONFIG_PHY_RESET_DELAY
1824
1825 Some PHY like Intel LXT971A need extra delay after
1826 reset before any MII register access is possible.
1827 For such PHY, set this option to the usec delay
1828 required. (minimum 300usec for LXT971A)
1829
1830 CONFIG_PHY_CMD_DELAY (ppc4xx)
1831
1832 Some PHY like Intel LXT971A need extra delay after
1833 command issued before MII status register can be read
1834
wdenkc6097192002-11-03 00:24:07 +00001835- Ethernet address:
1836 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001837 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001838 CONFIG_ETH2ADDR
1839 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001840 CONFIG_ETH4ADDR
1841 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001842
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001843 Define a default value for Ethernet address to use
1844 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001845 is not determined automatically.
1846
1847- IP address:
1848 CONFIG_IPADDR
1849
1850 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001851 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001852 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001853 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001854
1855- Server IP address:
1856 CONFIG_SERVERIP
1857
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001858 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001859 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001860 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001861
Robin Getz97cfe862009-07-21 12:15:28 -04001862 CONFIG_KEEP_SERVERADDR
1863
1864 Keeps the server's MAC address, in the env 'serveraddr'
1865 for passing to bootargs (like Linux's netconsole option)
1866
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001867- Gateway IP address:
1868 CONFIG_GATEWAYIP
1869
1870 Defines a default value for the IP address of the
1871 default router where packets to other networks are
1872 sent to.
1873 (Environment variable "gatewayip")
1874
1875- Subnet mask:
1876 CONFIG_NETMASK
1877
1878 Defines a default value for the subnet mask (or
1879 routing prefix) which is used to determine if an IP
1880 address belongs to the local subnet or needs to be
1881 forwarded through a router.
1882 (Environment variable "netmask")
1883
David Updegraff53a5c422007-06-11 10:41:07 -05001884- Multicast TFTP Mode:
1885 CONFIG_MCAST_TFTP
1886
1887 Defines whether you want to support multicast TFTP as per
1888 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001889 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001890 driver in use must provide a function: mcast() to join/leave a
1891 multicast group.
1892
wdenkc6097192002-11-03 00:24:07 +00001893- BOOTP Recovery Mode:
1894 CONFIG_BOOTP_RANDOM_DELAY
1895
1896 If you have many targets in a network that try to
1897 boot using BOOTP, you may want to avoid that all
1898 systems send out BOOTP requests at precisely the same
1899 moment (which would happen for instance at recovery
1900 from a power failure, when all systems will try to
1901 boot, thus flooding the BOOTP server. Defining
1902 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1903 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001904 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001905
1906 1st BOOTP request: delay 0 ... 1 sec
1907 2nd BOOTP request: delay 0 ... 2 sec
1908 3rd BOOTP request: delay 0 ... 4 sec
1909 4th and following
1910 BOOTP requests: delay 0 ... 8 sec
1911
stroesefe389a82003-08-28 14:17:32 +00001912- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001913 You can fine tune the DHCP functionality by defining
1914 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001915
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001916 CONFIG_BOOTP_SUBNETMASK
1917 CONFIG_BOOTP_GATEWAY
1918 CONFIG_BOOTP_HOSTNAME
1919 CONFIG_BOOTP_NISDOMAIN
1920 CONFIG_BOOTP_BOOTPATH
1921 CONFIG_BOOTP_BOOTFILESIZE
1922 CONFIG_BOOTP_DNS
1923 CONFIG_BOOTP_DNS2
1924 CONFIG_BOOTP_SEND_HOSTNAME
1925 CONFIG_BOOTP_NTPSERVER
1926 CONFIG_BOOTP_TIMEOFFSET
1927 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001928 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001929
Wilson Callan5d110f02007-07-28 10:56:13 -04001930 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1931 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001932
Joe Hershberger2c00e092012-05-23 07:59:19 +00001933 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1934 after the configured retry count, the call will fail
1935 instead of starting over. This can be used to fail over
1936 to Link-local IP address configuration if the DHCP server
1937 is not available.
1938
stroesefe389a82003-08-28 14:17:32 +00001939 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1940 serverip from a DHCP server, it is possible that more
1941 than one DNS serverip is offered to the client.
1942 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1943 serverip will be stored in the additional environment
1944 variable "dnsip2". The first DNS serverip is always
1945 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001946 is defined.
stroesefe389a82003-08-28 14:17:32 +00001947
1948 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1949 to do a dynamic update of a DNS server. To do this, they
1950 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001951 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001952 of the "hostname" environment variable is passed as
1953 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001954
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001955 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1956
1957 A 32bit value in microseconds for a delay between
1958 receiving a "DHCP Offer" and sending the "DHCP Request".
1959 This fixes a problem with certain DHCP servers that don't
1960 respond 100% of the time to a "DHCP request". E.g. On an
1961 AT91RM9200 processor running at 180MHz, this delay needed
1962 to be *at least* 15,000 usec before a Windows Server 2003
1963 DHCP server would reply 100% of the time. I recommend at
1964 least 50,000 usec to be safe. The alternative is to hope
1965 that one of the retries will be successful but note that
1966 the DHCP timeout and retry process takes a longer than
1967 this delay.
1968
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001969 - Link-local IP address negotiation:
1970 Negotiate with other link-local clients on the local network
1971 for an address that doesn't require explicit configuration.
1972 This is especially useful if a DHCP server cannot be guaranteed
1973 to exist in all environments that the device must operate.
1974
1975 See doc/README.link-local for more information.
1976
wdenka3d991b2004-04-15 21:48:45 +00001977 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001978 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001979
1980 The device id used in CDP trigger frames.
1981
1982 CONFIG_CDP_DEVICE_ID_PREFIX
1983
1984 A two character string which is prefixed to the MAC address
1985 of the device.
1986
1987 CONFIG_CDP_PORT_ID
1988
1989 A printf format string which contains the ascii name of
1990 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001991 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001992
1993 CONFIG_CDP_CAPABILITIES
1994
1995 A 32bit integer which indicates the device capabilities;
1996 0x00000010 for a normal host which does not forwards.
1997
1998 CONFIG_CDP_VERSION
1999
2000 An ascii string containing the version of the software.
2001
2002 CONFIG_CDP_PLATFORM
2003
2004 An ascii string containing the name of the platform.
2005
2006 CONFIG_CDP_TRIGGER
2007
2008 A 32bit integer sent on the trigger.
2009
2010 CONFIG_CDP_POWER_CONSUMPTION
2011
2012 A 16bit integer containing the power consumption of the
2013 device in .1 of milliwatts.
2014
2015 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2016
2017 A byte containing the id of the VLAN.
2018
wdenkc6097192002-11-03 00:24:07 +00002019- Status LED: CONFIG_STATUS_LED
2020
2021 Several configurations allow to display the current
2022 status using a LED. For instance, the LED will blink
2023 fast while running U-Boot code, stop blinking as
2024 soon as a reply to a BOOTP request was received, and
2025 start blinking slow once the Linux kernel is running
2026 (supported by a status LED driver in the Linux
2027 kernel). Defining CONFIG_STATUS_LED enables this
2028 feature in U-Boot.
2029
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002030 Additional options:
2031
2032 CONFIG_GPIO_LED
2033 The status LED can be connected to a GPIO pin.
2034 In such cases, the gpio_led driver can be used as a
2035 status LED backend implementation. Define CONFIG_GPIO_LED
2036 to include the gpio_led driver in the U-Boot binary.
2037
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002038 CONFIG_GPIO_LED_INVERTED_TABLE
2039 Some GPIO connected LEDs may have inverted polarity in which
2040 case the GPIO high value corresponds to LED off state and
2041 GPIO low value corresponds to LED on state.
2042 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2043 with a list of GPIO LEDs that have inverted polarity.
2044
wdenkc6097192002-11-03 00:24:07 +00002045- CAN Support: CONFIG_CAN_DRIVER
2046
2047 Defining CONFIG_CAN_DRIVER enables CAN driver support
2048 on those systems that support this (optional)
2049 feature, like the TQM8xxL modules.
2050
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002051- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002052
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002053 This enable the NEW i2c subsystem, and will allow you to use
2054 i2c commands at the u-boot command line (as long as you set
2055 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2056 based realtime clock chips or other i2c devices. See
2057 common/cmd_i2c.c for a description of the command line
2058 interface.
2059
2060 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002061 - drivers/i2c/soft_i2c.c:
2062 - activate first bus with CONFIG_SYS_I2C_SOFT define
2063 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2064 for defining speed and slave address
2065 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2066 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2067 for defining speed and slave address
2068 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2069 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2070 for defining speed and slave address
2071 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2072 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2073 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002074
Heiko Schocher00f792e2012-10-24 13:48:22 +02002075 - drivers/i2c/fsl_i2c.c:
2076 - activate i2c driver with CONFIG_SYS_I2C_FSL
2077 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2078 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2079 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2080 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002081 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002082 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2083 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2084 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2085 second bus.
2086
Simon Glass1f2ba722012-10-30 07:28:53 +00002087 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002088 - activate this driver with CONFIG_SYS_I2C_TEGRA
2089 - This driver adds 4 i2c buses with a fix speed from
2090 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002091
Dirk Eibach880540d2013-04-25 02:40:01 +00002092 - drivers/i2c/ppc4xx_i2c.c
2093 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2094 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2095 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2096
tremfac96402013-09-21 18:13:35 +02002097 - drivers/i2c/i2c_mxc.c
2098 - activate this driver with CONFIG_SYS_I2C_MXC
2099 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2100 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2101 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2102 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2103 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2104 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2105 If thoses defines are not set, default value is 100000
2106 for speed, and 0 for slave.
2107
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002108 - drivers/i2c/rcar_i2c.c:
2109 - activate this driver with CONFIG_SYS_I2C_RCAR
2110 - This driver adds 4 i2c buses
2111
2112 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2113 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2114 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2115 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2116 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2117 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2118 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2119 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2120 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2121
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002122 - drivers/i2c/sh_i2c.c:
2123 - activate this driver with CONFIG_SYS_I2C_SH
2124 - This driver adds from 2 to 5 i2c buses
2125
2126 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2127 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2128 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2129 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2130 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2131 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2132 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2133 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2134 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2135 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2136 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2137 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2138 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2139
Heiko Schocher6789e842013-10-22 11:03:18 +02002140 - drivers/i2c/omap24xx_i2c.c
2141 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2142 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2143 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2144 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2145 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2146 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2147 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2148 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2149 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2150 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2151 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2152
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002153 - drivers/i2c/zynq_i2c.c
2154 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2155 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2156 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2157
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302158 - drivers/i2c/s3c24x0_i2c.c:
2159 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2160 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2161 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2162 with a fix speed from 100000 and the slave addr 0!
2163
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002164 additional defines:
2165
2166 CONFIG_SYS_NUM_I2C_BUSES
2167 Hold the number of i2c busses you want to use. If you
2168 don't use/have i2c muxes on your i2c bus, this
2169 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2170 omit this define.
2171
2172 CONFIG_SYS_I2C_DIRECT_BUS
2173 define this, if you don't use i2c muxes on your hardware.
2174 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2175 omit this define.
2176
2177 CONFIG_SYS_I2C_MAX_HOPS
2178 define how many muxes are maximal consecutively connected
2179 on one i2c bus. If you not use i2c muxes, omit this
2180 define.
2181
2182 CONFIG_SYS_I2C_BUSES
2183 hold a list of busses you want to use, only used if
2184 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2185 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2186 CONFIG_SYS_NUM_I2C_BUSES = 9:
2187
2188 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2189 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2190 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2191 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2192 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2193 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2194 {1, {I2C_NULL_HOP}}, \
2195 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2196 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2197 }
2198
2199 which defines
2200 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002201 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2202 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2203 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2204 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2205 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002206 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002207 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2208 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002209
2210 If you do not have i2c muxes on your board, omit this define.
2211
Heiko Schocherea818db2013-01-29 08:53:15 +01002212- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002213
2214 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2215 provides the following compelling advantages:
2216
2217 - more than one i2c adapter is usable
2218 - approved multibus support
2219 - better i2c mux support
2220
2221 ** Please consider updating your I2C driver now. **
2222
Heiko Schocherea818db2013-01-29 08:53:15 +01002223 These enable legacy I2C serial bus commands. Defining
2224 CONFIG_HARD_I2C will include the appropriate I2C driver
2225 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk945af8d2003-07-16 21:53:01 +00002227 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002228 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002229 CONFIG_COMMANDS) and communicate with i2c based realtime
2230 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002231 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002232
Ben Warrenbb99ad62006-09-07 16:50:54 -04002233 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002234
wdenk945af8d2003-07-16 21:53:01 +00002235 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002236 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002238 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002239 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002240 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002241 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002242
Peter Tyser8d321b82010-04-12 22:28:21 -05002243 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002244 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002245 and so its address should therefore be cleared to 0 (See,
2246 eg, MPC823e User's Manual p.16-473). So, set
2247 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002248
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002249 CONFIG_SYS_I2C_INIT_MPC5XXX
2250
2251 When a board is reset during an i2c bus transfer
2252 chips might think that the current transfer is still
2253 in progress. Reset the slave devices by sending start
2254 commands until the slave device responds.
2255
wdenk945af8d2003-07-16 21:53:01 +00002256 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002257
Heiko Schocherea818db2013-01-29 08:53:15 +01002258 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002259 then the following macros need to be defined (examples are
2260 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002261
2262 I2C_INIT
2263
wdenkb37c7e52003-06-30 16:24:52 +00002264 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002265 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002266
wdenkba56f622004-02-06 23:19:44 +00002267 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002268
wdenkc6097192002-11-03 00:24:07 +00002269 I2C_PORT
2270
wdenk43d96162003-03-06 00:02:04 +00002271 (Only for MPC8260 CPU). The I/O port to use (the code
2272 assumes both bits are on the same port). Valid values
2273 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002274
2275 I2C_ACTIVE
2276
2277 The code necessary to make the I2C data line active
2278 (driven). If the data line is open collector, this
2279 define can be null.
2280
wdenkb37c7e52003-06-30 16:24:52 +00002281 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2282
wdenkc6097192002-11-03 00:24:07 +00002283 I2C_TRISTATE
2284
2285 The code necessary to make the I2C data line tri-stated
2286 (inactive). If the data line is open collector, this
2287 define can be null.
2288
wdenkb37c7e52003-06-30 16:24:52 +00002289 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2290
wdenkc6097192002-11-03 00:24:07 +00002291 I2C_READ
2292
York Sun472d5462013-04-01 11:29:11 -07002293 Code that returns true if the I2C data line is high,
2294 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002295
wdenkb37c7e52003-06-30 16:24:52 +00002296 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2297
wdenkc6097192002-11-03 00:24:07 +00002298 I2C_SDA(bit)
2299
York Sun472d5462013-04-01 11:29:11 -07002300 If <bit> is true, sets the I2C data line high. If it
2301 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002302
wdenkb37c7e52003-06-30 16:24:52 +00002303 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002304 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002305 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002306
wdenkc6097192002-11-03 00:24:07 +00002307 I2C_SCL(bit)
2308
York Sun472d5462013-04-01 11:29:11 -07002309 If <bit> is true, sets the I2C clock line high. If it
2310 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002311
wdenkb37c7e52003-06-30 16:24:52 +00002312 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002313 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002314 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002315
wdenkc6097192002-11-03 00:24:07 +00002316 I2C_DELAY
2317
2318 This delay is invoked four times per clock cycle so this
2319 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002320 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002321 like:
2322
wdenkb37c7e52003-06-30 16:24:52 +00002323 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002324
Mike Frysinger793b5722010-07-21 13:38:02 -04002325 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2326
2327 If your arch supports the generic GPIO framework (asm/gpio.h),
2328 then you may alternatively define the two GPIOs that are to be
2329 used as SCL / SDA. Any of the previous I2C_xxx macros will
2330 have GPIO-based defaults assigned to them as appropriate.
2331
2332 You should define these to the GPIO value as given directly to
2333 the generic GPIO functions.
2334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002336
wdenk8bde7f72003-06-27 21:31:46 +00002337 When a board is reset during an i2c bus transfer
2338 chips might think that the current transfer is still
2339 in progress. On some boards it is possible to access
2340 the i2c SCLK line directly, either by using the
2341 processor pin as a GPIO or by having a second pin
2342 connected to the bus. If this option is defined a
2343 custom i2c_init_board() routine in boards/xxx/board.c
2344 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002345
Richard Retanubun26a33502010-04-12 15:08:17 -04002346 CONFIG_SYS_I2C_BOARD_LATE_INIT
2347
2348 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2349 defined a custom i2c_board_late_init() routine in
2350 boards/xxx/board.c is run AFTER the operations in i2c_init()
2351 is completed. This callpoint can be used to unreset i2c bus
2352 using CPU i2c controller register accesses for CPUs whose i2c
2353 controller provide such a method. It is called at the end of
2354 i2c_init() to allow i2c_init operations to setup the i2c bus
2355 controller on the CPU (e.g. setting bus speed & slave address).
2356
wdenk17ea1172004-06-06 21:51:03 +00002357 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2358
2359 This option enables configuration of bi_iic_fast[] flags
2360 in u-boot bd_info structure based on u-boot environment
2361 variable "i2cfast". (see also i2cfast)
2362
Ben Warrenbb99ad62006-09-07 16:50:54 -04002363 CONFIG_I2C_MULTI_BUS
2364
2365 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002366 must have a controller. At any point in time, only one bus is
2367 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002368 Note that bus numbering is zero-based.
2369
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002370 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002371
2372 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002373 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002374 is set, specify a list of bus-device pairs. Otherwise, specify
2375 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002376
2377 e.g.
2378 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002379 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002380
2381 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2382
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002383 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002384 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002385
2386 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002389
2390 If defined, then this indicates the I2C bus number for DDR SPD.
2391 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002394
2395 If defined, then this indicates the I2C bus number for the RTC.
2396 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002398 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002399
2400 If defined, then this indicates the I2C bus number for the DTT.
2401 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002403 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002404
2405 If defined, specifies the I2C address of the DTT device.
2406 If not defined, then U-Boot uses predefined value for
2407 specified DTT device.
2408
Andrew Dyer2ac69852008-12-29 17:36:01 -06002409 CONFIG_SOFT_I2C_READ_REPEATED_START
2410
2411 defining this will force the i2c_read() function in
2412 the soft_i2c driver to perform an I2C repeated start
2413 between writing the address pointer and reading the
2414 data. If this define is omitted the default behaviour
2415 of doing a stop-start sequence will be used. Most I2C
2416 devices can use either method, but some require one or
2417 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002418
wdenkc6097192002-11-03 00:24:07 +00002419- SPI Support: CONFIG_SPI
2420
2421 Enables SPI driver (so far only tested with
2422 SPI EEPROM, also an instance works with Crystal A/D and
2423 D/As on the SACSng board)
2424
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002425 CONFIG_SH_SPI
2426
2427 Enables the driver for SPI controller on SuperH. Currently
2428 only SH7757 is supported.
2429
wdenkc6097192002-11-03 00:24:07 +00002430 CONFIG_SPI_X
2431
2432 Enables extended (16-bit) SPI EEPROM addressing.
2433 (symmetrical to CONFIG_I2C_X)
2434
2435 CONFIG_SOFT_SPI
2436
wdenk43d96162003-03-06 00:02:04 +00002437 Enables a software (bit-bang) SPI driver rather than
2438 using hardware support. This is a general purpose
2439 driver that only requires three general I/O port pins
2440 (two outputs, one input) to function. If this is
2441 defined, the board configuration must define several
2442 SPI configuration items (port pins to use, etc). For
2443 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002444
Ben Warren04a9e112008-01-16 22:37:35 -05002445 CONFIG_HARD_SPI
2446
2447 Enables a hardware SPI driver for general-purpose reads
2448 and writes. As with CONFIG_SOFT_SPI, the board configuration
2449 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002450 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002451 example, see include/configs/mpc8349emds.h.
2452
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002453 CONFIG_MXC_SPI
2454
2455 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002456 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002457
Matthias Fuchs01335022007-12-27 17:12:34 +01002458- FPGA Support: CONFIG_FPGA
2459
2460 Enables FPGA subsystem.
2461
2462 CONFIG_FPGA_<vendor>
2463
2464 Enables support for specific chip vendors.
2465 (ALTERA, XILINX)
2466
2467 CONFIG_FPGA_<family>
2468
2469 Enables support for FPGA family.
2470 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2471
2472 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002473
wdenk43d96162003-03-06 00:02:04 +00002474 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002476 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002477
wdenk8bde7f72003-06-27 21:31:46 +00002478 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002479
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002480 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002481
wdenk43d96162003-03-06 00:02:04 +00002482 Enable checks on FPGA configuration interface busy
2483 status by the configuration function. This option
2484 will require a board or device specific function to
2485 be written.
wdenkc6097192002-11-03 00:24:07 +00002486
2487 CONFIG_FPGA_DELAY
2488
2489 If defined, a function that provides delays in the FPGA
2490 configuration driver.
2491
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002492 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002493 Allow Control-C to interrupt FPGA configuration
2494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002495 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002496
wdenk43d96162003-03-06 00:02:04 +00002497 Check for configuration errors during FPGA bitfile
2498 loading. For example, abort during Virtex II
2499 configuration if the INIT_B line goes low (which
2500 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002502 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002503
wdenk43d96162003-03-06 00:02:04 +00002504 Maximum time to wait for the INIT_B line to deassert
2505 after PROB_B has been deasserted during a Virtex II
2506 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002507 ms.
wdenkc6097192002-11-03 00:24:07 +00002508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002509 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002510
wdenk43d96162003-03-06 00:02:04 +00002511 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002512 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002514 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002515
wdenk43d96162003-03-06 00:02:04 +00002516 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002517 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002518
2519- Configuration Management:
2520 CONFIG_IDENT_STRING
2521
wdenk43d96162003-03-06 00:02:04 +00002522 If defined, this string will be added to the U-Boot
2523 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002524
2525- Vendor Parameter Protection:
2526
wdenk43d96162003-03-06 00:02:04 +00002527 U-Boot considers the values of the environment
2528 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002529 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002530 are set once by the board vendor / manufacturer, and
2531 protects these variables from casual modification by
2532 the user. Once set, these variables are read-only,
2533 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002534 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002535
2536 If CONFIG_ENV_OVERWRITE is #defined in your config
2537 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002538 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002539 these parameters.
2540
2541 Alternatively, if you #define _both_ CONFIG_ETHADDR
2542 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002543 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002544 which can be changed exactly ONCE by the user. [The
2545 serial# is unaffected by this, i. e. it remains
2546 read-only.]
2547
Joe Hershberger25980902012-12-11 22:16:31 -06002548 The same can be accomplished in a more flexible way
2549 for any variable by configuring the type of access
2550 to allow for those variables in the ".flags" variable
2551 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2552
wdenkc6097192002-11-03 00:24:07 +00002553- Protected RAM:
2554 CONFIG_PRAM
2555
2556 Define this variable to enable the reservation of
2557 "protected RAM", i. e. RAM which is not overwritten
2558 by U-Boot. Define CONFIG_PRAM to hold the number of
2559 kB you want to reserve for pRAM. You can overwrite
2560 this default value by defining an environment
2561 variable "pram" to the number of kB you want to
2562 reserve. Note that the board info structure will
2563 still show the full amount of RAM. If pRAM is
2564 reserved, a new environment variable "mem" will
2565 automatically be defined to hold the amount of
2566 remaining RAM in a form that can be passed as boot
2567 argument to Linux, for instance like that:
2568
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002569 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002570 saveenv
2571
2572 This way you can tell Linux not to use this memory,
2573 either, which results in a memory region that will
2574 not be affected by reboots.
2575
2576 *WARNING* If your board configuration uses automatic
2577 detection of the RAM size, you must make sure that
2578 this memory test is non-destructive. So far, the
2579 following board configurations are known to be
2580 "pRAM-clean":
2581
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002582 IVMS8, IVML24, SPD8xx, TQM8xxL,
2583 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002584 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002585
Gabe Black40fef042012-12-02 04:55:18 +00002586- Access to physical memory region (> 4GB)
2587 Some basic support is provided for operations on memory not
2588 normally accessible to U-Boot - e.g. some architectures
2589 support access to more than 4GB of memory on 32-bit
2590 machines using physical address extension or similar.
2591 Define CONFIG_PHYSMEM to access this basic support, which
2592 currently only supports clearing the memory.
2593
wdenkc6097192002-11-03 00:24:07 +00002594- Error Recovery:
2595 CONFIG_PANIC_HANG
2596
2597 Define this variable to stop the system in case of a
2598 fatal error, so that you have to reset it manually.
2599 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002600 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002601 automatically as fast as possible, but it may be
2602 useful during development since you can try to debug
2603 the conditions that lead to the situation.
2604
2605 CONFIG_NET_RETRY_COUNT
2606
wdenk43d96162003-03-06 00:02:04 +00002607 This variable defines the number of retries for
2608 network operations like ARP, RARP, TFTP, or BOOTP
2609 before giving up the operation. If not defined, a
2610 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002611
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002612 CONFIG_ARP_TIMEOUT
2613
2614 Timeout waiting for an ARP reply in milliseconds.
2615
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002616 CONFIG_NFS_TIMEOUT
2617
2618 Timeout in milliseconds used in NFS protocol.
2619 If you encounter "ERROR: Cannot umount" in nfs command,
2620 try longer timeout such as
2621 #define CONFIG_NFS_TIMEOUT 10000UL
2622
wdenkc6097192002-11-03 00:24:07 +00002623- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002624 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002625
2626 Enable auto completion of commands using TAB.
2627
Wolfgang Denka9398e02006-11-27 15:32:42 +01002628 Note that this feature has NOT been implemented yet
2629 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002630
2631
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002632 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002633
2634 Define this variable to enable the "hush" shell (from
2635 Busybox) as command line interpreter, thus enabling
2636 powerful command line syntax like
2637 if...then...else...fi conditionals or `&&' and '||'
2638 constructs ("shell scripts").
2639
2640 If undefined, you get the old, much simpler behaviour
2641 with a somewhat smaller memory footprint.
2642
2643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002644 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002645
2646 This defines the secondary prompt string, which is
2647 printed when the command interpreter needs more input
2648 to complete a command. Usually "> ".
2649
2650 Note:
2651
wdenk8bde7f72003-06-27 21:31:46 +00002652 In the current implementation, the local variables
2653 space and global environment variables space are
2654 separated. Local variables are those you define by
2655 simply typing `name=value'. To access a local
2656 variable later on, you have write `$name' or
2657 `${name}'; to execute the contents of a variable
2658 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002659
wdenk43d96162003-03-06 00:02:04 +00002660 Global environment variables are those you use
2661 setenv/printenv to work with. To run a command stored
2662 in such a variable, you need to use the run command,
2663 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002664
2665 To store commands and special characters in a
2666 variable, please use double quotation marks
2667 surrounding the whole text of the variable, instead
2668 of the backslashes before semicolons and special
2669 symbols.
2670
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002671- Commandline Editing and History:
2672 CONFIG_CMDLINE_EDITING
2673
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002674 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002675 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002676
wdenka8c7c702003-12-06 19:49:23 +00002677- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002678 CONFIG_EXTRA_ENV_SETTINGS
2679
wdenk43d96162003-03-06 00:02:04 +00002680 Define this to contain any number of null terminated
2681 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002682 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002683
wdenk43d96162003-03-06 00:02:04 +00002684 For example, place something like this in your
2685 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002686
2687 #define CONFIG_EXTRA_ENV_SETTINGS \
2688 "myvar1=value1\0" \
2689 "myvar2=value2\0"
2690
wdenk43d96162003-03-06 00:02:04 +00002691 Warning: This method is based on knowledge about the
2692 internal format how the environment is stored by the
2693 U-Boot code. This is NOT an official, exported
2694 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002695 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002696 You better know what you are doing here.
2697
wdenk43d96162003-03-06 00:02:04 +00002698 Note: overly (ab)use of the default environment is
2699 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002700 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002701 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002702
Stephen Warren5e724ca2012-05-22 09:21:54 +00002703 CONFIG_ENV_VARS_UBOOT_CONFIG
2704
2705 Define this in order to add variables describing the
2706 U-Boot build configuration to the default environment.
2707 These will be named arch, cpu, board, vendor, and soc.
2708
2709 Enabling this option will cause the following to be defined:
2710
2711 - CONFIG_SYS_ARCH
2712 - CONFIG_SYS_CPU
2713 - CONFIG_SYS_BOARD
2714 - CONFIG_SYS_VENDOR
2715 - CONFIG_SYS_SOC
2716
Tom Rini7e27f892012-10-24 07:28:16 +00002717 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2718
2719 Define this in order to add variables describing certain
2720 run-time determined information about the hardware to the
2721 environment. These will be named board_name, board_rev.
2722
Simon Glass06fd8532012-11-30 13:01:17 +00002723 CONFIG_DELAY_ENVIRONMENT
2724
2725 Normally the environment is loaded when the board is
2726 intialised so that it is available to U-Boot. This inhibits
2727 that so that the environment is not available until
2728 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2729 this is instead controlled by the value of
2730 /config/load-environment.
2731
wdenka8c7c702003-12-06 19:49:23 +00002732- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002733 CONFIG_HAS_DATAFLASH
2734
wdenk8bde7f72003-06-27 21:31:46 +00002735 Defining this option enables DataFlash features and
2736 allows to read/write in Dataflash via the standard
2737 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002738
Eric Nelsonf61ec452012-01-31 10:52:08 -07002739- Serial Flash support
2740 CONFIG_CMD_SF
2741
2742 Defining this option enables SPI flash commands
2743 'sf probe/read/write/erase/update'.
2744
2745 Usage requires an initial 'probe' to define the serial
2746 flash parameters, followed by read/write/erase/update
2747 commands.
2748
2749 The following defaults may be provided by the platform
2750 to handle the common case when only a single serial
2751 flash is present on the system.
2752
2753 CONFIG_SF_DEFAULT_BUS Bus identifier
2754 CONFIG_SF_DEFAULT_CS Chip-select
2755 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2756 CONFIG_SF_DEFAULT_SPEED in Hz
2757
Simon Glass24007272012-10-08 13:16:02 +00002758 CONFIG_CMD_SF_TEST
2759
2760 Define this option to include a destructive SPI flash
2761 test ('sf test').
2762
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302763 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2764
2765 Define this option to use the Bank addr/Extended addr
2766 support on SPI flashes which has size > 16Mbytes.
2767
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302768 CONFIG_SF_DUAL_FLASH Dual flash memories
2769
2770 Define this option to use dual flash support where two flash
2771 memories can be connected with a given cs line.
2772 currently Xilinx Zynq qspi support these type of connections.
2773
wdenk3f85ce22004-02-23 16:11:30 +00002774- SystemACE Support:
2775 CONFIG_SYSTEMACE
2776
2777 Adding this option adds support for Xilinx SystemACE
2778 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002779 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002781
2782 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002783 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002784
2785 When SystemACE support is added, the "ace" device type
2786 becomes available to the fat commands, i.e. fatls.
2787
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002788- TFTP Fixed UDP Port:
2789 CONFIG_TFTP_PORT
2790
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002791 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002792 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002793 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002794 number generator is used.
2795
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002796 Also, the environment variable tftpdstp is used to supply
2797 the TFTP UDP destination port value. If tftpdstp isn't
2798 defined, the normal port 69 is used.
2799
2800 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002801 blindly start the TFTP transfer using the pre-configured
2802 target IP address and UDP port. This has the effect of
2803 "punching through" the (Windows XP) firewall, allowing
2804 the remainder of the TFTP transfer to proceed normally.
2805 A better solution is to properly configure the firewall,
2806 but sometimes that is not allowed.
2807
Simon Glassbf36c5d2012-12-05 14:46:38 +00002808- Hashing support:
2809 CONFIG_CMD_HASH
2810
2811 This enables a generic 'hash' command which can produce
2812 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2813
2814 CONFIG_HASH_VERIFY
2815
2816 Enable the hash verify command (hash -v). This adds to code
2817 size a little.
2818
2819 CONFIG_SHA1 - support SHA1 hashing
2820 CONFIG_SHA256 - support SHA256 hashing
2821
2822 Note: There is also a sha1sum command, which should perhaps
2823 be deprecated in favour of 'hash sha1'.
2824
Robert Winklera11f1872013-07-24 17:57:06 -07002825- Freescale i.MX specific commands:
2826 CONFIG_CMD_HDMIDETECT
2827 This enables 'hdmidet' command which returns true if an
2828 HDMI monitor is detected. This command is i.MX 6 specific.
2829
2830 CONFIG_CMD_BMODE
2831 This enables the 'bmode' (bootmode) command for forcing
2832 a boot from specific media.
2833
2834 This is useful for forcing the ROM's usb downloader to
2835 activate upon a watchdog reset which is nice when iterating
2836 on U-Boot. Using the reset button or running bmode normal
2837 will set it back to normal. This command currently
2838 supports i.MX53 and i.MX6.
2839
Simon Glass19c402a2013-06-13 15:10:02 -07002840- Signing support:
2841 CONFIG_RSA
2842
2843 This enables the RSA algorithm used for FIT image verification
2844 in U-Boot. See doc/uImage/signature for more information.
2845
2846 The signing part is build into mkimage regardless of this
2847 option.
2848
2849
wdenka8c7c702003-12-06 19:49:23 +00002850- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002851 CONFIG_SHOW_BOOT_PROGRESS
2852
wdenk43d96162003-03-06 00:02:04 +00002853 Defining this option allows to add some board-
2854 specific code (calling a user-provided function
2855 "show_boot_progress(int)") that enables you to show
2856 the system's boot progress on some display (for
2857 example, some LED's) on your board. At the moment,
2858 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002859
Simon Glass3a608ca2012-02-13 13:51:19 +00002860- Detailed boot stage timing
2861 CONFIG_BOOTSTAGE
2862 Define this option to get detailed timing of each stage
2863 of the boot process.
2864
2865 CONFIG_BOOTSTAGE_USER_COUNT
2866 This is the number of available user bootstage records.
2867 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2868 a new ID will be allocated from this stash. If you exceed
2869 the limit, recording will stop.
2870
2871 CONFIG_BOOTSTAGE_REPORT
2872 Define this to print a report before boot, similar to this:
2873
2874 Timer summary in microseconds:
2875 Mark Elapsed Stage
2876 0 0 reset
2877 3,575,678 3,575,678 board_init_f start
2878 3,575,695 17 arch_cpu_init A9
2879 3,575,777 82 arch_cpu_init done
2880 3,659,598 83,821 board_init_r start
2881 3,910,375 250,777 main_loop
2882 29,916,167 26,005,792 bootm_start
2883 30,361,327 445,160 start_kernel
2884
Simon Glass2eba38c2012-09-28 08:56:39 +00002885 CONFIG_CMD_BOOTSTAGE
2886 Add a 'bootstage' command which supports printing a report
2887 and un/stashing of bootstage data.
2888
Simon Glass94fd1312012-09-28 08:56:37 +00002889 CONFIG_BOOTSTAGE_FDT
2890 Stash the bootstage information in the FDT. A root 'bootstage'
2891 node is created with each bootstage id as a child. Each child
2892 has a 'name' property and either 'mark' containing the
2893 mark time in microsecond, or 'accum' containing the
2894 accumulated time for that bootstage id in microseconds.
2895 For example:
2896
2897 bootstage {
2898 154 {
2899 name = "board_init_f";
2900 mark = <3575678>;
2901 };
2902 170 {
2903 name = "lcd";
2904 accum = <33482>;
2905 };
2906 };
2907
2908 Code in the Linux kernel can find this in /proc/devicetree.
2909
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002910Legacy uImage format:
2911
wdenkc6097192002-11-03 00:24:07 +00002912 Arg Where When
2913 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002914 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002915 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002916 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002917 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002918 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002919 4 common/cmd_bootm.c Image data has correct checksum
2920 -4 common/cmd_bootm.c Image is for unsupported architecture
2921 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002922 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002923 6 common/cmd_bootm.c Image Type check OK
2924 -6 common/cmd_bootm.c gunzip uncompression error
2925 -7 common/cmd_bootm.c Unimplemented compression type
2926 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002927 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002928 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002929
2930 9 common/image.c Start initial ramdisk verification
2931 -10 common/image.c Ramdisk header has bad magic number
2932 -11 common/image.c Ramdisk header has bad checksum
2933 10 common/image.c Ramdisk header is OK
2934 -12 common/image.c Ramdisk data has bad checksum
2935 11 common/image.c Ramdisk data has correct checksum
2936 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002937 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002938 13 common/image.c Start multifile image verification
2939 14 common/image.c No initial ramdisk, no multifile, continue.
2940
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002941 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002942
Stefan Roesea47a12b2010-04-15 16:07:28 +02002943 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00002944 -31 post/post.c POST test failed, detected by post_output_backlog()
2945 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002946
Heiko Schocher566a4942007-06-22 19:11:54 +02002947 34 common/cmd_doc.c before loading a Image from a DOC device
2948 -35 common/cmd_doc.c Bad usage of "doc" command
2949 35 common/cmd_doc.c correct usage of "doc" command
2950 -36 common/cmd_doc.c No boot device
2951 36 common/cmd_doc.c correct boot device
2952 -37 common/cmd_doc.c Unknown Chip ID on boot device
2953 37 common/cmd_doc.c correct chip ID found, device available
2954 -38 common/cmd_doc.c Read Error on boot device
2955 38 common/cmd_doc.c reading Image header from DOC device OK
2956 -39 common/cmd_doc.c Image header has bad magic number
2957 39 common/cmd_doc.c Image header has correct magic number
2958 -40 common/cmd_doc.c Error reading Image from DOC device
2959 40 common/cmd_doc.c Image header has correct magic number
2960 41 common/cmd_ide.c before loading a Image from a IDE device
2961 -42 common/cmd_ide.c Bad usage of "ide" command
2962 42 common/cmd_ide.c correct usage of "ide" command
2963 -43 common/cmd_ide.c No boot device
2964 43 common/cmd_ide.c boot device found
2965 -44 common/cmd_ide.c Device not available
2966 44 common/cmd_ide.c Device available
2967 -45 common/cmd_ide.c wrong partition selected
2968 45 common/cmd_ide.c partition selected
2969 -46 common/cmd_ide.c Unknown partition table
2970 46 common/cmd_ide.c valid partition table found
2971 -47 common/cmd_ide.c Invalid partition type
2972 47 common/cmd_ide.c correct partition type
2973 -48 common/cmd_ide.c Error reading Image Header on boot device
2974 48 common/cmd_ide.c reading Image Header from IDE device OK
2975 -49 common/cmd_ide.c Image header has bad magic number
2976 49 common/cmd_ide.c Image header has correct magic number
2977 -50 common/cmd_ide.c Image header has bad checksum
2978 50 common/cmd_ide.c Image header has correct checksum
2979 -51 common/cmd_ide.c Error reading Image from IDE device
2980 51 common/cmd_ide.c reading Image from IDE device OK
2981 52 common/cmd_nand.c before loading a Image from a NAND device
2982 -53 common/cmd_nand.c Bad usage of "nand" command
2983 53 common/cmd_nand.c correct usage of "nand" command
2984 -54 common/cmd_nand.c No boot device
2985 54 common/cmd_nand.c boot device found
2986 -55 common/cmd_nand.c Unknown Chip ID on boot device
2987 55 common/cmd_nand.c correct chip ID found, device available
2988 -56 common/cmd_nand.c Error reading Image Header on boot device
2989 56 common/cmd_nand.c reading Image Header from NAND device OK
2990 -57 common/cmd_nand.c Image header has bad magic number
2991 57 common/cmd_nand.c Image header has correct magic number
2992 -58 common/cmd_nand.c Error reading Image from NAND device
2993 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002994
Heiko Schocher566a4942007-06-22 19:11:54 +02002995 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002996
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002997 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002998 -64 net/eth.c no Ethernet found.
2999 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003000
Heiko Schocher566a4942007-06-22 19:11:54 +02003001 -80 common/cmd_net.c usage wrong
3002 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003003 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003004 81 common/cmd_net.c NetLoop() back without error
3005 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3006 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003007 83 common/cmd_net.c running "source" command
3008 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003009 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003010
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003011FIT uImage format:
3012
3013 Arg Where When
3014 100 common/cmd_bootm.c Kernel FIT Image has correct format
3015 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3016 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3017 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3018 102 common/cmd_bootm.c Kernel unit name specified
3019 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003020 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003021 104 common/cmd_bootm.c Got kernel subimage node offset
3022 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3023 105 common/cmd_bootm.c Kernel subimage hash verification OK
3024 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3025 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003026 -106 common/cmd_bootm.c Kernel subimage has wrong type
3027 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003028 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3029 108 common/cmd_bootm.c Got kernel subimage data/size
3030 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3031 -109 common/cmd_bootm.c Can't get kernel subimage type
3032 -110 common/cmd_bootm.c Can't get kernel subimage comp
3033 -111 common/cmd_bootm.c Can't get kernel subimage os
3034 -112 common/cmd_bootm.c Can't get kernel subimage load address
3035 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3036
3037 120 common/image.c Start initial ramdisk verification
3038 -120 common/image.c Ramdisk FIT image has incorrect format
3039 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003040 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003041 -122 common/image.c Can't get configuration for ramdisk subimage
3042 123 common/image.c Ramdisk unit name specified
3043 -124 common/image.c Can't get ramdisk subimage node offset
3044 125 common/image.c Got ramdisk subimage node offset
3045 -125 common/image.c Ramdisk subimage hash verification failed
3046 126 common/image.c Ramdisk subimage hash verification OK
3047 -126 common/image.c Ramdisk subimage for unsupported architecture
3048 127 common/image.c Architecture check OK
3049 -127 common/image.c Can't get ramdisk subimage data/size
3050 128 common/image.c Got ramdisk subimage data/size
3051 129 common/image.c Can't get ramdisk load address
3052 -129 common/image.c Got ramdisk load address
3053
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003054 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003055 131 common/cmd_doc.c FIT image format OK
3056
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003057 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003058 141 common/cmd_ide.c FIT image format OK
3059
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003060 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003061 151 common/cmd_nand.c FIT image format OK
3062
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003063- FIT image support:
3064 CONFIG_FIT
3065 Enable support for the FIT uImage format.
3066
3067 CONFIG_FIT_BEST_MATCH
3068 When no configuration is explicitly selected, default to the
3069 one whose fdt's compatibility field best matches that of
3070 U-Boot itself. A match is considered "best" if it matches the
3071 most specific compatibility entry of U-Boot's fdt's root node.
3072 The order of entries in the configuration's fdt is ignored.
3073
Simon Glass3e569a62013-06-13 15:10:00 -07003074 CONFIG_FIT_SIGNATURE
3075 This option enables signature verification of FIT uImages,
3076 using a hash signed and verified using RSA. See
3077 doc/uImage.FIT/signature.txt for more details.
3078
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003079- Standalone program support:
3080 CONFIG_STANDALONE_LOAD_ADDR
3081
Wolfgang Denk6feff892011-10-09 21:06:34 +02003082 This option defines a board specific value for the
3083 address where standalone program gets loaded, thus
3084 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003085 settings.
3086
3087- Frame Buffer Address:
3088 CONFIG_FB_ADDR
3089
3090 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003091 address for frame buffer. This is typically the case
3092 when using a graphics controller has separate video
3093 memory. U-Boot will then place the frame buffer at
3094 the given address instead of dynamically reserving it
3095 in system RAM by calling lcd_setmem(), which grabs
3096 the memory for the frame buffer depending on the
3097 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003098
3099 Please see board_init_f function.
3100
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003101- Automatic software updates via TFTP server
3102 CONFIG_UPDATE_TFTP
3103 CONFIG_UPDATE_TFTP_CNT_MAX
3104 CONFIG_UPDATE_TFTP_MSEC_MAX
3105
3106 These options enable and control the auto-update feature;
3107 for a more detailed description refer to doc/README.update.
3108
3109- MTD Support (mtdparts command, UBI support)
3110 CONFIG_MTD_DEVICE
3111
3112 Adds the MTD device infrastructure from the Linux kernel.
3113 Needed for mtdparts command support.
3114
3115 CONFIG_MTD_PARTITIONS
3116
3117 Adds the MTD partitioning infrastructure from the Linux
3118 kernel. Needed for UBI support.
3119
Joe Hershberger70c219c2013-04-08 10:32:48 +00003120- UBI support
3121 CONFIG_CMD_UBI
3122
3123 Adds commands for interacting with MTD partitions formatted
3124 with the UBI flash translation layer
3125
3126 Requires also defining CONFIG_RBTREE
3127
Joe Hershberger147162d2013-04-08 10:32:49 +00003128 CONFIG_UBI_SILENCE_MSG
3129
3130 Make the verbose messages from UBI stop printing. This leaves
3131 warnings and errors enabled.
3132
Joe Hershberger70c219c2013-04-08 10:32:48 +00003133- UBIFS support
3134 CONFIG_CMD_UBIFS
3135
3136 Adds commands for interacting with UBI volumes formatted as
3137 UBIFS. UBIFS is read-only in u-boot.
3138
3139 Requires UBI support as well as CONFIG_LZO
3140
Joe Hershberger147162d2013-04-08 10:32:49 +00003141 CONFIG_UBIFS_SILENCE_MSG
3142
3143 Make the verbose messages from UBIFS stop printing. This leaves
3144 warnings and errors enabled.
3145
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003146- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003147 CONFIG_SPL
3148 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003149
Tom Rini95579792012-02-14 07:29:40 +00003150 CONFIG_SPL_LDSCRIPT
3151 LDSCRIPT for linking the SPL binary.
3152
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003153 CONFIG_SPL_MAX_FOOTPRINT
3154 Maximum size in memory allocated to the SPL, BSS included.
3155 When defined, the linker checks that the actual memory
3156 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003157 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003158 must not be both defined at the same time.
3159
Tom Rini95579792012-02-14 07:29:40 +00003160 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003161 Maximum size of the SPL image (text, data, rodata, and
3162 linker lists sections), BSS excluded.
3163 When defined, the linker checks that the actual size does
3164 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003165
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003166 CONFIG_SPL_TEXT_BASE
3167 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003168
Scott Wood94a45bb2012-09-20 19:05:12 -05003169 CONFIG_SPL_RELOC_TEXT_BASE
3170 Address to relocate to. If unspecified, this is equal to
3171 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3172
Tom Rini95579792012-02-14 07:29:40 +00003173 CONFIG_SPL_BSS_START_ADDR
3174 Link address for the BSS within the SPL binary.
3175
3176 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003177 Maximum size in memory allocated to the SPL BSS.
3178 When defined, the linker checks that the actual memory used
3179 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003180 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003181 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003182
3183 CONFIG_SPL_STACK
3184 Adress of the start of the stack SPL will use
3185
Scott Wood94a45bb2012-09-20 19:05:12 -05003186 CONFIG_SPL_RELOC_STACK
3187 Adress of the start of the stack SPL will use after
3188 relocation. If unspecified, this is equal to
3189 CONFIG_SPL_STACK.
3190
Tom Rini95579792012-02-14 07:29:40 +00003191 CONFIG_SYS_SPL_MALLOC_START
3192 Starting address of the malloc pool used in SPL.
3193
3194 CONFIG_SYS_SPL_MALLOC_SIZE
3195 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003196
Tom Rini47f7bca2012-08-13 12:03:19 -07003197 CONFIG_SPL_FRAMEWORK
3198 Enable the SPL framework under common/. This framework
3199 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3200 NAND loading of the Linux Kernel.
3201
Tom Rini861a86f2012-08-13 11:37:56 -07003202 CONFIG_SPL_DISPLAY_PRINT
3203 For ARM, enable an optional function to print more information
3204 about the running system.
3205
Scott Wood4b919722012-09-20 16:35:21 -05003206 CONFIG_SPL_INIT_MINIMAL
3207 Arch init code should be built for a very small image
3208
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003209 CONFIG_SPL_LIBCOMMON_SUPPORT
3210 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003211
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003212 CONFIG_SPL_LIBDISK_SUPPORT
3213 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003214
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003215 CONFIG_SPL_I2C_SUPPORT
3216 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003217
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003218 CONFIG_SPL_GPIO_SUPPORT
3219 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003220
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003221 CONFIG_SPL_MMC_SUPPORT
3222 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003223
Tom Rini95579792012-02-14 07:29:40 +00003224 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3225 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3226 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3227 Address, size and partition on the MMC to load U-Boot from
3228 when the MMC is being used in raw mode.
3229
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003230 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3231 Sector to load kernel uImage from when MMC is being
3232 used in raw mode (for Falcon mode)
3233
3234 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3235 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3236 Sector and number of sectors to load kernel argument
3237 parameters from when MMC is being used in raw mode
3238 (for falcon mode)
3239
Tom Rini95579792012-02-14 07:29:40 +00003240 CONFIG_SPL_FAT_SUPPORT
3241 Support for fs/fat/libfat.o in SPL binary
3242
3243 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3244 Filename to read to load U-Boot when reading from FAT
3245
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003246 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3247 Filename to read to load kernel uImage when reading
3248 from FAT (for Falcon mode)
3249
3250 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3251 Filename to read to load kernel argument parameters
3252 when reading from FAT (for Falcon mode)
3253
Scott Wood06f60ae2012-12-06 13:33:17 +00003254 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3255 Set this for NAND SPL on PPC mpc83xx targets, so that
3256 start.S waits for the rest of the SPL to load before
3257 continuing (the hardware starts execution after just
3258 loading the first page rather than the full 4K).
3259
Scott Wood6f2f01b2012-09-20 19:09:07 -05003260 CONFIG_SPL_NAND_BASE
3261 Include nand_base.c in the SPL. Requires
3262 CONFIG_SPL_NAND_DRIVERS.
3263
3264 CONFIG_SPL_NAND_DRIVERS
3265 SPL uses normal NAND drivers, not minimal drivers.
3266
3267 CONFIG_SPL_NAND_ECC
3268 Include standard software ECC in the SPL
3269
Tom Rini95579792012-02-14 07:29:40 +00003270 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003271 Support for NAND boot using simple NAND drivers that
3272 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003273
Ying Zhangbb0dc102013-08-16 15:16:11 +08003274 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3275 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003276 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003277
Ying Zhang7c8eea52013-08-16 15:16:12 +08003278 CONFIG_SPL_COMMON_INIT_DDR
3279 Set for common ddr init with serial presence detect in
3280 SPL binary.
3281
Tom Rini95579792012-02-14 07:29:40 +00003282 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3283 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3284 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3285 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3286 CONFIG_SYS_NAND_ECCBYTES
3287 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003288 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003289
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303290 CONFIG_SPL_NAND_BOOT
3291 Add support NAND boot
3292
Tom Rini95579792012-02-14 07:29:40 +00003293 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003294 Location in NAND to read U-Boot from
3295
3296 CONFIG_SYS_NAND_U_BOOT_DST
3297 Location in memory to load U-Boot to
3298
3299 CONFIG_SYS_NAND_U_BOOT_SIZE
3300 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003301
3302 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003303 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003304
3305 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3306 Define this if you need to first read the OOB and then the
3307 data. This is used for example on davinci plattforms.
3308
3309 CONFIG_SPL_OMAP3_ID_NAND
3310 Support for an OMAP3-specific set of functions to return the
3311 ID and MFR of the first attached NAND chip, if present.
3312
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003313 CONFIG_SPL_SERIAL_SUPPORT
3314 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003315
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003316 CONFIG_SPL_SPI_FLASH_SUPPORT
3317 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003318
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003319 CONFIG_SPL_SPI_SUPPORT
3320 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003321
Pavel Machekc57b9532012-08-30 22:42:11 +02003322 CONFIG_SPL_RAM_DEVICE
3323 Support for running image already present in ram, in SPL binary
3324
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003325 CONFIG_SPL_LIBGENERIC_SUPPORT
3326 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003327
Ying Zhangba1bee42013-05-20 14:07:25 +08003328 CONFIG_SPL_ENV_SUPPORT
3329 Support for the environment operating in SPL binary
3330
3331 CONFIG_SPL_NET_SUPPORT
3332 Support for the net/libnet.o in SPL binary.
3333 It conflicts with SPL env from storage medium specified by
3334 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3335
Scott Wood74752ba2012-12-06 13:33:16 +00003336 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003337 Image offset to which the SPL should be padded before appending
3338 the SPL payload. By default, this is defined as
3339 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3340 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3341 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003342
Scott Woodca2fca22012-09-21 16:27:32 -05003343 CONFIG_SPL_TARGET
3344 Final target image containing SPL and payload. Some SPLs
3345 use an arch-specific makefile fragment instead, for
3346 example if more than one image needs to be produced.
3347
Simon Glass87ebee32013-05-08 08:05:59 +00003348 CONFIG_FIT_SPL_PRINT
3349 Printing information about a FIT image adds quite a bit of
3350 code to SPL. So this is normally disabled in SPL. Use this
3351 option to re-enable it. This will affect the output of the
3352 bootm command when booting a FIT image.
3353
Ying Zhang3aa29de2013-08-16 15:16:15 +08003354- TPL framework
3355 CONFIG_TPL
3356 Enable building of TPL globally.
3357
3358 CONFIG_TPL_PAD_TO
3359 Image offset to which the TPL should be padded before appending
3360 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003361 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3362 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3363 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003364
wdenkc6097192002-11-03 00:24:07 +00003365Modem Support:
3366--------------
3367
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003368[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003369
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003370- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003371 CONFIG_MODEM_SUPPORT
3372
3373- RTS/CTS Flow control enable:
3374 CONFIG_HWFLOW
3375
3376- Modem debug support:
3377 CONFIG_MODEM_SUPPORT_DEBUG
3378
wdenk43d96162003-03-06 00:02:04 +00003379 Enables debugging stuff (char screen[1024], dbg())
3380 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003381
wdenka8c7c702003-12-06 19:49:23 +00003382- Interrupt support (PPC):
3383
wdenkd4ca31c2004-01-02 14:00:00 +00003384 There are common interrupt_init() and timer_interrupt()
3385 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003386 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003387 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003388 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003389 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003390 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003391 specific handling. If board has watchdog / status_led
3392 / other_activity_monitor it works automatically from
3393 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003394
wdenkc6097192002-11-03 00:24:07 +00003395- General:
3396
wdenk43d96162003-03-06 00:02:04 +00003397 In the target system modem support is enabled when a
3398 specific key (key combination) is pressed during
3399 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003400 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003401 board_init(). Currently key_pressed() is a dummy
3402 function, returning 1 and thus enabling modem
3403 initialization.
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk43d96162003-03-06 00:02:04 +00003405 If there are no modem init strings in the
3406 environment, U-Boot proceed to autoboot; the
3407 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003408 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003409
3410 See also: doc/README.Modem
3411
Helmut Raiger9660e442011-10-20 04:19:47 +00003412Board initialization settings:
3413------------------------------
3414
3415During Initialization u-boot calls a number of board specific functions
3416to allow the preparation of board specific prerequisites, e.g. pin setup
3417before drivers are initialized. To enable these callbacks the
3418following configuration macros have to be defined. Currently this is
3419architecture specific, so please check arch/your_architecture/lib/board.c
3420typically in board_init_f() and board_init_r().
3421
3422- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3423- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3424- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3425- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003426
wdenkc6097192002-11-03 00:24:07 +00003427Configuration Settings:
3428-----------------------
3429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003430- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003431 undefine this when you're short of memory.
3432
Peter Tyser2fb26042009-01-27 18:03:12 -06003433- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3434 width of the commands listed in the 'help' command output.
3435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003436- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003437 prompt for user input.
3438
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003439- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003441- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003442
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003443- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003444
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003445- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003446 the application (usually a Linux kernel) when it is
3447 booted
3448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003449- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003450 List of legal baudrate settings for this board.
3451
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003452- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003453 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003456 If the board specific function
3457 extern int overwrite_console (void);
3458 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003459 serial port, else the settings in the environment are used.
3460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003461- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003462 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003463
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003464- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003465 Enable overwrite of previous console environment settings.
3466
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003467- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003468 Begin and End addresses of the area used by the
3469 simple memory test.
3470
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003471- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003472 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003474- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003475 Scratch address used by the alternate memory test
3476 You only need to set this if address zero isn't writeable
3477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003478- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3479 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003480 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003481 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003482 fixing up gd->ram_size the Linux kernel should gets passed
3483 the now "corrected" memory size and won't touch it either.
3484 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003485 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003486 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003487 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003488
3489 This option can be used as a workaround for the 440EPx/GRx
3490 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3491 be touched.
3492
3493 WARNING: Please make sure that this value is a multiple of
3494 the Linux page size (normally 4k). If this is not the case,
3495 then the end address of the Linux memory will be located at a
3496 non page size aligned address and this could cause major
3497 problems.
3498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003500 Enable temporary baudrate change while serial download
3501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003502- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003503 Physical start address of SDRAM. _Must_ be 0 here.
3504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003505- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003506 Physical start address of Motherboard I/O (if using a
3507 Cogent motherboard)
3508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003509- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003510 Physical start address of Flash memory.
3511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003512- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003513 Physical start address of boot monitor code (set by
3514 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003515 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003516 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003518- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003519 Size of memory reserved for monitor code, used to
3520 determine _at_compile_time_ (!) if the environment is
3521 embedded within the U-Boot image, or in a separate
3522 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003525 Size of DRAM reserved for malloc() use.
3526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003527- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003528 Normally compressed uImages are limited to an
3529 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003531 to adjust this setting to your needs.
3532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003533- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003534 Maximum size of memory mapped by the startup code of
3535 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003536 the Linux kernel (bd_info, boot arguments, FDT blob if
3537 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003538 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003539 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003540 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003541 variable "bootm_mapsize" will override the value of
3542 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3543 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003544
John Rigbyfca43cc2010-10-13 13:57:35 -06003545- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3546 Enable initrd_high functionality. If defined then the
3547 initrd_high feature is enabled and the bootm ramdisk subcommand
3548 is enabled.
3549
3550- CONFIG_SYS_BOOT_GET_CMDLINE:
3551 Enables allocating and saving kernel cmdline in space between
3552 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3553
3554- CONFIG_SYS_BOOT_GET_KBD:
3555 Enables allocating and saving a kernel copy of the bd_info in
3556 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003558- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003559 Max number of Flash memory banks
3560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003561- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003562 Max number of sectors on a Flash chip
3563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003564- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003565 Timeout for Flash erase operations (in ms)
3566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003567- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003568 Timeout for Flash write operations (in ms)
3569
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003570- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003571 Timeout for Flash set sector lock bit operation (in ms)
3572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003573- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003574 Timeout for Flash clear lock bits operation (in ms)
3575
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003576- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003577 If defined, hardware flash sectors protection is used
3578 instead of U-Boot software protection.
3579
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003580- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003581
3582 Enable TFTP transfers directly to flash memory;
3583 without this option such a download has to be
3584 performed in two steps: (1) download to RAM, and (2)
3585 copy from RAM to flash.
3586
3587 The two-step approach is usually more reliable, since
3588 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003589 the flash, but in some situations (when system RAM is
3590 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003591 downloaded image) this option may be very useful.
3592
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003593- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003594 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003595 common flash structure for storing flash geometry.
3596
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003597- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003598 This option also enables the building of the cfi_flash driver
3599 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003600
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003601- CONFIG_FLASH_CFI_MTD
3602 This option enables the building of the cfi_mtd driver
3603 in the drivers directory. The driver exports CFI flash
3604 to the MTD layer.
3605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003606- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003607 Use buffered writes to flash.
3608
3609- CONFIG_FLASH_SPANSION_S29WS_N
3610 s29ws-n MirrorBit flash has non-standard addresses for buffered
3611 write commands.
3612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003613- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003614 If this option is defined, the common CFI flash doesn't
3615 print it's warning upon not recognized FLASH banks. This
3616 is useful, if some of the configured banks are only
3617 optionally available.
3618
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003619- CONFIG_FLASH_SHOW_PROGRESS
3620 If defined (must be an integer), print out countdown
3621 digits and dots. Recommended value: 45 (9..1) for 80
3622 column displays, 15 (3..1) for 40 column displays.
3623
Stefan Roese352ef3f2013-04-04 15:53:14 +02003624- CONFIG_FLASH_VERIFY
3625 If defined, the content of the flash (destination) is compared
3626 against the source after the write operation. An error message
3627 will be printed when the contents are not identical.
3628 Please note that this option is useless in nearly all cases,
3629 since such flash programming errors usually are detected earlier
3630 while unprotecting/erasing/programming. Please only enable
3631 this option if you really know what you are doing.
3632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003633- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003634 Defines the number of Ethernet receive buffers. On some
3635 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003636 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3637 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003638 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003639 Defaults to 4 if not defined.
3640
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003641- CONFIG_ENV_MAX_ENTRIES
3642
Wolfgang Denk071bc922010-10-27 22:48:30 +02003643 Maximum number of entries in the hash table that is used
3644 internally to store the environment settings. The default
3645 setting is supposed to be generous and should work in most
3646 cases. This setting can be used to tune behaviour; see
3647 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003648
Joe Hershberger25980902012-12-11 22:16:31 -06003649- CONFIG_ENV_FLAGS_LIST_DEFAULT
3650- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003651 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003652 calling env set. Variables can be restricted to only decimal,
3653 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3654 the variables can also be restricted to IP address or MAC address.
3655
3656 The format of the list is:
3657 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003658 access_atribute = [a|r|o|c]
3659 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003660 entry = variable_name[:attributes]
3661 list = entry[,list]
3662
3663 The type attributes are:
3664 s - String (default)
3665 d - Decimal
3666 x - Hexadecimal
3667 b - Boolean ([1yYtT|0nNfF])
3668 i - IP address
3669 m - MAC address
3670
Joe Hershberger267541f2012-12-11 22:16:34 -06003671 The access attributes are:
3672 a - Any (default)
3673 r - Read-only
3674 o - Write-once
3675 c - Change-default
3676
Joe Hershberger25980902012-12-11 22:16:31 -06003677 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3678 Define this to a list (string) to define the ".flags"
3679 envirnoment variable in the default or embedded environment.
3680
3681 - CONFIG_ENV_FLAGS_LIST_STATIC
3682 Define this to a list (string) to define validation that
3683 should be done if an entry is not found in the ".flags"
3684 environment variable. To override a setting in the static
3685 list, simply add an entry for the same variable name to the
3686 ".flags" variable.
3687
Joe Hershberger267541f2012-12-11 22:16:34 -06003688- CONFIG_ENV_ACCESS_IGNORE_FORCE
3689 If defined, don't allow the -f switch to env set override variable
3690 access flags.
3691
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003692- CONFIG_SYS_GENERIC_BOARD
3693 This selects the architecture-generic board system instead of the
3694 architecture-specific board files. It is intended to move boards
3695 to this new framework over time. Defining this will disable the
3696 arch/foo/lib/board.c file and use common/board_f.c and
3697 common/board_r.c instead. To use this option your architecture
3698 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3699 its config.mk file). If you find problems enabling this option on
3700 your board please report the problem and send patches!
3701
Simon Glass632efa72013-03-11 07:06:48 +00003702- CONFIG_SYS_SYM_OFFSETS
3703 This is set by architectures that use offsets for link symbols
3704 instead of absolute values. So bss_start is obtained using an
3705 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3706 directly. You should not need to touch this setting.
3707
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003708- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3709 This is set by OMAP boards for the max time that reset should
3710 be asserted. See doc/README.omap-reset-time for details on how
3711 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003712
wdenkc6097192002-11-03 00:24:07 +00003713The following definitions that deal with the placement and management
3714of environment data (variable area); in general, we support the
3715following configurations:
3716
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003717- CONFIG_BUILD_ENVCRC:
3718
3719 Builds up envcrc with the target environment so that external utils
3720 may easily extract it and embed it in final U-Boot images.
3721
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003722- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003723
3724 Define this if the environment is in flash memory.
3725
3726 a) The environment occupies one whole flash sector, which is
3727 "embedded" in the text segment with the U-Boot code. This
3728 happens usually with "bottom boot sector" or "top boot
3729 sector" type flash chips, which have several smaller
3730 sectors at the start or the end. For instance, such a
3731 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3732 such a case you would place the environment in one of the
3733 4 kB sectors - with U-Boot code before and after it. With
3734 "top boot sector" type flash chips, you would put the
3735 environment in one of the last sectors, leaving a gap
3736 between U-Boot and the environment.
3737
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003738 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003739
3740 Offset of environment data (variable area) to the
3741 beginning of flash memory; for instance, with bottom boot
3742 type flash chips the second sector can be used: the offset
3743 for this sector is given here.
3744
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003745 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003746
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003747 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003748
3749 This is just another way to specify the start address of
3750 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003751 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003752
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003753 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003754
3755 Size of the sector containing the environment.
3756
3757
3758 b) Sometimes flash chips have few, equal sized, BIG sectors.
3759 In such a case you don't want to spend a whole sector for
3760 the environment.
3761
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003762 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003763
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003764 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003765 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003766 of this flash sector for the environment. This saves
3767 memory for the RAM copy of the environment.
3768
3769 It may also save flash memory if you decide to use this
3770 when your environment is "embedded" within U-Boot code,
3771 since then the remainder of the flash sector could be used
3772 for U-Boot code. It should be pointed out that this is
3773 STRONGLY DISCOURAGED from a robustness point of view:
3774 updating the environment in flash makes it always
3775 necessary to erase the WHOLE sector. If something goes
3776 wrong before the contents has been restored from a copy in
3777 RAM, your target system will be dead.
3778
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003779 - CONFIG_ENV_ADDR_REDUND
3780 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk43d96162003-03-06 00:02:04 +00003782 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003783 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003784 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003785 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003786
3787BE CAREFUL! Any changes to the flash layout, and some changes to the
3788source code will make it necessary to adapt <board>/u-boot.lds*
3789accordingly!
3790
3791
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003792- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003793
3794 Define this if you have some non-volatile memory device
3795 (NVRAM, battery buffered SRAM) which you want to use for the
3796 environment.
3797
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003798 - CONFIG_ENV_ADDR:
3799 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003800
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003801 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003802 want to use for environment. It is assumed that this memory
3803 can just be read and written to, without any special
3804 provision.
3805
3806BE CAREFUL! The first access to the environment happens quite early
3807in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003808console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003809U-Boot will hang.
3810
3811Please note that even with NVRAM we still use a copy of the
3812environment in RAM: we could work on NVRAM directly, but we want to
3813keep settings there always unmodified except somebody uses "saveenv"
3814to save the current settings.
3815
3816
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003817- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003818
3819 Use this if you have an EEPROM or similar serial access
3820 device and a driver for it.
3821
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003822 - CONFIG_ENV_OFFSET:
3823 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003824
3825 These two #defines specify the offset and size of the
3826 environment area within the total memory of your EEPROM.
3827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003828 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003829 If defined, specified the chip address of the EEPROM device.
3830 The default address is zero.
3831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003832 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003833 If defined, the number of bits used to address bytes in a
3834 single page in the EEPROM device. A 64 byte page, for example
3835 would require six bits.
3836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003837 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003838 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003839 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003841 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003842 The length in bytes of the EEPROM memory array address. Note
3843 that this is NOT the chip address length!
3844
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003845 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003846 EEPROM chips that implement "address overflow" are ones
3847 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3848 address and the extra bits end up in the "chip address" bit
3849 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3850 byte chips.
3851
3852 Note that we consider the length of the address field to
3853 still be one byte because the extra address bits are hidden
3854 in the chip address.
3855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003856 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003857 The size in bytes of the EEPROM device.
3858
Heiko Schocher548738b2010-01-07 08:55:40 +01003859 - CONFIG_ENV_EEPROM_IS_ON_I2C
3860 define this, if you have I2C and SPI activated, and your
3861 EEPROM, which holds the environment, is on the I2C bus.
3862
3863 - CONFIG_I2C_ENV_EEPROM_BUS
3864 if you have an Environment on an EEPROM reached over
3865 I2C muxes, you can define here, how to reach this
3866 EEPROM. For example:
3867
Heiko Schocherea818db2013-01-29 08:53:15 +01003868 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003869
3870 EEPROM which holds the environment, is reached over
3871 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003872
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003873- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003874
wdenkd4ca31c2004-01-02 14:00:00 +00003875 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003876 want to use for the environment.
3877
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003878 - CONFIG_ENV_OFFSET:
3879 - CONFIG_ENV_ADDR:
3880 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003881
3882 These three #defines specify the offset and size of the
3883 environment area within the total memory of your DataFlash placed
3884 at the specified address.
3885
Liu Gang0a85a9e2012-03-08 00:33:20 +00003886- CONFIG_ENV_IS_IN_REMOTE:
3887
3888 Define this if you have a remote memory space which you
3889 want to use for the local device's environment.
3890
3891 - CONFIG_ENV_ADDR:
3892 - CONFIG_ENV_SIZE:
3893
3894 These two #defines specify the address and size of the
3895 environment area within the remote memory space. The
3896 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003897 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003898
3899BE CAREFUL! For some special cases, the local device can not use
3900"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003901environment stored in a remote NOR flash by SRIO or PCIE link,
3902but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003903
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003904- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003905
3906 Define this if you have a NAND device which you want to use
3907 for the environment.
3908
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003909 - CONFIG_ENV_OFFSET:
3910 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003911
3912 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003913 area within the first NAND device. CONFIG_ENV_OFFSET must be
3914 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003915
Scott Woodfdd813d2010-09-17 14:38:37 -05003916 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003917
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003918 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003919 size used to hold a redundant copy of the environment data, so
3920 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003921 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003922 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003923
Scott Woodfdd813d2010-09-17 14:38:37 -05003924 - CONFIG_ENV_RANGE (optional):
3925
3926 Specifies the length of the region in which the environment
3927 can be written. This should be a multiple of the NAND device's
3928 block size. Specifying a range with more erase blocks than
3929 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3930 the range to be avoided.
3931
3932 - CONFIG_ENV_OFFSET_OOB (optional):
3933
3934 Enables support for dynamically retrieving the offset of the
3935 environment from block zero's out-of-band data. The
3936 "nand env.oob" command can be used to record this offset.
3937 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3938 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003939
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003940- CONFIG_NAND_ENV_DST
3941
3942 Defines address in RAM to which the nand_spl code should copy the
3943 environment. If redundant environment is used, it will be copied to
3944 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3945
Joe Hershberger2b744332013-04-08 10:32:51 +00003946- CONFIG_ENV_IS_IN_UBI:
3947
3948 Define this if you have an UBI volume that you want to use for the
3949 environment. This has the benefit of wear-leveling the environment
3950 accesses, which is important on NAND.
3951
3952 - CONFIG_ENV_UBI_PART:
3953
3954 Define this to a string that is the mtd partition containing the UBI.
3955
3956 - CONFIG_ENV_UBI_VOLUME:
3957
3958 Define this to the name of the volume that you want to store the
3959 environment in.
3960
Joe Hershberger785881f2013-04-08 10:32:52 +00003961 - CONFIG_ENV_UBI_VOLUME_REDUND:
3962
3963 Define this to the name of another volume to store a second copy of
3964 the environment in. This will enable redundant environments in UBI.
3965 It is assumed that both volumes are in the same MTD partition.
3966
Joe Hershberger2b744332013-04-08 10:32:51 +00003967 - CONFIG_UBI_SILENCE_MSG
3968 - CONFIG_UBIFS_SILENCE_MSG
3969
3970 You will probably want to define these to avoid a really noisy system
3971 when storing the env in UBI.
3972
Stephen Warren06e4ae52013-06-11 15:14:00 -06003973- CONFIG_ENV_IS_IN_MMC:
3974
3975 Define this if you have an MMC device which you want to use for the
3976 environment.
3977
3978 - CONFIG_SYS_MMC_ENV_DEV:
3979
3980 Specifies which MMC device the environment is stored in.
3981
3982 - CONFIG_SYS_MMC_ENV_PART (optional):
3983
3984 Specifies which MMC partition the environment is stored in. If not
3985 set, defaults to partition 0, the user area. Common values might be
3986 1 (first MMC boot partition), 2 (second MMC boot partition).
3987
3988 - CONFIG_ENV_OFFSET:
3989 - CONFIG_ENV_SIZE:
3990
3991 These two #defines specify the offset and size of the environment
3992 area within the specified MMC device.
3993
Stephen Warren5c088ee2013-06-11 15:14:02 -06003994 If offset is positive (the usual case), it is treated as relative to
3995 the start of the MMC partition. If offset is negative, it is treated
3996 as relative to the end of the MMC partition. This can be useful if
3997 your board may be fitted with different MMC devices, which have
3998 different sizes for the MMC partitions, and you always want the
3999 environment placed at the very end of the partition, to leave the
4000 maximum possible space before it, to store other data.
4001
Stephen Warren06e4ae52013-06-11 15:14:00 -06004002 These two values are in units of bytes, but must be aligned to an
4003 MMC sector boundary.
4004
4005 - CONFIG_ENV_OFFSET_REDUND (optional):
4006
4007 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4008 hold a redundant copy of the environment data. This provides a
4009 valid backup copy in case the other copy is corrupted, e.g. due
4010 to a power failure during a "saveenv" operation.
4011
Stephen Warren5c088ee2013-06-11 15:14:02 -06004012 This value may also be positive or negative; this is handled in the
4013 same way as CONFIG_ENV_OFFSET.
4014
Stephen Warren06e4ae52013-06-11 15:14:00 -06004015 This value is also in units of bytes, but must also be aligned to
4016 an MMC sector boundary.
4017
4018 - CONFIG_ENV_SIZE_REDUND (optional):
4019
4020 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4021 set. If this value is set, it must be set to the same value as
4022 CONFIG_ENV_SIZE.
4023
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004024- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004025
4026 Defines offset to the initial SPI buffer area in DPRAM. The
4027 area is used at an early stage (ROM part) if the environment
4028 is configured to reside in the SPI EEPROM: We need a 520 byte
4029 scratch DPRAM area. It is used between the two initialization
4030 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4031 to be a good choice since it makes it far enough from the
4032 start of the data area as well as from the stack pointer.
4033
Bruce Adlere881cb52007-11-02 13:15:42 -07004034Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004035has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004036created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004037until then to read environment variables.
4038
wdenk85ec0bc2003-03-31 16:34:49 +00004039The environment is protected by a CRC32 checksum. Before the monitor
4040is relocated into RAM, as a result of a bad CRC you will be working
4041with the compiled-in default environment - *silently*!!! [This is
4042necessary, because the first environment variable we need is the
4043"baudrate" setting for the console - if we have a bad CRC, we don't
4044have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004045
4046Note: once the monitor has been relocated, then it will complain if
4047the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004048use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004050- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004051 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004053 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004054 also needs to be defined.
4055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004056- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004057 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004058
Ron Madridf5675aa2009-02-18 14:30:44 -08004059- CONFIG_NS16550_MIN_FUNCTIONS:
4060 Define this if you desire to only have use of the NS16550_init
4061 and NS16550_putc functions for the serial driver located at
4062 drivers/serial/ns16550.c. This option is useful for saving
4063 space for already greatly restricted images, including but not
4064 limited to NAND_SPL configurations.
4065
Simon Glassb2b92f52012-11-30 13:01:18 +00004066- CONFIG_DISPLAY_BOARDINFO
4067 Display information about the board that U-Boot is running on
4068 when U-Boot starts up. The board function checkboard() is called
4069 to do this.
4070
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004071- CONFIG_DISPLAY_BOARDINFO_LATE
4072 Similar to the previous option, but display this information
4073 later, once stdio is running and output goes to the LCD, if
4074 present.
4075
wdenkc6097192002-11-03 00:24:07 +00004076Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004077---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004079- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004080 Cache Line Size of the CPU.
4081
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004082- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004083 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004084
wdenk42d1f032003-10-15 23:53:47 +00004085 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4086 and RPXsuper) to be able to adjust the position of
4087 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004088
Timur Tabie46fedf2011-08-04 18:03:41 -05004089- CONFIG_SYS_CCSRBAR_DEFAULT:
4090 Default (power-on reset) physical address of CCSR on Freescale
4091 PowerPC SOCs.
4092
4093- CONFIG_SYS_CCSRBAR:
4094 Virtual address of CCSR. On a 32-bit build, this is typically
4095 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4096
4097 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4098 for cross-platform code that uses that macro instead.
4099
4100- CONFIG_SYS_CCSRBAR_PHYS:
4101 Physical address of CCSR. CCSR can be relocated to a new
4102 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004103 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004104 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4105 is typically relocated on 36-bit builds. It is recommended
4106 that this macro be defined via the _HIGH and _LOW macros:
4107
4108 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4109 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4110
4111- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004112 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4113 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004114 used in assembly code, so it must not contain typecasts or
4115 integer size suffixes (e.g. "ULL").
4116
4117- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4118 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4119 used in assembly code, so it must not contain typecasts or
4120 integer size suffixes (e.g. "ULL").
4121
4122- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4123 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4124 forced to a value that ensures that CCSR is not relocated.
4125
wdenk7f6c2cb2002-11-10 22:06:23 +00004126- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004127 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004128
4129 the default drive number (default value 0)
4130
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004131 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004132
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004133 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004134 (default value 1)
4135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004136 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004137
wdenk43d96162003-03-06 00:02:04 +00004138 defines the offset of register from address. It
4139 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004140 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004141
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004142 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4143 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004144 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004145
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004146 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004147 fdc_hw_init() is called at the beginning of the FDC
4148 setup. fdc_hw_init() must be provided by the board
4149 source code. It is used to make hardware dependant
4150 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004151
Macpaul Lin0abddf82011-04-11 20:45:32 +00004152- CONFIG_IDE_AHB:
4153 Most IDE controllers were designed to be connected with PCI
4154 interface. Only few of them were designed for AHB interface.
4155 When software is doing ATA command and data transfer to
4156 IDE devices through IDE-AHB controller, some additional
4157 registers accessing to these kind of IDE-AHB controller
4158 is requierd.
4159
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004160- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004161 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004162 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004163
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004164- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk7152b1d2003-09-05 23:19:14 +00004166 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004167 initial data and stack; please note that this must be
4168 writable memory that is working WITHOUT special
4169 initialization, i. e. you CANNOT use normal RAM which
4170 will become available only after programming the
4171 memory controller and running certain initialization
4172 sequences.
4173
4174 U-Boot uses the following memory types:
4175 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4176 - MPC824X: data cache
4177 - PPC4xx: data cache
4178
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004179- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004180
4181 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004182 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4183 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004184 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004185 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004186 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4187 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4188 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004189
4190 Note:
4191 On the MPC824X (or other systems that use the data
4192 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004193 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004194 point to an otherwise UNUSED address space between
4195 the top of RAM and the start of the PCI space.
4196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004197- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004199- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004201- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004203- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004205- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004207- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004208
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004209- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004210 SDRAM timing
4211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004212- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004213 periodic timer for refresh
4214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004215- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004216
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004217- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4218 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4219 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4220 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004221 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4222
4223- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004224 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4225 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004226 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004228- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4229 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004230 Machine Mode Register and Memory Periodic Timer
4231 Prescaler definitions (SDRAM timing)
4232
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004233- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004234 enable I2C microcode relocation patch (MPC8xx);
4235 define relocation offset in DPRAM [DSP2]
4236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004237- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004238 enable SMC microcode relocation patch (MPC8xx);
4239 define relocation offset in DPRAM [SMC1]
4240
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004241- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004242 enable SPI microcode relocation patch (MPC8xx);
4243 define relocation offset in DPRAM [SCC4]
4244
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004245- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004246 Use OSCM clock mode on MBX8xx board. Be careful,
4247 wrong setting might damage your board. Read
4248 doc/README.MBX before setting this variable!
4249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004250- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004251 Offset of the bootmode word in DPRAM used by post
4252 (Power On Self Tests). This definition overrides
4253 #define'd default value in commproc.h resp.
4254 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004256- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4257 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4258 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4259 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4260 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4261 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4262 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4263 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004264 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004265
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004266- CONFIG_PCI_DISABLE_PCIE:
4267 Disable PCI-Express on systems where it is supported but not
4268 required.
4269
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004270- CONFIG_PCI_ENUM_ONLY
4271 Only scan through and get the devices on the busses.
4272 Don't do any setup work, presumably because someone or
4273 something has already done it, and we don't need to do it
4274 a second time. Useful for platforms that are pre-booted
4275 by coreboot or similar.
4276
Gabor Juhos842033e2013-05-30 07:06:12 +00004277- CONFIG_PCI_INDIRECT_BRIDGE:
4278 Enable support for indirect PCI bridges.
4279
Kumar Galaa09b9b62010-12-30 12:09:53 -06004280- CONFIG_SYS_SRIO:
4281 Chip has SRIO or not
4282
4283- CONFIG_SRIO1:
4284 Board has SRIO 1 port available
4285
4286- CONFIG_SRIO2:
4287 Board has SRIO 2 port available
4288
Liu Gangc8b28152013-05-07 16:30:46 +08004289- CONFIG_SRIO_PCIE_BOOT_MASTER
4290 Board can support master function for Boot from SRIO and PCIE
4291
Kumar Galaa09b9b62010-12-30 12:09:53 -06004292- CONFIG_SYS_SRIOn_MEM_VIRT:
4293 Virtual Address of SRIO port 'n' memory region
4294
4295- CONFIG_SYS_SRIOn_MEM_PHYS:
4296 Physical Address of SRIO port 'n' memory region
4297
4298- CONFIG_SYS_SRIOn_MEM_SIZE:
4299 Size of SRIO port 'n' memory region
4300
Fabio Estevam66bd1842013-04-11 09:35:34 +00004301- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4302 Defined to tell the NAND controller that the NAND chip is using
4303 a 16 bit bus.
4304 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004305 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004306 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004307 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004308
4309- CONFIG_SYS_NDFC_EBC0_CFG
4310 Sets the EBC0_CFG register for the NDFC. If not defined
4311 a default value will be used.
4312
Ben Warrenbb99ad62006-09-07 16:50:54 -04004313- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004314 Get DDR timing information from an I2C EEPROM. Common
4315 with pluggable memory modules such as SODIMMs
4316
Ben Warrenbb99ad62006-09-07 16:50:54 -04004317 SPD_EEPROM_ADDRESS
4318 I2C address of the SPD EEPROM
4319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004320- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004321 If SPD EEPROM is on an I2C bus other than the first
4322 one, specify here. Note that the value must resolve
4323 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004324
York Sun1b3e3c42011-06-07 09:42:16 +08004325- CONFIG_SYS_DDR_RAW_TIMING
4326 Get DDR timing information from other than SPD. Common with
4327 soldered DDR chips onboard without SPD. DDR raw timing
4328 parameters are extracted from datasheet and hard-coded into
4329 header files or board specific files.
4330
York Sun6f5e1dc2011-09-16 13:21:35 -07004331- CONFIG_FSL_DDR_INTERACTIVE
4332 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004334- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004335 Only for 83xx systems. If specified, then DDR should
4336 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004337
wdenkc26e4542004-04-18 10:13:26 +00004338- CONFIG_ETHER_ON_FEC[12]
4339 Define to enable FEC[12] on a 8xx series processor.
4340
4341- CONFIG_FEC[12]_PHY
4342 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004343 to the given FEC; i. e.
4344 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004345 means that the PHY with address 4 is connected to FEC1
4346
4347 When set to -1, means to probe for first available.
4348
4349- CONFIG_FEC[12]_PHY_NORXERR
4350 The PHY does not have a RXERR line (RMII only).
4351 (so program the FEC to ignore it).
4352
4353- CONFIG_RMII
4354 Enable RMII mode for all FECs.
4355 Note that this is a global option, we can't
4356 have one FEC in standard MII mode and another in RMII mode.
4357
wdenk5cf91d62004-04-23 20:32:05 +00004358- CONFIG_CRC32_VERIFY
4359 Add a verify option to the crc32 command.
4360 The syntax is:
4361
4362 => crc32 -v <address> <count> <crc32>
4363
4364 Where address/count indicate a memory area
4365 and crc32 is the correct crc32 which the
4366 area should have.
4367
wdenk56523f12004-07-11 17:40:54 +00004368- CONFIG_LOOPW
4369 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004370 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004371
stroese7b466642004-12-16 18:46:55 +00004372- CONFIG_MX_CYCLIC
4373 Add the "mdc" and "mwc" memory commands. These are cyclic
4374 "md/mw" commands.
4375 Examples:
4376
wdenkefe2a4d2004-12-16 21:44:03 +00004377 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004378 This command will print 4 bytes (10,11,12,13) each 500 ms.
4379
wdenkefe2a4d2004-12-16 21:44:03 +00004380 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004381 This command will write 12345678 to address 100 all 10 ms.
4382
wdenkefe2a4d2004-12-16 21:44:03 +00004383 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004384 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004385
wdenk8aa1a2d2005-04-04 12:44:11 +00004386- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004387 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004388 low level initializations (like setting up the memory
4389 controller) are omitted and/or U-Boot does not
4390 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004391
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004392 Normally this variable MUST NOT be defined. The only
4393 exception is when U-Boot is loaded (to RAM) by some
4394 other boot loader or by a debugger which performs
4395 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004396
Aneesh V401bb302011-07-13 05:11:07 +00004397- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004398 Modifies the behaviour of start.S when compiling a loader
4399 that is executed before the actual U-Boot. E.g. when
4400 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004401
Ying Zhang3aa29de2013-08-16 15:16:15 +08004402- CONFIG_TPL_BUILD
4403 Modifies the behaviour of start.S when compiling a loader
4404 that is executed after the SPL and before the actual U-Boot.
4405 It is loaded by the SPL.
4406
Ying Zhang5df572f2013-05-20 14:07:23 +08004407- CONFIG_SYS_MPC85XX_NO_RESETVEC
4408 Only for 85xx systems. If this variable is specified, the section
4409 .resetvec is not kept and the section .bootpg is placed in the
4410 previous 4k of the .text section.
4411
Simon Glass4213fc22013-02-24 17:33:14 +00004412- CONFIG_ARCH_MAP_SYSMEM
4413 Generally U-Boot (and in particular the md command) uses
4414 effective address. It is therefore not necessary to regard
4415 U-Boot address as virtual addresses that need to be translated
4416 to physical addresses. However, sandbox requires this, since
4417 it maintains its own little RAM buffer which contains all
4418 addressable memory. This option causes some memory accesses
4419 to be mapped through map_sysmem() / unmap_sysmem().
4420
Matthias Weisserd8834a12011-03-10 21:36:32 +00004421- CONFIG_USE_ARCH_MEMCPY
4422 CONFIG_USE_ARCH_MEMSET
4423 If these options are used a optimized version of memcpy/memset will
4424 be used if available. These functions may be faster under some
4425 conditions but may increase the binary size.
4426
Simon Glass588a13f2013-02-14 04:18:54 +00004427- CONFIG_X86_RESET_VECTOR
4428 If defined, the x86 reset vector code is included. This is not
4429 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004430
Mark Jacksonfc337052013-03-04 01:27:20 +00004431- CONFIG_SYS_MPUCLK
4432 Defines the MPU clock speed (in MHz).
4433
4434 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004435
Heiko Schocher16678eb2013-11-04 14:05:00 +01004436- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4437 Enables the RTC32K OSC on AM33xx based plattforms
4438
Timur Tabif2717b42011-11-22 09:21:25 -06004439Freescale QE/FMAN Firmware Support:
4440-----------------------------------
4441
4442The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4443loading of "firmware", which is encoded in the QE firmware binary format.
4444This firmware often needs to be loaded during U-Boot booting, so macros
4445are used to identify the storage device (NOR flash, SPI, etc) and the address
4446within that device.
4447
4448- CONFIG_SYS_QE_FMAN_FW_ADDR
4449 The address in the storage device where the firmware is located. The
4450 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4451 is also specified.
4452
4453- CONFIG_SYS_QE_FMAN_FW_LENGTH
4454 The maximum possible size of the firmware. The firmware binary format
4455 has a field that specifies the actual size of the firmware, but it
4456 might not be possible to read any part of the firmware unless some
4457 local storage is allocated to hold the entire firmware first.
4458
4459- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4460 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4461 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4462 virtual address in NOR flash.
4463
4464- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4465 Specifies that QE/FMAN firmware is located in NAND flash.
4466 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4467
4468- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4469 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4470 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4471
4472- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4473 Specifies that QE/FMAN firmware is located on the primary SPI
4474 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4475
Liu Gang292dc6c2012-03-08 00:33:18 +00004476- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4477 Specifies that QE/FMAN firmware is located in the remote (master)
4478 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004479 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4480 window->master inbound window->master LAW->the ucode address in
4481 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004482
wdenkc6097192002-11-03 00:24:07 +00004483Building the Software:
4484======================
4485
Wolfgang Denk218ca722008-03-26 10:40:12 +01004486Building U-Boot has been tested in several native build environments
4487and in many different cross environments. Of course we cannot support
4488all possibly existing versions of cross development tools in all
4489(potentially obsolete) versions. In case of tool chain problems we
4490recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4491which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004492
Wolfgang Denk218ca722008-03-26 10:40:12 +01004493If you are not using a native environment, it is assumed that you
4494have GNU cross compiling tools available in your path. In this case,
4495you must set the environment variable CROSS_COMPILE in your shell.
4496Note that no changes to the Makefile or any other source files are
4497necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004498
Wolfgang Denk218ca722008-03-26 10:40:12 +01004499 $ CROSS_COMPILE=ppc_4xx-
4500 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004501
Peter Tyser2f8d3962009-03-13 18:54:51 -05004502Note: If you wish to generate Windows versions of the utilities in
4503 the tools directory you can use the MinGW toolchain
4504 (http://www.mingw.org). Set your HOST tools to the MinGW
4505 toolchain and execute 'make tools'. For example:
4506
4507 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4508
4509 Binaries such as tools/mkimage.exe will be created which can
4510 be executed on computers running Windows.
4511
Wolfgang Denk218ca722008-03-26 10:40:12 +01004512U-Boot is intended to be simple to build. After installing the
4513sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004514is done by typing:
4515
4516 make NAME_config
4517
Wolfgang Denk218ca722008-03-26 10:40:12 +01004518where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004519rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521Note: for some board special configuration names may exist; check if
4522 additional information is available from the board vendor; for
4523 instance, the TQM823L systems are available without (standard)
4524 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004525 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004526
wdenk2729af92004-05-03 20:45:30 +00004527 make TQM823L_config
4528 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004529
wdenk2729af92004-05-03 20:45:30 +00004530 make TQM823L_LCD_config
4531 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533 etc.
wdenkc6097192002-11-03 00:24:07 +00004534
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536Finally, type "make all", and you should get some working U-Boot
4537images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539- "u-boot.bin" is a raw binary image
4540- "u-boot" is an image in ELF binary format
4541- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004542
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004543By default the build is performed locally and the objects are saved
4544in the source directory. One of the two methods can be used to change
4545this behavior and build U-Boot to some external directory:
4546
45471. Add O= to the make command line invocations:
4548
4549 make O=/tmp/build distclean
4550 make O=/tmp/build NAME_config
4551 make O=/tmp/build all
4552
45532. Set environment variable BUILD_DIR to point to the desired location:
4554
4555 export BUILD_DIR=/tmp/build
4556 make distclean
4557 make NAME_config
4558 make all
4559
4560Note that the command line "O=" setting overrides the BUILD_DIR environment
4561variable.
4562
wdenkc6097192002-11-03 00:24:07 +00004563
wdenk2729af92004-05-03 20:45:30 +00004564Please be aware that the Makefiles assume you are using GNU make, so
4565for instance on NetBSD you might need to use "gmake" instead of
4566native "make".
wdenkc6097192002-11-03 00:24:07 +00004567
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569If the system board that you have is not listed, then you will need
4570to port U-Boot to your hardware platform. To do this, follow these
4571steps:
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk2729af92004-05-03 20:45:30 +000045731. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004574 "boards.cfg" file, using the existing entries as examples.
4575 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000045762. Create a new directory to hold your board specific code. Add any
4577 files you need. In your board directory, you will need at least
4578 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
45793. Create a new configuration file "include/configs/<board>.h" for
4580 your board
45813. If you're porting U-Boot to a new CPU, then also create a new
4582 directory to hold your CPU specific code. Add any files you need.
45834. Run "make <board>_config" with your new name.
45845. Type "make", and you should get a working "u-boot.srec" file
4585 to be installed on your target system.
45866. Debug and solve any problems that might arise.
4587 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004588
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4591==============================================================
wdenkc6097192002-11-03 00:24:07 +00004592
Wolfgang Denk218ca722008-03-26 10:40:12 +01004593If you have modified U-Boot sources (for instance added a new board
4594or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004595provide feedback to the other developers. The feedback normally takes
4596the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004597official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004598
Wolfgang Denk218ca722008-03-26 10:40:12 +01004599But before you submit such a patch, please verify that your modifi-
4600cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004601the supported boards compile WITHOUT ANY compiler warnings. To do so,
4602just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004603for ALL supported system. Be warned, this will take a while. You can
4604select which (cross) compiler to use by passing a `CROSS_COMPILE'
4605environment variable to the script, i. e. to use the ELDK cross tools
4606you can type
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004609
wdenk2729af92004-05-03 20:45:30 +00004610or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004613
Wolfgang Denk218ca722008-03-26 10:40:12 +01004614When using the MAKEALL script, the default behaviour is to build
4615U-Boot in the source directory. This location can be changed by
4616setting the BUILD_DIR environment variable. Also, for each target
4617built, the MAKEALL script saves two log files (<target>.ERR and
4618<target>.MAKEALL) in the <source dir>/LOG directory. This default
4619location can be changed by setting the MAKEALL_LOGDIR environment
4620variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004621
4622 export BUILD_DIR=/tmp/build
4623 export MAKEALL_LOGDIR=/tmp/log
4624 CROSS_COMPILE=ppc_8xx- MAKEALL
4625
Wolfgang Denk218ca722008-03-26 10:40:12 +01004626With the above settings build objects are saved in the /tmp/build,
4627log files are saved in the /tmp/log and the source tree remains clean
4628during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004629
4630
wdenk2729af92004-05-03 20:45:30 +00004631See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004632
wdenkc6097192002-11-03 00:24:07 +00004633
wdenk2729af92004-05-03 20:45:30 +00004634Monitor Commands - Overview:
4635============================
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk2729af92004-05-03 20:45:30 +00004637go - start application at address 'addr'
4638run - run commands in an environment variable
4639bootm - boot application image from memory
4640bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004641bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004642tftpboot- boot image via network using TFTP protocol
4643 and env variables "ipaddr" and "serverip"
4644 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004645tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004646rarpboot- boot image via network using RARP/TFTP protocol
4647diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4648loads - load S-Record file over serial line
4649loadb - load binary file over serial line (kermit mode)
4650md - memory display
4651mm - memory modify (auto-incrementing)
4652nm - memory modify (constant address)
4653mw - memory write (fill)
4654cp - memory copy
4655cmp - memory compare
4656crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004657i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004658sspi - SPI utility commands
4659base - print or set address offset
4660printenv- print environment variables
4661setenv - set environment variables
4662saveenv - save environment variables to persistent storage
4663protect - enable or disable FLASH write protection
4664erase - erase FLASH memory
4665flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004666nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004667bdinfo - print Board Info structure
4668iminfo - print header information for application image
4669coninfo - print console devices and informations
4670ide - IDE sub-system
4671loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004672loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004673mtest - simple RAM test
4674icache - enable or disable instruction cache
4675dcache - enable or disable data cache
4676reset - Perform RESET of the CPU
4677echo - echo args to console
4678version - print monitor version
4679help - print online help
4680? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004681
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk2729af92004-05-03 20:45:30 +00004683Monitor Commands - Detailed Description:
4684========================================
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686TODO.
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk2729af92004-05-03 20:45:30 +00004688For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004689
4690
wdenk2729af92004-05-03 20:45:30 +00004691Environment Variables:
4692======================
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694U-Boot supports user configuration using Environment Variables which
4695can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004696
wdenk2729af92004-05-03 20:45:30 +00004697Environment Variables are set using "setenv", printed using
4698"printenv", and saved to Flash using "saveenv". Using "setenv"
4699without a value can be used to delete a variable from the
4700environment. As long as you don't save the environment you are
4701working with an in-memory copy. In case the Flash area containing the
4702environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004703
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004704Some configuration options can be set using Environment Variables.
4705
4706List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk2729af92004-05-03 20:45:30 +00004708 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk2729af92004-05-03 20:45:30 +00004710 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004711
wdenk2729af92004-05-03 20:45:30 +00004712 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004717
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004718 bootm_low - Memory range available for image processing in the bootm
4719 command can be restricted. This variable is given as
4720 a hexadecimal number and defines lowest address allowed
4721 for use by the bootm command. See also "bootm_size"
4722 environment variable. Address defined by "bootm_low" is
4723 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004724 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4725 bootm_mapsize.
4726
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004727 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004728 This variable is given as a hexadecimal number and it
4729 defines the size of the memory region starting at base
4730 address bootm_low that is accessible by the Linux kernel
4731 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4732 as the default value if it is defined, and bootm_size is
4733 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004734
4735 bootm_size - Memory range available for image processing in the bootm
4736 command can be restricted. This variable is given as
4737 a hexadecimal number and defines the size of the region
4738 allowed for use by the bootm command. See also "bootm_low"
4739 environment variable.
4740
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004741 updatefile - Location of the software update file on a TFTP server, used
4742 by the automatic software update feature. Please refer to
4743 documentation in doc/README.update for more details.
4744
wdenk2729af92004-05-03 20:45:30 +00004745 autoload - if set to "no" (any string beginning with 'n'),
4746 "bootp" will just load perform a lookup of the
4747 configuration from the BOOTP server, but not try to
4748 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004749
wdenk2729af92004-05-03 20:45:30 +00004750 autostart - if set to "yes", an image loaded using the "bootp",
4751 "rarpboot", "tftpboot" or "diskboot" commands will
4752 be automatically started (by internally calling
4753 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755 If set to "no", a standalone image passed to the
4756 "bootm" command will be copied to the load address
4757 (and eventually uncompressed), but NOT be started.
4758 This can be used to load and uncompress arbitrary
4759 data.
wdenkc6097192002-11-03 00:24:07 +00004760
David A. Longa28afca2011-07-09 16:40:19 -04004761 fdt_high - if set this restricts the maximum address that the
4762 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004763 For example, if you have a system with 1 GB memory
4764 at physical address 0x10000000, while Linux kernel
4765 only recognizes the first 704 MB as low memory, you
4766 may need to set fdt_high as 0x3C000000 to have the
4767 device tree blob be copied to the maximum address
4768 of the 704 MB low memory, so that Linux kernel can
4769 access it during the boot procedure.
4770
David A. Longa28afca2011-07-09 16:40:19 -04004771 If this is set to the special value 0xFFFFFFFF then
4772 the fdt will not be copied at all on boot. For this
4773 to work it must reside in writable memory, have
4774 sufficient padding on the end of it for u-boot to
4775 add the information it needs into it, and the memory
4776 must be accessible by the kernel.
4777
Simon Glasseea63e02011-10-24 19:15:34 +00004778 fdtcontroladdr- if set this is the address of the control flattened
4779 device tree used by U-Boot when CONFIG_OF_CONTROL is
4780 defined.
4781
wdenk17ea1172004-06-06 21:51:03 +00004782 i2cfast - (PPC405GP|PPC405EP only)
4783 if set to 'y' configures Linux I2C driver for fast
4784 mode (400kHZ). This environment variable is used in
4785 initialization code. So, for changes to be effective
4786 it must be saved and board must be reset.
4787
wdenk2729af92004-05-03 20:45:30 +00004788 initrd_high - restrict positioning of initrd images:
4789 If this variable is not set, initrd images will be
4790 copied to the highest possible address in RAM; this
4791 is usually what you want since it allows for
4792 maximum initrd size. If for some reason you want to
4793 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004794 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004795 variable to a value of "no" or "off" or "0".
4796 Alternatively, you can set it to a maximum upper
4797 address to use (U-Boot will still check that it
4798 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004799
wdenk2729af92004-05-03 20:45:30 +00004800 For instance, when you have a system with 16 MB
4801 RAM, and want to reserve 4 MB from use by Linux,
4802 you can do this by adding "mem=12M" to the value of
4803 the "bootargs" variable. However, now you must make
4804 sure that the initrd image is placed in the first
4805 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk2729af92004-05-03 20:45:30 +00004807 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk2729af92004-05-03 20:45:30 +00004809 If you set initrd_high to 0xFFFFFFFF, this is an
4810 indication to U-Boot that all addresses are legal
4811 for the Linux kernel, including addresses in flash
4812 memory. In this case U-Boot will NOT COPY the
4813 ramdisk at all. This may be useful to reduce the
4814 boot time on your system, but requires that this
4815 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004816
wdenk2729af92004-05-03 20:45:30 +00004817 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004818
wdenk2729af92004-05-03 20:45:30 +00004819 loadaddr - Default load address for commands like "bootp",
4820 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk2729af92004-05-03 20:45:30 +00004822 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk2729af92004-05-03 20:45:30 +00004824 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004831
Mike Frysingere2a53452011-10-02 10:01:27 +00004832 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004833
Mike Frysingere2a53452011-10-02 10:01:27 +00004834 ethact - controls which interface is currently active.
4835 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004836
Heiko Schocher48690d82010-07-20 17:45:02 +02004837 => setenv ethact FEC
4838 => ping 192.168.0.1 # traffic sent on FEC
4839 => setenv ethact SCC
4840 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004841
Matthias Fuchse1692572008-01-17 07:45:05 +01004842 ethrotate - When set to "no" U-Boot does not go through all
4843 available network interfaces.
4844 It just stays at the currently selected interface.
4845
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004846 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004847 either succeed or fail without retrying.
4848 When set to "once" the network operation will
4849 fail when all the available network interfaces
4850 are tried once without success.
4851 Useful on scripts which control the retry operation
4852 themselves.
wdenkc6097192002-11-03 00:24:07 +00004853
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004854 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004855
Simon Glass8d51aac2013-07-16 20:10:00 -07004856 silent_linux - If set then linux will be told to boot silently, by
4857 changing the console to be empty. If "yes" it will be
4858 made silent. If "no" it will not be made silent. If
4859 unset, then it will be made silent if the U-Boot console
4860 is silent.
4861
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004862 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004863 UDP source port.
4864
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004865 tftpdstport - If this is set, the value is used for TFTP's UDP
4866 destination port instead of the Well Know Port 69.
4867
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004868 tftpblocksize - Block size to use for TFTP transfers; if not set,
4869 we use the TFTP server's default block size
4870
4871 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4872 seconds, minimum value is 1000 = 1 second). Defines
4873 when a packet is considered to be lost so it has to
4874 be retransmitted. The default is 5000 = 5 seconds.
4875 Lowering this value may make downloads succeed
4876 faster in networks with high packet loss rates or
4877 with unreliable TFTP servers.
4878
4879 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004880 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004881 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004882
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004883The following image location variables contain the location of images
4884used in booting. The "Image" column gives the role of the image and is
4885not an environment variable name. The other columns are environment
4886variable names. "File Name" gives the name of the file on a TFTP
4887server, "RAM Address" gives the location in RAM the image will be
4888loaded to, and "Flash Location" gives the image's address in NOR
4889flash or offset in NAND flash.
4890
4891*Note* - these variables don't have to be defined for all boards, some
4892boards currenlty use other variables for these purposes, and some
4893boards use these variables for other purposes.
4894
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004895Image File Name RAM Address Flash Location
4896----- --------- ----------- --------------
4897u-boot u-boot u-boot_addr_r u-boot_addr
4898Linux kernel bootfile kernel_addr_r kernel_addr
4899device tree blob fdtfile fdt_addr_r fdt_addr
4900ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004901
wdenk2729af92004-05-03 20:45:30 +00004902The following environment variables may be used and automatically
4903updated by the network boot commands ("bootp" and "rarpboot"),
4904depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906 bootfile - see above
4907 dnsip - IP address of your Domain Name Server
4908 dnsip2 - IP address of your secondary Domain Name Server
4909 gatewayip - IP address of the Gateway (Router) to use
4910 hostname - Target hostname
4911 ipaddr - see above
4912 netmask - Subnet Mask
4913 rootpath - Pathname of the root filesystem on the NFS server
4914 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004915
wdenka3d991b2004-04-15 21:48:45 +00004916
wdenk2729af92004-05-03 20:45:30 +00004917There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk2729af92004-05-03 20:45:30 +00004919 serial# - contains hardware identification information such
4920 as type string and/or serial number
4921 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004922
wdenk2729af92004-05-03 20:45:30 +00004923These variables can be set only once (usually during manufacturing of
4924the board). U-Boot refuses to delete or overwrite these variables
4925once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004926
4927
wdenk2729af92004-05-03 20:45:30 +00004928Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004929
wdenk2729af92004-05-03 20:45:30 +00004930 ver - Contains the U-Boot version string as printed
4931 with the "version" command. This variable is
4932 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004933
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk2729af92004-05-03 20:45:30 +00004935Please note that changes to some configuration parameters may take
4936only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004937
stroesec1551ea2003-04-04 15:53:41 +00004938
Joe Hershberger170ab112012-12-11 22:16:24 -06004939Callback functions for environment variables:
4940---------------------------------------------
4941
4942For some environment variables, the behavior of u-boot needs to change
4943when their values are changed. This functionailty allows functions to
4944be associated with arbitrary variables. On creation, overwrite, or
4945deletion, the callback will provide the opportunity for some side
4946effect to happen or for the change to be rejected.
4947
4948The callbacks are named and associated with a function using the
4949U_BOOT_ENV_CALLBACK macro in your board or driver code.
4950
4951These callbacks are associated with variables in one of two ways. The
4952static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4953in the board configuration to a string that defines a list of
4954associations. The list must be in the following format:
4955
4956 entry = variable_name[:callback_name]
4957 list = entry[,list]
4958
4959If the callback name is not specified, then the callback is deleted.
4960Spaces are also allowed anywhere in the list.
4961
4962Callbacks can also be associated by defining the ".callbacks" variable
4963with the same list format above. Any association in ".callbacks" will
4964override any association in the static list. You can define
4965CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4966".callbacks" envirnoment variable in the default or embedded environment.
4967
4968
wdenk2729af92004-05-03 20:45:30 +00004969Command Line Parsing:
4970=====================
stroesec1551ea2003-04-04 15:53:41 +00004971
wdenk2729af92004-05-03 20:45:30 +00004972There are two different command line parsers available with U-Boot:
4973the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975Old, simple command line parser:
4976--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk2729af92004-05-03 20:45:30 +00004978- supports environment variables (through setenv / saveenv commands)
4979- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004980- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004981- special characters ('$', ';') can be escaped by prefixing with '\',
4982 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004983 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004984- You can also escape text by enclosing in single apostrophes, for example:
4985 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk2729af92004-05-03 20:45:30 +00004987Hush shell:
4988-----------
wdenkf07771c2003-05-28 08:06:31 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990- similar to Bourne shell, with control structures like
4991 if...then...else...fi, for...do...done; while...do...done,
4992 until...do...done, ...
4993- supports environment ("global") variables (through setenv / saveenv
4994 commands) and local shell variables (through standard shell syntax
4995 "name=value"); only environment variables can be used with "run"
4996 command
wdenkf07771c2003-05-28 08:06:31 +00004997
wdenk2729af92004-05-03 20:45:30 +00004998General rules:
4999--------------
wdenkf07771c2003-05-28 08:06:31 +00005000
wdenk2729af92004-05-03 20:45:30 +00005001(1) If a command line (or an environment variable executed by a "run"
5002 command) contains several commands separated by semicolon, and
5003 one of these commands fails, then the remaining commands will be
5004 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005005
wdenk2729af92004-05-03 20:45:30 +00005006(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005007 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005008 command will cause "run" to terminate, i. e. the remaining
5009 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011Note for Redundant Ethernet Interfaces:
5012=======================================
wdenkf07771c2003-05-28 08:06:31 +00005013
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005014Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005015such configurations and is capable of automatic selection of a
5016"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005017
wdenk2729af92004-05-03 20:45:30 +00005018Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5019MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5020"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005021
wdenk2729af92004-05-03 20:45:30 +00005022If the network interface stores some valid MAC address (for instance
5023in SROM), this is used as default address if there is NO correspon-
5024ding setting in the environment; if the corresponding environment
5025variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005026
wdenk2729af92004-05-03 20:45:30 +00005027o If the SROM has a valid MAC address, and there is no address in the
5028 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030o If there is no valid address in the SROM, and a definition in the
5031 environment exists, then the value from the environment variable is
5032 used.
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk2729af92004-05-03 20:45:30 +00005034o If both the SROM and the environment contain a MAC address, and
5035 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk2729af92004-05-03 20:45:30 +00005037o If both the SROM and the environment contain a MAC address, and the
5038 addresses differ, the value from the environment is used and a
5039 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005040
wdenk2729af92004-05-03 20:45:30 +00005041o If neither SROM nor the environment contain a MAC address, an error
5042 is raised.
wdenkc6097192002-11-03 00:24:07 +00005043
Ben Warrenecee9322010-04-26 11:11:46 -07005044If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005045will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005046may be skipped by setting the appropriate 'ethmacskip' environment variable.
5047The naming convention is as follows:
5048"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005049
wdenk2729af92004-05-03 20:45:30 +00005050Image Formats:
5051==============
wdenkc6097192002-11-03 00:24:07 +00005052
Marian Balakowicz3310c542008-03-12 12:13:13 +01005053U-Boot is capable of booting (and performing other auxiliary operations on)
5054images in two formats:
5055
5056New uImage format (FIT)
5057-----------------------
5058
5059Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5060to Flattened Device Tree). It allows the use of images with multiple
5061components (several kernels, ramdisks, etc.), with contents protected by
5062SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5063
5064
5065Old uImage format
5066-----------------
5067
5068Old image format is based on binary files which can be basically anything,
5069preceded by a special header; see the definitions in include/image.h for
5070details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk2729af92004-05-03 20:45:30 +00005072* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5073 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005074 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5075 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5076 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005077* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005078 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5079 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005080* Compression Type (uncompressed, gzip, bzip2)
5081* Load Address
5082* Entry Point
5083* Image Name
5084* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005085
wdenk2729af92004-05-03 20:45:30 +00005086The header is marked by a special Magic Number, and both the header
5087and the data portions of the image are secured against corruption by
5088CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005089
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk2729af92004-05-03 20:45:30 +00005091Linux Support:
5092==============
wdenkc6097192002-11-03 00:24:07 +00005093
wdenk2729af92004-05-03 20:45:30 +00005094Although U-Boot should support any OS or standalone application
5095easily, the main focus has always been on Linux during the design of
5096U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098U-Boot includes many features that so far have been part of some
5099special "boot loader" code within the Linux kernel. Also, any
5100"initrd" images to be used are no longer part of one big Linux image;
5101instead, kernel and "initrd" are separate images. This implementation
5102serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk2729af92004-05-03 20:45:30 +00005104- the same features can be used for other OS or standalone
5105 applications (for instance: using compressed images to reduce the
5106 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk2729af92004-05-03 20:45:30 +00005108- it becomes much easier to port new Linux kernel versions because
5109 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk2729af92004-05-03 20:45:30 +00005111- the same Linux kernel image can now be used with different "initrd"
5112 images; of course this also means that different kernel images can
5113 be run with the same "initrd". This makes testing easier (you don't
5114 have to build a new "zImage.initrd" Linux image when you just
5115 change a file in your "initrd"). Also, a field-upgrade of the
5116 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005117
wdenkc6097192002-11-03 00:24:07 +00005118
wdenk2729af92004-05-03 20:45:30 +00005119Linux HOWTO:
5120============
wdenkc6097192002-11-03 00:24:07 +00005121
wdenk2729af92004-05-03 20:45:30 +00005122Porting Linux to U-Boot based systems:
5123---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125U-Boot cannot save you from doing all the necessary modifications to
5126configure the Linux device drivers for use with your target hardware
5127(no, we don't intend to provide a full virtual machine interface to
5128Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005129
Stefan Roesea47a12b2010-04-15 16:07:28 +02005130But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk2729af92004-05-03 20:45:30 +00005132Just make sure your machine specific header file (for instance
5133include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005134Information structure as we define in include/asm-<arch>/u-boot.h,
5135and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005136as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005137
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk2729af92004-05-03 20:45:30 +00005139Configuring the Linux kernel:
5140-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk2729af92004-05-03 20:45:30 +00005142No specific requirements for U-Boot. Make sure you have some root
5143device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005144
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk2729af92004-05-03 20:45:30 +00005146Building a Linux Image:
5147-----------------------
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5150not used. If you use recent kernel source, a new build target
5151"uImage" will exist which automatically builds an image usable by
5152U-Boot. Most older kernels also have support for a "pImage" target,
5153which was introduced for our predecessor project PPCBoot and uses a
5154100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156Example:
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk2729af92004-05-03 20:45:30 +00005158 make TQM850L_config
5159 make oldconfig
5160 make dep
5161 make uImage
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk2729af92004-05-03 20:45:30 +00005163The "uImage" build target uses a special tool (in 'tools/mkimage') to
5164encapsulate a compressed Linux kernel image with header information,
5165CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk2729af92004-05-03 20:45:30 +00005169* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171 ${CROSS_COMPILE}-objcopy -O binary \
5172 -R .note -R .comment \
5173 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk2729af92004-05-03 20:45:30 +00005179* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005180
wdenk2729af92004-05-03 20:45:30 +00005181 mkimage -A ppc -O linux -T kernel -C gzip \
5182 -a 0 -e 0 -n "Linux Kernel Image" \
5183 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005184
wdenk24ee89b2002-11-03 17:56:27 +00005185
wdenk2729af92004-05-03 20:45:30 +00005186The "mkimage" tool can also be used to create ramdisk images for use
5187with U-Boot, either separated from the Linux kernel image, or
5188combined into one file. "mkimage" encapsulates the images with a 64
5189byte header containing information about target architecture,
5190operating system, image type, compression method, entry points, time
5191stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005192
wdenk2729af92004-05-03 20:45:30 +00005193"mkimage" can be called in two ways: to verify existing images and
5194print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005195
wdenk2729af92004-05-03 20:45:30 +00005196In the first form (with "-l" option) mkimage lists the information
5197contained in the header of an existing U-Boot image; this includes
5198checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005199
wdenk2729af92004-05-03 20:45:30 +00005200 tools/mkimage -l image
5201 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005202
wdenk2729af92004-05-03 20:45:30 +00005203The second form (with "-d" option) is used to build a U-Boot image
5204from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005205
wdenk2729af92004-05-03 20:45:30 +00005206 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5207 -n name -d data_file image
5208 -A ==> set architecture to 'arch'
5209 -O ==> set operating system to 'os'
5210 -T ==> set image type to 'type'
5211 -C ==> set compression type 'comp'
5212 -a ==> set load address to 'addr' (hex)
5213 -e ==> set entry point to 'ep' (hex)
5214 -n ==> set image name to 'name'
5215 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005216
wdenk69459792004-05-29 16:53:29 +00005217Right now, all Linux kernels for PowerPC systems use the same load
5218address (0x00000000), but the entry point address depends on the
5219kernel version:
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk2729af92004-05-03 20:45:30 +00005221- 2.2.x kernels have the entry point at 0x0000000C,
5222- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk2729af92004-05-03 20:45:30 +00005224So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5227 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005228 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005229 > examples/uImage.TQM850L
5230 Image Name: 2.4.4 kernel for TQM850L
5231 Created: Wed Jul 19 02:34:59 2000
5232 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5233 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5234 Load Address: 0x00000000
5235 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk2729af92004-05-03 20:45:30 +00005237To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk2729af92004-05-03 20:45:30 +00005239 -> tools/mkimage -l examples/uImage.TQM850L
5240 Image Name: 2.4.4 kernel for TQM850L
5241 Created: Wed Jul 19 02:34:59 2000
5242 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5243 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5244 Load Address: 0x00000000
5245 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk2729af92004-05-03 20:45:30 +00005247NOTE: for embedded systems where boot time is critical you can trade
5248speed for memory and install an UNCOMPRESSED image instead: this
5249needs more space in Flash, but boots much faster since it does not
5250need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005251
Stefan Roesea47a12b2010-04-15 16:07:28 +02005252 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005253 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5254 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005255 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005256 > examples/uImage.TQM850L-uncompressed
5257 Image Name: 2.4.4 kernel for TQM850L
5258 Created: Wed Jul 19 02:34:59 2000
5259 Image Type: PowerPC Linux Kernel Image (uncompressed)
5260 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5261 Load Address: 0x00000000
5262 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005263
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk2729af92004-05-03 20:45:30 +00005265Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5266when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005267
wdenk2729af92004-05-03 20:45:30 +00005268 -> tools/mkimage -n 'Simple Ramdisk Image' \
5269 > -A ppc -O linux -T ramdisk -C gzip \
5270 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5271 Image Name: Simple Ramdisk Image
5272 Created: Wed Jan 12 14:01:50 2000
5273 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5274 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5275 Load Address: 0x00000000
5276 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005277
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005278The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5279option performs the converse operation of the mkimage's second form (the "-d"
5280option). Given an image built by mkimage, the dumpimage extracts a "data file"
5281from the image:
5282
5283 tools/dumpimage -i image -p position data_file
5284 -i ==> extract from the 'image' a specific 'data_file', \
5285 indexed by 'position'
5286
wdenkdb01a2e2004-04-15 23:14:49 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288Installing a Linux Image:
5289-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291To downloading a U-Boot image over the serial (console) interface,
5292you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005295
wdenk2729af92004-05-03 20:45:30 +00005296The 'objcopy' does not understand the information in the U-Boot
5297image header, so the resulting S-Record file will be relative to
5298address 0x00000000. To load it to a given address, you need to
5299specify the target address as 'offset' parameter with the 'loads'
5300command.
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk2729af92004-05-03 20:45:30 +00005302Example: install the image to address 0x40100000 (which on the
5303TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk2729af92004-05-03 20:45:30 +00005305 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk2729af92004-05-03 20:45:30 +00005307 .......... done
5308 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk2729af92004-05-03 20:45:30 +00005310 => loads 40100000
5311 ## Ready for S-Record download ...
5312 ~>examples/image.srec
5313 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5314 ...
5315 15989 15990 15991 15992
5316 [file transfer complete]
5317 [connected]
5318 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005319
5320
wdenk2729af92004-05-03 20:45:30 +00005321You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005322this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005323corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk2729af92004-05-03 20:45:30 +00005325 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk2729af92004-05-03 20:45:30 +00005327 ## Checking Image at 40100000 ...
5328 Image Name: 2.2.13 for initrd on TQM850L
5329 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5330 Data Size: 335725 Bytes = 327 kB = 0 MB
5331 Load Address: 00000000
5332 Entry Point: 0000000c
5333 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005334
5335
wdenk2729af92004-05-03 20:45:30 +00005336Boot Linux:
5337-----------
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk2729af92004-05-03 20:45:30 +00005339The "bootm" command is used to boot an application that is stored in
5340memory (RAM or Flash). In case of a Linux kernel image, the contents
5341of the "bootargs" environment variable is passed to the kernel as
5342parameters. You can check and modify this variable using the
5343"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005344
5345
wdenk2729af92004-05-03 20:45:30 +00005346 => printenv bootargs
5347 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk2729af92004-05-03 20:45:30 +00005349 => 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 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351 => printenv bootargs
5352 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 +00005353
wdenk2729af92004-05-03 20:45:30 +00005354 => bootm 40020000
5355 ## Booting Linux kernel at 40020000 ...
5356 Image Name: 2.2.13 for NFS on TQM850L
5357 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5358 Data Size: 381681 Bytes = 372 kB = 0 MB
5359 Load Address: 00000000
5360 Entry Point: 0000000c
5361 Verifying Checksum ... OK
5362 Uncompressing Kernel Image ... OK
5363 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
5364 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5365 time_init: decrementer frequency = 187500000/60
5366 Calibrating delay loop... 49.77 BogoMIPS
5367 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5368 ...
wdenkc6097192002-11-03 00:24:07 +00005369
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005370If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005371the memory addresses of both the kernel and the initrd image (PPBCOOT
5372format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005373
wdenk2729af92004-05-03 20:45:30 +00005374 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376 ## Checking Image at 40100000 ...
5377 Image Name: 2.2.13 for initrd on TQM850L
5378 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5379 Data Size: 335725 Bytes = 327 kB = 0 MB
5380 Load Address: 00000000
5381 Entry Point: 0000000c
5382 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384 ## Checking Image at 40200000 ...
5385 Image Name: Simple Ramdisk Image
5386 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5387 Data Size: 566530 Bytes = 553 kB = 0 MB
5388 Load Address: 00000000
5389 Entry Point: 00000000
5390 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392 => bootm 40100000 40200000
5393 ## Booting Linux kernel at 40100000 ...
5394 Image Name: 2.2.13 for initrd on TQM850L
5395 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5396 Data Size: 335725 Bytes = 327 kB = 0 MB
5397 Load Address: 00000000
5398 Entry Point: 0000000c
5399 Verifying Checksum ... OK
5400 Uncompressing Kernel Image ... OK
5401 ## Loading RAMDisk Image at 40200000 ...
5402 Image Name: Simple Ramdisk Image
5403 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5404 Data Size: 566530 Bytes = 553 kB = 0 MB
5405 Load Address: 00000000
5406 Entry Point: 00000000
5407 Verifying Checksum ... OK
5408 Loading Ramdisk ... OK
5409 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
5410 Boot arguments: root=/dev/ram
5411 time_init: decrementer frequency = 187500000/60
5412 Calibrating delay loop... 49.77 BogoMIPS
5413 ...
5414 RAMDISK: Compressed image found at block 0
5415 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk2729af92004-05-03 20:45:30 +00005417 bash#
wdenkc6097192002-11-03 00:24:07 +00005418
Matthew McClintock02677682006-06-28 10:41:37 -05005419Boot Linux and pass a flat device tree:
5420-----------
5421
5422First, U-Boot must be compiled with the appropriate defines. See the section
5423titled "Linux Kernel Interface" above for a more in depth explanation. The
5424following is an example of how to start a kernel and pass an updated
5425flat device tree:
5426
5427=> print oftaddr
5428oftaddr=0x300000
5429=> print oft
5430oft=oftrees/mpc8540ads.dtb
5431=> tftp $oftaddr $oft
5432Speed: 1000, full duplex
5433Using TSEC0 device
5434TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5435Filename 'oftrees/mpc8540ads.dtb'.
5436Load address: 0x300000
5437Loading: #
5438done
5439Bytes transferred = 4106 (100a hex)
5440=> tftp $loadaddr $bootfile
5441Speed: 1000, full duplex
5442Using TSEC0 device
5443TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5444Filename 'uImage'.
5445Load address: 0x200000
5446Loading:############
5447done
5448Bytes transferred = 1029407 (fb51f hex)
5449=> print loadaddr
5450loadaddr=200000
5451=> print oftaddr
5452oftaddr=0x300000
5453=> bootm $loadaddr - $oftaddr
5454## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005455 Image Name: Linux-2.6.17-dirty
5456 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5457 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005458 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005459 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005460 Verifying Checksum ... OK
5461 Uncompressing Kernel Image ... OK
5462Booting using flat device tree at 0x300000
5463Using MPC85xx ADS machine description
5464Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5465[snip]
5466
5467
wdenk2729af92004-05-03 20:45:30 +00005468More About U-Boot Image Types:
5469------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005470
wdenk2729af92004-05-03 20:45:30 +00005471U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005472
wdenk2729af92004-05-03 20:45:30 +00005473 "Standalone Programs" are directly runnable in the environment
5474 provided by U-Boot; it is expected that (if they behave
5475 well) you can continue to work in U-Boot after return from
5476 the Standalone Program.
5477 "OS Kernel Images" are usually images of some Embedded OS which
5478 will take over control completely. Usually these programs
5479 will install their own set of exception handlers, device
5480 drivers, set up the MMU, etc. - this means, that you cannot
5481 expect to re-enter U-Boot except by resetting the CPU.
5482 "RAMDisk Images" are more or less just data blocks, and their
5483 parameters (address, size) are passed to an OS kernel that is
5484 being started.
5485 "Multi-File Images" contain several images, typically an OS
5486 (Linux) kernel image and one or more data images like
5487 RAMDisks. This construct is useful for instance when you want
5488 to boot over the network using BOOTP etc., where the boot
5489 server provides just a single image file, but you want to get
5490 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492 "Multi-File Images" start with a list of image sizes, each
5493 image size (in bytes) specified by an "uint32_t" in network
5494 byte order. This list is terminated by an "(uint32_t)0".
5495 Immediately after the terminating 0 follow the images, one by
5496 one, all aligned on "uint32_t" boundaries (size rounded up to
5497 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005498
wdenk2729af92004-05-03 20:45:30 +00005499 "Firmware Images" are binary images containing firmware (like
5500 U-Boot or FPGA images) which usually will be programmed to
5501 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503 "Script files" are command sequences that will be executed by
5504 U-Boot's command interpreter; this feature is especially
5505 useful when you configure U-Boot to use a real shell (hush)
5506 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005507
Marek Vasut44f074c2012-03-14 21:52:45 +00005508Booting the Linux zImage:
5509-------------------------
5510
5511On some platforms, it's possible to boot Linux zImage. This is done
5512using the "bootz" command. The syntax of "bootz" command is the same
5513as the syntax of "bootm" command.
5514
Tom Rini8ac28562013-05-16 11:40:11 -04005515Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005516kernel with raw initrd images. The syntax is slightly different, the
5517address of the initrd must be augmented by it's size, in the following
5518format: "<initrd addres>:<initrd size>".
5519
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk2729af92004-05-03 20:45:30 +00005521Standalone HOWTO:
5522=================
wdenkc6097192002-11-03 00:24:07 +00005523
wdenk2729af92004-05-03 20:45:30 +00005524One of the features of U-Boot is that you can dynamically load and
5525run "standalone" applications, which can use some resources of
5526U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk2729af92004-05-03 20:45:30 +00005528Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk2729af92004-05-03 20:45:30 +00005530"Hello World" Demo:
5531-------------------
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk2729af92004-05-03 20:45:30 +00005533'examples/hello_world.c' contains a small "Hello World" Demo
5534application; it is automatically compiled when you build U-Boot.
5535It's configured to run at address 0x00040004, so you can play with it
5536like that:
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk2729af92004-05-03 20:45:30 +00005538 => loads
5539 ## Ready for S-Record download ...
5540 ~>examples/hello_world.srec
5541 1 2 3 4 5 6 7 8 9 10 11 ...
5542 [file transfer complete]
5543 [connected]
5544 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk2729af92004-05-03 20:45:30 +00005546 => go 40004 Hello World! This is a test.
5547 ## Starting application at 0x00040004 ...
5548 Hello World
5549 argc = 7
5550 argv[0] = "40004"
5551 argv[1] = "Hello"
5552 argv[2] = "World!"
5553 argv[3] = "This"
5554 argv[4] = "is"
5555 argv[5] = "a"
5556 argv[6] = "test."
5557 argv[7] = "<NULL>"
5558 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk2729af92004-05-03 20:45:30 +00005560 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk2729af92004-05-03 20:45:30 +00005562Another example, which demonstrates how to register a CPM interrupt
5563handler with the U-Boot code, can be found in 'examples/timer.c'.
5564Here, a CPM timer is set up to generate an interrupt every second.
5565The interrupt service routine is trivial, just printing a '.'
5566character, but this is just a demo program. The application can be
5567controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569 ? - print current values og the CPM Timer registers
5570 b - enable interrupts and start timer
5571 e - stop timer and disable interrupts
5572 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk2729af92004-05-03 20:45:30 +00005574 => loads
5575 ## Ready for S-Record download ...
5576 ~>examples/timer.srec
5577 1 2 3 4 5 6 7 8 9 10 11 ...
5578 [file transfer complete]
5579 [connected]
5580 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582 => go 40004
5583 ## Starting application at 0x00040004 ...
5584 TIMERS=0xfff00980
5585 Using timer 1
5586 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005587
wdenk2729af92004-05-03 20:45:30 +00005588Hit 'b':
5589 [q, b, e, ?] Set interval 1000000 us
5590 Enabling timer
5591Hit '?':
5592 [q, b, e, ?] ........
5593 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5594Hit '?':
5595 [q, b, e, ?] .
5596 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5597Hit '?':
5598 [q, b, e, ?] .
5599 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5600Hit '?':
5601 [q, b, e, ?] .
5602 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5603Hit 'e':
5604 [q, b, e, ?] ...Stopping timer
5605Hit 'q':
5606 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005607
5608
wdenk2729af92004-05-03 20:45:30 +00005609Minicom warning:
5610================
wdenk85ec0bc2003-03-31 16:34:49 +00005611
wdenk2729af92004-05-03 20:45:30 +00005612Over time, many people have reported problems when trying to use the
5613"minicom" terminal emulation program for serial download. I (wd)
5614consider minicom to be broken, and recommend not to use it. Under
5615Unix, I recommend to use C-Kermit for general purpose use (and
5616especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005617use "cu" for S-Record download ("loads" command). See
5618http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5619for help with kermit.
5620
wdenk85ec0bc2003-03-31 16:34:49 +00005621
wdenk2729af92004-05-03 20:45:30 +00005622Nevertheless, if you absolutely want to use it try adding this
5623configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625 Name Program Name U/D FullScr IO-Red. Multi
5626 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5627 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005628
5629
wdenk2729af92004-05-03 20:45:30 +00005630NetBSD Notes:
5631=============
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk2729af92004-05-03 20:45:30 +00005633Starting at version 0.9.2, U-Boot supports NetBSD both as host
5634(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636Building requires a cross environment; it is known to work on
5637NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5638need gmake since the Makefiles are not compatible with BSD make).
5639Note that the cross-powerpc package does not install include files;
5640attempting to build U-Boot will fail because <machine/ansi.h> is
5641missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005642
wdenk2729af92004-05-03 20:45:30 +00005643 # cd /usr/pkg/cross/powerpc-netbsd/include
5644 # mkdir powerpc
5645 # ln -s powerpc machine
5646 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5647 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649Native builds *don't* work due to incompatibilities between native
5650and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652Booting assumes that (the first part of) the image booted is a
5653stage-2 loader which in turn loads and then invokes the kernel
5654proper. Loader sources will eventually appear in the NetBSD source
5655tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005656meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005657
5658
wdenk2729af92004-05-03 20:45:30 +00005659Implementation Internals:
5660=========================
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk2729af92004-05-03 20:45:30 +00005662The following is not intended to be a complete description of every
5663implementation detail. However, it should help to understand the
5664inner workings of U-Boot and make it easier to port it to custom
5665hardware.
wdenkc6097192002-11-03 00:24:07 +00005666
5667
wdenk2729af92004-05-03 20:45:30 +00005668Initial Stack, Global Data:
5669---------------------------
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk2729af92004-05-03 20:45:30 +00005671The implementation of U-Boot is complicated by the fact that U-Boot
5672starts running out of ROM (flash memory), usually without access to
5673system RAM (because the memory controller is not initialized yet).
5674This means that we don't have writable Data or BSS segments, and BSS
5675is not initialized as zero. To be able to get a C environment working
5676at all, we have to allocate at least a minimal stack. Implementation
5677options for this are defined and restricted by the CPU used: Some CPU
5678models provide on-chip memory (like the IMMR area on MPC8xx and
5679MPC826x processors), on others (parts of) the data cache can be
5680locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005681
Wolfgang Denk218ca722008-03-26 10:40:12 +01005682 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005683 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005684
wdenk2729af92004-05-03 20:45:30 +00005685 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5686 From: "Chris Hallinan" <clh@net1plus.com>
5687 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5688 ...
wdenk43d96162003-03-06 00:02:04 +00005689
wdenk2729af92004-05-03 20:45:30 +00005690 Correct me if I'm wrong, folks, but the way I understand it
5691 is this: Using DCACHE as initial RAM for Stack, etc, does not
5692 require any physical RAM backing up the cache. The cleverness
5693 is that the cache is being used as a temporary supply of
5694 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005695 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005696 can see how this works by studying the cache architecture and
5697 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005698
wdenk2729af92004-05-03 20:45:30 +00005699 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5700 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005701 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005702 option should work for you. Using CS 4 should be fine if your
5703 board designers haven't used it for something that would
5704 cause you grief during the initial boot! It is frequently not
5705 used.
wdenk43d96162003-03-06 00:02:04 +00005706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005707 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005708 with your processor/board/system design. The default value
5709 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005710 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005711 than your SDRAM module. If you have a 64MB SDRAM module, set
5712 it above 400_0000. Just make sure your board has no resources
5713 that are supposed to respond to that address! That code in
5714 start.S has been around a while and should work as is when
5715 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005716
wdenk2729af92004-05-03 20:45:30 +00005717 -Chris Hallinan
5718 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005719
wdenk2729af92004-05-03 20:45:30 +00005720It is essential to remember this, since it has some impact on the C
5721code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723* Initialized global data (data segment) is read-only. Do not attempt
5724 to write it.
wdenkc6097192002-11-03 00:24:07 +00005725
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005726* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005727 as zero data - BSS segment) at all - this is undefined, initiali-
5728 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005729
wdenk2729af92004-05-03 20:45:30 +00005730* Stack space is very limited. Avoid big data buffers or things like
5731 that.
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733Having only the stack as writable memory limits means we cannot use
5734normal global data to share information beween the code. But it
5735turned out that the implementation of U-Boot can be greatly
5736simplified by making a global data structure (gd_t) available to all
5737functions. We could pass a pointer to this data as argument to _all_
5738functions, but this would bloat the code. Instead we use a feature of
5739the GCC compiler (Global Register Variables) to share the data: we
5740place a pointer (gd) to the global data into a register which we
5741reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk2729af92004-05-03 20:45:30 +00005743When choosing a register for such a purpose we are restricted by the
5744relevant (E)ABI specifications for the current architecture, and by
5745GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747For PowerPC, the following registers have specific use:
5748 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005749 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005750 R3-R4: parameter passing and return values
5751 R5-R10: parameter passing
5752 R13: small data area pointer
5753 R30: GOT pointer
5754 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005755
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005756 (U-Boot also uses R12 as internal GOT pointer. r12
5757 is a volatile register so r12 needs to be reset when
5758 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005759
Wolfgang Denke7670f62008-02-14 22:43:22 +01005760 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk2729af92004-05-03 20:45:30 +00005762 Note: on PPC, we could use a static initializer (since the
5763 address of the global data structure is known at compile time),
5764 but it turned out that reserving a register results in somewhat
5765 smaller code - although the code savings are not that big (on
5766 average for all boards 752 bytes for the whole U-Boot image,
5767 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005768
Robin Getzc4db3352009-08-17 15:23:02 +00005769On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005770 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5771
Robin Getzc4db3352009-08-17 15:23:02 +00005772 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005773
wdenk2729af92004-05-03 20:45:30 +00005774On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk2729af92004-05-03 20:45:30 +00005776 R0: function argument word/integer result
5777 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005778 R9: platform specific
5779 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005780 R11: argument (frame) pointer
5781 R12: temporary workspace
5782 R13: stack pointer
5783 R14: link register
5784 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005785
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005786 ==> U-Boot will use R9 to hold a pointer to the global data
5787
5788 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005789
Thomas Chou0df01fd32010-05-21 11:08:03 +08005790On Nios II, the ABI is documented here:
5791 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5792
5793 ==> U-Boot will use gp to hold a pointer to the global data
5794
5795 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5796 to access small data sections, so gp is free.
5797
Macpaul Linafc1ce82011-10-19 20:41:11 +00005798On NDS32, the following registers are used:
5799
5800 R0-R1: argument/return
5801 R2-R5: argument
5802 R15: temporary register for assembler
5803 R16: trampoline register
5804 R28: frame pointer (FP)
5805 R29: global pointer (GP)
5806 R30: link register (LP)
5807 R31: stack pointer (SP)
5808 PC: program counter (PC)
5809
5810 ==> U-Boot will use R10 to hold a pointer to the global data
5811
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005812NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5813or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005814
wdenk2729af92004-05-03 20:45:30 +00005815Memory Management:
5816------------------
wdenkc6097192002-11-03 00:24:07 +00005817
wdenk2729af92004-05-03 20:45:30 +00005818U-Boot runs in system state and uses physical addresses, i.e. the
5819MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005820
wdenk2729af92004-05-03 20:45:30 +00005821The available memory is mapped to fixed addresses using the memory
5822controller. In this process, a contiguous block is formed for each
5823memory type (Flash, SDRAM, SRAM), even when it consists of several
5824physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005825
wdenk2729af92004-05-03 20:45:30 +00005826U-Boot is installed in the first 128 kB of the first Flash bank (on
5827TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5828booting and sizing and initializing DRAM, the code relocates itself
5829to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005830memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005831configuration setting]. Below that, a structure with global Board
5832Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk2729af92004-05-03 20:45:30 +00005834Additionally, some exception handler code is copied to the low 8 kB
5835of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005836
wdenk2729af92004-05-03 20:45:30 +00005837So a typical memory configuration with 16 MB of DRAM could look like
5838this:
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk2729af92004-05-03 20:45:30 +00005840 0x0000 0000 Exception Vector code
5841 :
5842 0x0000 1FFF
5843 0x0000 2000 Free for Application Use
5844 :
5845 :
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk2729af92004-05-03 20:45:30 +00005847 :
5848 :
5849 0x00FB FF20 Monitor Stack (Growing downward)
5850 0x00FB FFAC Board Info Data and permanent copy of global data
5851 0x00FC 0000 Malloc Arena
5852 :
5853 0x00FD FFFF
5854 0x00FE 0000 RAM Copy of Monitor Code
5855 ... eventually: LCD or video framebuffer
5856 ... eventually: pRAM (Protected RAM - unchanged by reset)
5857 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005858
5859
wdenk2729af92004-05-03 20:45:30 +00005860System Initialization:
5861----------------------
wdenkc6097192002-11-03 00:24:07 +00005862
wdenk2729af92004-05-03 20:45:30 +00005863In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005864(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005865configuration for CS0# this is a mirror of the onboard Flash memory.
5866To be able to re-map memory U-Boot then jumps to its link address.
5867To be able to implement the initialization code in C, a (small!)
5868initial stack is set up in the internal Dual Ported RAM (in case CPUs
5869which provide such a feature like MPC8xx or MPC8260), or in a locked
5870part of the data cache. After that, U-Boot initializes the CPU core,
5871the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk2729af92004-05-03 20:45:30 +00005873Next, all (potentially) available memory banks are mapped using a
5874preliminary mapping. For example, we put them on 512 MB boundaries
5875(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5876on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5877programmed for SDRAM access. Using the temporary configuration, a
5878simple memory test is run that determines the size of the SDRAM
5879banks.
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk2729af92004-05-03 20:45:30 +00005881When there is more than one SDRAM bank, and the banks are of
5882different size, the largest is mapped first. For equal size, the first
5883bank (CS2#) is mapped first. The first mapping is always for address
58840x00000000, with any additional banks following immediately to create
5885contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005886
wdenk2729af92004-05-03 20:45:30 +00005887Then, the monitor installs itself at the upper end of the SDRAM area
5888and allocates memory for use by malloc() and for the global Board
5889Info data; also, the exception vector code is copied to the low RAM
5890pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005891
wdenk2729af92004-05-03 20:45:30 +00005892Only after this relocation will you have a "normal" C environment;
5893until that you are restricted in several ways, mostly because you are
5894running from ROM, and because the code will have to be relocated to a
5895new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005896
5897
wdenk2729af92004-05-03 20:45:30 +00005898U-Boot Porting Guide:
5899----------------------
wdenkc6097192002-11-03 00:24:07 +00005900
wdenk2729af92004-05-03 20:45:30 +00005901[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5902list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005903
5904
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005905int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005906{
5907 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005908
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005909 signal(SIGALRM, no_more_time);
5910 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005911
wdenk2729af92004-05-03 20:45:30 +00005912 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005913 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005914 return 0;
5915 }
5916
wdenk2729af92004-05-03 20:45:30 +00005917 Download latest U-Boot source;
5918
Wolfgang Denk06682362008-12-30 22:56:11 +01005919 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005920
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005921 if (clueless)
5922 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk2729af92004-05-03 20:45:30 +00005924 while (learning) {
5925 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005926 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5927 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005928 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005929 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005930 }
wdenkc6097192002-11-03 00:24:07 +00005931
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005932 if (available_money > toLocalCurrency ($2500))
5933 Buy a BDI3000;
5934 else
wdenk2729af92004-05-03 20:45:30 +00005935 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005936
5937 if (a similar board exists) { /* hopefully... */
5938 cp -a board/<similar> board/<myboard>
5939 cp include/configs/<similar>.h include/configs/<myboard>.h
5940 } else {
5941 Create your own board support subdirectory;
5942 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005943 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005944 Edit new board/<myboard> files
5945 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005946
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005947 while (!accepted) {
5948 while (!running) {
5949 do {
5950 Add / modify source code;
5951 } until (compiles);
5952 Debug;
5953 if (clueless)
5954 email("Hi, I am having problems...");
5955 }
5956 Send patch file to the U-Boot email list;
5957 if (reasonable critiques)
5958 Incorporate improvements from email list code review;
5959 else
5960 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005961 }
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk2729af92004-05-03 20:45:30 +00005963 return 0;
5964}
5965
5966void no_more_time (int sig)
5967{
5968 hire_a_guru();
5969}
wdenkc6097192002-11-03 00:24:07 +00005970
5971
wdenk2729af92004-05-03 20:45:30 +00005972Coding Standards:
5973-----------------
wdenkc6097192002-11-03 00:24:07 +00005974
wdenk2729af92004-05-03 20:45:30 +00005975All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005976coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005977"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005978
Detlev Zundel2c051652006-09-01 15:39:02 +02005979Source files originating from a different project (for example the
5980MTD subsystem) are generally exempt from these guidelines and are not
5981reformated to ease subsequent migration to newer versions of those
5982sources.
5983
5984Please note that U-Boot is implemented in C (and to some small parts in
5985Assembler); no C++ is used, so please do not use C++ style comments (//)
5986in your code.
wdenk2729af92004-05-03 20:45:30 +00005987
5988Please also stick to the following formatting rules:
5989- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005990- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005991- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005992- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005993- do not add trailing empty lines to source files
5994
5995Submissions which do not conform to the standards may be returned
5996with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005997
5998
wdenk2729af92004-05-03 20:45:30 +00005999Submitting Patches:
6000-------------------
wdenkc6097192002-11-03 00:24:07 +00006001
wdenk2729af92004-05-03 20:45:30 +00006002Since the number of patches for U-Boot is growing, we need to
6003establish some rules. Submissions which do not conform to these rules
6004may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006005
Magnus Lilja0d28f342008-08-06 19:32:33 +02006006Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006007
Wolfgang Denk06682362008-12-30 22:56:11 +01006008Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6009see http://lists.denx.de/mailman/listinfo/u-boot
6010
wdenk2729af92004-05-03 20:45:30 +00006011When you send a patch, please include the following information with
6012it:
wdenkc6097192002-11-03 00:24:07 +00006013
wdenk2729af92004-05-03 20:45:30 +00006014* For bug fixes: a description of the bug and how your patch fixes
6015 this bug. Please try to include a way of demonstrating that the
6016 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk2729af92004-05-03 20:45:30 +00006018* For new features: a description of the feature and your
6019 implementation.
wdenkc6097192002-11-03 00:24:07 +00006020
wdenk2729af92004-05-03 20:45:30 +00006021* A CHANGELOG entry as plaintext (separate from the patch)
6022
6023* For major contributions, your entry to the CREDITS file
6024
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006025* When you add support for a new board, don't forget to add a
6026 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006027
6028* If your patch adds new configuration options, don't forget to
6029 document these in the README file.
6030
Wolfgang Denk218ca722008-03-26 10:40:12 +01006031* The patch itself. If you are using git (which is *strongly*
6032 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006033 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006034 the U-Boot mailing list, you will avoid most of the common problems
6035 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006036
Wolfgang Denk218ca722008-03-26 10:40:12 +01006037 If you cannot use git, use "diff -purN OLD NEW". If your version of
6038 diff does not support these options, then get the latest version of
6039 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006040
Wolfgang Denk218ca722008-03-26 10:40:12 +01006041 The current directory when running this command shall be the parent
6042 directory of the U-Boot source tree (i. e. please make sure that
6043 your patch includes sufficient directory information for the
6044 affected files).
6045
6046 We prefer patches as plain text. MIME attachments are discouraged,
6047 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006048
6049* If one logical set of modifications affects or creates several
6050 files, all these changes shall be submitted in a SINGLE patch file.
6051
6052* Changesets that contain different, unrelated modifications shall be
6053 submitted as SEPARATE patches, one patch per changeset.
6054
6055
6056Notes:
6057
6058* Before sending the patch, run the MAKEALL script on your patched
6059 source tree and make sure that no errors or warnings are reported
6060 for any of the boards.
6061
6062* Keep your modifications to the necessary minimum: A patch
6063 containing several unrelated changes or arbitrary reformats will be
6064 returned with a request to re-formatting / split it.
6065
6066* If you modify existing code, make sure that your new code does not
6067 add to the memory footprint of the code ;-) Small is beautiful!
6068 When adding new features, these should compile conditionally only
6069 (using #ifdef), and the resulting code with the new feature
6070 disabled must not need more memory than the old code without your
6071 modification.
wdenk90dc6702005-05-03 14:12:25 +00006072
Wolfgang Denk06682362008-12-30 22:56:11 +01006073* Remember that there is a size limit of 100 kB per message on the
6074 u-boot mailing list. Bigger patches will be moderated. If they are
6075 reasonable and not too big, they will be acknowledged. But patches
6076 bigger than the size limit should be avoided.