blob: f0ffaf491cd9c204b24a49aacf4d9712148cdf32 [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
York Suncb930712013-06-25 11:37:41 -0700426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
429
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000430- Generic CPU options:
431 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
432
433 Defines the endianess of the CPU. Implementation of those
434 values is arch specific.
435
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100436- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200437 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100438
439 Defines the Monahans run mode to oscillator
440 ratio. Valid values are 8, 16, 24, 31. The core
441 frequency is this value multiplied by 13 MHz.
442
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200443 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200444
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100445 Defines the Monahans turbo mode to oscillator
446 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200447 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100448 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200449
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200450- MIPS CPU options:
451 CONFIG_SYS_INIT_SP_OFFSET
452
453 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
454 pointer. This is needed for the temporary stack before
455 relocation.
456
457 CONFIG_SYS_MIPS_CACHE_MODE
458
459 Cache operation mode for the MIPS CPU.
460 See also arch/mips/include/asm/mipsregs.h.
461 Possible values are:
462 CONF_CM_CACHABLE_NO_WA
463 CONF_CM_CACHABLE_WA
464 CONF_CM_UNCACHED
465 CONF_CM_CACHABLE_NONCOHERENT
466 CONF_CM_CACHABLE_CE
467 CONF_CM_CACHABLE_COW
468 CONF_CM_CACHABLE_CUW
469 CONF_CM_CACHABLE_ACCELERATED
470
471 CONFIG_SYS_XWAY_EBU_BOOTCFG
472
473 Special option for Lantiq XWAY SoCs for booting from NOR flash.
474 See also arch/mips/cpu/mips32/start.S.
475
476 CONFIG_XWAY_SWAP_BYTES
477
478 Enable compilation of tools/xway-swap-bytes needed for Lantiq
479 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
480 be swapped if a flash programmer is used.
481
Christian Rieschb67d8812012-02-02 00:44:39 +0000482- ARM options:
483 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
484
485 Select high exception vectors of the ARM core, e.g., do not
486 clear the V bit of the c1 register of CP15.
487
Aneesh V5356f542012-03-08 07:20:19 +0000488 CONFIG_SYS_THUMB_BUILD
489
490 Use this flag to build U-Boot using the Thumb instruction
491 set for ARM architectures. Thumb instruction set provides
492 better code density. For ARM architectures that support
493 Thumb2 this flag will result in Thumb2 code generated by
494 GCC.
495
Stephen Warrenc5d47522013-03-04 13:29:40 +0000496 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000497 CONFIG_ARM_ERRATA_742230
498 CONFIG_ARM_ERRATA_743622
499 CONFIG_ARM_ERRATA_751472
500
501 If set, the workarounds for these ARM errata are applied early
502 during U-Boot startup. Note that these options force the
503 workarounds to be applied; no CPU-type/version detection
504 exists, unlike the similar options in the Linux kernel. Do not
505 set these options unless they apply!
506
Stephen Warren795659d2013-03-27 17:06:41 +0000507- CPU timer options:
508 CONFIG_SYS_HZ
509
510 The frequency of the timer returned by get_timer().
511 get_timer() must operate in milliseconds and this CONFIG
512 option must be set to 1000.
513
wdenk5da627a2003-10-09 20:09:04 +0000514- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000515 CONFIG_CLOCKS_IN_MHZ
516
517 U-Boot stores all clock information in Hz
518 internally. For binary compatibility with older Linux
519 kernels (which expect the clocks passed in the
520 bd_info data to be in MHz) the environment variable
521 "clocks_in_mhz" can be defined so that U-Boot
522 converts clock data to MHZ before passing it to the
523 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000524 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100525 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000526 default environment.
527
wdenk5da627a2003-10-09 20:09:04 +0000528 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
529
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200530 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000531 expect it to be in bytes, others in MB.
532 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
533
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400534 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200535
536 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400537 passed using flattened device trees (based on open firmware
538 concepts).
539
540 CONFIG_OF_LIBFDT
541 * New libfdt-based support
542 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500543 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400544
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200545 OF_CPU - The proper name of the cpus node (only required for
546 MPC512X and MPC5xxx based boards).
547 OF_SOC - The proper name of the soc node (only required for
548 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200549 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600550 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200551
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200552 boards with QUICC Engines require OF_QE to set UCC MAC
553 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500554
Kumar Gala4e253132006-01-11 13:54:17 -0600555 CONFIG_OF_BOARD_SETUP
556
557 Board code has addition modification that it wants to make
558 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000559
Matthew McClintock02677682006-06-28 10:41:37 -0500560 CONFIG_OF_BOOT_CPU
561
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200562 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500563 param header, the default value is zero if undefined.
564
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200565 CONFIG_OF_IDE_FIXUP
566
567 U-Boot can detect if an IDE device is present or not.
568 If not, and this new config option is activated, U-Boot
569 removes the ATA node from the DTS before booting Linux,
570 so the Linux IDE driver does not probe the device and
571 crash. This is needed for buggy hardware (uc101) where
572 no pull down resistor is connected to the signal IDE5V_DD7.
573
Igor Grinberg7eb29392011-07-14 05:45:07 +0000574 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
575
576 This setting is mandatory for all boards that have only one
577 machine type and must be used to specify the machine type
578 number as it appears in the ARM machine registry
579 (see http://www.arm.linux.org.uk/developer/machines/).
580 Only boards that have multiple machine types supported
581 in a single configuration file and the machine type is
582 runtime discoverable, do not have to use this setting.
583
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100584- vxWorks boot parameters:
585
586 bootvx constructs a valid bootline using the following
587 environments variables: bootfile, ipaddr, serverip, hostname.
588 It loads the vxWorks image pointed bootfile.
589
590 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
591 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
592 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
593 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
594
595 CONFIG_SYS_VXWORKS_ADD_PARAMS
596
597 Add it at the end of the bootline. E.g "u=username pw=secret"
598
599 Note: If a "bootargs" environment is defined, it will overwride
600 the defaults discussed just above.
601
Aneesh V2c451f72011-06-16 23:30:47 +0000602- Cache Configuration:
603 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
604 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
605 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
606
Aneesh V93bc2192011-06-16 23:30:51 +0000607- Cache Configuration for ARM:
608 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
609 controller
610 CONFIG_SYS_PL310_BASE - Physical base address of PL310
611 controller register space
612
wdenk6705d812004-08-02 23:22:59 +0000613- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200614 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000615
616 Define this if you want support for Amba PrimeCell PL010 UARTs.
617
Andreas Engel48d01922008-09-08 14:30:53 +0200618 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000619
620 Define this if you want support for Amba PrimeCell PL011 UARTs.
621
622 CONFIG_PL011_CLOCK
623
624 If you have Amba PrimeCell PL011 UARTs, set this variable to
625 the clock speed of the UARTs.
626
627 CONFIG_PL01x_PORTS
628
629 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
630 define this to a list of base addresses for each (supported)
631 port. See e.g. include/configs/versatile.h
632
John Rigby910f1ae2011-04-19 10:42:39 +0000633 CONFIG_PL011_SERIAL_RLCR
634
635 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636 have separate receive and transmit line control registers. Set
637 this variable to initialize the extra register.
638
639 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
640
641 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642 boot loader that has already initialized the UART. Define this
643 variable to flush the UART at init time.
644
wdenk6705d812004-08-02 23:22:59 +0000645
wdenkc6097192002-11-03 00:24:07 +0000646- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000647 Depending on board, define exactly one serial port
648 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000651
652 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653 port routines must be defined elsewhere
654 (i.e. serial_init(), serial_getc(), ...)
655
656 CONFIG_CFB_CONSOLE
657 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000658 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000659 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
660 (default big endian)
661 VIDEO_HW_RECTFILL graphic chip supports
662 rectangle fill
663 (cf. smiLynxEM)
664 VIDEO_HW_BITBLT graphic chip supports
665 bit-blit (cf. smiLynxEM)
666 VIDEO_VISIBLE_COLS visible pixel columns
667 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000668 VIDEO_VISIBLE_ROWS visible pixel rows
669 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000670 VIDEO_DATA_FORMAT graphic data format
671 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000672 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000673 VIDEO_KBD_INIT_FCT keyboard int fct
674 (i.e. i8042_kbd_init())
675 VIDEO_TSTC_FCT test char fct
676 (i.e. i8042_tstc)
677 VIDEO_GETC_FCT get char fct
678 (i.e. i8042_getc)
679 CONFIG_CONSOLE_CURSOR cursor drawing on/off
680 (requires blink timer
681 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200682 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000683 CONFIG_CONSOLE_TIME display time/date info in
684 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500685 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000686 CONFIG_VIDEO_LOGO display Linux logo in
687 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000688 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
689 linux_logo.h for logo.
690 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000691 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200692 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000693 the logo
694
Pali Rohár33a35bb2012-10-19 13:30:09 +0000695 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
696 a limited number of ANSI escape sequences (cursor control,
697 erase functions and limited graphics rendition control).
698
wdenk43d96162003-03-06 00:02:04 +0000699 When CONFIG_CFB_CONSOLE is defined, video console is
700 default i/o. Serial console can be forced with
701 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000702
wdenkd4ca31c2004-01-02 14:00:00 +0000703 When CONFIG_SILENT_CONSOLE is defined, all console
704 messages (by U-Boot and Linux!) can be silenced with
705 the "silent" environment variable. See
706 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000707
Heiko Schocher45ae2542013-10-22 11:06:06 +0200708 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
709 is 0x00.
710 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
711 is 0xa0.
712
wdenkc6097192002-11-03 00:24:07 +0000713- Console Baudrate:
714 CONFIG_BAUDRATE - in bps
715 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200716 CONFIG_SYS_BAUDRATE_TABLE, see below.
717 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000718
Heiko Schocherc92fac92009-01-30 12:55:38 +0100719- Console Rx buffer length
720 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
721 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100722 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100723 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
724 must be defined, to setup the maximum idle timeout for
725 the SMC.
726
Graeme Russ9558b482011-09-01 00:48:27 +0000727- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200728 Prior to the console being initialised (i.e. serial UART
729 initialised etc) all console output is silently discarded.
730 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
731 buffer any console messages prior to the console being
732 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
733 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
734 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200735 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200736 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000737
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200738 'Sane' compilers will generate smaller code if
739 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000740
Sonny Rao046a37b2011-11-02 09:52:08 +0000741- Safe printf() functions
742 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
743 the printf() functions. These are defined in
744 include/vsprintf.h and include snprintf(), vsnprintf() and
745 so on. Code size increase is approximately 300-500 bytes.
746 If this option is not given then these functions will
747 silently discard their buffer size argument - this means
748 you are not getting any overflow checking in this case.
749
wdenkc6097192002-11-03 00:24:07 +0000750- Boot Delay: CONFIG_BOOTDELAY - in seconds
751 Delay before automatically booting the default image;
752 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000753 set to -2 to autoboot with no delay and not check for abort
754 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000755
756 See doc/README.autoboot for these options that
757 work with CONFIG_BOOTDELAY. None are required.
758 CONFIG_BOOT_RETRY_TIME
759 CONFIG_BOOT_RETRY_MIN
760 CONFIG_AUTOBOOT_KEYED
761 CONFIG_AUTOBOOT_PROMPT
762 CONFIG_AUTOBOOT_DELAY_STR
763 CONFIG_AUTOBOOT_STOP_STR
764 CONFIG_AUTOBOOT_DELAY_STR2
765 CONFIG_AUTOBOOT_STOP_STR2
766 CONFIG_ZERO_BOOTDELAY_CHECK
767 CONFIG_RESET_TO_RETRY
768
769- Autoboot Command:
770 CONFIG_BOOTCOMMAND
771 Only needed when CONFIG_BOOTDELAY is enabled;
772 define a command string that is automatically executed
773 when no character is read on the console interface
774 within "Boot Delay" after reset.
775
776 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000777 This can be used to pass arguments to the bootm
778 command. The value of CONFIG_BOOTARGS goes into the
779 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000780
781 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000782 The value of these goes into the environment as
783 "ramboot" and "nfsboot" respectively, and can be used
784 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200785 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000786
Heiko Schochereda0ba32013-11-04 14:04:59 +0100787- Bootcount:
788 CONFIG_BOOTCOUNT_LIMIT
789 Implements a mechanism for detecting a repeating reboot
790 cycle, see:
791 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
792
793 CONFIG_BOOTCOUNT_ENV
794 If no softreset save registers are found on the hardware
795 "bootcount" is stored in the environment. To prevent a
796 saveenv on all reboots, the environment variable
797 "upgrade_available" is used. If "upgrade_available" is
798 0, "bootcount" is always 0, if "upgrade_available" is
799 1 "bootcount" is incremented in the environment.
800 So the Userspace Applikation must set the "upgrade_available"
801 and "bootcount" variable to 0, if a boot was successfully.
802
wdenkc6097192002-11-03 00:24:07 +0000803- Pre-Boot Commands:
804 CONFIG_PREBOOT
805
806 When this option is #defined, the existence of the
807 environment variable "preboot" will be checked
808 immediately before starting the CONFIG_BOOTDELAY
809 countdown and/or running the auto-boot command resp.
810 entering interactive mode.
811
812 This feature is especially useful when "preboot" is
813 automatically generated or modified. For an example
814 see the LWMON board specific code: here "preboot" is
815 modified when the user holds down a certain
816 combination of keys on the (special) keyboard when
817 booting the systems
818
819- Serial Download Echo Mode:
820 CONFIG_LOADS_ECHO
821 If defined to 1, all characters received during a
822 serial download (using the "loads" command) are
823 echoed back. This might be needed by some terminal
824 emulations (like "cu"), but may as well just take
825 time on others. This setting #define's the initial
826 value of the "loads_echo" environment variable.
827
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500828- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000829 CONFIG_KGDB_BAUDRATE
830 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200831 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000832
833- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 Monitor commands can be included or excluded
835 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000836 <config_cmd_all.h> and #undef'ing unwanted
837 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 and augmenting with additional #define's
839 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000840
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 The default command configuration includes all commands
842 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000843
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500845 CONFIG_CMD_BDI bdinfo
846 CONFIG_CMD_BEDBUG * Include BedBug Debugger
847 CONFIG_CMD_BMP * BMP support
848 CONFIG_CMD_BSP * Board specific commands
849 CONFIG_CMD_BOOTD bootd
850 CONFIG_CMD_CACHE * icache, dcache
851 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500852 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500853 CONFIG_CMD_DATE * support for RTC, date/time...
854 CONFIG_CMD_DHCP * DHCP support
855 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600856 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
857 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
858 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
859 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500860 CONFIG_CMD_DTT * Digital Therm and Thermostat
861 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500862 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500863 CONFIG_CMD_EEPROM * EEPROM read/write support
864 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600865 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600866 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500867 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500868 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000869 CONFIG_CMD_EXT2 * ext2 command support
870 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500871 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500872 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000873 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500874 CONFIG_CMD_FDOS * Dos diskette Support
875 CONFIG_CMD_FLASH flinfo, erase, protect
876 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200877 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000878 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500879 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000880 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000881 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
883 CONFIG_CMD_I2C * I2C serial bus support
884 CONFIG_CMD_IDE * IDE harddisk support
885 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000886 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200887 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500888 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500889 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000890 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500891 CONFIG_CMD_IRQ * irqinfo
892 CONFIG_CMD_ITEST Integer/string test of 2 values
893 CONFIG_CMD_JFFS2 * JFFS2 Support
894 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200895 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000896 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
897 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500898 CONFIG_CMD_LOADB loadb
899 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200900 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400901 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000902 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000904 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200905 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500906 CONFIG_CMD_MISC Misc functions like sleep etc
907 CONFIG_CMD_MMC * MMC memory mapped support
908 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100909 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500910 CONFIG_CMD_NAND * NAND support
911 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200912 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600913 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000914 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 CONFIG_CMD_PCI * pciinfo
916 CONFIG_CMD_PCMCIA * PCMCIA support
917 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
918 host
919 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000920 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500921 CONFIG_CMD_REGINFO * Register dump
922 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000923 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500924 CONFIG_CMD_SAVES * save S record dump
925 CONFIG_CMD_SCSI * SCSI Support
926 CONFIG_CMD_SDRAM * print SDRAM configuration information
927 (requires CONFIG_CMD_I2C)
928 CONFIG_CMD_SETGETDCR Support for DCR Register access
929 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700930 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200931 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400932 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800933 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200934 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500935 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000936 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000937 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000938 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
939 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500940 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500941 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000942 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200943 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000944
wdenkc6097192002-11-03 00:24:07 +0000945
946 EXAMPLE: If you want all functions except of network
947 support you can write:
948
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500949 #include "config_cmd_all.h"
950 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000951
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400952 Other Commands:
953 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000954
955 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500956 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000957 what you (and your U-Boot users) are doing. Data
958 cache cannot be enabled on systems like the 8xx or
959 8260 (where accesses to the IMMR region must be
960 uncached), and it cannot be disabled on all other
961 systems where we (mis-) use the data cache to hold an
962 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000963
964
965 XXX - this list needs to get updated!
966
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000967- Regular expression support:
968 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200969 If this variable is defined, U-Boot is linked against
970 the SLRE (Super Light Regular Expression) library,
971 which adds regex support to some commands, as for
972 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000973
Simon Glass45ba8072011-10-15 05:48:20 +0000974- Device tree:
975 CONFIG_OF_CONTROL
976 If this variable is defined, U-Boot will use a device tree
977 to configure its devices, instead of relying on statically
978 compiled #defines in the board file. This option is
979 experimental and only available on a few boards. The device
980 tree is available in the global data as gd->fdt_blob.
981
Simon Glass2c0f79e2011-10-24 19:15:31 +0000982 U-Boot needs to get its device tree from somewhere. This can
983 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000984
985 CONFIG_OF_EMBED
986 If this variable is defined, U-Boot will embed a device tree
987 binary in its image. This device tree file should be in the
988 board directory and called <soc>-<board>.dts. The binary file
989 is then picked up in board_init_f() and made available through
990 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000991
Simon Glass2c0f79e2011-10-24 19:15:31 +0000992 CONFIG_OF_SEPARATE
993 If this variable is defined, U-Boot will build a device tree
994 binary. It will be called u-boot.dtb. Architecture-specific
995 code will locate it at run-time. Generally this works by:
996
997 cat u-boot.bin u-boot.dtb >image.bin
998
999 and in fact, U-Boot does this for you, creating a file called
1000 u-boot-dtb.bin which is useful in the common case. You can
1001 still use the individual files if you need something more
1002 exotic.
1003
wdenkc6097192002-11-03 00:24:07 +00001004- Watchdog:
1005 CONFIG_WATCHDOG
1006 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001007 support for the SoC. There must be support in the SoC
1008 specific code for a watchdog. For the 8xx and 8260
1009 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1010 register. When supported for a specific SoC is
1011 available, then no further board specific code should
1012 be needed to use it.
1013
1014 CONFIG_HW_WATCHDOG
1015 When using a watchdog circuitry external to the used
1016 SoC, then define this variable and provide board
1017 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001018
stroesec1551ea2003-04-04 15:53:41 +00001019- U-Boot Version:
1020 CONFIG_VERSION_VARIABLE
1021 If this variable is defined, an environment variable
1022 named "ver" is created by U-Boot showing the U-Boot
1023 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001024 Any change to this variable will be reverted at the
1025 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001026
wdenkc6097192002-11-03 00:24:07 +00001027- Real-Time Clock:
1028
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001029 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001030 has to be selected, too. Define exactly one of the
1031 following options:
1032
1033 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1034 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001035 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001036 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001037 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001038 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001039 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001040 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001041 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001042 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001043 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001044 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1045 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001046
wdenkb37c7e52003-06-30 16:24:52 +00001047 Note that if the RTC uses I2C, then the I2C interface
1048 must also be configured. See I2C Support, below.
1049
Peter Tysere92739d2008-12-17 16:36:21 -06001050- GPIO Support:
1051 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001052
Chris Packham5dec49c2010-12-19 10:12:13 +00001053 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1054 chip-ngpio pairs that tell the PCA953X driver the number of
1055 pins supported by a particular chip.
1056
Peter Tysere92739d2008-12-17 16:36:21 -06001057 Note that if the GPIO device uses I2C, then the I2C interface
1058 must also be configured. See I2C Support, below.
1059
wdenkc6097192002-11-03 00:24:07 +00001060- Timestamp Support:
1061
wdenk43d96162003-03-06 00:02:04 +00001062 When CONFIG_TIMESTAMP is selected, the timestamp
1063 (date and time) of an image is printed by image
1064 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001065 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001066
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001067- Partition Labels (disklabels) Supported:
1068 Zero or more of the following:
1069 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1070 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1071 Intel architecture, USB sticks, etc.
1072 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1073 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1074 bootloader. Note 2TB partition limit; see
1075 disk/part_efi.c
1076 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001077
Wolfgang Denk218ca722008-03-26 10:40:12 +01001078 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1079 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001080 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001081
1082- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001083 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1084 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001085
wdenk4d13cba2004-03-14 14:09:05 +00001086 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1087 be performed by calling the function
1088 ide_set_reset(int reset)
1089 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001090
1091- ATAPI Support:
1092 CONFIG_ATAPI
1093
1094 Set this to enable ATAPI support.
1095
wdenkc40b2952004-03-13 23:29:43 +00001096- LBA48 Support
1097 CONFIG_LBA48
1098
1099 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001100 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001101 Whithout these , LBA48 support uses 32bit variables and will 'only'
1102 support disks up to 2.1TB.
1103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001104 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001105 When enabled, makes the IDE subsystem use 64bit sector addresses.
1106 Default is 32bit.
1107
wdenkc6097192002-11-03 00:24:07 +00001108- SCSI Support:
1109 At the moment only there is only support for the
1110 SYM53C8XX SCSI controller; define
1111 CONFIG_SCSI_SYM53C8XX to enable it.
1112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001113 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1114 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1115 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001116 maximum numbers of LUNs, SCSI ID's and target
1117 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001118 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001119
Wolfgang Denk93e14592013-10-04 17:43:24 +02001120 The environment variable 'scsidevs' is set to the number of
1121 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001122
wdenkc6097192002-11-03 00:24:07 +00001123- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001124 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001125 Support for Intel 8254x/8257x gigabit chips.
1126
1127 CONFIG_E1000_SPI
1128 Utility code for direct access to the SPI bus on Intel 8257x.
1129 This does not do anything useful unless you set at least one
1130 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1131
1132 CONFIG_E1000_SPI_GENERIC
1133 Allow generic access to the SPI bus on the Intel 8257x, for
1134 example with the "sspi" command.
1135
1136 CONFIG_CMD_E1000
1137 Management command for E1000 devices. When used on devices
1138 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001139
Andre Schwarzac3315c2008-03-06 16:45:44 +01001140 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001141 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001142
wdenkc6097192002-11-03 00:24:07 +00001143 CONFIG_EEPRO100
1144 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001145 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001146 write routine for first time initialisation.
1147
1148 CONFIG_TULIP
1149 Support for Digital 2114x chips.
1150 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1151 modem chip initialisation (KS8761/QS6611).
1152
1153 CONFIG_NATSEMI
1154 Support for National dp83815 chips.
1155
1156 CONFIG_NS8382X
1157 Support for National dp8382[01] gigabit chips.
1158
wdenk45219c42003-05-12 21:50:16 +00001159- NETWORK Support (other):
1160
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001161 CONFIG_DRIVER_AT91EMAC
1162 Support for AT91RM9200 EMAC.
1163
1164 CONFIG_RMII
1165 Define this to use reduced MII inteface
1166
1167 CONFIG_DRIVER_AT91EMAC_QUIET
1168 If this defined, the driver is quiet.
1169 The driver doen't show link status messages.
1170
Rob Herringefdd7312011-12-15 11:15:49 +00001171 CONFIG_CALXEDA_XGMAC
1172 Support for the Calxeda XGMAC device
1173
Ashok3bb46d22012-10-15 06:20:47 +00001174 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001175 Support for SMSC's LAN91C96 chips.
1176
1177 CONFIG_LAN91C96_BASE
1178 Define this to hold the physical address
1179 of the LAN91C96's I/O space
1180
1181 CONFIG_LAN91C96_USE_32_BIT
1182 Define this to enable 32 bit addressing
1183
Ashok3bb46d22012-10-15 06:20:47 +00001184 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001185 Support for SMSC's LAN91C111 chip
1186
1187 CONFIG_SMC91111_BASE
1188 Define this to hold the physical address
1189 of the device (I/O space)
1190
1191 CONFIG_SMC_USE_32_BIT
1192 Define this if data bus is 32 bits
1193
1194 CONFIG_SMC_USE_IOFUNCS
1195 Define this to use i/o functions instead of macros
1196 (some hardware wont work with macros)
1197
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001198 CONFIG_DRIVER_TI_EMAC
1199 Support for davinci emac
1200
1201 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1202 Define this if you have more then 3 PHYs.
1203
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001204 CONFIG_FTGMAC100
1205 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1206
1207 CONFIG_FTGMAC100_EGIGA
1208 Define this to use GE link update with gigabit PHY.
1209 Define this if FTGMAC100 is connected to gigabit PHY.
1210 If your system has 10/100 PHY only, it might not occur
1211 wrong behavior. Because PHY usually return timeout or
1212 useless data when polling gigabit status and gigabit
1213 control registers. This behavior won't affect the
1214 correctnessof 10/100 link speed update.
1215
Mike Rapoportc2fff332009-11-11 10:03:03 +02001216 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001217 Support for SMSC's LAN911x and LAN921x chips
1218
Mike Rapoportc2fff332009-11-11 10:03:03 +02001219 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001220 Define this to hold the physical address
1221 of the device (I/O space)
1222
Mike Rapoportc2fff332009-11-11 10:03:03 +02001223 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001224 Define this if data bus is 32 bits
1225
Mike Rapoportc2fff332009-11-11 10:03:03 +02001226 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001227 Define this if data bus is 16 bits. If your processor
1228 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001229 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001230
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001231 CONFIG_SH_ETHER
1232 Support for Renesas on-chip Ethernet controller
1233
1234 CONFIG_SH_ETHER_USE_PORT
1235 Define the number of ports to be used
1236
1237 CONFIG_SH_ETHER_PHY_ADDR
1238 Define the ETH PHY's address
1239
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001240 CONFIG_SH_ETHER_CACHE_WRITEBACK
1241 If this option is set, the driver enables cache flush.
1242
Vadim Bendebury5e124722011-10-17 08:36:14 +00001243- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001244 CONFIG_TPM
1245 Support TPM devices.
1246
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001247 CONFIG_TPM_TIS_I2C
1248 Support for i2c bus TPM devices. Only one device
1249 per system is supported at this time.
1250
1251 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1252 Define the the i2c bus number for the TPM device
1253
1254 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1255 Define the TPM's address on the i2c bus
1256
1257 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1258 Define the burst count bytes upper limit
1259
Dirk Eibachc01939c2013-06-26 15:55:15 +02001260 CONFIG_TPM_ATMEL_TWI
1261 Support for Atmel TWI TPM device. Requires I2C support.
1262
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001263 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001264 Support for generic parallel port TPM devices. Only one device
1265 per system is supported at this time.
1266
1267 CONFIG_TPM_TIS_BASE_ADDRESS
1268 Base address where the generic TPM device is mapped
1269 to. Contemporary x86 systems usually map it at
1270 0xfed40000.
1271
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001272 CONFIG_CMD_TPM
1273 Add tpm monitor functions.
1274 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1275 provides monitor access to authorized functions.
1276
1277 CONFIG_TPM
1278 Define this to enable the TPM support library which provides
1279 functional interfaces to some TPM commands.
1280 Requires support for a TPM device.
1281
1282 CONFIG_TPM_AUTH_SESSIONS
1283 Define this to enable authorized functions in the TPM library.
1284 Requires CONFIG_TPM and CONFIG_SHA1.
1285
wdenkc6097192002-11-03 00:24:07 +00001286- USB Support:
1287 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001288 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001289 CONFIG_USB_UHCI to enable it.
1290 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001291 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001292 storage devices.
1293 Note:
1294 Supported are USB Keyboards and USB Floppy drives
1295 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001296 MPC5200 USB requires additional defines:
1297 CONFIG_USB_CLOCK
1298 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001299 CONFIG_PSC3_USB
1300 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001301 CONFIG_USB_CONFIG
1302 for differential drivers: 0x00001000
1303 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001304 for differential drivers on PSC3: 0x00000100
1305 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001306 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001307 May be defined to allow interrupt polling
1308 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001309
Simon Glass9ab4ce22012-02-27 10:52:47 +00001310 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1311 txfilltuning field in the EHCI controller on reset.
1312
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001313 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1314 interval for usb hub power-on delay.(minimum 100msec)
1315
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001316- USB Device:
1317 Define the below if you wish to use the USB console.
1318 Once firmware is rebuilt from a serial console issue the
1319 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001320 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001321 it has found a new device. The environment variable usbtty
1322 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001323 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001324 Common Device Class Abstract Control Model serial device.
1325 If you select usbtty = gserial you should be able to enumerate
1326 a Linux host by
1327 # modprobe usbserial vendor=0xVendorID product=0xProductID
1328 else if using cdc_acm, simply setting the environment
1329 variable usbtty to be cdc_acm should suffice. The following
1330 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001331
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001332 CONFIG_USB_DEVICE
1333 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001334
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001335 CONFIG_USB_TTY
1336 Define this to have a tty type of device available to
1337 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001338
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301339 CONFIG_USBD_HS
1340 Define this to enable the high speed support for usb
1341 device and usbtty. If this feature is enabled, a routine
1342 int is_usbd_high_speed(void)
1343 also needs to be defined by the driver to dynamically poll
1344 whether the enumeration has succeded at high speed or full
1345 speed.
1346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001347 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001348 Define this if you want stdin, stdout &/or stderr to
1349 be set to usbtty.
1350
1351 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001352 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001353 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001354 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001356 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001357 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001358 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001359
Wolfgang Denk386eda02006-06-14 18:14:56 +02001360 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001361 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001362 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001363 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1364 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1365 should pretend to be a Linux device to it's target host.
1366
1367 CONFIG_USBD_MANUFACTURER
1368 Define this string as the name of your company for
1369 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001370
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001371 CONFIG_USBD_PRODUCT_NAME
1372 Define this string as the name of your product
1373 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1374
1375 CONFIG_USBD_VENDORID
1376 Define this as your assigned Vendor ID from the USB
1377 Implementors Forum. This *must* be a genuine Vendor ID
1378 to avoid polluting the USB namespace.
1379 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001380
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001381 CONFIG_USBD_PRODUCTID
1382 Define this as the unique Product ID
1383 for your device
1384 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001385
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001386 Some USB device drivers may need to check USB cable attachment.
1387 In this case you can enable following config in BoardName.h:
1388 CONFIG_USB_CABLE_CHECK
1389 This enables function definition:
1390 - usb_cable_connected() in include/usb.h
1391 Implementation of this function is board-specific.
1392
Igor Grinbergd70a5602011-12-12 12:08:35 +02001393- ULPI Layer Support:
1394 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1395 the generic ULPI layer. The generic layer accesses the ULPI PHY
1396 via the platform viewport, so you need both the genric layer and
1397 the viewport enabled. Currently only Chipidea/ARC based
1398 viewport is supported.
1399 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1400 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001401 If your ULPI phy needs a different reference clock than the
1402 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1403 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001404
1405- MMC Support:
1406 The MMC controller on the Intel PXA is supported. To
1407 enable this define CONFIG_MMC. The MMC can be
1408 accessed from the boot prompt by mapping the device
1409 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001410 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1411 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001412
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001413 CONFIG_SH_MMCIF
1414 Support for Renesas on-chip MMCIF controller
1415
1416 CONFIG_SH_MMCIF_ADDR
1417 Define the base address of MMCIF registers
1418
1419 CONFIG_SH_MMCIF_CLK
1420 Define the clock frequency for MMCIF
1421
Tom Rinib3ba6e92013-03-14 05:32:47 +00001422- USB Device Firmware Update (DFU) class support:
1423 CONFIG_DFU_FUNCTION
1424 This enables the USB portion of the DFU USB class
1425
1426 CONFIG_CMD_DFU
1427 This enables the command "dfu" which is used to have
1428 U-Boot create a DFU class device via USB. This command
1429 requires that the "dfu_alt_info" environment variable be
1430 set and define the alt settings to expose to the host.
1431
1432 CONFIG_DFU_MMC
1433 This enables support for exposing (e)MMC devices via DFU.
1434
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001435 CONFIG_DFU_NAND
1436 This enables support for exposing NAND devices via DFU.
1437
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301438 CONFIG_DFU_RAM
1439 This enables support for exposing RAM via DFU.
1440 Note: DFU spec refer to non-volatile memory usage, but
1441 allow usages beyond the scope of spec - here RAM usage,
1442 one that would help mostly the developer.
1443
Heiko Schochere7e75c72013-06-12 06:05:51 +02001444 CONFIG_SYS_DFU_DATA_BUF_SIZE
1445 Dfu transfer uses a buffer before writing data to the
1446 raw storage device. Make the size (in bytes) of this buffer
1447 configurable. The size of this buffer is also configurable
1448 through the "dfu_bufsiz" environment variable.
1449
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001450 CONFIG_SYS_DFU_MAX_FILE_SIZE
1451 When updating files rather than the raw storage device,
1452 we use a static buffer to copy the file into and then write
1453 the buffer once we've been given the whole file. Define
1454 this to the maximum filesize (in bytes) for the buffer.
1455 Default is 4 MiB if undefined.
1456
wdenk6705d812004-08-02 23:22:59 +00001457- Journaling Flash filesystem support:
1458 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1459 CONFIG_JFFS2_NAND_DEV
1460 Define these for a default partition on a NAND device
1461
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001462 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1463 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001464 Define these for a default partition on a NOR device
1465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001466 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001467 Define this to create an own partition. You have to provide a
1468 function struct part_info* jffs2_part_info(int part_num)
1469
1470 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001471 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001472 to disable the command chpart. This is the default when you
1473 have not defined a custom partition
1474
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001475- FAT(File Allocation Table) filesystem write function support:
1476 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001477
1478 Define this to enable support for saving memory data as a
1479 file in FAT formatted partition.
1480
1481 This will also enable the command "fatwrite" enabling the
1482 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001483
Gabe Black84cd9322012-10-12 14:26:11 +00001484CBFS (Coreboot Filesystem) support
1485 CONFIG_CMD_CBFS
1486
1487 Define this to enable support for reading from a Coreboot
1488 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1489 and cbfsload.
1490
wdenkc6097192002-11-03 00:24:07 +00001491- Keyboard Support:
1492 CONFIG_ISA_KEYBOARD
1493
1494 Define this to enable standard (PC-Style) keyboard
1495 support
1496
1497 CONFIG_I8042_KBD
1498 Standard PC keyboard driver with US (is default) and
1499 GERMAN key layout (switch via environment 'keymap=de') support.
1500 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1501 for cfb_console. Supports cursor blinking.
1502
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001503 CONFIG_CROS_EC_KEYB
1504 Enables a Chrome OS keyboard using the CROS_EC interface.
1505 This uses CROS_EC to communicate with a second microcontroller
1506 which provides key scans on request.
1507
wdenkc6097192002-11-03 00:24:07 +00001508- Video support:
1509 CONFIG_VIDEO
1510
1511 Define this to enable video support (for output to
1512 video).
1513
1514 CONFIG_VIDEO_CT69000
1515
1516 Enable Chips & Technologies 69000 Video chip
1517
1518 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001519 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001520 video output is selected via environment 'videoout'
1521 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1522 assumed.
wdenkc6097192002-11-03 00:24:07 +00001523
wdenkb79a11c2004-03-25 15:14:43 +00001524 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001525 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001526 are possible:
1527 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001528 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001529
1530 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1531 -------------+---------------------------------------------
1532 8 bits | 0x301* 0x303 0x305 0x161 0x307
1533 15 bits | 0x310 0x313 0x316 0x162 0x319
1534 16 bits | 0x311 0x314 0x317 0x163 0x31A
1535 24 bits | 0x312 0x315 0x318 ? 0x31B
1536 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001537 (i.e. setenv videomode 317; saveenv; reset;)
1538
wdenkb79a11c2004-03-25 15:14:43 +00001539 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001540 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001541
1542
stroesec1551ea2003-04-04 15:53:41 +00001543 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001544 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001545 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1546 or CONFIG_VIDEO_SED13806_16BPP
1547
Timur Tabi7d3053f2011-02-15 17:09:19 -06001548 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001549 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001550 SOCs that have a DIU should define this macro to enable DIU
1551 support, and should also define these other macros:
1552
1553 CONFIG_SYS_DIU_ADDR
1554 CONFIG_VIDEO
1555 CONFIG_CMD_BMP
1556 CONFIG_CFB_CONSOLE
1557 CONFIG_VIDEO_SW_CURSOR
1558 CONFIG_VGA_AS_SINGLE_DEVICE
1559 CONFIG_VIDEO_LOGO
1560 CONFIG_VIDEO_BMP_LOGO
1561
Timur Tabiba8e76b2011-04-11 14:18:22 -05001562 The DIU driver will look for the 'video-mode' environment
1563 variable, and if defined, enable the DIU as a console during
1564 boot. See the documentation file README.video for a
1565 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001566
Simon Glass058d59b2012-12-03 13:59:47 +00001567 CONFIG_VIDEO_VGA
1568
1569 Enable the VGA video / BIOS for x86. The alternative if you
1570 are using coreboot is to use the coreboot frame buffer
1571 driver.
1572
1573
wdenk682011f2003-06-03 23:54:09 +00001574- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001575 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001576
wdenk8bde7f72003-06-27 21:31:46 +00001577 Define this to enable a custom keyboard support.
1578 This simply calls drv_keyboard_init() which must be
1579 defined in your board-specific files.
1580 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001581
wdenkc6097192002-11-03 00:24:07 +00001582- LCD Support: CONFIG_LCD
1583
1584 Define this to enable LCD support (for output to LCD
1585 display); also select one of the supported displays
1586 by defining one of these:
1587
Stelian Pop39cf4802008-05-09 21:57:18 +02001588 CONFIG_ATMEL_LCD:
1589
1590 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1591
wdenkfd3103b2003-11-25 16:55:19 +00001592 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001593
wdenkfd3103b2003-11-25 16:55:19 +00001594 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001595
wdenkfd3103b2003-11-25 16:55:19 +00001596 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001597
wdenkfd3103b2003-11-25 16:55:19 +00001598 NEC NL6448BC20-08. 6.5", 640x480.
1599 Active, color, single scan.
1600
1601 CONFIG_NEC_NL6448BC33_54
1602
1603 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001604 Active, color, single scan.
1605
1606 CONFIG_SHARP_16x9
1607
1608 Sharp 320x240. Active, color, single scan.
1609 It isn't 16x9, and I am not sure what it is.
1610
1611 CONFIG_SHARP_LQ64D341
1612
1613 Sharp LQ64D341 display, 640x480.
1614 Active, color, single scan.
1615
1616 CONFIG_HLD1045
1617
1618 HLD1045 display, 640x480.
1619 Active, color, single scan.
1620
1621 CONFIG_OPTREX_BW
1622
1623 Optrex CBL50840-2 NF-FW 99 22 M5
1624 or
1625 Hitachi LMG6912RPFC-00T
1626 or
1627 Hitachi SP14Q002
1628
1629 320x240. Black & white.
1630
1631 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001632 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001633
Simon Glass676d3192012-10-17 13:24:54 +00001634 CONFIG_LCD_ALIGNMENT
1635
1636 Normally the LCD is page-aligned (tyically 4KB). If this is
1637 defined then the LCD will be aligned to this value instead.
1638 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1639 here, since it is cheaper to change data cache settings on
1640 a per-section basis.
1641
Simon Glass0d89efe2012-10-17 13:24:59 +00001642 CONFIG_CONSOLE_SCROLL_LINES
1643
1644 When the console need to be scrolled, this is the number of
1645 lines to scroll by. It defaults to 1. Increasing this makes
1646 the console jump but can help speed up operation when scrolling
1647 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001648
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001649 CONFIG_LCD_BMP_RLE8
1650
1651 Support drawing of RLE8-compressed bitmaps on the LCD.
1652
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001653 CONFIG_I2C_EDID
1654
1655 Enables an 'i2c edid' command which can read EDID
1656 information over I2C from an attached LCD display.
1657
wdenk7152b1d2003-09-05 23:19:14 +00001658- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001659
wdenk8bde7f72003-06-27 21:31:46 +00001660 If this option is set, the environment is checked for
1661 a variable "splashimage". If found, the usual display
1662 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001663 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001664 specified in "splashimage" is loaded instead. The
1665 console is redirected to the "nulldev", too. This
1666 allows for a "silent" boot where a splash screen is
1667 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001668
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001669 CONFIG_SPLASHIMAGE_GUARD
1670
1671 If this option is set, then U-Boot will prevent the environment
1672 variable "splashimage" from being set to a problematic address
1673 (see README.displaying-bmps and README.arm-unaligned-accesses).
1674 This option is useful for targets where, due to alignment
1675 restrictions, an improperly aligned BMP image will cause a data
1676 abort. If you think you will not have problems with unaligned
1677 accesses (for example because your toolchain prevents them)
1678 there is no need to set this option.
1679
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001680 CONFIG_SPLASH_SCREEN_ALIGN
1681
1682 If this option is set the splash image can be freely positioned
1683 on the screen. Environment variable "splashpos" specifies the
1684 position as "x,y". If a positive number is given it is used as
1685 number of pixel from left/top. If a negative number is given it
1686 is used as number of pixel from right/bottom. You can also
1687 specify 'm' for centering the image.
1688
1689 Example:
1690 setenv splashpos m,m
1691 => image at center of screen
1692
1693 setenv splashpos 30,20
1694 => image at x = 30 and y = 20
1695
1696 setenv splashpos -10,m
1697 => vertically centered image
1698 at x = dspWidth - bmpWidth - 9
1699
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001700- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1701
1702 If this option is set, additionally to standard BMP
1703 images, gzipped BMP images can be displayed via the
1704 splashscreen support or the bmp command.
1705
Anatolij Gustschind5011762010-03-15 14:50:25 +01001706- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1707
1708 If this option is set, 8-bit RLE compressed BMP images
1709 can be displayed via the splashscreen support or the
1710 bmp command.
1711
Lei Wenf2b96df2012-09-28 04:26:47 +00001712- Do compresssing for memory range:
1713 CONFIG_CMD_ZIP
1714
1715 If this option is set, it would use zlib deflate method
1716 to compress the specified memory at its best effort.
1717
wdenkc29fdfc2003-08-29 20:57:53 +00001718- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001719 CONFIG_GZIP
1720
1721 Enabled by default to support gzip compressed images.
1722
wdenkc29fdfc2003-08-29 20:57:53 +00001723 CONFIG_BZIP2
1724
1725 If this option is set, support for bzip2 compressed
1726 images is included. If not, only uncompressed and gzip
1727 compressed images are supported.
1728
wdenk42d1f032003-10-15 23:53:47 +00001729 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001730 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001731 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001732
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001733 CONFIG_LZMA
1734
1735 If this option is set, support for lzma compressed
1736 images is included.
1737
1738 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1739 requires an amount of dynamic memory that is given by the
1740 formula:
1741
1742 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1743
1744 Where lc and lp stand for, respectively, Literal context bits
1745 and Literal pos bits.
1746
1747 This value is upper-bounded by 14MB in the worst case. Anyway,
1748 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1749 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1750 a very small buffer.
1751
1752 Use the lzmainfo tool to determinate the lc and lp values and
1753 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001754 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001755
Kees Cook8ef70472013-08-16 07:59:12 -07001756 CONFIG_LZO
1757
1758 If this option is set, support for LZO compressed images
1759 is included.
1760
wdenk17ea1172004-06-06 21:51:03 +00001761- MII/PHY support:
1762 CONFIG_PHY_ADDR
1763
1764 The address of PHY on MII bus.
1765
1766 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1767
1768 The clock frequency of the MII bus
1769
1770 CONFIG_PHY_GIGE
1771
1772 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001773 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001774
1775 CONFIG_PHY_RESET_DELAY
1776
1777 Some PHY like Intel LXT971A need extra delay after
1778 reset before any MII register access is possible.
1779 For such PHY, set this option to the usec delay
1780 required. (minimum 300usec for LXT971A)
1781
1782 CONFIG_PHY_CMD_DELAY (ppc4xx)
1783
1784 Some PHY like Intel LXT971A need extra delay after
1785 command issued before MII status register can be read
1786
wdenkc6097192002-11-03 00:24:07 +00001787- Ethernet address:
1788 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001789 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001790 CONFIG_ETH2ADDR
1791 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001792 CONFIG_ETH4ADDR
1793 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001794
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001795 Define a default value for Ethernet address to use
1796 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001797 is not determined automatically.
1798
1799- IP address:
1800 CONFIG_IPADDR
1801
1802 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001803 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001804 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001805 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001806
1807- Server IP address:
1808 CONFIG_SERVERIP
1809
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001810 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001811 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001812 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001813
Robin Getz97cfe862009-07-21 12:15:28 -04001814 CONFIG_KEEP_SERVERADDR
1815
1816 Keeps the server's MAC address, in the env 'serveraddr'
1817 for passing to bootargs (like Linux's netconsole option)
1818
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001819- Gateway IP address:
1820 CONFIG_GATEWAYIP
1821
1822 Defines a default value for the IP address of the
1823 default router where packets to other networks are
1824 sent to.
1825 (Environment variable "gatewayip")
1826
1827- Subnet mask:
1828 CONFIG_NETMASK
1829
1830 Defines a default value for the subnet mask (or
1831 routing prefix) which is used to determine if an IP
1832 address belongs to the local subnet or needs to be
1833 forwarded through a router.
1834 (Environment variable "netmask")
1835
David Updegraff53a5c422007-06-11 10:41:07 -05001836- Multicast TFTP Mode:
1837 CONFIG_MCAST_TFTP
1838
1839 Defines whether you want to support multicast TFTP as per
1840 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001841 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001842 driver in use must provide a function: mcast() to join/leave a
1843 multicast group.
1844
wdenkc6097192002-11-03 00:24:07 +00001845- BOOTP Recovery Mode:
1846 CONFIG_BOOTP_RANDOM_DELAY
1847
1848 If you have many targets in a network that try to
1849 boot using BOOTP, you may want to avoid that all
1850 systems send out BOOTP requests at precisely the same
1851 moment (which would happen for instance at recovery
1852 from a power failure, when all systems will try to
1853 boot, thus flooding the BOOTP server. Defining
1854 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1855 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001856 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001857
1858 1st BOOTP request: delay 0 ... 1 sec
1859 2nd BOOTP request: delay 0 ... 2 sec
1860 3rd BOOTP request: delay 0 ... 4 sec
1861 4th and following
1862 BOOTP requests: delay 0 ... 8 sec
1863
stroesefe389a82003-08-28 14:17:32 +00001864- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001865 You can fine tune the DHCP functionality by defining
1866 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001867
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001868 CONFIG_BOOTP_SUBNETMASK
1869 CONFIG_BOOTP_GATEWAY
1870 CONFIG_BOOTP_HOSTNAME
1871 CONFIG_BOOTP_NISDOMAIN
1872 CONFIG_BOOTP_BOOTPATH
1873 CONFIG_BOOTP_BOOTFILESIZE
1874 CONFIG_BOOTP_DNS
1875 CONFIG_BOOTP_DNS2
1876 CONFIG_BOOTP_SEND_HOSTNAME
1877 CONFIG_BOOTP_NTPSERVER
1878 CONFIG_BOOTP_TIMEOFFSET
1879 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001880 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001881
Wilson Callan5d110f02007-07-28 10:56:13 -04001882 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1883 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001884
Joe Hershberger2c00e092012-05-23 07:59:19 +00001885 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1886 after the configured retry count, the call will fail
1887 instead of starting over. This can be used to fail over
1888 to Link-local IP address configuration if the DHCP server
1889 is not available.
1890
stroesefe389a82003-08-28 14:17:32 +00001891 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1892 serverip from a DHCP server, it is possible that more
1893 than one DNS serverip is offered to the client.
1894 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1895 serverip will be stored in the additional environment
1896 variable "dnsip2". The first DNS serverip is always
1897 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001898 is defined.
stroesefe389a82003-08-28 14:17:32 +00001899
1900 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1901 to do a dynamic update of a DNS server. To do this, they
1902 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001903 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001904 of the "hostname" environment variable is passed as
1905 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001906
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001907 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1908
1909 A 32bit value in microseconds for a delay between
1910 receiving a "DHCP Offer" and sending the "DHCP Request".
1911 This fixes a problem with certain DHCP servers that don't
1912 respond 100% of the time to a "DHCP request". E.g. On an
1913 AT91RM9200 processor running at 180MHz, this delay needed
1914 to be *at least* 15,000 usec before a Windows Server 2003
1915 DHCP server would reply 100% of the time. I recommend at
1916 least 50,000 usec to be safe. The alternative is to hope
1917 that one of the retries will be successful but note that
1918 the DHCP timeout and retry process takes a longer than
1919 this delay.
1920
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001921 - Link-local IP address negotiation:
1922 Negotiate with other link-local clients on the local network
1923 for an address that doesn't require explicit configuration.
1924 This is especially useful if a DHCP server cannot be guaranteed
1925 to exist in all environments that the device must operate.
1926
1927 See doc/README.link-local for more information.
1928
wdenka3d991b2004-04-15 21:48:45 +00001929 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001930 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001931
1932 The device id used in CDP trigger frames.
1933
1934 CONFIG_CDP_DEVICE_ID_PREFIX
1935
1936 A two character string which is prefixed to the MAC address
1937 of the device.
1938
1939 CONFIG_CDP_PORT_ID
1940
1941 A printf format string which contains the ascii name of
1942 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001943 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001944
1945 CONFIG_CDP_CAPABILITIES
1946
1947 A 32bit integer which indicates the device capabilities;
1948 0x00000010 for a normal host which does not forwards.
1949
1950 CONFIG_CDP_VERSION
1951
1952 An ascii string containing the version of the software.
1953
1954 CONFIG_CDP_PLATFORM
1955
1956 An ascii string containing the name of the platform.
1957
1958 CONFIG_CDP_TRIGGER
1959
1960 A 32bit integer sent on the trigger.
1961
1962 CONFIG_CDP_POWER_CONSUMPTION
1963
1964 A 16bit integer containing the power consumption of the
1965 device in .1 of milliwatts.
1966
1967 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1968
1969 A byte containing the id of the VLAN.
1970
wdenkc6097192002-11-03 00:24:07 +00001971- Status LED: CONFIG_STATUS_LED
1972
1973 Several configurations allow to display the current
1974 status using a LED. For instance, the LED will blink
1975 fast while running U-Boot code, stop blinking as
1976 soon as a reply to a BOOTP request was received, and
1977 start blinking slow once the Linux kernel is running
1978 (supported by a status LED driver in the Linux
1979 kernel). Defining CONFIG_STATUS_LED enables this
1980 feature in U-Boot.
1981
1982- CAN Support: CONFIG_CAN_DRIVER
1983
1984 Defining CONFIG_CAN_DRIVER enables CAN driver support
1985 on those systems that support this (optional)
1986 feature, like the TQM8xxL modules.
1987
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001988- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001989
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001990 This enable the NEW i2c subsystem, and will allow you to use
1991 i2c commands at the u-boot command line (as long as you set
1992 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1993 based realtime clock chips or other i2c devices. See
1994 common/cmd_i2c.c for a description of the command line
1995 interface.
1996
1997 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001998 - drivers/i2c/soft_i2c.c:
1999 - activate first bus with CONFIG_SYS_I2C_SOFT define
2000 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2001 for defining speed and slave address
2002 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2003 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2004 for defining speed and slave address
2005 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2006 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2007 for defining speed and slave address
2008 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2009 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2010 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002011
Heiko Schocher00f792e2012-10-24 13:48:22 +02002012 - drivers/i2c/fsl_i2c.c:
2013 - activate i2c driver with CONFIG_SYS_I2C_FSL
2014 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2015 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2016 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2017 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002018 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002019 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2020 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2021 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2022 second bus.
2023
Simon Glass1f2ba722012-10-30 07:28:53 +00002024 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002025 - activate this driver with CONFIG_SYS_I2C_TEGRA
2026 - This driver adds 4 i2c buses with a fix speed from
2027 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002028
Dirk Eibach880540d2013-04-25 02:40:01 +00002029 - drivers/i2c/ppc4xx_i2c.c
2030 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2031 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2032 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2033
tremfac96402013-09-21 18:13:35 +02002034 - drivers/i2c/i2c_mxc.c
2035 - activate this driver with CONFIG_SYS_I2C_MXC
2036 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2037 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2038 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2039 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2040 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2041 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2042 If thoses defines are not set, default value is 100000
2043 for speed, and 0 for slave.
2044
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002045 - drivers/i2c/rcar_i2c.c:
2046 - activate this driver with CONFIG_SYS_I2C_RCAR
2047 - This driver adds 4 i2c buses
2048
2049 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2050 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2051 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2052 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2053 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2054 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2055 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2056 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2057 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2058
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002059 additional defines:
2060
2061 CONFIG_SYS_NUM_I2C_BUSES
2062 Hold the number of i2c busses you want to use. If you
2063 don't use/have i2c muxes on your i2c bus, this
2064 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2065 omit this define.
2066
2067 CONFIG_SYS_I2C_DIRECT_BUS
2068 define this, if you don't use i2c muxes on your hardware.
2069 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2070 omit this define.
2071
2072 CONFIG_SYS_I2C_MAX_HOPS
2073 define how many muxes are maximal consecutively connected
2074 on one i2c bus. If you not use i2c muxes, omit this
2075 define.
2076
2077 CONFIG_SYS_I2C_BUSES
2078 hold a list of busses you want to use, only used if
2079 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2080 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2081 CONFIG_SYS_NUM_I2C_BUSES = 9:
2082
2083 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2084 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2085 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2086 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2087 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2088 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2089 {1, {I2C_NULL_HOP}}, \
2090 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2091 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2092 }
2093
2094 which defines
2095 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002096 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2097 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2098 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2099 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2100 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002101 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002102 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2103 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002104
2105 If you do not have i2c muxes on your board, omit this define.
2106
Heiko Schocherea818db2013-01-29 08:53:15 +01002107- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002108
2109 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2110 provides the following compelling advantages:
2111
2112 - more than one i2c adapter is usable
2113 - approved multibus support
2114 - better i2c mux support
2115
2116 ** Please consider updating your I2C driver now. **
2117
Heiko Schocherea818db2013-01-29 08:53:15 +01002118 These enable legacy I2C serial bus commands. Defining
2119 CONFIG_HARD_I2C will include the appropriate I2C driver
2120 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002121
wdenk945af8d2003-07-16 21:53:01 +00002122 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002123 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002124 CONFIG_COMMANDS) and communicate with i2c based realtime
2125 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002126 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002127
Ben Warrenbb99ad62006-09-07 16:50:54 -04002128 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002129
wdenk945af8d2003-07-16 21:53:01 +00002130 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002131 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002133 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002134 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002135 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002136 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002137
Peter Tyser8d321b82010-04-12 22:28:21 -05002138 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002139 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002140 and so its address should therefore be cleared to 0 (See,
2141 eg, MPC823e User's Manual p.16-473). So, set
2142 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002143
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002144 CONFIG_SYS_I2C_INIT_MPC5XXX
2145
2146 When a board is reset during an i2c bus transfer
2147 chips might think that the current transfer is still
2148 in progress. Reset the slave devices by sending start
2149 commands until the slave device responds.
2150
wdenk945af8d2003-07-16 21:53:01 +00002151 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002152
Heiko Schocherea818db2013-01-29 08:53:15 +01002153 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002154 then the following macros need to be defined (examples are
2155 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002156
2157 I2C_INIT
2158
wdenkb37c7e52003-06-30 16:24:52 +00002159 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002160 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002161
wdenkba56f622004-02-06 23:19:44 +00002162 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002163
wdenkc6097192002-11-03 00:24:07 +00002164 I2C_PORT
2165
wdenk43d96162003-03-06 00:02:04 +00002166 (Only for MPC8260 CPU). The I/O port to use (the code
2167 assumes both bits are on the same port). Valid values
2168 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002169
2170 I2C_ACTIVE
2171
2172 The code necessary to make the I2C data line active
2173 (driven). If the data line is open collector, this
2174 define can be null.
2175
wdenkb37c7e52003-06-30 16:24:52 +00002176 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2177
wdenkc6097192002-11-03 00:24:07 +00002178 I2C_TRISTATE
2179
2180 The code necessary to make the I2C data line tri-stated
2181 (inactive). If the data line is open collector, this
2182 define can be null.
2183
wdenkb37c7e52003-06-30 16:24:52 +00002184 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2185
wdenkc6097192002-11-03 00:24:07 +00002186 I2C_READ
2187
York Sun472d5462013-04-01 11:29:11 -07002188 Code that returns true if the I2C data line is high,
2189 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002190
wdenkb37c7e52003-06-30 16:24:52 +00002191 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2192
wdenkc6097192002-11-03 00:24:07 +00002193 I2C_SDA(bit)
2194
York Sun472d5462013-04-01 11:29:11 -07002195 If <bit> is true, sets the I2C data line high. If it
2196 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002197
wdenkb37c7e52003-06-30 16:24:52 +00002198 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002199 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002200 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002201
wdenkc6097192002-11-03 00:24:07 +00002202 I2C_SCL(bit)
2203
York Sun472d5462013-04-01 11:29:11 -07002204 If <bit> is true, sets the I2C clock line high. If it
2205 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002206
wdenkb37c7e52003-06-30 16:24:52 +00002207 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002208 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002209 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002210
wdenkc6097192002-11-03 00:24:07 +00002211 I2C_DELAY
2212
2213 This delay is invoked four times per clock cycle so this
2214 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002215 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002216 like:
2217
wdenkb37c7e52003-06-30 16:24:52 +00002218 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002219
Mike Frysinger793b5722010-07-21 13:38:02 -04002220 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2221
2222 If your arch supports the generic GPIO framework (asm/gpio.h),
2223 then you may alternatively define the two GPIOs that are to be
2224 used as SCL / SDA. Any of the previous I2C_xxx macros will
2225 have GPIO-based defaults assigned to them as appropriate.
2226
2227 You should define these to the GPIO value as given directly to
2228 the generic GPIO functions.
2229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002230 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002231
wdenk8bde7f72003-06-27 21:31:46 +00002232 When a board is reset during an i2c bus transfer
2233 chips might think that the current transfer is still
2234 in progress. On some boards it is possible to access
2235 the i2c SCLK line directly, either by using the
2236 processor pin as a GPIO or by having a second pin
2237 connected to the bus. If this option is defined a
2238 custom i2c_init_board() routine in boards/xxx/board.c
2239 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002240
Richard Retanubun26a33502010-04-12 15:08:17 -04002241 CONFIG_SYS_I2C_BOARD_LATE_INIT
2242
2243 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2244 defined a custom i2c_board_late_init() routine in
2245 boards/xxx/board.c is run AFTER the operations in i2c_init()
2246 is completed. This callpoint can be used to unreset i2c bus
2247 using CPU i2c controller register accesses for CPUs whose i2c
2248 controller provide such a method. It is called at the end of
2249 i2c_init() to allow i2c_init operations to setup the i2c bus
2250 controller on the CPU (e.g. setting bus speed & slave address).
2251
wdenk17ea1172004-06-06 21:51:03 +00002252 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2253
2254 This option enables configuration of bi_iic_fast[] flags
2255 in u-boot bd_info structure based on u-boot environment
2256 variable "i2cfast". (see also i2cfast)
2257
Ben Warrenbb99ad62006-09-07 16:50:54 -04002258 CONFIG_I2C_MULTI_BUS
2259
2260 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002261 must have a controller. At any point in time, only one bus is
2262 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002263 Note that bus numbering is zero-based.
2264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002265 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002266
2267 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002268 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002269 is set, specify a list of bus-device pairs. Otherwise, specify
2270 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002271
2272 e.g.
2273 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002274 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002275
2276 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2277
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002278 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002279 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002280
2281 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2282
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002283 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002284
2285 If defined, then this indicates the I2C bus number for DDR SPD.
2286 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002288 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002289
2290 If defined, then this indicates the I2C bus number for the RTC.
2291 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002293 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002294
2295 If defined, then this indicates the I2C bus number for the DTT.
2296 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002298 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002299
2300 If defined, specifies the I2C address of the DTT device.
2301 If not defined, then U-Boot uses predefined value for
2302 specified DTT device.
2303
Andrew Dyer2ac69852008-12-29 17:36:01 -06002304 CONFIG_SOFT_I2C_READ_REPEATED_START
2305
2306 defining this will force the i2c_read() function in
2307 the soft_i2c driver to perform an I2C repeated start
2308 between writing the address pointer and reading the
2309 data. If this define is omitted the default behaviour
2310 of doing a stop-start sequence will be used. Most I2C
2311 devices can use either method, but some require one or
2312 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002313
wdenkc6097192002-11-03 00:24:07 +00002314- SPI Support: CONFIG_SPI
2315
2316 Enables SPI driver (so far only tested with
2317 SPI EEPROM, also an instance works with Crystal A/D and
2318 D/As on the SACSng board)
2319
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002320 CONFIG_SH_SPI
2321
2322 Enables the driver for SPI controller on SuperH. Currently
2323 only SH7757 is supported.
2324
wdenkc6097192002-11-03 00:24:07 +00002325 CONFIG_SPI_X
2326
2327 Enables extended (16-bit) SPI EEPROM addressing.
2328 (symmetrical to CONFIG_I2C_X)
2329
2330 CONFIG_SOFT_SPI
2331
wdenk43d96162003-03-06 00:02:04 +00002332 Enables a software (bit-bang) SPI driver rather than
2333 using hardware support. This is a general purpose
2334 driver that only requires three general I/O port pins
2335 (two outputs, one input) to function. If this is
2336 defined, the board configuration must define several
2337 SPI configuration items (port pins to use, etc). For
2338 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002339
Ben Warren04a9e112008-01-16 22:37:35 -05002340 CONFIG_HARD_SPI
2341
2342 Enables a hardware SPI driver for general-purpose reads
2343 and writes. As with CONFIG_SOFT_SPI, the board configuration
2344 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002345 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002346 example, see include/configs/mpc8349emds.h.
2347
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002348 CONFIG_MXC_SPI
2349
2350 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002351 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002352
Matthias Fuchs01335022007-12-27 17:12:34 +01002353- FPGA Support: CONFIG_FPGA
2354
2355 Enables FPGA subsystem.
2356
2357 CONFIG_FPGA_<vendor>
2358
2359 Enables support for specific chip vendors.
2360 (ALTERA, XILINX)
2361
2362 CONFIG_FPGA_<family>
2363
2364 Enables support for FPGA family.
2365 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2366
2367 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002368
wdenk43d96162003-03-06 00:02:04 +00002369 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002370
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002371 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002372
wdenk8bde7f72003-06-27 21:31:46 +00002373 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002375 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002376
wdenk43d96162003-03-06 00:02:04 +00002377 Enable checks on FPGA configuration interface busy
2378 status by the configuration function. This option
2379 will require a board or device specific function to
2380 be written.
wdenkc6097192002-11-03 00:24:07 +00002381
2382 CONFIG_FPGA_DELAY
2383
2384 If defined, a function that provides delays in the FPGA
2385 configuration driver.
2386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002387 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002388 Allow Control-C to interrupt FPGA configuration
2389
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002390 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002391
wdenk43d96162003-03-06 00:02:04 +00002392 Check for configuration errors during FPGA bitfile
2393 loading. For example, abort during Virtex II
2394 configuration if the INIT_B line goes low (which
2395 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002398
wdenk43d96162003-03-06 00:02:04 +00002399 Maximum time to wait for the INIT_B line to deassert
2400 after PROB_B has been deasserted during a Virtex II
2401 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002402 ms.
wdenkc6097192002-11-03 00:24:07 +00002403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002405
wdenk43d96162003-03-06 00:02:04 +00002406 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002407 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002410
wdenk43d96162003-03-06 00:02:04 +00002411 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002412 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002413
2414- Configuration Management:
2415 CONFIG_IDENT_STRING
2416
wdenk43d96162003-03-06 00:02:04 +00002417 If defined, this string will be added to the U-Boot
2418 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002419
2420- Vendor Parameter Protection:
2421
wdenk43d96162003-03-06 00:02:04 +00002422 U-Boot considers the values of the environment
2423 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002424 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002425 are set once by the board vendor / manufacturer, and
2426 protects these variables from casual modification by
2427 the user. Once set, these variables are read-only,
2428 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002429 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002430
2431 If CONFIG_ENV_OVERWRITE is #defined in your config
2432 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002433 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002434 these parameters.
2435
2436 Alternatively, if you #define _both_ CONFIG_ETHADDR
2437 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002438 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002439 which can be changed exactly ONCE by the user. [The
2440 serial# is unaffected by this, i. e. it remains
2441 read-only.]
2442
Joe Hershberger25980902012-12-11 22:16:31 -06002443 The same can be accomplished in a more flexible way
2444 for any variable by configuring the type of access
2445 to allow for those variables in the ".flags" variable
2446 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2447
wdenkc6097192002-11-03 00:24:07 +00002448- Protected RAM:
2449 CONFIG_PRAM
2450
2451 Define this variable to enable the reservation of
2452 "protected RAM", i. e. RAM which is not overwritten
2453 by U-Boot. Define CONFIG_PRAM to hold the number of
2454 kB you want to reserve for pRAM. You can overwrite
2455 this default value by defining an environment
2456 variable "pram" to the number of kB you want to
2457 reserve. Note that the board info structure will
2458 still show the full amount of RAM. If pRAM is
2459 reserved, a new environment variable "mem" will
2460 automatically be defined to hold the amount of
2461 remaining RAM in a form that can be passed as boot
2462 argument to Linux, for instance like that:
2463
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002464 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002465 saveenv
2466
2467 This way you can tell Linux not to use this memory,
2468 either, which results in a memory region that will
2469 not be affected by reboots.
2470
2471 *WARNING* If your board configuration uses automatic
2472 detection of the RAM size, you must make sure that
2473 this memory test is non-destructive. So far, the
2474 following board configurations are known to be
2475 "pRAM-clean":
2476
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002477 IVMS8, IVML24, SPD8xx, TQM8xxL,
2478 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002479 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002480
Gabe Black40fef042012-12-02 04:55:18 +00002481- Access to physical memory region (> 4GB)
2482 Some basic support is provided for operations on memory not
2483 normally accessible to U-Boot - e.g. some architectures
2484 support access to more than 4GB of memory on 32-bit
2485 machines using physical address extension or similar.
2486 Define CONFIG_PHYSMEM to access this basic support, which
2487 currently only supports clearing the memory.
2488
wdenkc6097192002-11-03 00:24:07 +00002489- Error Recovery:
2490 CONFIG_PANIC_HANG
2491
2492 Define this variable to stop the system in case of a
2493 fatal error, so that you have to reset it manually.
2494 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002495 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002496 automatically as fast as possible, but it may be
2497 useful during development since you can try to debug
2498 the conditions that lead to the situation.
2499
2500 CONFIG_NET_RETRY_COUNT
2501
wdenk43d96162003-03-06 00:02:04 +00002502 This variable defines the number of retries for
2503 network operations like ARP, RARP, TFTP, or BOOTP
2504 before giving up the operation. If not defined, a
2505 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002506
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002507 CONFIG_ARP_TIMEOUT
2508
2509 Timeout waiting for an ARP reply in milliseconds.
2510
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002511 CONFIG_NFS_TIMEOUT
2512
2513 Timeout in milliseconds used in NFS protocol.
2514 If you encounter "ERROR: Cannot umount" in nfs command,
2515 try longer timeout such as
2516 #define CONFIG_NFS_TIMEOUT 10000UL
2517
wdenkc6097192002-11-03 00:24:07 +00002518- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002519 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002520
2521 Enable auto completion of commands using TAB.
2522
Wolfgang Denka9398e02006-11-27 15:32:42 +01002523 Note that this feature has NOT been implemented yet
2524 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002525
2526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002528
2529 Define this variable to enable the "hush" shell (from
2530 Busybox) as command line interpreter, thus enabling
2531 powerful command line syntax like
2532 if...then...else...fi conditionals or `&&' and '||'
2533 constructs ("shell scripts").
2534
2535 If undefined, you get the old, much simpler behaviour
2536 with a somewhat smaller memory footprint.
2537
2538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002539 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002540
2541 This defines the secondary prompt string, which is
2542 printed when the command interpreter needs more input
2543 to complete a command. Usually "> ".
2544
2545 Note:
2546
wdenk8bde7f72003-06-27 21:31:46 +00002547 In the current implementation, the local variables
2548 space and global environment variables space are
2549 separated. Local variables are those you define by
2550 simply typing `name=value'. To access a local
2551 variable later on, you have write `$name' or
2552 `${name}'; to execute the contents of a variable
2553 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002554
wdenk43d96162003-03-06 00:02:04 +00002555 Global environment variables are those you use
2556 setenv/printenv to work with. To run a command stored
2557 in such a variable, you need to use the run command,
2558 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002559
2560 To store commands and special characters in a
2561 variable, please use double quotation marks
2562 surrounding the whole text of the variable, instead
2563 of the backslashes before semicolons and special
2564 symbols.
2565
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002566- Commandline Editing and History:
2567 CONFIG_CMDLINE_EDITING
2568
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002569 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002570 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002571
wdenka8c7c702003-12-06 19:49:23 +00002572- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002573 CONFIG_EXTRA_ENV_SETTINGS
2574
wdenk43d96162003-03-06 00:02:04 +00002575 Define this to contain any number of null terminated
2576 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002577 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002578
wdenk43d96162003-03-06 00:02:04 +00002579 For example, place something like this in your
2580 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002581
2582 #define CONFIG_EXTRA_ENV_SETTINGS \
2583 "myvar1=value1\0" \
2584 "myvar2=value2\0"
2585
wdenk43d96162003-03-06 00:02:04 +00002586 Warning: This method is based on knowledge about the
2587 internal format how the environment is stored by the
2588 U-Boot code. This is NOT an official, exported
2589 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002590 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002591 You better know what you are doing here.
2592
wdenk43d96162003-03-06 00:02:04 +00002593 Note: overly (ab)use of the default environment is
2594 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002595 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002596 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002597
Stephen Warren5e724ca2012-05-22 09:21:54 +00002598 CONFIG_ENV_VARS_UBOOT_CONFIG
2599
2600 Define this in order to add variables describing the
2601 U-Boot build configuration to the default environment.
2602 These will be named arch, cpu, board, vendor, and soc.
2603
2604 Enabling this option will cause the following to be defined:
2605
2606 - CONFIG_SYS_ARCH
2607 - CONFIG_SYS_CPU
2608 - CONFIG_SYS_BOARD
2609 - CONFIG_SYS_VENDOR
2610 - CONFIG_SYS_SOC
2611
Tom Rini7e27f892012-10-24 07:28:16 +00002612 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2613
2614 Define this in order to add variables describing certain
2615 run-time determined information about the hardware to the
2616 environment. These will be named board_name, board_rev.
2617
Simon Glass06fd8532012-11-30 13:01:17 +00002618 CONFIG_DELAY_ENVIRONMENT
2619
2620 Normally the environment is loaded when the board is
2621 intialised so that it is available to U-Boot. This inhibits
2622 that so that the environment is not available until
2623 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2624 this is instead controlled by the value of
2625 /config/load-environment.
2626
wdenka8c7c702003-12-06 19:49:23 +00002627- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002628 CONFIG_HAS_DATAFLASH
2629
wdenk8bde7f72003-06-27 21:31:46 +00002630 Defining this option enables DataFlash features and
2631 allows to read/write in Dataflash via the standard
2632 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002633
Eric Nelsonf61ec452012-01-31 10:52:08 -07002634- Serial Flash support
2635 CONFIG_CMD_SF
2636
2637 Defining this option enables SPI flash commands
2638 'sf probe/read/write/erase/update'.
2639
2640 Usage requires an initial 'probe' to define the serial
2641 flash parameters, followed by read/write/erase/update
2642 commands.
2643
2644 The following defaults may be provided by the platform
2645 to handle the common case when only a single serial
2646 flash is present on the system.
2647
2648 CONFIG_SF_DEFAULT_BUS Bus identifier
2649 CONFIG_SF_DEFAULT_CS Chip-select
2650 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2651 CONFIG_SF_DEFAULT_SPEED in Hz
2652
Simon Glass24007272012-10-08 13:16:02 +00002653 CONFIG_CMD_SF_TEST
2654
2655 Define this option to include a destructive SPI flash
2656 test ('sf test').
2657
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302658 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2659
2660 Define this option to use the Bank addr/Extended addr
2661 support on SPI flashes which has size > 16Mbytes.
2662
wdenk3f85ce22004-02-23 16:11:30 +00002663- SystemACE Support:
2664 CONFIG_SYSTEMACE
2665
2666 Adding this option adds support for Xilinx SystemACE
2667 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002668 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002669 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002670
2671 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002672 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002673
2674 When SystemACE support is added, the "ace" device type
2675 becomes available to the fat commands, i.e. fatls.
2676
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002677- TFTP Fixed UDP Port:
2678 CONFIG_TFTP_PORT
2679
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002680 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002681 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002682 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002683 number generator is used.
2684
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002685 Also, the environment variable tftpdstp is used to supply
2686 the TFTP UDP destination port value. If tftpdstp isn't
2687 defined, the normal port 69 is used.
2688
2689 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002690 blindly start the TFTP transfer using the pre-configured
2691 target IP address and UDP port. This has the effect of
2692 "punching through" the (Windows XP) firewall, allowing
2693 the remainder of the TFTP transfer to proceed normally.
2694 A better solution is to properly configure the firewall,
2695 but sometimes that is not allowed.
2696
Simon Glassbf36c5d2012-12-05 14:46:38 +00002697- Hashing support:
2698 CONFIG_CMD_HASH
2699
2700 This enables a generic 'hash' command which can produce
2701 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2702
2703 CONFIG_HASH_VERIFY
2704
2705 Enable the hash verify command (hash -v). This adds to code
2706 size a little.
2707
2708 CONFIG_SHA1 - support SHA1 hashing
2709 CONFIG_SHA256 - support SHA256 hashing
2710
2711 Note: There is also a sha1sum command, which should perhaps
2712 be deprecated in favour of 'hash sha1'.
2713
Robert Winklera11f1872013-07-24 17:57:06 -07002714- Freescale i.MX specific commands:
2715 CONFIG_CMD_HDMIDETECT
2716 This enables 'hdmidet' command which returns true if an
2717 HDMI monitor is detected. This command is i.MX 6 specific.
2718
2719 CONFIG_CMD_BMODE
2720 This enables the 'bmode' (bootmode) command for forcing
2721 a boot from specific media.
2722
2723 This is useful for forcing the ROM's usb downloader to
2724 activate upon a watchdog reset which is nice when iterating
2725 on U-Boot. Using the reset button or running bmode normal
2726 will set it back to normal. This command currently
2727 supports i.MX53 and i.MX6.
2728
Simon Glass19c402a2013-06-13 15:10:02 -07002729- Signing support:
2730 CONFIG_RSA
2731
2732 This enables the RSA algorithm used for FIT image verification
2733 in U-Boot. See doc/uImage/signature for more information.
2734
2735 The signing part is build into mkimage regardless of this
2736 option.
2737
2738
wdenka8c7c702003-12-06 19:49:23 +00002739- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002740 CONFIG_SHOW_BOOT_PROGRESS
2741
wdenk43d96162003-03-06 00:02:04 +00002742 Defining this option allows to add some board-
2743 specific code (calling a user-provided function
2744 "show_boot_progress(int)") that enables you to show
2745 the system's boot progress on some display (for
2746 example, some LED's) on your board. At the moment,
2747 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002748
Simon Glass3a608ca2012-02-13 13:51:19 +00002749- Detailed boot stage timing
2750 CONFIG_BOOTSTAGE
2751 Define this option to get detailed timing of each stage
2752 of the boot process.
2753
2754 CONFIG_BOOTSTAGE_USER_COUNT
2755 This is the number of available user bootstage records.
2756 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2757 a new ID will be allocated from this stash. If you exceed
2758 the limit, recording will stop.
2759
2760 CONFIG_BOOTSTAGE_REPORT
2761 Define this to print a report before boot, similar to this:
2762
2763 Timer summary in microseconds:
2764 Mark Elapsed Stage
2765 0 0 reset
2766 3,575,678 3,575,678 board_init_f start
2767 3,575,695 17 arch_cpu_init A9
2768 3,575,777 82 arch_cpu_init done
2769 3,659,598 83,821 board_init_r start
2770 3,910,375 250,777 main_loop
2771 29,916,167 26,005,792 bootm_start
2772 30,361,327 445,160 start_kernel
2773
Simon Glass2eba38c2012-09-28 08:56:39 +00002774 CONFIG_CMD_BOOTSTAGE
2775 Add a 'bootstage' command which supports printing a report
2776 and un/stashing of bootstage data.
2777
Simon Glass94fd1312012-09-28 08:56:37 +00002778 CONFIG_BOOTSTAGE_FDT
2779 Stash the bootstage information in the FDT. A root 'bootstage'
2780 node is created with each bootstage id as a child. Each child
2781 has a 'name' property and either 'mark' containing the
2782 mark time in microsecond, or 'accum' containing the
2783 accumulated time for that bootstage id in microseconds.
2784 For example:
2785
2786 bootstage {
2787 154 {
2788 name = "board_init_f";
2789 mark = <3575678>;
2790 };
2791 170 {
2792 name = "lcd";
2793 accum = <33482>;
2794 };
2795 };
2796
2797 Code in the Linux kernel can find this in /proc/devicetree.
2798
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002799Legacy uImage format:
2800
wdenkc6097192002-11-03 00:24:07 +00002801 Arg Where When
2802 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002803 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002804 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002805 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002806 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002807 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002808 4 common/cmd_bootm.c Image data has correct checksum
2809 -4 common/cmd_bootm.c Image is for unsupported architecture
2810 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002811 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002812 6 common/cmd_bootm.c Image Type check OK
2813 -6 common/cmd_bootm.c gunzip uncompression error
2814 -7 common/cmd_bootm.c Unimplemented compression type
2815 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002816 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002817 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002818
2819 9 common/image.c Start initial ramdisk verification
2820 -10 common/image.c Ramdisk header has bad magic number
2821 -11 common/image.c Ramdisk header has bad checksum
2822 10 common/image.c Ramdisk header is OK
2823 -12 common/image.c Ramdisk data has bad checksum
2824 11 common/image.c Ramdisk data has correct checksum
2825 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002826 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002827 13 common/image.c Start multifile image verification
2828 14 common/image.c No initial ramdisk, no multifile, continue.
2829
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002830 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002831
Stefan Roesea47a12b2010-04-15 16:07:28 +02002832 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002833 -31 post/post.c POST test failed, detected by post_output_backlog()
2834 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002835
Heiko Schocher566a4942007-06-22 19:11:54 +02002836 34 common/cmd_doc.c before loading a Image from a DOC device
2837 -35 common/cmd_doc.c Bad usage of "doc" command
2838 35 common/cmd_doc.c correct usage of "doc" command
2839 -36 common/cmd_doc.c No boot device
2840 36 common/cmd_doc.c correct boot device
2841 -37 common/cmd_doc.c Unknown Chip ID on boot device
2842 37 common/cmd_doc.c correct chip ID found, device available
2843 -38 common/cmd_doc.c Read Error on boot device
2844 38 common/cmd_doc.c reading Image header from DOC device OK
2845 -39 common/cmd_doc.c Image header has bad magic number
2846 39 common/cmd_doc.c Image header has correct magic number
2847 -40 common/cmd_doc.c Error reading Image from DOC device
2848 40 common/cmd_doc.c Image header has correct magic number
2849 41 common/cmd_ide.c before loading a Image from a IDE device
2850 -42 common/cmd_ide.c Bad usage of "ide" command
2851 42 common/cmd_ide.c correct usage of "ide" command
2852 -43 common/cmd_ide.c No boot device
2853 43 common/cmd_ide.c boot device found
2854 -44 common/cmd_ide.c Device not available
2855 44 common/cmd_ide.c Device available
2856 -45 common/cmd_ide.c wrong partition selected
2857 45 common/cmd_ide.c partition selected
2858 -46 common/cmd_ide.c Unknown partition table
2859 46 common/cmd_ide.c valid partition table found
2860 -47 common/cmd_ide.c Invalid partition type
2861 47 common/cmd_ide.c correct partition type
2862 -48 common/cmd_ide.c Error reading Image Header on boot device
2863 48 common/cmd_ide.c reading Image Header from IDE device OK
2864 -49 common/cmd_ide.c Image header has bad magic number
2865 49 common/cmd_ide.c Image header has correct magic number
2866 -50 common/cmd_ide.c Image header has bad checksum
2867 50 common/cmd_ide.c Image header has correct checksum
2868 -51 common/cmd_ide.c Error reading Image from IDE device
2869 51 common/cmd_ide.c reading Image from IDE device OK
2870 52 common/cmd_nand.c before loading a Image from a NAND device
2871 -53 common/cmd_nand.c Bad usage of "nand" command
2872 53 common/cmd_nand.c correct usage of "nand" command
2873 -54 common/cmd_nand.c No boot device
2874 54 common/cmd_nand.c boot device found
2875 -55 common/cmd_nand.c Unknown Chip ID on boot device
2876 55 common/cmd_nand.c correct chip ID found, device available
2877 -56 common/cmd_nand.c Error reading Image Header on boot device
2878 56 common/cmd_nand.c reading Image Header from NAND device OK
2879 -57 common/cmd_nand.c Image header has bad magic number
2880 57 common/cmd_nand.c Image header has correct magic number
2881 -58 common/cmd_nand.c Error reading Image from NAND device
2882 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002883
Heiko Schocher566a4942007-06-22 19:11:54 +02002884 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002885
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002886 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002887 -64 net/eth.c no Ethernet found.
2888 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002889
Heiko Schocher566a4942007-06-22 19:11:54 +02002890 -80 common/cmd_net.c usage wrong
2891 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002892 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002893 81 common/cmd_net.c NetLoop() back without error
2894 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2895 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002896 83 common/cmd_net.c running "source" command
2897 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002898 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002899
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002900FIT uImage format:
2901
2902 Arg Where When
2903 100 common/cmd_bootm.c Kernel FIT Image has correct format
2904 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2905 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2906 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2907 102 common/cmd_bootm.c Kernel unit name specified
2908 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002909 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002910 104 common/cmd_bootm.c Got kernel subimage node offset
2911 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2912 105 common/cmd_bootm.c Kernel subimage hash verification OK
2913 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2914 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002915 -106 common/cmd_bootm.c Kernel subimage has wrong type
2916 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002917 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2918 108 common/cmd_bootm.c Got kernel subimage data/size
2919 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2920 -109 common/cmd_bootm.c Can't get kernel subimage type
2921 -110 common/cmd_bootm.c Can't get kernel subimage comp
2922 -111 common/cmd_bootm.c Can't get kernel subimage os
2923 -112 common/cmd_bootm.c Can't get kernel subimage load address
2924 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2925
2926 120 common/image.c Start initial ramdisk verification
2927 -120 common/image.c Ramdisk FIT image has incorrect format
2928 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002929 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002930 -122 common/image.c Can't get configuration for ramdisk subimage
2931 123 common/image.c Ramdisk unit name specified
2932 -124 common/image.c Can't get ramdisk subimage node offset
2933 125 common/image.c Got ramdisk subimage node offset
2934 -125 common/image.c Ramdisk subimage hash verification failed
2935 126 common/image.c Ramdisk subimage hash verification OK
2936 -126 common/image.c Ramdisk subimage for unsupported architecture
2937 127 common/image.c Architecture check OK
2938 -127 common/image.c Can't get ramdisk subimage data/size
2939 128 common/image.c Got ramdisk subimage data/size
2940 129 common/image.c Can't get ramdisk load address
2941 -129 common/image.c Got ramdisk load address
2942
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002943 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002944 131 common/cmd_doc.c FIT image format OK
2945
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002946 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002947 141 common/cmd_ide.c FIT image format OK
2948
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002949 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002950 151 common/cmd_nand.c FIT image format OK
2951
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002952- FIT image support:
2953 CONFIG_FIT
2954 Enable support for the FIT uImage format.
2955
2956 CONFIG_FIT_BEST_MATCH
2957 When no configuration is explicitly selected, default to the
2958 one whose fdt's compatibility field best matches that of
2959 U-Boot itself. A match is considered "best" if it matches the
2960 most specific compatibility entry of U-Boot's fdt's root node.
2961 The order of entries in the configuration's fdt is ignored.
2962
Simon Glass3e569a62013-06-13 15:10:00 -07002963 CONFIG_FIT_SIGNATURE
2964 This option enables signature verification of FIT uImages,
2965 using a hash signed and verified using RSA. See
2966 doc/uImage.FIT/signature.txt for more details.
2967
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002968- Standalone program support:
2969 CONFIG_STANDALONE_LOAD_ADDR
2970
Wolfgang Denk6feff892011-10-09 21:06:34 +02002971 This option defines a board specific value for the
2972 address where standalone program gets loaded, thus
2973 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002974 settings.
2975
2976- Frame Buffer Address:
2977 CONFIG_FB_ADDR
2978
2979 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002980 address for frame buffer. This is typically the case
2981 when using a graphics controller has separate video
2982 memory. U-Boot will then place the frame buffer at
2983 the given address instead of dynamically reserving it
2984 in system RAM by calling lcd_setmem(), which grabs
2985 the memory for the frame buffer depending on the
2986 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002987
2988 Please see board_init_f function.
2989
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002990- Automatic software updates via TFTP server
2991 CONFIG_UPDATE_TFTP
2992 CONFIG_UPDATE_TFTP_CNT_MAX
2993 CONFIG_UPDATE_TFTP_MSEC_MAX
2994
2995 These options enable and control the auto-update feature;
2996 for a more detailed description refer to doc/README.update.
2997
2998- MTD Support (mtdparts command, UBI support)
2999 CONFIG_MTD_DEVICE
3000
3001 Adds the MTD device infrastructure from the Linux kernel.
3002 Needed for mtdparts command support.
3003
3004 CONFIG_MTD_PARTITIONS
3005
3006 Adds the MTD partitioning infrastructure from the Linux
3007 kernel. Needed for UBI support.
3008
Joe Hershberger70c219c2013-04-08 10:32:48 +00003009- UBI support
3010 CONFIG_CMD_UBI
3011
3012 Adds commands for interacting with MTD partitions formatted
3013 with the UBI flash translation layer
3014
3015 Requires also defining CONFIG_RBTREE
3016
Joe Hershberger147162d2013-04-08 10:32:49 +00003017 CONFIG_UBI_SILENCE_MSG
3018
3019 Make the verbose messages from UBI stop printing. This leaves
3020 warnings and errors enabled.
3021
Joe Hershberger70c219c2013-04-08 10:32:48 +00003022- UBIFS support
3023 CONFIG_CMD_UBIFS
3024
3025 Adds commands for interacting with UBI volumes formatted as
3026 UBIFS. UBIFS is read-only in u-boot.
3027
3028 Requires UBI support as well as CONFIG_LZO
3029
Joe Hershberger147162d2013-04-08 10:32:49 +00003030 CONFIG_UBIFS_SILENCE_MSG
3031
3032 Make the verbose messages from UBIFS stop printing. This leaves
3033 warnings and errors enabled.
3034
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003035- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003036 CONFIG_SPL
3037 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003038
Tom Rini95579792012-02-14 07:29:40 +00003039 CONFIG_SPL_LDSCRIPT
3040 LDSCRIPT for linking the SPL binary.
3041
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003042 CONFIG_SPL_MAX_FOOTPRINT
3043 Maximum size in memory allocated to the SPL, BSS included.
3044 When defined, the linker checks that the actual memory
3045 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003046 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003047 must not be both defined at the same time.
3048
Tom Rini95579792012-02-14 07:29:40 +00003049 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003050 Maximum size of the SPL image (text, data, rodata, and
3051 linker lists sections), BSS excluded.
3052 When defined, the linker checks that the actual size does
3053 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003054
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003055 CONFIG_SPL_TEXT_BASE
3056 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003057
Scott Wood94a45bb2012-09-20 19:05:12 -05003058 CONFIG_SPL_RELOC_TEXT_BASE
3059 Address to relocate to. If unspecified, this is equal to
3060 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3061
Tom Rini95579792012-02-14 07:29:40 +00003062 CONFIG_SPL_BSS_START_ADDR
3063 Link address for the BSS within the SPL binary.
3064
3065 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003066 Maximum size in memory allocated to the SPL BSS.
3067 When defined, the linker checks that the actual memory used
3068 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003069 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003070 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003071
3072 CONFIG_SPL_STACK
3073 Adress of the start of the stack SPL will use
3074
Scott Wood94a45bb2012-09-20 19:05:12 -05003075 CONFIG_SPL_RELOC_STACK
3076 Adress of the start of the stack SPL will use after
3077 relocation. If unspecified, this is equal to
3078 CONFIG_SPL_STACK.
3079
Tom Rini95579792012-02-14 07:29:40 +00003080 CONFIG_SYS_SPL_MALLOC_START
3081 Starting address of the malloc pool used in SPL.
3082
3083 CONFIG_SYS_SPL_MALLOC_SIZE
3084 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003085
Tom Rini47f7bca2012-08-13 12:03:19 -07003086 CONFIG_SPL_FRAMEWORK
3087 Enable the SPL framework under common/. This framework
3088 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3089 NAND loading of the Linux Kernel.
3090
Tom Rini861a86f2012-08-13 11:37:56 -07003091 CONFIG_SPL_DISPLAY_PRINT
3092 For ARM, enable an optional function to print more information
3093 about the running system.
3094
Scott Wood4b919722012-09-20 16:35:21 -05003095 CONFIG_SPL_INIT_MINIMAL
3096 Arch init code should be built for a very small image
3097
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003098 CONFIG_SPL_LIBCOMMON_SUPPORT
3099 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003100
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003101 CONFIG_SPL_LIBDISK_SUPPORT
3102 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003103
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003104 CONFIG_SPL_I2C_SUPPORT
3105 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003106
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003107 CONFIG_SPL_GPIO_SUPPORT
3108 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003109
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003110 CONFIG_SPL_MMC_SUPPORT
3111 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003112
Tom Rini95579792012-02-14 07:29:40 +00003113 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3114 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3115 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3116 Address, size and partition on the MMC to load U-Boot from
3117 when the MMC is being used in raw mode.
3118
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003119 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3120 Sector to load kernel uImage from when MMC is being
3121 used in raw mode (for Falcon mode)
3122
3123 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3124 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3125 Sector and number of sectors to load kernel argument
3126 parameters from when MMC is being used in raw mode
3127 (for falcon mode)
3128
Tom Rini95579792012-02-14 07:29:40 +00003129 CONFIG_SPL_FAT_SUPPORT
3130 Support for fs/fat/libfat.o in SPL binary
3131
3132 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3133 Filename to read to load U-Boot when reading from FAT
3134
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003135 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3136 Filename to read to load kernel uImage when reading
3137 from FAT (for Falcon mode)
3138
3139 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3140 Filename to read to load kernel argument parameters
3141 when reading from FAT (for Falcon mode)
3142
Scott Wood06f60ae2012-12-06 13:33:17 +00003143 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3144 Set this for NAND SPL on PPC mpc83xx targets, so that
3145 start.S waits for the rest of the SPL to load before
3146 continuing (the hardware starts execution after just
3147 loading the first page rather than the full 4K).
3148
Scott Wood6f2f01b2012-09-20 19:09:07 -05003149 CONFIG_SPL_NAND_BASE
3150 Include nand_base.c in the SPL. Requires
3151 CONFIG_SPL_NAND_DRIVERS.
3152
3153 CONFIG_SPL_NAND_DRIVERS
3154 SPL uses normal NAND drivers, not minimal drivers.
3155
3156 CONFIG_SPL_NAND_ECC
3157 Include standard software ECC in the SPL
3158
Tom Rini95579792012-02-14 07:29:40 +00003159 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003160 Support for NAND boot using simple NAND drivers that
3161 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003162
Ying Zhangbb0dc102013-08-16 15:16:11 +08003163 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3164 Set for the SPL on PPC mpc8xxx targets, support for
3165 arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3166
Ying Zhang7c8eea52013-08-16 15:16:12 +08003167 CONFIG_SPL_COMMON_INIT_DDR
3168 Set for common ddr init with serial presence detect in
3169 SPL binary.
3170
Tom Rini95579792012-02-14 07:29:40 +00003171 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3172 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3173 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3174 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3175 CONFIG_SYS_NAND_ECCBYTES
3176 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003177 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003178
3179 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003180 Location in NAND to read U-Boot from
3181
3182 CONFIG_SYS_NAND_U_BOOT_DST
3183 Location in memory to load U-Boot to
3184
3185 CONFIG_SYS_NAND_U_BOOT_SIZE
3186 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003187
3188 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003189 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003190
3191 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3192 Define this if you need to first read the OOB and then the
3193 data. This is used for example on davinci plattforms.
3194
3195 CONFIG_SPL_OMAP3_ID_NAND
3196 Support for an OMAP3-specific set of functions to return the
3197 ID and MFR of the first attached NAND chip, if present.
3198
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003199 CONFIG_SPL_SERIAL_SUPPORT
3200 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003201
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003202 CONFIG_SPL_SPI_FLASH_SUPPORT
3203 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003204
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003205 CONFIG_SPL_SPI_SUPPORT
3206 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003207
Pavel Machekc57b9532012-08-30 22:42:11 +02003208 CONFIG_SPL_RAM_DEVICE
3209 Support for running image already present in ram, in SPL binary
3210
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003211 CONFIG_SPL_LIBGENERIC_SUPPORT
3212 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003213
Ying Zhangba1bee42013-05-20 14:07:25 +08003214 CONFIG_SPL_ENV_SUPPORT
3215 Support for the environment operating in SPL binary
3216
3217 CONFIG_SPL_NET_SUPPORT
3218 Support for the net/libnet.o in SPL binary.
3219 It conflicts with SPL env from storage medium specified by
3220 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3221
Scott Wood74752ba2012-12-06 13:33:16 +00003222 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003223 Image offset to which the SPL should be padded before appending
3224 the SPL payload. By default, this is defined as
3225 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3226 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3227 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003228
Scott Woodca2fca22012-09-21 16:27:32 -05003229 CONFIG_SPL_TARGET
3230 Final target image containing SPL and payload. Some SPLs
3231 use an arch-specific makefile fragment instead, for
3232 example if more than one image needs to be produced.
3233
Simon Glass87ebee32013-05-08 08:05:59 +00003234 CONFIG_FIT_SPL_PRINT
3235 Printing information about a FIT image adds quite a bit of
3236 code to SPL. So this is normally disabled in SPL. Use this
3237 option to re-enable it. This will affect the output of the
3238 bootm command when booting a FIT image.
3239
Ying Zhang3aa29de2013-08-16 15:16:15 +08003240- TPL framework
3241 CONFIG_TPL
3242 Enable building of TPL globally.
3243
3244 CONFIG_TPL_PAD_TO
3245 Image offset to which the TPL should be padded before appending
3246 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003247 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3248 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3249 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003250
wdenkc6097192002-11-03 00:24:07 +00003251Modem Support:
3252--------------
3253
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003254[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003255
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003256- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003257 CONFIG_MODEM_SUPPORT
3258
3259- RTS/CTS Flow control enable:
3260 CONFIG_HWFLOW
3261
3262- Modem debug support:
3263 CONFIG_MODEM_SUPPORT_DEBUG
3264
wdenk43d96162003-03-06 00:02:04 +00003265 Enables debugging stuff (char screen[1024], dbg())
3266 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003267
wdenka8c7c702003-12-06 19:49:23 +00003268- Interrupt support (PPC):
3269
wdenkd4ca31c2004-01-02 14:00:00 +00003270 There are common interrupt_init() and timer_interrupt()
3271 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003272 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003273 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003274 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003275 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003276 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003277 specific handling. If board has watchdog / status_led
3278 / other_activity_monitor it works automatically from
3279 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003280
wdenkc6097192002-11-03 00:24:07 +00003281- General:
3282
wdenk43d96162003-03-06 00:02:04 +00003283 In the target system modem support is enabled when a
3284 specific key (key combination) is pressed during
3285 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003286 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003287 board_init(). Currently key_pressed() is a dummy
3288 function, returning 1 and thus enabling modem
3289 initialization.
wdenkc6097192002-11-03 00:24:07 +00003290
wdenk43d96162003-03-06 00:02:04 +00003291 If there are no modem init strings in the
3292 environment, U-Boot proceed to autoboot; the
3293 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003294 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003295
3296 See also: doc/README.Modem
3297
Helmut Raiger9660e442011-10-20 04:19:47 +00003298Board initialization settings:
3299------------------------------
3300
3301During Initialization u-boot calls a number of board specific functions
3302to allow the preparation of board specific prerequisites, e.g. pin setup
3303before drivers are initialized. To enable these callbacks the
3304following configuration macros have to be defined. Currently this is
3305architecture specific, so please check arch/your_architecture/lib/board.c
3306typically in board_init_f() and board_init_r().
3307
3308- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3309- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3310- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3311- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003312
wdenkc6097192002-11-03 00:24:07 +00003313Configuration Settings:
3314-----------------------
3315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003316- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003317 undefine this when you're short of memory.
3318
Peter Tyser2fb26042009-01-27 18:03:12 -06003319- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3320 width of the commands listed in the 'help' command output.
3321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003322- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003323 prompt for user input.
3324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003325- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003327- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003328
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003329- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003331- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003332 the application (usually a Linux kernel) when it is
3333 booted
3334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003335- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003336 List of legal baudrate settings for this board.
3337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003338- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003339 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003341- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003342 If the board specific function
3343 extern int overwrite_console (void);
3344 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003345 serial port, else the settings in the environment are used.
3346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003347- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003348 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003350- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003351 Enable overwrite of previous console environment settings.
3352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003353- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003354 Begin and End addresses of the area used by the
3355 simple memory test.
3356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003357- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003358 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003360- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003361 Scratch address used by the alternate memory test
3362 You only need to set this if address zero isn't writeable
3363
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003364- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3365 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003366 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003367 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003368 fixing up gd->ram_size the Linux kernel should gets passed
3369 the now "corrected" memory size and won't touch it either.
3370 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003371 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003372 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003373 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003374
3375 This option can be used as a workaround for the 440EPx/GRx
3376 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3377 be touched.
3378
3379 WARNING: Please make sure that this value is a multiple of
3380 the Linux page size (normally 4k). If this is not the case,
3381 then the end address of the Linux memory will be located at a
3382 non page size aligned address and this could cause major
3383 problems.
3384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003385- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003386 Enable temporary baudrate change while serial download
3387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003388- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003389 Physical start address of SDRAM. _Must_ be 0 here.
3390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003391- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003392 Physical start address of Motherboard I/O (if using a
3393 Cogent motherboard)
3394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003395- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003396 Physical start address of Flash memory.
3397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003398- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003399 Physical start address of boot monitor code (set by
3400 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003401 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003402 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003404- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003405 Size of memory reserved for monitor code, used to
3406 determine _at_compile_time_ (!) if the environment is
3407 embedded within the U-Boot image, or in a separate
3408 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003410- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003411 Size of DRAM reserved for malloc() use.
3412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003413- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003414 Normally compressed uImages are limited to an
3415 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003416 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003417 to adjust this setting to your needs.
3418
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003419- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003420 Maximum size of memory mapped by the startup code of
3421 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003422 the Linux kernel (bd_info, boot arguments, FDT blob if
3423 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003424 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003425 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003426 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003427 variable "bootm_mapsize" will override the value of
3428 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3429 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003430
John Rigbyfca43cc2010-10-13 13:57:35 -06003431- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3432 Enable initrd_high functionality. If defined then the
3433 initrd_high feature is enabled and the bootm ramdisk subcommand
3434 is enabled.
3435
3436- CONFIG_SYS_BOOT_GET_CMDLINE:
3437 Enables allocating and saving kernel cmdline in space between
3438 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3439
3440- CONFIG_SYS_BOOT_GET_KBD:
3441 Enables allocating and saving a kernel copy of the bd_info in
3442 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003444- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003445 Max number of Flash memory banks
3446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003447- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003448 Max number of sectors on a Flash chip
3449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003450- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003451 Timeout for Flash erase operations (in ms)
3452
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003453- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003454 Timeout for Flash write operations (in ms)
3455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003456- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003457 Timeout for Flash set sector lock bit operation (in ms)
3458
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003459- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003460 Timeout for Flash clear lock bits operation (in ms)
3461
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003462- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003463 If defined, hardware flash sectors protection is used
3464 instead of U-Boot software protection.
3465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003466- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003467
3468 Enable TFTP transfers directly to flash memory;
3469 without this option such a download has to be
3470 performed in two steps: (1) download to RAM, and (2)
3471 copy from RAM to flash.
3472
3473 The two-step approach is usually more reliable, since
3474 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003475 the flash, but in some situations (when system RAM is
3476 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003477 downloaded image) this option may be very useful.
3478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003479- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003480 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003481 common flash structure for storing flash geometry.
3482
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003483- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003484 This option also enables the building of the cfi_flash driver
3485 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003486
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003487- CONFIG_FLASH_CFI_MTD
3488 This option enables the building of the cfi_mtd driver
3489 in the drivers directory. The driver exports CFI flash
3490 to the MTD layer.
3491
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003492- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003493 Use buffered writes to flash.
3494
3495- CONFIG_FLASH_SPANSION_S29WS_N
3496 s29ws-n MirrorBit flash has non-standard addresses for buffered
3497 write commands.
3498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003499- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003500 If this option is defined, the common CFI flash doesn't
3501 print it's warning upon not recognized FLASH banks. This
3502 is useful, if some of the configured banks are only
3503 optionally available.
3504
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003505- CONFIG_FLASH_SHOW_PROGRESS
3506 If defined (must be an integer), print out countdown
3507 digits and dots. Recommended value: 45 (9..1) for 80
3508 column displays, 15 (3..1) for 40 column displays.
3509
Stefan Roese352ef3f2013-04-04 15:53:14 +02003510- CONFIG_FLASH_VERIFY
3511 If defined, the content of the flash (destination) is compared
3512 against the source after the write operation. An error message
3513 will be printed when the contents are not identical.
3514 Please note that this option is useless in nearly all cases,
3515 since such flash programming errors usually are detected earlier
3516 while unprotecting/erasing/programming. Please only enable
3517 this option if you really know what you are doing.
3518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003519- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003520 Defines the number of Ethernet receive buffers. On some
3521 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003522 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3523 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003524 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003525 Defaults to 4 if not defined.
3526
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003527- CONFIG_ENV_MAX_ENTRIES
3528
Wolfgang Denk071bc922010-10-27 22:48:30 +02003529 Maximum number of entries in the hash table that is used
3530 internally to store the environment settings. The default
3531 setting is supposed to be generous and should work in most
3532 cases. This setting can be used to tune behaviour; see
3533 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003534
Joe Hershberger25980902012-12-11 22:16:31 -06003535- CONFIG_ENV_FLAGS_LIST_DEFAULT
3536- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003537 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003538 calling env set. Variables can be restricted to only decimal,
3539 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3540 the variables can also be restricted to IP address or MAC address.
3541
3542 The format of the list is:
3543 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003544 access_atribute = [a|r|o|c]
3545 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003546 entry = variable_name[:attributes]
3547 list = entry[,list]
3548
3549 The type attributes are:
3550 s - String (default)
3551 d - Decimal
3552 x - Hexadecimal
3553 b - Boolean ([1yYtT|0nNfF])
3554 i - IP address
3555 m - MAC address
3556
Joe Hershberger267541f2012-12-11 22:16:34 -06003557 The access attributes are:
3558 a - Any (default)
3559 r - Read-only
3560 o - Write-once
3561 c - Change-default
3562
Joe Hershberger25980902012-12-11 22:16:31 -06003563 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3564 Define this to a list (string) to define the ".flags"
3565 envirnoment variable in the default or embedded environment.
3566
3567 - CONFIG_ENV_FLAGS_LIST_STATIC
3568 Define this to a list (string) to define validation that
3569 should be done if an entry is not found in the ".flags"
3570 environment variable. To override a setting in the static
3571 list, simply add an entry for the same variable name to the
3572 ".flags" variable.
3573
Joe Hershberger267541f2012-12-11 22:16:34 -06003574- CONFIG_ENV_ACCESS_IGNORE_FORCE
3575 If defined, don't allow the -f switch to env set override variable
3576 access flags.
3577
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003578- CONFIG_SYS_GENERIC_BOARD
3579 This selects the architecture-generic board system instead of the
3580 architecture-specific board files. It is intended to move boards
3581 to this new framework over time. Defining this will disable the
3582 arch/foo/lib/board.c file and use common/board_f.c and
3583 common/board_r.c instead. To use this option your architecture
3584 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3585 its config.mk file). If you find problems enabling this option on
3586 your board please report the problem and send patches!
3587
Simon Glass632efa72013-03-11 07:06:48 +00003588- CONFIG_SYS_SYM_OFFSETS
3589 This is set by architectures that use offsets for link symbols
3590 instead of absolute values. So bss_start is obtained using an
3591 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3592 directly. You should not need to touch this setting.
3593
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003594- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3595 This is set by OMAP boards for the max time that reset should
3596 be asserted. See doc/README.omap-reset-time for details on how
3597 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003598
wdenkc6097192002-11-03 00:24:07 +00003599The following definitions that deal with the placement and management
3600of environment data (variable area); in general, we support the
3601following configurations:
3602
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003603- CONFIG_BUILD_ENVCRC:
3604
3605 Builds up envcrc with the target environment so that external utils
3606 may easily extract it and embed it in final U-Boot images.
3607
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003608- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003609
3610 Define this if the environment is in flash memory.
3611
3612 a) The environment occupies one whole flash sector, which is
3613 "embedded" in the text segment with the U-Boot code. This
3614 happens usually with "bottom boot sector" or "top boot
3615 sector" type flash chips, which have several smaller
3616 sectors at the start or the end. For instance, such a
3617 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3618 such a case you would place the environment in one of the
3619 4 kB sectors - with U-Boot code before and after it. With
3620 "top boot sector" type flash chips, you would put the
3621 environment in one of the last sectors, leaving a gap
3622 between U-Boot and the environment.
3623
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003624 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003625
3626 Offset of environment data (variable area) to the
3627 beginning of flash memory; for instance, with bottom boot
3628 type flash chips the second sector can be used: the offset
3629 for this sector is given here.
3630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003631 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003632
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003633 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003634
3635 This is just another way to specify the start address of
3636 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003637 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003638
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003639 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003640
3641 Size of the sector containing the environment.
3642
3643
3644 b) Sometimes flash chips have few, equal sized, BIG sectors.
3645 In such a case you don't want to spend a whole sector for
3646 the environment.
3647
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003648 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003649
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003650 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003651 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003652 of this flash sector for the environment. This saves
3653 memory for the RAM copy of the environment.
3654
3655 It may also save flash memory if you decide to use this
3656 when your environment is "embedded" within U-Boot code,
3657 since then the remainder of the flash sector could be used
3658 for U-Boot code. It should be pointed out that this is
3659 STRONGLY DISCOURAGED from a robustness point of view:
3660 updating the environment in flash makes it always
3661 necessary to erase the WHOLE sector. If something goes
3662 wrong before the contents has been restored from a copy in
3663 RAM, your target system will be dead.
3664
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003665 - CONFIG_ENV_ADDR_REDUND
3666 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003667
wdenk43d96162003-03-06 00:02:04 +00003668 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003669 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003670 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003671 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003672
3673BE CAREFUL! Any changes to the flash layout, and some changes to the
3674source code will make it necessary to adapt <board>/u-boot.lds*
3675accordingly!
3676
3677
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003678- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003679
3680 Define this if you have some non-volatile memory device
3681 (NVRAM, battery buffered SRAM) which you want to use for the
3682 environment.
3683
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003684 - CONFIG_ENV_ADDR:
3685 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003686
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003687 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003688 want to use for environment. It is assumed that this memory
3689 can just be read and written to, without any special
3690 provision.
3691
3692BE CAREFUL! The first access to the environment happens quite early
3693in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003694console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003695U-Boot will hang.
3696
3697Please note that even with NVRAM we still use a copy of the
3698environment in RAM: we could work on NVRAM directly, but we want to
3699keep settings there always unmodified except somebody uses "saveenv"
3700to save the current settings.
3701
3702
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003703- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003704
3705 Use this if you have an EEPROM or similar serial access
3706 device and a driver for it.
3707
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003708 - CONFIG_ENV_OFFSET:
3709 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003710
3711 These two #defines specify the offset and size of the
3712 environment area within the total memory of your EEPROM.
3713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003714 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003715 If defined, specified the chip address of the EEPROM device.
3716 The default address is zero.
3717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003718 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003719 If defined, the number of bits used to address bytes in a
3720 single page in the EEPROM device. A 64 byte page, for example
3721 would require six bits.
3722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003723 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003724 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003725 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003727 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003728 The length in bytes of the EEPROM memory array address. Note
3729 that this is NOT the chip address length!
3730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003731 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003732 EEPROM chips that implement "address overflow" are ones
3733 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3734 address and the extra bits end up in the "chip address" bit
3735 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3736 byte chips.
3737
3738 Note that we consider the length of the address field to
3739 still be one byte because the extra address bits are hidden
3740 in the chip address.
3741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003742 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003743 The size in bytes of the EEPROM device.
3744
Heiko Schocher548738b2010-01-07 08:55:40 +01003745 - CONFIG_ENV_EEPROM_IS_ON_I2C
3746 define this, if you have I2C and SPI activated, and your
3747 EEPROM, which holds the environment, is on the I2C bus.
3748
3749 - CONFIG_I2C_ENV_EEPROM_BUS
3750 if you have an Environment on an EEPROM reached over
3751 I2C muxes, you can define here, how to reach this
3752 EEPROM. For example:
3753
Heiko Schocherea818db2013-01-29 08:53:15 +01003754 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003755
3756 EEPROM which holds the environment, is reached over
3757 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003758
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003759- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003760
wdenkd4ca31c2004-01-02 14:00:00 +00003761 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003762 want to use for the environment.
3763
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003764 - CONFIG_ENV_OFFSET:
3765 - CONFIG_ENV_ADDR:
3766 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003767
3768 These three #defines specify the offset and size of the
3769 environment area within the total memory of your DataFlash placed
3770 at the specified address.
3771
Liu Gang0a85a9e2012-03-08 00:33:20 +00003772- CONFIG_ENV_IS_IN_REMOTE:
3773
3774 Define this if you have a remote memory space which you
3775 want to use for the local device's environment.
3776
3777 - CONFIG_ENV_ADDR:
3778 - CONFIG_ENV_SIZE:
3779
3780 These two #defines specify the address and size of the
3781 environment area within the remote memory space. The
3782 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003783 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003784
3785BE CAREFUL! For some special cases, the local device can not use
3786"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003787environment stored in a remote NOR flash by SRIO or PCIE link,
3788but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003789
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003790- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003791
3792 Define this if you have a NAND device which you want to use
3793 for the environment.
3794
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003795 - CONFIG_ENV_OFFSET:
3796 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003797
3798 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003799 area within the first NAND device. CONFIG_ENV_OFFSET must be
3800 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003801
Scott Woodfdd813d2010-09-17 14:38:37 -05003802 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003803
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003804 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003805 size used to hold a redundant copy of the environment data, so
3806 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003807 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003808 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003809
Scott Woodfdd813d2010-09-17 14:38:37 -05003810 - CONFIG_ENV_RANGE (optional):
3811
3812 Specifies the length of the region in which the environment
3813 can be written. This should be a multiple of the NAND device's
3814 block size. Specifying a range with more erase blocks than
3815 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3816 the range to be avoided.
3817
3818 - CONFIG_ENV_OFFSET_OOB (optional):
3819
3820 Enables support for dynamically retrieving the offset of the
3821 environment from block zero's out-of-band data. The
3822 "nand env.oob" command can be used to record this offset.
3823 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3824 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003825
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003826- CONFIG_NAND_ENV_DST
3827
3828 Defines address in RAM to which the nand_spl code should copy the
3829 environment. If redundant environment is used, it will be copied to
3830 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3831
Joe Hershberger2b744332013-04-08 10:32:51 +00003832- CONFIG_ENV_IS_IN_UBI:
3833
3834 Define this if you have an UBI volume that you want to use for the
3835 environment. This has the benefit of wear-leveling the environment
3836 accesses, which is important on NAND.
3837
3838 - CONFIG_ENV_UBI_PART:
3839
3840 Define this to a string that is the mtd partition containing the UBI.
3841
3842 - CONFIG_ENV_UBI_VOLUME:
3843
3844 Define this to the name of the volume that you want to store the
3845 environment in.
3846
Joe Hershberger785881f2013-04-08 10:32:52 +00003847 - CONFIG_ENV_UBI_VOLUME_REDUND:
3848
3849 Define this to the name of another volume to store a second copy of
3850 the environment in. This will enable redundant environments in UBI.
3851 It is assumed that both volumes are in the same MTD partition.
3852
Joe Hershberger2b744332013-04-08 10:32:51 +00003853 - CONFIG_UBI_SILENCE_MSG
3854 - CONFIG_UBIFS_SILENCE_MSG
3855
3856 You will probably want to define these to avoid a really noisy system
3857 when storing the env in UBI.
3858
Stephen Warren06e4ae52013-06-11 15:14:00 -06003859- CONFIG_ENV_IS_IN_MMC:
3860
3861 Define this if you have an MMC device which you want to use for the
3862 environment.
3863
3864 - CONFIG_SYS_MMC_ENV_DEV:
3865
3866 Specifies which MMC device the environment is stored in.
3867
3868 - CONFIG_SYS_MMC_ENV_PART (optional):
3869
3870 Specifies which MMC partition the environment is stored in. If not
3871 set, defaults to partition 0, the user area. Common values might be
3872 1 (first MMC boot partition), 2 (second MMC boot partition).
3873
3874 - CONFIG_ENV_OFFSET:
3875 - CONFIG_ENV_SIZE:
3876
3877 These two #defines specify the offset and size of the environment
3878 area within the specified MMC device.
3879
Stephen Warren5c088ee2013-06-11 15:14:02 -06003880 If offset is positive (the usual case), it is treated as relative to
3881 the start of the MMC partition. If offset is negative, it is treated
3882 as relative to the end of the MMC partition. This can be useful if
3883 your board may be fitted with different MMC devices, which have
3884 different sizes for the MMC partitions, and you always want the
3885 environment placed at the very end of the partition, to leave the
3886 maximum possible space before it, to store other data.
3887
Stephen Warren06e4ae52013-06-11 15:14:00 -06003888 These two values are in units of bytes, but must be aligned to an
3889 MMC sector boundary.
3890
3891 - CONFIG_ENV_OFFSET_REDUND (optional):
3892
3893 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3894 hold a redundant copy of the environment data. This provides a
3895 valid backup copy in case the other copy is corrupted, e.g. due
3896 to a power failure during a "saveenv" operation.
3897
Stephen Warren5c088ee2013-06-11 15:14:02 -06003898 This value may also be positive or negative; this is handled in the
3899 same way as CONFIG_ENV_OFFSET.
3900
Stephen Warren06e4ae52013-06-11 15:14:00 -06003901 This value is also in units of bytes, but must also be aligned to
3902 an MMC sector boundary.
3903
3904 - CONFIG_ENV_SIZE_REDUND (optional):
3905
3906 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3907 set. If this value is set, it must be set to the same value as
3908 CONFIG_ENV_SIZE.
3909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003910- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003911
3912 Defines offset to the initial SPI buffer area in DPRAM. The
3913 area is used at an early stage (ROM part) if the environment
3914 is configured to reside in the SPI EEPROM: We need a 520 byte
3915 scratch DPRAM area. It is used between the two initialization
3916 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3917 to be a good choice since it makes it far enough from the
3918 start of the data area as well as from the stack pointer.
3919
Bruce Adlere881cb52007-11-02 13:15:42 -07003920Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003921has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003922created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003923until then to read environment variables.
3924
wdenk85ec0bc2003-03-31 16:34:49 +00003925The environment is protected by a CRC32 checksum. Before the monitor
3926is relocated into RAM, as a result of a bad CRC you will be working
3927with the compiled-in default environment - *silently*!!! [This is
3928necessary, because the first environment variable we need is the
3929"baudrate" setting for the console - if we have a bad CRC, we don't
3930have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003931
3932Note: once the monitor has been relocated, then it will complain if
3933the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003934use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003937 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003939 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003940 also needs to be defined.
3941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003942- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003943 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003944
Ron Madridf5675aa2009-02-18 14:30:44 -08003945- CONFIG_NS16550_MIN_FUNCTIONS:
3946 Define this if you desire to only have use of the NS16550_init
3947 and NS16550_putc functions for the serial driver located at
3948 drivers/serial/ns16550.c. This option is useful for saving
3949 space for already greatly restricted images, including but not
3950 limited to NAND_SPL configurations.
3951
Simon Glassb2b92f52012-11-30 13:01:18 +00003952- CONFIG_DISPLAY_BOARDINFO
3953 Display information about the board that U-Boot is running on
3954 when U-Boot starts up. The board function checkboard() is called
3955 to do this.
3956
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003957- CONFIG_DISPLAY_BOARDINFO_LATE
3958 Similar to the previous option, but display this information
3959 later, once stdio is running and output goes to the LCD, if
3960 present.
3961
wdenkc6097192002-11-03 00:24:07 +00003962Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003963---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003964
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003965- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003966 Cache Line Size of the CPU.
3967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003968- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003969 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003970
wdenk42d1f032003-10-15 23:53:47 +00003971 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3972 and RPXsuper) to be able to adjust the position of
3973 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003974
Timur Tabie46fedf2011-08-04 18:03:41 -05003975- CONFIG_SYS_CCSRBAR_DEFAULT:
3976 Default (power-on reset) physical address of CCSR on Freescale
3977 PowerPC SOCs.
3978
3979- CONFIG_SYS_CCSRBAR:
3980 Virtual address of CCSR. On a 32-bit build, this is typically
3981 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3982
3983 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3984 for cross-platform code that uses that macro instead.
3985
3986- CONFIG_SYS_CCSRBAR_PHYS:
3987 Physical address of CCSR. CCSR can be relocated to a new
3988 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003989 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003990 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3991 is typically relocated on 36-bit builds. It is recommended
3992 that this macro be defined via the _HIGH and _LOW macros:
3993
3994 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3995 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3996
3997- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003998 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3999 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004000 used in assembly code, so it must not contain typecasts or
4001 integer size suffixes (e.g. "ULL").
4002
4003- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4004 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4005 used in assembly code, so it must not contain typecasts or
4006 integer size suffixes (e.g. "ULL").
4007
4008- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4009 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4010 forced to a value that ensures that CCSR is not relocated.
4011
wdenk7f6c2cb2002-11-10 22:06:23 +00004012- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004013 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004014
4015 the default drive number (default value 0)
4016
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004017 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004018
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004019 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004020 (default value 1)
4021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004022 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004023
wdenk43d96162003-03-06 00:02:04 +00004024 defines the offset of register from address. It
4025 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004026 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004028 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4029 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004030 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004032 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004033 fdc_hw_init() is called at the beginning of the FDC
4034 setup. fdc_hw_init() must be provided by the board
4035 source code. It is used to make hardware dependant
4036 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004037
Macpaul Lin0abddf82011-04-11 20:45:32 +00004038- CONFIG_IDE_AHB:
4039 Most IDE controllers were designed to be connected with PCI
4040 interface. Only few of them were designed for AHB interface.
4041 When software is doing ATA command and data transfer to
4042 IDE devices through IDE-AHB controller, some additional
4043 registers accessing to these kind of IDE-AHB controller
4044 is requierd.
4045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004046- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004047 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004048 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004050- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk7152b1d2003-09-05 23:19:14 +00004052 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004053 initial data and stack; please note that this must be
4054 writable memory that is working WITHOUT special
4055 initialization, i. e. you CANNOT use normal RAM which
4056 will become available only after programming the
4057 memory controller and running certain initialization
4058 sequences.
4059
4060 U-Boot uses the following memory types:
4061 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4062 - MPC824X: data cache
4063 - PPC4xx: data cache
4064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004065- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004066
4067 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004068 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4069 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004070 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004071 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004072 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4073 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4074 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004075
4076 Note:
4077 On the MPC824X (or other systems that use the data
4078 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004079 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004080 point to an otherwise UNUSED address space between
4081 the top of RAM and the start of the PCI space.
4082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004083- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004085- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004086
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004087- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004089- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004091- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004093- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004094
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004095- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004096 SDRAM timing
4097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004098- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004099 periodic timer for refresh
4100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004101- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004103- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4104 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4105 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4106 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004107 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4108
4109- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004110 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4111 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004112 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4113
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004114- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4115 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004116 Machine Mode Register and Memory Periodic Timer
4117 Prescaler definitions (SDRAM timing)
4118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004119- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004120 enable I2C microcode relocation patch (MPC8xx);
4121 define relocation offset in DPRAM [DSP2]
4122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004123- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004124 enable SMC microcode relocation patch (MPC8xx);
4125 define relocation offset in DPRAM [SMC1]
4126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004127- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004128 enable SPI microcode relocation patch (MPC8xx);
4129 define relocation offset in DPRAM [SCC4]
4130
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004131- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004132 Use OSCM clock mode on MBX8xx board. Be careful,
4133 wrong setting might damage your board. Read
4134 doc/README.MBX before setting this variable!
4135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004136- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004137 Offset of the bootmode word in DPRAM used by post
4138 (Power On Self Tests). This definition overrides
4139 #define'd default value in commproc.h resp.
4140 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004141
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004142- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4143 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4144 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4145 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4146 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4147 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4148 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4149 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004150 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004151
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004152- CONFIG_PCI_DISABLE_PCIE:
4153 Disable PCI-Express on systems where it is supported but not
4154 required.
4155
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004156- CONFIG_PCI_ENUM_ONLY
4157 Only scan through and get the devices on the busses.
4158 Don't do any setup work, presumably because someone or
4159 something has already done it, and we don't need to do it
4160 a second time. Useful for platforms that are pre-booted
4161 by coreboot or similar.
4162
Gabor Juhos842033e2013-05-30 07:06:12 +00004163- CONFIG_PCI_INDIRECT_BRIDGE:
4164 Enable support for indirect PCI bridges.
4165
Kumar Galaa09b9b62010-12-30 12:09:53 -06004166- CONFIG_SYS_SRIO:
4167 Chip has SRIO or not
4168
4169- CONFIG_SRIO1:
4170 Board has SRIO 1 port available
4171
4172- CONFIG_SRIO2:
4173 Board has SRIO 2 port available
4174
Liu Gangc8b28152013-05-07 16:30:46 +08004175- CONFIG_SRIO_PCIE_BOOT_MASTER
4176 Board can support master function for Boot from SRIO and PCIE
4177
Kumar Galaa09b9b62010-12-30 12:09:53 -06004178- CONFIG_SYS_SRIOn_MEM_VIRT:
4179 Virtual Address of SRIO port 'n' memory region
4180
4181- CONFIG_SYS_SRIOn_MEM_PHYS:
4182 Physical Address of SRIO port 'n' memory region
4183
4184- CONFIG_SYS_SRIOn_MEM_SIZE:
4185 Size of SRIO port 'n' memory region
4186
Fabio Estevam66bd1842013-04-11 09:35:34 +00004187- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4188 Defined to tell the NAND controller that the NAND chip is using
4189 a 16 bit bus.
4190 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004191 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004192 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004193 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004194
4195- CONFIG_SYS_NDFC_EBC0_CFG
4196 Sets the EBC0_CFG register for the NDFC. If not defined
4197 a default value will be used.
4198
Ben Warrenbb99ad62006-09-07 16:50:54 -04004199- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004200 Get DDR timing information from an I2C EEPROM. Common
4201 with pluggable memory modules such as SODIMMs
4202
Ben Warrenbb99ad62006-09-07 16:50:54 -04004203 SPD_EEPROM_ADDRESS
4204 I2C address of the SPD EEPROM
4205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004206- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004207 If SPD EEPROM is on an I2C bus other than the first
4208 one, specify here. Note that the value must resolve
4209 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004210
York Sun1b3e3c42011-06-07 09:42:16 +08004211- CONFIG_SYS_DDR_RAW_TIMING
4212 Get DDR timing information from other than SPD. Common with
4213 soldered DDR chips onboard without SPD. DDR raw timing
4214 parameters are extracted from datasheet and hard-coded into
4215 header files or board specific files.
4216
York Sun6f5e1dc2011-09-16 13:21:35 -07004217- CONFIG_FSL_DDR_INTERACTIVE
4218 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004220- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004221 Only for 83xx systems. If specified, then DDR should
4222 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004223
wdenkc26e4542004-04-18 10:13:26 +00004224- CONFIG_ETHER_ON_FEC[12]
4225 Define to enable FEC[12] on a 8xx series processor.
4226
4227- CONFIG_FEC[12]_PHY
4228 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004229 to the given FEC; i. e.
4230 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004231 means that the PHY with address 4 is connected to FEC1
4232
4233 When set to -1, means to probe for first available.
4234
4235- CONFIG_FEC[12]_PHY_NORXERR
4236 The PHY does not have a RXERR line (RMII only).
4237 (so program the FEC to ignore it).
4238
4239- CONFIG_RMII
4240 Enable RMII mode for all FECs.
4241 Note that this is a global option, we can't
4242 have one FEC in standard MII mode and another in RMII mode.
4243
wdenk5cf91d62004-04-23 20:32:05 +00004244- CONFIG_CRC32_VERIFY
4245 Add a verify option to the crc32 command.
4246 The syntax is:
4247
4248 => crc32 -v <address> <count> <crc32>
4249
4250 Where address/count indicate a memory area
4251 and crc32 is the correct crc32 which the
4252 area should have.
4253
wdenk56523f12004-07-11 17:40:54 +00004254- CONFIG_LOOPW
4255 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004256 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004257
stroese7b466642004-12-16 18:46:55 +00004258- CONFIG_MX_CYCLIC
4259 Add the "mdc" and "mwc" memory commands. These are cyclic
4260 "md/mw" commands.
4261 Examples:
4262
wdenkefe2a4d2004-12-16 21:44:03 +00004263 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004264 This command will print 4 bytes (10,11,12,13) each 500 ms.
4265
wdenkefe2a4d2004-12-16 21:44:03 +00004266 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004267 This command will write 12345678 to address 100 all 10 ms.
4268
wdenkefe2a4d2004-12-16 21:44:03 +00004269 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004270 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004271
wdenk8aa1a2d2005-04-04 12:44:11 +00004272- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004273 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004274 low level initializations (like setting up the memory
4275 controller) are omitted and/or U-Boot does not
4276 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004277
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004278 Normally this variable MUST NOT be defined. The only
4279 exception is when U-Boot is loaded (to RAM) by some
4280 other boot loader or by a debugger which performs
4281 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004282
Aneesh V401bb302011-07-13 05:11:07 +00004283- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004284 Modifies the behaviour of start.S when compiling a loader
4285 that is executed before the actual U-Boot. E.g. when
4286 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004287
Ying Zhang3aa29de2013-08-16 15:16:15 +08004288- CONFIG_TPL_BUILD
4289 Modifies the behaviour of start.S when compiling a loader
4290 that is executed after the SPL and before the actual U-Boot.
4291 It is loaded by the SPL.
4292
Ying Zhang5df572f2013-05-20 14:07:23 +08004293- CONFIG_SYS_MPC85XX_NO_RESETVEC
4294 Only for 85xx systems. If this variable is specified, the section
4295 .resetvec is not kept and the section .bootpg is placed in the
4296 previous 4k of the .text section.
4297
Simon Glass4213fc22013-02-24 17:33:14 +00004298- CONFIG_ARCH_MAP_SYSMEM
4299 Generally U-Boot (and in particular the md command) uses
4300 effective address. It is therefore not necessary to regard
4301 U-Boot address as virtual addresses that need to be translated
4302 to physical addresses. However, sandbox requires this, since
4303 it maintains its own little RAM buffer which contains all
4304 addressable memory. This option causes some memory accesses
4305 to be mapped through map_sysmem() / unmap_sysmem().
4306
Matthias Weisserd8834a12011-03-10 21:36:32 +00004307- CONFIG_USE_ARCH_MEMCPY
4308 CONFIG_USE_ARCH_MEMSET
4309 If these options are used a optimized version of memcpy/memset will
4310 be used if available. These functions may be faster under some
4311 conditions but may increase the binary size.
4312
Simon Glass588a13f2013-02-14 04:18:54 +00004313- CONFIG_X86_RESET_VECTOR
4314 If defined, the x86 reset vector code is included. This is not
4315 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004316
Mark Jacksonfc337052013-03-04 01:27:20 +00004317- CONFIG_SYS_MPUCLK
4318 Defines the MPU clock speed (in MHz).
4319
4320 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004321
Heiko Schocher16678eb2013-11-04 14:05:00 +01004322- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4323 Enables the RTC32K OSC on AM33xx based plattforms
4324
Timur Tabif2717b42011-11-22 09:21:25 -06004325Freescale QE/FMAN Firmware Support:
4326-----------------------------------
4327
4328The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4329loading of "firmware", which is encoded in the QE firmware binary format.
4330This firmware often needs to be loaded during U-Boot booting, so macros
4331are used to identify the storage device (NOR flash, SPI, etc) and the address
4332within that device.
4333
4334- CONFIG_SYS_QE_FMAN_FW_ADDR
4335 The address in the storage device where the firmware is located. The
4336 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4337 is also specified.
4338
4339- CONFIG_SYS_QE_FMAN_FW_LENGTH
4340 The maximum possible size of the firmware. The firmware binary format
4341 has a field that specifies the actual size of the firmware, but it
4342 might not be possible to read any part of the firmware unless some
4343 local storage is allocated to hold the entire firmware first.
4344
4345- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4346 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4347 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4348 virtual address in NOR flash.
4349
4350- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4351 Specifies that QE/FMAN firmware is located in NAND flash.
4352 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4353
4354- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4355 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4356 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4357
4358- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4359 Specifies that QE/FMAN firmware is located on the primary SPI
4360 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4361
Liu Gang292dc6c2012-03-08 00:33:18 +00004362- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4363 Specifies that QE/FMAN firmware is located in the remote (master)
4364 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004365 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4366 window->master inbound window->master LAW->the ucode address in
4367 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004368
wdenkc6097192002-11-03 00:24:07 +00004369Building the Software:
4370======================
4371
Wolfgang Denk218ca722008-03-26 10:40:12 +01004372Building U-Boot has been tested in several native build environments
4373and in many different cross environments. Of course we cannot support
4374all possibly existing versions of cross development tools in all
4375(potentially obsolete) versions. In case of tool chain problems we
4376recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4377which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004378
Wolfgang Denk218ca722008-03-26 10:40:12 +01004379If you are not using a native environment, it is assumed that you
4380have GNU cross compiling tools available in your path. In this case,
4381you must set the environment variable CROSS_COMPILE in your shell.
4382Note that no changes to the Makefile or any other source files are
4383necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004384
Wolfgang Denk218ca722008-03-26 10:40:12 +01004385 $ CROSS_COMPILE=ppc_4xx-
4386 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004387
Peter Tyser2f8d3962009-03-13 18:54:51 -05004388Note: If you wish to generate Windows versions of the utilities in
4389 the tools directory you can use the MinGW toolchain
4390 (http://www.mingw.org). Set your HOST tools to the MinGW
4391 toolchain and execute 'make tools'. For example:
4392
4393 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4394
4395 Binaries such as tools/mkimage.exe will be created which can
4396 be executed on computers running Windows.
4397
Wolfgang Denk218ca722008-03-26 10:40:12 +01004398U-Boot is intended to be simple to build. After installing the
4399sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004400is done by typing:
4401
4402 make NAME_config
4403
Wolfgang Denk218ca722008-03-26 10:40:12 +01004404where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004405rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407Note: for some board special configuration names may exist; check if
4408 additional information is available from the board vendor; for
4409 instance, the TQM823L systems are available without (standard)
4410 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004411 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk2729af92004-05-03 20:45:30 +00004413 make TQM823L_config
4414 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004415
wdenk2729af92004-05-03 20:45:30 +00004416 make TQM823L_LCD_config
4417 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419 etc.
wdenkc6097192002-11-03 00:24:07 +00004420
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422Finally, type "make all", and you should get some working U-Boot
4423images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk2729af92004-05-03 20:45:30 +00004425- "u-boot.bin" is a raw binary image
4426- "u-boot" is an image in ELF binary format
4427- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004428
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004429By default the build is performed locally and the objects are saved
4430in the source directory. One of the two methods can be used to change
4431this behavior and build U-Boot to some external directory:
4432
44331. Add O= to the make command line invocations:
4434
4435 make O=/tmp/build distclean
4436 make O=/tmp/build NAME_config
4437 make O=/tmp/build all
4438
44392. Set environment variable BUILD_DIR to point to the desired location:
4440
4441 export BUILD_DIR=/tmp/build
4442 make distclean
4443 make NAME_config
4444 make all
4445
4446Note that the command line "O=" setting overrides the BUILD_DIR environment
4447variable.
4448
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk2729af92004-05-03 20:45:30 +00004450Please be aware that the Makefiles assume you are using GNU make, so
4451for instance on NetBSD you might need to use "gmake" instead of
4452native "make".
wdenkc6097192002-11-03 00:24:07 +00004453
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455If the system board that you have is not listed, then you will need
4456to port U-Boot to your hardware platform. To do this, follow these
4457steps:
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk2729af92004-05-03 20:45:30 +000044591. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004460 "boards.cfg" file, using the existing entries as examples.
4461 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000044622. Create a new directory to hold your board specific code. Add any
4463 files you need. In your board directory, you will need at least
4464 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
44653. Create a new configuration file "include/configs/<board>.h" for
4466 your board
44673. If you're porting U-Boot to a new CPU, then also create a new
4468 directory to hold your CPU specific code. Add any files you need.
44694. Run "make <board>_config" with your new name.
44705. Type "make", and you should get a working "u-boot.srec" file
4471 to be installed on your target system.
44726. Debug and solve any problems that might arise.
4473 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004474
wdenkc6097192002-11-03 00:24:07 +00004475
wdenk2729af92004-05-03 20:45:30 +00004476Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4477==============================================================
wdenkc6097192002-11-03 00:24:07 +00004478
Wolfgang Denk218ca722008-03-26 10:40:12 +01004479If you have modified U-Boot sources (for instance added a new board
4480or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004481provide feedback to the other developers. The feedback normally takes
4482the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004483official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004484
Wolfgang Denk218ca722008-03-26 10:40:12 +01004485But before you submit such a patch, please verify that your modifi-
4486cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004487the supported boards compile WITHOUT ANY compiler warnings. To do so,
4488just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004489for ALL supported system. Be warned, this will take a while. You can
4490select which (cross) compiler to use by passing a `CROSS_COMPILE'
4491environment variable to the script, i. e. to use the ELDK cross tools
4492you can type
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004497
wdenk2729af92004-05-03 20:45:30 +00004498 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004499
Wolfgang Denk218ca722008-03-26 10:40:12 +01004500When using the MAKEALL script, the default behaviour is to build
4501U-Boot in the source directory. This location can be changed by
4502setting the BUILD_DIR environment variable. Also, for each target
4503built, the MAKEALL script saves two log files (<target>.ERR and
4504<target>.MAKEALL) in the <source dir>/LOG directory. This default
4505location can be changed by setting the MAKEALL_LOGDIR environment
4506variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004507
4508 export BUILD_DIR=/tmp/build
4509 export MAKEALL_LOGDIR=/tmp/log
4510 CROSS_COMPILE=ppc_8xx- MAKEALL
4511
Wolfgang Denk218ca722008-03-26 10:40:12 +01004512With the above settings build objects are saved in the /tmp/build,
4513log files are saved in the /tmp/log and the source tree remains clean
4514during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004515
4516
wdenk2729af92004-05-03 20:45:30 +00004517See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004518
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk2729af92004-05-03 20:45:30 +00004520Monitor Commands - Overview:
4521============================
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk2729af92004-05-03 20:45:30 +00004523go - start application at address 'addr'
4524run - run commands in an environment variable
4525bootm - boot application image from memory
4526bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004527bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004528tftpboot- boot image via network using TFTP protocol
4529 and env variables "ipaddr" and "serverip"
4530 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004531tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004532rarpboot- boot image via network using RARP/TFTP protocol
4533diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4534loads - load S-Record file over serial line
4535loadb - load binary file over serial line (kermit mode)
4536md - memory display
4537mm - memory modify (auto-incrementing)
4538nm - memory modify (constant address)
4539mw - memory write (fill)
4540cp - memory copy
4541cmp - memory compare
4542crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004543i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004544sspi - SPI utility commands
4545base - print or set address offset
4546printenv- print environment variables
4547setenv - set environment variables
4548saveenv - save environment variables to persistent storage
4549protect - enable or disable FLASH write protection
4550erase - erase FLASH memory
4551flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004552nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004553bdinfo - print Board Info structure
4554iminfo - print header information for application image
4555coninfo - print console devices and informations
4556ide - IDE sub-system
4557loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004558loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004559mtest - simple RAM test
4560icache - enable or disable instruction cache
4561dcache - enable or disable data cache
4562reset - Perform RESET of the CPU
4563echo - echo args to console
4564version - print monitor version
4565help - print online help
4566? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004567
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569Monitor Commands - Detailed Description:
4570========================================
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk2729af92004-05-03 20:45:30 +00004572TODO.
wdenkc6097192002-11-03 00:24:07 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004575
4576
wdenk2729af92004-05-03 20:45:30 +00004577Environment Variables:
4578======================
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580U-Boot supports user configuration using Environment Variables which
4581can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583Environment Variables are set using "setenv", printed using
4584"printenv", and saved to Flash using "saveenv". Using "setenv"
4585without a value can be used to delete a variable from the
4586environment. As long as you don't save the environment you are
4587working with an in-memory copy. In case the Flash area containing the
4588environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004589
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004590Some configuration options can be set using Environment Variables.
4591
4592List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk2729af92004-05-03 20:45:30 +00004594 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004601
wdenk2729af92004-05-03 20:45:30 +00004602 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004603
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004604 bootm_low - Memory range available for image processing in the bootm
4605 command can be restricted. This variable is given as
4606 a hexadecimal number and defines lowest address allowed
4607 for use by the bootm command. See also "bootm_size"
4608 environment variable. Address defined by "bootm_low" is
4609 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004610 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4611 bootm_mapsize.
4612
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004613 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004614 This variable is given as a hexadecimal number and it
4615 defines the size of the memory region starting at base
4616 address bootm_low that is accessible by the Linux kernel
4617 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4618 as the default value if it is defined, and bootm_size is
4619 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004620
4621 bootm_size - Memory range available for image processing in the bootm
4622 command can be restricted. This variable is given as
4623 a hexadecimal number and defines the size of the region
4624 allowed for use by the bootm command. See also "bootm_low"
4625 environment variable.
4626
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004627 updatefile - Location of the software update file on a TFTP server, used
4628 by the automatic software update feature. Please refer to
4629 documentation in doc/README.update for more details.
4630
wdenk2729af92004-05-03 20:45:30 +00004631 autoload - if set to "no" (any string beginning with 'n'),
4632 "bootp" will just load perform a lookup of the
4633 configuration from the BOOTP server, but not try to
4634 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636 autostart - if set to "yes", an image loaded using the "bootp",
4637 "rarpboot", "tftpboot" or "diskboot" commands will
4638 be automatically started (by internally calling
4639 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk2729af92004-05-03 20:45:30 +00004641 If set to "no", a standalone image passed to the
4642 "bootm" command will be copied to the load address
4643 (and eventually uncompressed), but NOT be started.
4644 This can be used to load and uncompress arbitrary
4645 data.
wdenkc6097192002-11-03 00:24:07 +00004646
David A. Longa28afca2011-07-09 16:40:19 -04004647 fdt_high - if set this restricts the maximum address that the
4648 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004649 For example, if you have a system with 1 GB memory
4650 at physical address 0x10000000, while Linux kernel
4651 only recognizes the first 704 MB as low memory, you
4652 may need to set fdt_high as 0x3C000000 to have the
4653 device tree blob be copied to the maximum address
4654 of the 704 MB low memory, so that Linux kernel can
4655 access it during the boot procedure.
4656
David A. Longa28afca2011-07-09 16:40:19 -04004657 If this is set to the special value 0xFFFFFFFF then
4658 the fdt will not be copied at all on boot. For this
4659 to work it must reside in writable memory, have
4660 sufficient padding on the end of it for u-boot to
4661 add the information it needs into it, and the memory
4662 must be accessible by the kernel.
4663
Simon Glasseea63e02011-10-24 19:15:34 +00004664 fdtcontroladdr- if set this is the address of the control flattened
4665 device tree used by U-Boot when CONFIG_OF_CONTROL is
4666 defined.
4667
wdenk17ea1172004-06-06 21:51:03 +00004668 i2cfast - (PPC405GP|PPC405EP only)
4669 if set to 'y' configures Linux I2C driver for fast
4670 mode (400kHZ). This environment variable is used in
4671 initialization code. So, for changes to be effective
4672 it must be saved and board must be reset.
4673
wdenk2729af92004-05-03 20:45:30 +00004674 initrd_high - restrict positioning of initrd images:
4675 If this variable is not set, initrd images will be
4676 copied to the highest possible address in RAM; this
4677 is usually what you want since it allows for
4678 maximum initrd size. If for some reason you want to
4679 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004680 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004681 variable to a value of "no" or "off" or "0".
4682 Alternatively, you can set it to a maximum upper
4683 address to use (U-Boot will still check that it
4684 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686 For instance, when you have a system with 16 MB
4687 RAM, and want to reserve 4 MB from use by Linux,
4688 you can do this by adding "mem=12M" to the value of
4689 the "bootargs" variable. However, now you must make
4690 sure that the initrd image is placed in the first
4691 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk2729af92004-05-03 20:45:30 +00004693 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk2729af92004-05-03 20:45:30 +00004695 If you set initrd_high to 0xFFFFFFFF, this is an
4696 indication to U-Boot that all addresses are legal
4697 for the Linux kernel, including addresses in flash
4698 memory. In this case U-Boot will NOT COPY the
4699 ramdisk at all. This may be useful to reduce the
4700 boot time on your system, but requires that this
4701 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004704
wdenk2729af92004-05-03 20:45:30 +00004705 loadaddr - Default load address for commands like "bootp",
4706 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk2729af92004-05-03 20:45:30 +00004708 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk2729af92004-05-03 20:45:30 +00004710 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004711
wdenk2729af92004-05-03 20:45:30 +00004712 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004717
Mike Frysingere2a53452011-10-02 10:01:27 +00004718 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004719
Mike Frysingere2a53452011-10-02 10:01:27 +00004720 ethact - controls which interface is currently active.
4721 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004722
Heiko Schocher48690d82010-07-20 17:45:02 +02004723 => setenv ethact FEC
4724 => ping 192.168.0.1 # traffic sent on FEC
4725 => setenv ethact SCC
4726 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004727
Matthias Fuchse1692572008-01-17 07:45:05 +01004728 ethrotate - When set to "no" U-Boot does not go through all
4729 available network interfaces.
4730 It just stays at the currently selected interface.
4731
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004732 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004733 either succeed or fail without retrying.
4734 When set to "once" the network operation will
4735 fail when all the available network interfaces
4736 are tried once without success.
4737 Useful on scripts which control the retry operation
4738 themselves.
wdenkc6097192002-11-03 00:24:07 +00004739
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004740 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004741
Simon Glass8d51aac2013-07-16 20:10:00 -07004742 silent_linux - If set then linux will be told to boot silently, by
4743 changing the console to be empty. If "yes" it will be
4744 made silent. If "no" it will not be made silent. If
4745 unset, then it will be made silent if the U-Boot console
4746 is silent.
4747
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004748 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004749 UDP source port.
4750
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004751 tftpdstport - If this is set, the value is used for TFTP's UDP
4752 destination port instead of the Well Know Port 69.
4753
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004754 tftpblocksize - Block size to use for TFTP transfers; if not set,
4755 we use the TFTP server's default block size
4756
4757 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4758 seconds, minimum value is 1000 = 1 second). Defines
4759 when a packet is considered to be lost so it has to
4760 be retransmitted. The default is 5000 = 5 seconds.
4761 Lowering this value may make downloads succeed
4762 faster in networks with high packet loss rates or
4763 with unreliable TFTP servers.
4764
4765 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004766 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004767 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004768
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004769The following image location variables contain the location of images
4770used in booting. The "Image" column gives the role of the image and is
4771not an environment variable name. The other columns are environment
4772variable names. "File Name" gives the name of the file on a TFTP
4773server, "RAM Address" gives the location in RAM the image will be
4774loaded to, and "Flash Location" gives the image's address in NOR
4775flash or offset in NAND flash.
4776
4777*Note* - these variables don't have to be defined for all boards, some
4778boards currenlty use other variables for these purposes, and some
4779boards use these variables for other purposes.
4780
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004781Image File Name RAM Address Flash Location
4782----- --------- ----------- --------------
4783u-boot u-boot u-boot_addr_r u-boot_addr
4784Linux kernel bootfile kernel_addr_r kernel_addr
4785device tree blob fdtfile fdt_addr_r fdt_addr
4786ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004787
wdenk2729af92004-05-03 20:45:30 +00004788The following environment variables may be used and automatically
4789updated by the network boot commands ("bootp" and "rarpboot"),
4790depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792 bootfile - see above
4793 dnsip - IP address of your Domain Name Server
4794 dnsip2 - IP address of your secondary Domain Name Server
4795 gatewayip - IP address of the Gateway (Router) to use
4796 hostname - Target hostname
4797 ipaddr - see above
4798 netmask - Subnet Mask
4799 rootpath - Pathname of the root filesystem on the NFS server
4800 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004801
wdenka3d991b2004-04-15 21:48:45 +00004802
wdenk2729af92004-05-03 20:45:30 +00004803There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004804
wdenk2729af92004-05-03 20:45:30 +00004805 serial# - contains hardware identification information such
4806 as type string and/or serial number
4807 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk2729af92004-05-03 20:45:30 +00004809These variables can be set only once (usually during manufacturing of
4810the board). U-Boot refuses to delete or overwrite these variables
4811once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004812
4813
wdenk2729af92004-05-03 20:45:30 +00004814Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004815
wdenk2729af92004-05-03 20:45:30 +00004816 ver - Contains the U-Boot version string as printed
4817 with the "version" command. This variable is
4818 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004819
wdenkc6097192002-11-03 00:24:07 +00004820
wdenk2729af92004-05-03 20:45:30 +00004821Please note that changes to some configuration parameters may take
4822only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004823
stroesec1551ea2003-04-04 15:53:41 +00004824
Joe Hershberger170ab112012-12-11 22:16:24 -06004825Callback functions for environment variables:
4826---------------------------------------------
4827
4828For some environment variables, the behavior of u-boot needs to change
4829when their values are changed. This functionailty allows functions to
4830be associated with arbitrary variables. On creation, overwrite, or
4831deletion, the callback will provide the opportunity for some side
4832effect to happen or for the change to be rejected.
4833
4834The callbacks are named and associated with a function using the
4835U_BOOT_ENV_CALLBACK macro in your board or driver code.
4836
4837These callbacks are associated with variables in one of two ways. The
4838static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4839in the board configuration to a string that defines a list of
4840associations. The list must be in the following format:
4841
4842 entry = variable_name[:callback_name]
4843 list = entry[,list]
4844
4845If the callback name is not specified, then the callback is deleted.
4846Spaces are also allowed anywhere in the list.
4847
4848Callbacks can also be associated by defining the ".callbacks" variable
4849with the same list format above. Any association in ".callbacks" will
4850override any association in the static list. You can define
4851CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4852".callbacks" envirnoment variable in the default or embedded environment.
4853
4854
wdenk2729af92004-05-03 20:45:30 +00004855Command Line Parsing:
4856=====================
stroesec1551ea2003-04-04 15:53:41 +00004857
wdenk2729af92004-05-03 20:45:30 +00004858There are two different command line parsers available with U-Boot:
4859the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004860
wdenk2729af92004-05-03 20:45:30 +00004861Old, simple command line parser:
4862--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004863
wdenk2729af92004-05-03 20:45:30 +00004864- supports environment variables (through setenv / saveenv commands)
4865- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004866- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004867- special characters ('$', ';') can be escaped by prefixing with '\',
4868 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004869 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004870- You can also escape text by enclosing in single apostrophes, for example:
4871 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk2729af92004-05-03 20:45:30 +00004873Hush shell:
4874-----------
wdenkf07771c2003-05-28 08:06:31 +00004875
wdenk2729af92004-05-03 20:45:30 +00004876- similar to Bourne shell, with control structures like
4877 if...then...else...fi, for...do...done; while...do...done,
4878 until...do...done, ...
4879- supports environment ("global") variables (through setenv / saveenv
4880 commands) and local shell variables (through standard shell syntax
4881 "name=value"); only environment variables can be used with "run"
4882 command
wdenkf07771c2003-05-28 08:06:31 +00004883
wdenk2729af92004-05-03 20:45:30 +00004884General rules:
4885--------------
wdenkf07771c2003-05-28 08:06:31 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887(1) If a command line (or an environment variable executed by a "run"
4888 command) contains several commands separated by semicolon, and
4889 one of these commands fails, then the remaining commands will be
4890 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004891
wdenk2729af92004-05-03 20:45:30 +00004892(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004893 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004894 command will cause "run" to terminate, i. e. the remaining
4895 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004896
wdenk2729af92004-05-03 20:45:30 +00004897Note for Redundant Ethernet Interfaces:
4898=======================================
wdenkf07771c2003-05-28 08:06:31 +00004899
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004900Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004901such configurations and is capable of automatic selection of a
4902"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004903
wdenk2729af92004-05-03 20:45:30 +00004904Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4905MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4906"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004907
wdenk2729af92004-05-03 20:45:30 +00004908If the network interface stores some valid MAC address (for instance
4909in SROM), this is used as default address if there is NO correspon-
4910ding setting in the environment; if the corresponding environment
4911variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913o If the SROM has a valid MAC address, and there is no address in the
4914 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk2729af92004-05-03 20:45:30 +00004916o If there is no valid address in the SROM, and a definition in the
4917 environment exists, then the value from the environment variable is
4918 used.
wdenkc6097192002-11-03 00:24:07 +00004919
wdenk2729af92004-05-03 20:45:30 +00004920o If both the SROM and the environment contain a MAC address, and
4921 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004922
wdenk2729af92004-05-03 20:45:30 +00004923o If both the SROM and the environment contain a MAC address, and the
4924 addresses differ, the value from the environment is used and a
4925 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk2729af92004-05-03 20:45:30 +00004927o If neither SROM nor the environment contain a MAC address, an error
4928 is raised.
wdenkc6097192002-11-03 00:24:07 +00004929
Ben Warrenecee9322010-04-26 11:11:46 -07004930If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004931will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004932may be skipped by setting the appropriate 'ethmacskip' environment variable.
4933The naming convention is as follows:
4934"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936Image Formats:
4937==============
wdenkc6097192002-11-03 00:24:07 +00004938
Marian Balakowicz3310c542008-03-12 12:13:13 +01004939U-Boot is capable of booting (and performing other auxiliary operations on)
4940images in two formats:
4941
4942New uImage format (FIT)
4943-----------------------
4944
4945Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4946to Flattened Device Tree). It allows the use of images with multiple
4947components (several kernels, ramdisks, etc.), with contents protected by
4948SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4949
4950
4951Old uImage format
4952-----------------
4953
4954Old image format is based on binary files which can be basically anything,
4955preceded by a special header; see the definitions in include/image.h for
4956details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk2729af92004-05-03 20:45:30 +00004958* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4959 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004960 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4961 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4962 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004963* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004964 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4965 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004966* Compression Type (uncompressed, gzip, bzip2)
4967* Load Address
4968* Entry Point
4969* Image Name
4970* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004971
wdenk2729af92004-05-03 20:45:30 +00004972The header is marked by a special Magic Number, and both the header
4973and the data portions of the image are secured against corruption by
4974CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004975
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk2729af92004-05-03 20:45:30 +00004977Linux Support:
4978==============
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk2729af92004-05-03 20:45:30 +00004980Although U-Boot should support any OS or standalone application
4981easily, the main focus has always been on Linux during the design of
4982U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984U-Boot includes many features that so far have been part of some
4985special "boot loader" code within the Linux kernel. Also, any
4986"initrd" images to be used are no longer part of one big Linux image;
4987instead, kernel and "initrd" are separate images. This implementation
4988serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990- the same features can be used for other OS or standalone
4991 applications (for instance: using compressed images to reduce the
4992 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk2729af92004-05-03 20:45:30 +00004994- it becomes much easier to port new Linux kernel versions because
4995 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997- the same Linux kernel image can now be used with different "initrd"
4998 images; of course this also means that different kernel images can
4999 be run with the same "initrd". This makes testing easier (you don't
5000 have to build a new "zImage.initrd" Linux image when you just
5001 change a file in your "initrd"). Also, a field-upgrade of the
5002 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005003
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005Linux HOWTO:
5006============
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008Porting Linux to U-Boot based systems:
5009---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011U-Boot cannot save you from doing all the necessary modifications to
5012configure the Linux device drivers for use with your target hardware
5013(no, we don't intend to provide a full virtual machine interface to
5014Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005015
Stefan Roesea47a12b2010-04-15 16:07:28 +02005016But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk2729af92004-05-03 20:45:30 +00005018Just make sure your machine specific header file (for instance
5019include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005020Information structure as we define in include/asm-<arch>/u-boot.h,
5021and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005022as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005023
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025Configuring the Linux kernel:
5026-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028No specific requirements for U-Boot. Make sure you have some root
5029device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005030
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk2729af92004-05-03 20:45:30 +00005032Building a Linux Image:
5033-----------------------
wdenkc6097192002-11-03 00:24:07 +00005034
wdenk2729af92004-05-03 20:45:30 +00005035With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5036not used. If you use recent kernel source, a new build target
5037"uImage" will exist which automatically builds an image usable by
5038U-Boot. Most older kernels also have support for a "pImage" target,
5039which was introduced for our predecessor project PPCBoot and uses a
5040100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005041
wdenk2729af92004-05-03 20:45:30 +00005042Example:
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044 make TQM850L_config
5045 make oldconfig
5046 make dep
5047 make uImage
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk2729af92004-05-03 20:45:30 +00005049The "uImage" build target uses a special tool (in 'tools/mkimage') to
5050encapsulate a compressed Linux kernel image with header information,
5051CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk2729af92004-05-03 20:45:30 +00005057 ${CROSS_COMPILE}-objcopy -O binary \
5058 -R .note -R .comment \
5059 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk2729af92004-05-03 20:45:30 +00005065* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005066
wdenk2729af92004-05-03 20:45:30 +00005067 mkimage -A ppc -O linux -T kernel -C gzip \
5068 -a 0 -e 0 -n "Linux Kernel Image" \
5069 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005070
wdenk24ee89b2002-11-03 17:56:27 +00005071
wdenk2729af92004-05-03 20:45:30 +00005072The "mkimage" tool can also be used to create ramdisk images for use
5073with U-Boot, either separated from the Linux kernel image, or
5074combined into one file. "mkimage" encapsulates the images with a 64
5075byte header containing information about target architecture,
5076operating system, image type, compression method, entry points, time
5077stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005078
wdenk2729af92004-05-03 20:45:30 +00005079"mkimage" can be called in two ways: to verify existing images and
5080print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082In the first form (with "-l" option) mkimage lists the information
5083contained in the header of an existing U-Boot image; this includes
5084checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005085
wdenk2729af92004-05-03 20:45:30 +00005086 tools/mkimage -l image
5087 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089The second form (with "-d" option) is used to build a U-Boot image
5090from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5093 -n name -d data_file image
5094 -A ==> set architecture to 'arch'
5095 -O ==> set operating system to 'os'
5096 -T ==> set image type to 'type'
5097 -C ==> set compression type 'comp'
5098 -a ==> set load address to 'addr' (hex)
5099 -e ==> set entry point to 'ep' (hex)
5100 -n ==> set image name to 'name'
5101 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005102
wdenk69459792004-05-29 16:53:29 +00005103Right now, all Linux kernels for PowerPC systems use the same load
5104address (0x00000000), but the entry point address depends on the
5105kernel version:
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk2729af92004-05-03 20:45:30 +00005107- 2.2.x kernels have the entry point at 0x0000000C,
5108- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5113 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005114 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005115 > examples/uImage.TQM850L
5116 Image Name: 2.4.4 kernel for TQM850L
5117 Created: Wed Jul 19 02:34:59 2000
5118 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5119 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5120 Load Address: 0x00000000
5121 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125 -> tools/mkimage -l examples/uImage.TQM850L
5126 Image Name: 2.4.4 kernel for TQM850L
5127 Created: Wed Jul 19 02:34:59 2000
5128 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5129 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5130 Load Address: 0x00000000
5131 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk2729af92004-05-03 20:45:30 +00005133NOTE: for embedded systems where boot time is critical you can trade
5134speed for memory and install an UNCOMPRESSED image instead: this
5135needs more space in Flash, but boots much faster since it does not
5136need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005137
Stefan Roesea47a12b2010-04-15 16:07:28 +02005138 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005139 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5140 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005141 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005142 > examples/uImage.TQM850L-uncompressed
5143 Image Name: 2.4.4 kernel for TQM850L
5144 Created: Wed Jul 19 02:34:59 2000
5145 Image Type: PowerPC Linux Kernel Image (uncompressed)
5146 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5147 Load Address: 0x00000000
5148 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005149
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5152when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005153
wdenk2729af92004-05-03 20:45:30 +00005154 -> tools/mkimage -n 'Simple Ramdisk Image' \
5155 > -A ppc -O linux -T ramdisk -C gzip \
5156 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5157 Image Name: Simple Ramdisk Image
5158 Created: Wed Jan 12 14:01:50 2000
5159 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5160 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5161 Load Address: 0x00000000
5162 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005163
wdenkdb01a2e2004-04-15 23:14:49 +00005164
wdenk2729af92004-05-03 20:45:30 +00005165Installing a Linux Image:
5166-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005167
wdenk2729af92004-05-03 20:45:30 +00005168To downloading a U-Boot image over the serial (console) interface,
5169you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173The 'objcopy' does not understand the information in the U-Boot
5174image header, so the resulting S-Record file will be relative to
5175address 0x00000000. To load it to a given address, you need to
5176specify the target address as 'offset' parameter with the 'loads'
5177command.
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk2729af92004-05-03 20:45:30 +00005179Example: install the image to address 0x40100000 (which on the
5180TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk2729af92004-05-03 20:45:30 +00005184 .......... done
5185 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187 => loads 40100000
5188 ## Ready for S-Record download ...
5189 ~>examples/image.srec
5190 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5191 ...
5192 15989 15990 15991 15992
5193 [file transfer complete]
5194 [connected]
5195 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005196
5197
wdenk2729af92004-05-03 20:45:30 +00005198You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005199this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005200corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005201
wdenk2729af92004-05-03 20:45:30 +00005202 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204 ## Checking Image at 40100000 ...
5205 Image Name: 2.2.13 for initrd on TQM850L
5206 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5207 Data Size: 335725 Bytes = 327 kB = 0 MB
5208 Load Address: 00000000
5209 Entry Point: 0000000c
5210 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005211
5212
wdenk2729af92004-05-03 20:45:30 +00005213Boot Linux:
5214-----------
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk2729af92004-05-03 20:45:30 +00005216The "bootm" command is used to boot an application that is stored in
5217memory (RAM or Flash). In case of a Linux kernel image, the contents
5218of the "bootargs" environment variable is passed to the kernel as
5219parameters. You can check and modify this variable using the
5220"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005221
5222
wdenk2729af92004-05-03 20:45:30 +00005223 => printenv bootargs
5224 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226 => 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 +00005227
wdenk2729af92004-05-03 20:45:30 +00005228 => printenv bootargs
5229 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 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231 => bootm 40020000
5232 ## Booting Linux kernel at 40020000 ...
5233 Image Name: 2.2.13 for NFS on TQM850L
5234 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5235 Data Size: 381681 Bytes = 372 kB = 0 MB
5236 Load Address: 00000000
5237 Entry Point: 0000000c
5238 Verifying Checksum ... OK
5239 Uncompressing Kernel Image ... OK
5240 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
5241 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5242 time_init: decrementer frequency = 187500000/60
5243 Calibrating delay loop... 49.77 BogoMIPS
5244 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5245 ...
wdenkc6097192002-11-03 00:24:07 +00005246
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005247If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005248the memory addresses of both the kernel and the initrd image (PPBCOOT
5249format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk2729af92004-05-03 20:45:30 +00005251 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk2729af92004-05-03 20:45:30 +00005253 ## Checking Image at 40100000 ...
5254 Image Name: 2.2.13 for initrd on TQM850L
5255 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5256 Data Size: 335725 Bytes = 327 kB = 0 MB
5257 Load Address: 00000000
5258 Entry Point: 0000000c
5259 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261 ## Checking Image at 40200000 ...
5262 Image Name: Simple Ramdisk Image
5263 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5264 Data Size: 566530 Bytes = 553 kB = 0 MB
5265 Load Address: 00000000
5266 Entry Point: 00000000
5267 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269 => bootm 40100000 40200000
5270 ## Booting Linux kernel at 40100000 ...
5271 Image Name: 2.2.13 for initrd on TQM850L
5272 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5273 Data Size: 335725 Bytes = 327 kB = 0 MB
5274 Load Address: 00000000
5275 Entry Point: 0000000c
5276 Verifying Checksum ... OK
5277 Uncompressing Kernel Image ... OK
5278 ## Loading RAMDisk Image at 40200000 ...
5279 Image Name: Simple Ramdisk Image
5280 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5281 Data Size: 566530 Bytes = 553 kB = 0 MB
5282 Load Address: 00000000
5283 Entry Point: 00000000
5284 Verifying Checksum ... OK
5285 Loading Ramdisk ... OK
5286 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
5287 Boot arguments: root=/dev/ram
5288 time_init: decrementer frequency = 187500000/60
5289 Calibrating delay loop... 49.77 BogoMIPS
5290 ...
5291 RAMDISK: Compressed image found at block 0
5292 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294 bash#
wdenkc6097192002-11-03 00:24:07 +00005295
Matthew McClintock02677682006-06-28 10:41:37 -05005296Boot Linux and pass a flat device tree:
5297-----------
5298
5299First, U-Boot must be compiled with the appropriate defines. See the section
5300titled "Linux Kernel Interface" above for a more in depth explanation. The
5301following is an example of how to start a kernel and pass an updated
5302flat device tree:
5303
5304=> print oftaddr
5305oftaddr=0x300000
5306=> print oft
5307oft=oftrees/mpc8540ads.dtb
5308=> tftp $oftaddr $oft
5309Speed: 1000, full duplex
5310Using TSEC0 device
5311TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5312Filename 'oftrees/mpc8540ads.dtb'.
5313Load address: 0x300000
5314Loading: #
5315done
5316Bytes transferred = 4106 (100a hex)
5317=> tftp $loadaddr $bootfile
5318Speed: 1000, full duplex
5319Using TSEC0 device
5320TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5321Filename 'uImage'.
5322Load address: 0x200000
5323Loading:############
5324done
5325Bytes transferred = 1029407 (fb51f hex)
5326=> print loadaddr
5327loadaddr=200000
5328=> print oftaddr
5329oftaddr=0x300000
5330=> bootm $loadaddr - $oftaddr
5331## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005332 Image Name: Linux-2.6.17-dirty
5333 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5334 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005335 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005336 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005337 Verifying Checksum ... OK
5338 Uncompressing Kernel Image ... OK
5339Booting using flat device tree at 0x300000
5340Using MPC85xx ADS machine description
5341Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5342[snip]
5343
5344
wdenk2729af92004-05-03 20:45:30 +00005345More About U-Boot Image Types:
5346------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005349
wdenk2729af92004-05-03 20:45:30 +00005350 "Standalone Programs" are directly runnable in the environment
5351 provided by U-Boot; it is expected that (if they behave
5352 well) you can continue to work in U-Boot after return from
5353 the Standalone Program.
5354 "OS Kernel Images" are usually images of some Embedded OS which
5355 will take over control completely. Usually these programs
5356 will install their own set of exception handlers, device
5357 drivers, set up the MMU, etc. - this means, that you cannot
5358 expect to re-enter U-Boot except by resetting the CPU.
5359 "RAMDisk Images" are more or less just data blocks, and their
5360 parameters (address, size) are passed to an OS kernel that is
5361 being started.
5362 "Multi-File Images" contain several images, typically an OS
5363 (Linux) kernel image and one or more data images like
5364 RAMDisks. This construct is useful for instance when you want
5365 to boot over the network using BOOTP etc., where the boot
5366 server provides just a single image file, but you want to get
5367 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 "Multi-File Images" start with a list of image sizes, each
5370 image size (in bytes) specified by an "uint32_t" in network
5371 byte order. This list is terminated by an "(uint32_t)0".
5372 Immediately after the terminating 0 follow the images, one by
5373 one, all aligned on "uint32_t" boundaries (size rounded up to
5374 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376 "Firmware Images" are binary images containing firmware (like
5377 U-Boot or FPGA images) which usually will be programmed to
5378 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380 "Script files" are command sequences that will be executed by
5381 U-Boot's command interpreter; this feature is especially
5382 useful when you configure U-Boot to use a real shell (hush)
5383 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005384
Marek Vasut44f074c2012-03-14 21:52:45 +00005385Booting the Linux zImage:
5386-------------------------
5387
5388On some platforms, it's possible to boot Linux zImage. This is done
5389using the "bootz" command. The syntax of "bootz" command is the same
5390as the syntax of "bootm" command.
5391
Tom Rini8ac28562013-05-16 11:40:11 -04005392Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005393kernel with raw initrd images. The syntax is slightly different, the
5394address of the initrd must be augmented by it's size, in the following
5395format: "<initrd addres>:<initrd size>".
5396
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk2729af92004-05-03 20:45:30 +00005398Standalone HOWTO:
5399=================
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401One of the features of U-Boot is that you can dynamically load and
5402run "standalone" applications, which can use some resources of
5403U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk2729af92004-05-03 20:45:30 +00005405Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005406
wdenk2729af92004-05-03 20:45:30 +00005407"Hello World" Demo:
5408-------------------
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk2729af92004-05-03 20:45:30 +00005410'examples/hello_world.c' contains a small "Hello World" Demo
5411application; it is automatically compiled when you build U-Boot.
5412It's configured to run at address 0x00040004, so you can play with it
5413like that:
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk2729af92004-05-03 20:45:30 +00005415 => loads
5416 ## Ready for S-Record download ...
5417 ~>examples/hello_world.srec
5418 1 2 3 4 5 6 7 8 9 10 11 ...
5419 [file transfer complete]
5420 [connected]
5421 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423 => go 40004 Hello World! This is a test.
5424 ## Starting application at 0x00040004 ...
5425 Hello World
5426 argc = 7
5427 argv[0] = "40004"
5428 argv[1] = "Hello"
5429 argv[2] = "World!"
5430 argv[3] = "This"
5431 argv[4] = "is"
5432 argv[5] = "a"
5433 argv[6] = "test."
5434 argv[7] = "<NULL>"
5435 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk2729af92004-05-03 20:45:30 +00005437 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk2729af92004-05-03 20:45:30 +00005439Another example, which demonstrates how to register a CPM interrupt
5440handler with the U-Boot code, can be found in 'examples/timer.c'.
5441Here, a CPM timer is set up to generate an interrupt every second.
5442The interrupt service routine is trivial, just printing a '.'
5443character, but this is just a demo program. The application can be
5444controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446 ? - print current values og the CPM Timer registers
5447 b - enable interrupts and start timer
5448 e - stop timer and disable interrupts
5449 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005450
wdenk2729af92004-05-03 20:45:30 +00005451 => loads
5452 ## Ready for S-Record download ...
5453 ~>examples/timer.srec
5454 1 2 3 4 5 6 7 8 9 10 11 ...
5455 [file transfer complete]
5456 [connected]
5457 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk2729af92004-05-03 20:45:30 +00005459 => go 40004
5460 ## Starting application at 0x00040004 ...
5461 TIMERS=0xfff00980
5462 Using timer 1
5463 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk2729af92004-05-03 20:45:30 +00005465Hit 'b':
5466 [q, b, e, ?] Set interval 1000000 us
5467 Enabling timer
5468Hit '?':
5469 [q, b, e, ?] ........
5470 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5471Hit '?':
5472 [q, b, e, ?] .
5473 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5474Hit '?':
5475 [q, b, e, ?] .
5476 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5477Hit '?':
5478 [q, b, e, ?] .
5479 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5480Hit 'e':
5481 [q, b, e, ?] ...Stopping timer
5482Hit 'q':
5483 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005484
5485
wdenk2729af92004-05-03 20:45:30 +00005486Minicom warning:
5487================
wdenk85ec0bc2003-03-31 16:34:49 +00005488
wdenk2729af92004-05-03 20:45:30 +00005489Over time, many people have reported problems when trying to use the
5490"minicom" terminal emulation program for serial download. I (wd)
5491consider minicom to be broken, and recommend not to use it. Under
5492Unix, I recommend to use C-Kermit for general purpose use (and
5493especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005494use "cu" for S-Record download ("loads" command). See
5495http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5496for help with kermit.
5497
wdenk85ec0bc2003-03-31 16:34:49 +00005498
wdenk2729af92004-05-03 20:45:30 +00005499Nevertheless, if you absolutely want to use it try adding this
5500configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005501
wdenk2729af92004-05-03 20:45:30 +00005502 Name Program Name U/D FullScr IO-Red. Multi
5503 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5504 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005505
5506
wdenk2729af92004-05-03 20:45:30 +00005507NetBSD Notes:
5508=============
wdenkc6097192002-11-03 00:24:07 +00005509
wdenk2729af92004-05-03 20:45:30 +00005510Starting at version 0.9.2, U-Boot supports NetBSD both as host
5511(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005512
wdenk2729af92004-05-03 20:45:30 +00005513Building requires a cross environment; it is known to work on
5514NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5515need gmake since the Makefiles are not compatible with BSD make).
5516Note that the cross-powerpc package does not install include files;
5517attempting to build U-Boot will fail because <machine/ansi.h> is
5518missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520 # cd /usr/pkg/cross/powerpc-netbsd/include
5521 # mkdir powerpc
5522 # ln -s powerpc machine
5523 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5524 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk2729af92004-05-03 20:45:30 +00005526Native builds *don't* work due to incompatibilities between native
5527and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk2729af92004-05-03 20:45:30 +00005529Booting assumes that (the first part of) the image booted is a
5530stage-2 loader which in turn loads and then invokes the kernel
5531proper. Loader sources will eventually appear in the NetBSD source
5532tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005533meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005534
5535
wdenk2729af92004-05-03 20:45:30 +00005536Implementation Internals:
5537=========================
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539The following is not intended to be a complete description of every
5540implementation detail. However, it should help to understand the
5541inner workings of U-Boot and make it easier to port it to custom
5542hardware.
wdenkc6097192002-11-03 00:24:07 +00005543
5544
wdenk2729af92004-05-03 20:45:30 +00005545Initial Stack, Global Data:
5546---------------------------
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk2729af92004-05-03 20:45:30 +00005548The implementation of U-Boot is complicated by the fact that U-Boot
5549starts running out of ROM (flash memory), usually without access to
5550system RAM (because the memory controller is not initialized yet).
5551This means that we don't have writable Data or BSS segments, and BSS
5552is not initialized as zero. To be able to get a C environment working
5553at all, we have to allocate at least a minimal stack. Implementation
5554options for this are defined and restricted by the CPU used: Some CPU
5555models provide on-chip memory (like the IMMR area on MPC8xx and
5556MPC826x processors), on others (parts of) the data cache can be
5557locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005558
Wolfgang Denk218ca722008-03-26 10:40:12 +01005559 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005560 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005561
wdenk2729af92004-05-03 20:45:30 +00005562 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5563 From: "Chris Hallinan" <clh@net1plus.com>
5564 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5565 ...
wdenk43d96162003-03-06 00:02:04 +00005566
wdenk2729af92004-05-03 20:45:30 +00005567 Correct me if I'm wrong, folks, but the way I understand it
5568 is this: Using DCACHE as initial RAM for Stack, etc, does not
5569 require any physical RAM backing up the cache. The cleverness
5570 is that the cache is being used as a temporary supply of
5571 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005572 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005573 can see how this works by studying the cache architecture and
5574 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005575
wdenk2729af92004-05-03 20:45:30 +00005576 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5577 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005578 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005579 option should work for you. Using CS 4 should be fine if your
5580 board designers haven't used it for something that would
5581 cause you grief during the initial boot! It is frequently not
5582 used.
wdenk43d96162003-03-06 00:02:04 +00005583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005584 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005585 with your processor/board/system design. The default value
5586 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005587 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005588 than your SDRAM module. If you have a 64MB SDRAM module, set
5589 it above 400_0000. Just make sure your board has no resources
5590 that are supposed to respond to that address! That code in
5591 start.S has been around a while and should work as is when
5592 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594 -Chris Hallinan
5595 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597It is essential to remember this, since it has some impact on the C
5598code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk2729af92004-05-03 20:45:30 +00005600* Initialized global data (data segment) is read-only. Do not attempt
5601 to write it.
wdenkc6097192002-11-03 00:24:07 +00005602
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005603* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005604 as zero data - BSS segment) at all - this is undefined, initiali-
5605 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk2729af92004-05-03 20:45:30 +00005607* Stack space is very limited. Avoid big data buffers or things like
5608 that.
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk2729af92004-05-03 20:45:30 +00005610Having only the stack as writable memory limits means we cannot use
5611normal global data to share information beween the code. But it
5612turned out that the implementation of U-Boot can be greatly
5613simplified by making a global data structure (gd_t) available to all
5614functions. We could pass a pointer to this data as argument to _all_
5615functions, but this would bloat the code. Instead we use a feature of
5616the GCC compiler (Global Register Variables) to share the data: we
5617place a pointer (gd) to the global data into a register which we
5618reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620When choosing a register for such a purpose we are restricted by the
5621relevant (E)ABI specifications for the current architecture, and by
5622GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk2729af92004-05-03 20:45:30 +00005624For PowerPC, the following registers have specific use:
5625 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005626 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005627 R3-R4: parameter passing and return values
5628 R5-R10: parameter passing
5629 R13: small data area pointer
5630 R30: GOT pointer
5631 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005632
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005633 (U-Boot also uses R12 as internal GOT pointer. r12
5634 is a volatile register so r12 needs to be reset when
5635 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005636
Wolfgang Denke7670f62008-02-14 22:43:22 +01005637 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk2729af92004-05-03 20:45:30 +00005639 Note: on PPC, we could use a static initializer (since the
5640 address of the global data structure is known at compile time),
5641 but it turned out that reserving a register results in somewhat
5642 smaller code - although the code savings are not that big (on
5643 average for all boards 752 bytes for the whole U-Boot image,
5644 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005645
Robin Getzc4db3352009-08-17 15:23:02 +00005646On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005647 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5648
Robin Getzc4db3352009-08-17 15:23:02 +00005649 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005650
wdenk2729af92004-05-03 20:45:30 +00005651On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk2729af92004-05-03 20:45:30 +00005653 R0: function argument word/integer result
5654 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005655 R9: platform specific
5656 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005657 R11: argument (frame) pointer
5658 R12: temporary workspace
5659 R13: stack pointer
5660 R14: link register
5661 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005662
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005663 ==> U-Boot will use R9 to hold a pointer to the global data
5664
5665 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005666
Thomas Chou0df01fd2010-05-21 11:08:03 +08005667On Nios II, the ABI is documented here:
5668 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5669
5670 ==> U-Boot will use gp to hold a pointer to the global data
5671
5672 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5673 to access small data sections, so gp is free.
5674
Macpaul Linafc1ce82011-10-19 20:41:11 +00005675On NDS32, the following registers are used:
5676
5677 R0-R1: argument/return
5678 R2-R5: argument
5679 R15: temporary register for assembler
5680 R16: trampoline register
5681 R28: frame pointer (FP)
5682 R29: global pointer (GP)
5683 R30: link register (LP)
5684 R31: stack pointer (SP)
5685 PC: program counter (PC)
5686
5687 ==> U-Boot will use R10 to hold a pointer to the global data
5688
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005689NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5690or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk2729af92004-05-03 20:45:30 +00005692Memory Management:
5693------------------
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk2729af92004-05-03 20:45:30 +00005695U-Boot runs in system state and uses physical addresses, i.e. the
5696MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698The available memory is mapped to fixed addresses using the memory
5699controller. In this process, a contiguous block is formed for each
5700memory type (Flash, SDRAM, SRAM), even when it consists of several
5701physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703U-Boot is installed in the first 128 kB of the first Flash bank (on
5704TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5705booting and sizing and initializing DRAM, the code relocates itself
5706to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005707memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005708configuration setting]. Below that, a structure with global Board
5709Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711Additionally, some exception handler code is copied to the low 8 kB
5712of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714So a typical memory configuration with 16 MB of DRAM could look like
5715this:
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk2729af92004-05-03 20:45:30 +00005717 0x0000 0000 Exception Vector code
5718 :
5719 0x0000 1FFF
5720 0x0000 2000 Free for Application Use
5721 :
5722 :
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724 :
5725 :
5726 0x00FB FF20 Monitor Stack (Growing downward)
5727 0x00FB FFAC Board Info Data and permanent copy of global data
5728 0x00FC 0000 Malloc Arena
5729 :
5730 0x00FD FFFF
5731 0x00FE 0000 RAM Copy of Monitor Code
5732 ... eventually: LCD or video framebuffer
5733 ... eventually: pRAM (Protected RAM - unchanged by reset)
5734 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005735
5736
wdenk2729af92004-05-03 20:45:30 +00005737System Initialization:
5738----------------------
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005741(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005742configuration for CS0# this is a mirror of the onboard Flash memory.
5743To be able to re-map memory U-Boot then jumps to its link address.
5744To be able to implement the initialization code in C, a (small!)
5745initial stack is set up in the internal Dual Ported RAM (in case CPUs
5746which provide such a feature like MPC8xx or MPC8260), or in a locked
5747part of the data cache. After that, U-Boot initializes the CPU core,
5748the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk2729af92004-05-03 20:45:30 +00005750Next, all (potentially) available memory banks are mapped using a
5751preliminary mapping. For example, we put them on 512 MB boundaries
5752(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5753on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5754programmed for SDRAM access. Using the temporary configuration, a
5755simple memory test is run that determines the size of the SDRAM
5756banks.
wdenkc6097192002-11-03 00:24:07 +00005757
wdenk2729af92004-05-03 20:45:30 +00005758When there is more than one SDRAM bank, and the banks are of
5759different size, the largest is mapped first. For equal size, the first
5760bank (CS2#) is mapped first. The first mapping is always for address
57610x00000000, with any additional banks following immediately to create
5762contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764Then, the monitor installs itself at the upper end of the SDRAM area
5765and allocates memory for use by malloc() and for the global Board
5766Info data; also, the exception vector code is copied to the low RAM
5767pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk2729af92004-05-03 20:45:30 +00005769Only after this relocation will you have a "normal" C environment;
5770until that you are restricted in several ways, mostly because you are
5771running from ROM, and because the code will have to be relocated to a
5772new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005773
5774
wdenk2729af92004-05-03 20:45:30 +00005775U-Boot Porting Guide:
5776----------------------
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk2729af92004-05-03 20:45:30 +00005778[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5779list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005780
5781
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005782int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005783{
5784 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005785
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005786 signal(SIGALRM, no_more_time);
5787 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005788
wdenk2729af92004-05-03 20:45:30 +00005789 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005790 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005791 return 0;
5792 }
5793
wdenk2729af92004-05-03 20:45:30 +00005794 Download latest U-Boot source;
5795
Wolfgang Denk06682362008-12-30 22:56:11 +01005796 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005797
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005798 if (clueless)
5799 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk2729af92004-05-03 20:45:30 +00005801 while (learning) {
5802 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005803 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5804 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005805 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005806 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005807 }
wdenkc6097192002-11-03 00:24:07 +00005808
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005809 if (available_money > toLocalCurrency ($2500))
5810 Buy a BDI3000;
5811 else
wdenk2729af92004-05-03 20:45:30 +00005812 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005813
5814 if (a similar board exists) { /* hopefully... */
5815 cp -a board/<similar> board/<myboard>
5816 cp include/configs/<similar>.h include/configs/<myboard>.h
5817 } else {
5818 Create your own board support subdirectory;
5819 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005820 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005821 Edit new board/<myboard> files
5822 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005823
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005824 while (!accepted) {
5825 while (!running) {
5826 do {
5827 Add / modify source code;
5828 } until (compiles);
5829 Debug;
5830 if (clueless)
5831 email("Hi, I am having problems...");
5832 }
5833 Send patch file to the U-Boot email list;
5834 if (reasonable critiques)
5835 Incorporate improvements from email list code review;
5836 else
5837 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005838 }
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk2729af92004-05-03 20:45:30 +00005840 return 0;
5841}
5842
5843void no_more_time (int sig)
5844{
5845 hire_a_guru();
5846}
wdenkc6097192002-11-03 00:24:07 +00005847
5848
wdenk2729af92004-05-03 20:45:30 +00005849Coding Standards:
5850-----------------
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk2729af92004-05-03 20:45:30 +00005852All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005853coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005854"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005855
Detlev Zundel2c051652006-09-01 15:39:02 +02005856Source files originating from a different project (for example the
5857MTD subsystem) are generally exempt from these guidelines and are not
5858reformated to ease subsequent migration to newer versions of those
5859sources.
5860
5861Please note that U-Boot is implemented in C (and to some small parts in
5862Assembler); no C++ is used, so please do not use C++ style comments (//)
5863in your code.
wdenk2729af92004-05-03 20:45:30 +00005864
5865Please also stick to the following formatting rules:
5866- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005867- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005868- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005869- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005870- do not add trailing empty lines to source files
5871
5872Submissions which do not conform to the standards may be returned
5873with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005874
5875
wdenk2729af92004-05-03 20:45:30 +00005876Submitting Patches:
5877-------------------
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk2729af92004-05-03 20:45:30 +00005879Since the number of patches for U-Boot is growing, we need to
5880establish some rules. Submissions which do not conform to these rules
5881may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005882
Magnus Lilja0d28f342008-08-06 19:32:33 +02005883Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005884
Wolfgang Denk06682362008-12-30 22:56:11 +01005885Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5886see http://lists.denx.de/mailman/listinfo/u-boot
5887
wdenk2729af92004-05-03 20:45:30 +00005888When you send a patch, please include the following information with
5889it:
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk2729af92004-05-03 20:45:30 +00005891* For bug fixes: a description of the bug and how your patch fixes
5892 this bug. Please try to include a way of demonstrating that the
5893 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk2729af92004-05-03 20:45:30 +00005895* For new features: a description of the feature and your
5896 implementation.
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk2729af92004-05-03 20:45:30 +00005898* A CHANGELOG entry as plaintext (separate from the patch)
5899
5900* For major contributions, your entry to the CREDITS file
5901
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005902* When you add support for a new board, don't forget to add a
5903 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005904
5905* If your patch adds new configuration options, don't forget to
5906 document these in the README file.
5907
Wolfgang Denk218ca722008-03-26 10:40:12 +01005908* The patch itself. If you are using git (which is *strongly*
5909 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005910 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005911 the U-Boot mailing list, you will avoid most of the common problems
5912 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005913
Wolfgang Denk218ca722008-03-26 10:40:12 +01005914 If you cannot use git, use "diff -purN OLD NEW". If your version of
5915 diff does not support these options, then get the latest version of
5916 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005917
Wolfgang Denk218ca722008-03-26 10:40:12 +01005918 The current directory when running this command shall be the parent
5919 directory of the U-Boot source tree (i. e. please make sure that
5920 your patch includes sufficient directory information for the
5921 affected files).
5922
5923 We prefer patches as plain text. MIME attachments are discouraged,
5924 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005925
5926* If one logical set of modifications affects or creates several
5927 files, all these changes shall be submitted in a SINGLE patch file.
5928
5929* Changesets that contain different, unrelated modifications shall be
5930 submitted as SEPARATE patches, one patch per changeset.
5931
5932
5933Notes:
5934
5935* Before sending the patch, run the MAKEALL script on your patched
5936 source tree and make sure that no errors or warnings are reported
5937 for any of the boards.
5938
5939* Keep your modifications to the necessary minimum: A patch
5940 containing several unrelated changes or arbitrary reformats will be
5941 returned with a request to re-formatting / split it.
5942
5943* If you modify existing code, make sure that your new code does not
5944 add to the memory footprint of the code ;-) Small is beautiful!
5945 When adding new features, these should compile conditionally only
5946 (using #ifdef), and the resulting code with the new feature
5947 disabled must not need more memory than the old code without your
5948 modification.
wdenk90dc6702005-05-03 14:12:25 +00005949
Wolfgang Denk06682362008-12-30 22:56:11 +01005950* Remember that there is a size limit of 100 kB per message on the
5951 u-boot mailing list. Bigger patches will be moderated. If they are
5952 reasonable and not too big, they will be acknowledged. But patches
5953 bigger than the size limit should be avoided.