blob: d832bcbb7c62e5bef5dbac9d36ebc6c4a6e60495 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denk218ca722008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
126
127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000129
130
wdenk93f19cc2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Weber360d8832010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000140
Thomas Weber360d8832010-09-28 08:06:25 +0200141Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
204 /mpc8220 Files specific to Freescale MPC8220 CPUs
205 /mpc824x Files specific to Freescale MPC824x CPUs
206 /mpc8260 Files specific to Freescale MPC8260 CPUs
207 /mpc85xx Files specific to Freescale MPC85xx CPUs
208 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
209 /lib Architecture specific library files
210 /sh Files generic to SH architecture
211 /cpu CPU specific files
212 /sh2 Files specific to sh2 CPUs
213 /sh3 Files specific to sh3 CPUs
214 /sh4 Files specific to sh4 CPUs
215 /lib Architecture specific library files
216 /sparc Files generic to SPARC architecture
217 /cpu CPU specific files
218 /leon2 Files specific to Gaisler LEON2 SPARC CPU
219 /leon3 Files specific to Gaisler LEON3 SPARC CPU
220 /lib Architecture specific library files
221/api Machine/arch independent API for external apps
222/board Board dependent files
223/common Misc architecture independent functions
224/disk Code for disk drive partition handling
225/doc Documentation (don't expect too much)
226/drivers Commonly used device drivers
227/examples Example code for standalone applications, etc.
228/fs Filesystem code (cramfs, ext2, jffs2, etc.)
229/include Header Files
230/lib Files generic to all architectures
231 /libfdt Library files to support flattened device trees
232 /lzma Library files to support LZMA decompression
233 /lzo Library files to support LZO decompression
234/net Networking code
235/post Power On Self Test
236/rtc Real Time Clock drivers
237/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000238
wdenkc6097192002-11-03 00:24:07 +0000239Software Configuration:
240=======================
241
242Configuration is usually done using C preprocessor defines; the
243rationale behind that is to avoid dead code whenever possible.
244
245There are two classes of configuration variables:
246
247* Configuration _OPTIONS_:
248 These are selectable by the user and have names beginning with
249 "CONFIG_".
250
251* Configuration _SETTINGS_:
252 These depend on the hardware etc. and should not be meddled with if
253 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200254 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000255
256Later we will add a configuration tool - probably similar to or even
257identical to what's used for the Linux kernel. Right now, we have to
258do the configuration by hand, which means creating some symbolic
259links and editing some configuration files. We use the TQM8xxL boards
260as an example here.
261
262
263Selection of Processor Architecture and Board Type:
264---------------------------------------------------
265
266For all supported boards there are ready-to-use default
267configurations available; just type "make <board_name>_config".
268
269Example: For a TQM823L module type:
270
271 cd u-boot
272 make TQM823L_config
273
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200274For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000275e.g. "make cogent_mpc8xx_config". And also configure the cogent
276directory according to the instructions in cogent/README.
277
278
279Configuration Options:
280----------------------
281
282Configuration depends on the combination of board and CPU type; all
283such information is kept in a configuration file
284"include/configs/<board_name>.h".
285
286Example: For a TQM823L module, all configuration settings are in
287"include/configs/TQM823L.h".
288
289
wdenk7f6c2cb2002-11-10 22:06:23 +0000290Many of the options are named exactly as the corresponding Linux
291kernel configuration options. The intention is to make it easier to
292build a config tool - later.
293
294
wdenkc6097192002-11-03 00:24:07 +0000295The following options need to be configured:
296
Kim Phillips26281142007-08-10 13:28:25 -0500297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000298
Kim Phillips26281142007-08-10 13:28:25 -0500299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200300
301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100302 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000303
304- CPU Module Type: (if CONFIG_COGENT is defined)
305 Define exactly one of
306 CONFIG_CMA286_60_OLD
307--- FIXME --- not tested yet:
308 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
309 CONFIG_CMA287_23, CONFIG_CMA287_50
310
311- Motherboard Type: (if CONFIG_COGENT is defined)
312 Define exactly one of
313 CONFIG_CMA101, CONFIG_CMA102
314
315- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
316 Define one or more of
317 CONFIG_CMA302
318
319- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
320 Define one or more of
321 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200322 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000323 a "rotator" |\-/|\-/
324
wdenk2535d602003-07-17 23:16:40 +0000325- Board flavour: (if CONFIG_MPC8260ADS is defined)
326 CONFIG_ADSTYPE
327 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200328 CONFIG_SYS_8260ADS - original MPC8260ADS
329 CONFIG_SYS_8266ADS - MPC8266ADS
330 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
331 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000332
Lei Wencf946c62011-02-09 18:06:58 +0530333- Marvell Family Member
334 CONFIG_SYS_MVFS - define it if you want to enable
335 multiple fs option at one time
336 for marvell soc family
337
wdenkc6097192002-11-03 00:24:07 +0000338- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000339 Define exactly one of
340 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000341
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200342- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
344 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000345 e.g. if there is no 32KHz
346 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000347 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
348 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000349
wdenk66ca92a2004-09-28 17:59:53 +0000350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_8xx_CPUCLK_MIN
352 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000353 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000354 See doc/README.MPC866
355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200356 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000357
wdenkba56f622004-02-06 23:19:44 +0000358 Define this to measure the actual CPU clock instead
359 of relying on the correctness of the configured
360 values. Mostly useful for board bringup to make sure
361 the PLL is locked at the intended frequency. Note
362 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200363 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000364
Heiko Schocher506f3912009-03-12 07:37:15 +0100365 CONFIG_SYS_DELAYED_ICACHE
366
367 Define this option if you want to enable the
368 ICache only when Code runs from RAM.
369
Kumar Gala66412c62011-02-18 05:40:54 -0600370- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000371 CONFIG_SYS_PPC64
372
373 Specifies that the core is a 64-bit PowerPC implementation (implements
374 the "64" category of the Power ISA). This is necessary for ePAPR
375 compliance, among other possible reasons.
376
Kumar Gala66412c62011-02-18 05:40:54 -0600377 CONFIG_SYS_FSL_TBCLK_DIV
378
379 Defines the core time base clock divider ratio compared to the
380 system clock. On most PQ3 devices this is 8, on newer QorIQ
381 devices it can be 16 or 32. The ratio varies from SoC to Soc.
382
Kumar Gala8f290842011-05-20 00:39:21 -0500383 CONFIG_SYS_FSL_PCIE_COMPAT
384
385 Defines the string to utilize when trying to match PCIe device
386 tree nodes for the given platform.
387
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000388 CONFIG_SYS_PPC_E500_DEBUG_TLB
389
390 Enables a temporary TLB entry to be used during boot to work
391 around limitations in e500v1 and e500v2 external debugger
392 support. This reduces the portions of the boot code where
393 breakpoints and single stepping do not work. The value of this
394 symbol should be set to the TLB1 entry to be used for this
395 purpose.
396
Scott Wood33eee332012-08-14 10:14:53 +0000397 CONFIG_SYS_FSL_ERRATUM_A004510
398
399 Enables a workaround for erratum A004510. If set,
400 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
401 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
402
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
404 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
405
406 Defines one or two SoC revisions (low 8 bits of SVR)
407 for which the A004510 workaround should be applied.
408
409 The rest of SVR is either not relevant to the decision
410 of whether the erratum is present (e.g. p2040 versus
411 p2041) or is implied by the build target, which controls
412 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
413
414 See Freescale App Note 4493 for more information about
415 this erratum.
416
417 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
418
419 This is the value to write into CCSR offset 0x18600
420 according to the A004510 workaround.
421
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000422- Generic CPU options:
423 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
424
425 Defines the endianess of the CPU. Implementation of those
426 values is arch specific.
427
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100428- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100430
431 Defines the Monahans run mode to oscillator
432 ratio. Valid values are 8, 16, 24, 31. The core
433 frequency is this value multiplied by 13 MHz.
434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200436
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100437 Defines the Monahans turbo mode to oscillator
438 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200439 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100440 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200441
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200442- MIPS CPU options:
443 CONFIG_SYS_INIT_SP_OFFSET
444
445 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
446 pointer. This is needed for the temporary stack before
447 relocation.
448
449 CONFIG_SYS_MIPS_CACHE_MODE
450
451 Cache operation mode for the MIPS CPU.
452 See also arch/mips/include/asm/mipsregs.h.
453 Possible values are:
454 CONF_CM_CACHABLE_NO_WA
455 CONF_CM_CACHABLE_WA
456 CONF_CM_UNCACHED
457 CONF_CM_CACHABLE_NONCOHERENT
458 CONF_CM_CACHABLE_CE
459 CONF_CM_CACHABLE_COW
460 CONF_CM_CACHABLE_CUW
461 CONF_CM_CACHABLE_ACCELERATED
462
463 CONFIG_SYS_XWAY_EBU_BOOTCFG
464
465 Special option for Lantiq XWAY SoCs for booting from NOR flash.
466 See also arch/mips/cpu/mips32/start.S.
467
468 CONFIG_XWAY_SWAP_BYTES
469
470 Enable compilation of tools/xway-swap-bytes needed for Lantiq
471 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
472 be swapped if a flash programmer is used.
473
Christian Rieschb67d8812012-02-02 00:44:39 +0000474- ARM options:
475 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
476
477 Select high exception vectors of the ARM core, e.g., do not
478 clear the V bit of the c1 register of CP15.
479
Aneesh V5356f542012-03-08 07:20:19 +0000480 CONFIG_SYS_THUMB_BUILD
481
482 Use this flag to build U-Boot using the Thumb instruction
483 set for ARM architectures. Thumb instruction set provides
484 better code density. For ARM architectures that support
485 Thumb2 this flag will result in Thumb2 code generated by
486 GCC.
487
Stephen Warrenc5d47522013-03-04 13:29:40 +0000488 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000489 CONFIG_ARM_ERRATA_742230
490 CONFIG_ARM_ERRATA_743622
491 CONFIG_ARM_ERRATA_751472
492
493 If set, the workarounds for these ARM errata are applied early
494 during U-Boot startup. Note that these options force the
495 workarounds to be applied; no CPU-type/version detection
496 exists, unlike the similar options in the Linux kernel. Do not
497 set these options unless they apply!
498
Stephen Warren795659d2013-03-27 17:06:41 +0000499- CPU timer options:
500 CONFIG_SYS_HZ
501
502 The frequency of the timer returned by get_timer().
503 get_timer() must operate in milliseconds and this CONFIG
504 option must be set to 1000.
505
wdenk5da627a2003-10-09 20:09:04 +0000506- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000507 CONFIG_CLOCKS_IN_MHZ
508
509 U-Boot stores all clock information in Hz
510 internally. For binary compatibility with older Linux
511 kernels (which expect the clocks passed in the
512 bd_info data to be in MHz) the environment variable
513 "clocks_in_mhz" can be defined so that U-Boot
514 converts clock data to MHZ before passing it to the
515 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000516 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100517 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000518 default environment.
519
wdenk5da627a2003-10-09 20:09:04 +0000520 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
521
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200522 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000523 expect it to be in bytes, others in MB.
524 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
525
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400526 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200527
528 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400529 passed using flattened device trees (based on open firmware
530 concepts).
531
532 CONFIG_OF_LIBFDT
533 * New libfdt-based support
534 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500535 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400536
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200537 OF_CPU - The proper name of the cpus node (only required for
538 MPC512X and MPC5xxx based boards).
539 OF_SOC - The proper name of the soc node (only required for
540 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200541 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600542 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200543
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200544 boards with QUICC Engines require OF_QE to set UCC MAC
545 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500546
Kumar Gala4e253132006-01-11 13:54:17 -0600547 CONFIG_OF_BOARD_SETUP
548
549 Board code has addition modification that it wants to make
550 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000551
Matthew McClintock02677682006-06-28 10:41:37 -0500552 CONFIG_OF_BOOT_CPU
553
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200554 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500555 param header, the default value is zero if undefined.
556
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200557 CONFIG_OF_IDE_FIXUP
558
559 U-Boot can detect if an IDE device is present or not.
560 If not, and this new config option is activated, U-Boot
561 removes the ATA node from the DTS before booting Linux,
562 so the Linux IDE driver does not probe the device and
563 crash. This is needed for buggy hardware (uc101) where
564 no pull down resistor is connected to the signal IDE5V_DD7.
565
Igor Grinberg7eb29392011-07-14 05:45:07 +0000566 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
567
568 This setting is mandatory for all boards that have only one
569 machine type and must be used to specify the machine type
570 number as it appears in the ARM machine registry
571 (see http://www.arm.linux.org.uk/developer/machines/).
572 Only boards that have multiple machine types supported
573 in a single configuration file and the machine type is
574 runtime discoverable, do not have to use this setting.
575
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100576- vxWorks boot parameters:
577
578 bootvx constructs a valid bootline using the following
579 environments variables: bootfile, ipaddr, serverip, hostname.
580 It loads the vxWorks image pointed bootfile.
581
582 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
583 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
584 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
585 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
586
587 CONFIG_SYS_VXWORKS_ADD_PARAMS
588
589 Add it at the end of the bootline. E.g "u=username pw=secret"
590
591 Note: If a "bootargs" environment is defined, it will overwride
592 the defaults discussed just above.
593
Aneesh V2c451f72011-06-16 23:30:47 +0000594- Cache Configuration:
595 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
596 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
597 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
598
Aneesh V93bc2192011-06-16 23:30:51 +0000599- Cache Configuration for ARM:
600 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
601 controller
602 CONFIG_SYS_PL310_BASE - Physical base address of PL310
603 controller register space
604
wdenk6705d812004-08-02 23:22:59 +0000605- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200606 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000607
608 Define this if you want support for Amba PrimeCell PL010 UARTs.
609
Andreas Engel48d01922008-09-08 14:30:53 +0200610 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000611
612 Define this if you want support for Amba PrimeCell PL011 UARTs.
613
614 CONFIG_PL011_CLOCK
615
616 If you have Amba PrimeCell PL011 UARTs, set this variable to
617 the clock speed of the UARTs.
618
619 CONFIG_PL01x_PORTS
620
621 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
622 define this to a list of base addresses for each (supported)
623 port. See e.g. include/configs/versatile.h
624
John Rigby910f1ae2011-04-19 10:42:39 +0000625 CONFIG_PL011_SERIAL_RLCR
626
627 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
628 have separate receive and transmit line control registers. Set
629 this variable to initialize the extra register.
630
631 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
632
633 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
634 boot loader that has already initialized the UART. Define this
635 variable to flush the UART at init time.
636
wdenk6705d812004-08-02 23:22:59 +0000637
wdenkc6097192002-11-03 00:24:07 +0000638- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000639 Depending on board, define exactly one serial port
640 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
641 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
642 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000643
644 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
645 port routines must be defined elsewhere
646 (i.e. serial_init(), serial_getc(), ...)
647
648 CONFIG_CFB_CONSOLE
649 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000650 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000651 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
652 (default big endian)
653 VIDEO_HW_RECTFILL graphic chip supports
654 rectangle fill
655 (cf. smiLynxEM)
656 VIDEO_HW_BITBLT graphic chip supports
657 bit-blit (cf. smiLynxEM)
658 VIDEO_VISIBLE_COLS visible pixel columns
659 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000660 VIDEO_VISIBLE_ROWS visible pixel rows
661 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000662 VIDEO_DATA_FORMAT graphic data format
663 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000664 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000665 VIDEO_KBD_INIT_FCT keyboard int fct
666 (i.e. i8042_kbd_init())
667 VIDEO_TSTC_FCT test char fct
668 (i.e. i8042_tstc)
669 VIDEO_GETC_FCT get char fct
670 (i.e. i8042_getc)
671 CONFIG_CONSOLE_CURSOR cursor drawing on/off
672 (requires blink timer
673 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200674 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000675 CONFIG_CONSOLE_TIME display time/date info in
676 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500677 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000678 CONFIG_VIDEO_LOGO display Linux logo in
679 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000680 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
681 linux_logo.h for logo.
682 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000683 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200684 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000685 the logo
686
Pali Rohár33a35bb2012-10-19 13:30:09 +0000687 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
688 a limited number of ANSI escape sequences (cursor control,
689 erase functions and limited graphics rendition control).
690
wdenk43d96162003-03-06 00:02:04 +0000691 When CONFIG_CFB_CONSOLE is defined, video console is
692 default i/o. Serial console can be forced with
693 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000694
wdenkd4ca31c2004-01-02 14:00:00 +0000695 When CONFIG_SILENT_CONSOLE is defined, all console
696 messages (by U-Boot and Linux!) can be silenced with
697 the "silent" environment variable. See
698 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000699
wdenkc6097192002-11-03 00:24:07 +0000700- Console Baudrate:
701 CONFIG_BAUDRATE - in bps
702 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200703 CONFIG_SYS_BAUDRATE_TABLE, see below.
704 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000705
Heiko Schocherc92fac92009-01-30 12:55:38 +0100706- Console Rx buffer length
707 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
708 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100709 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100710 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
711 must be defined, to setup the maximum idle timeout for
712 the SMC.
713
Graeme Russ9558b482011-09-01 00:48:27 +0000714- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200715 Prior to the console being initialised (i.e. serial UART
716 initialised etc) all console output is silently discarded.
717 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
718 buffer any console messages prior to the console being
719 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
720 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
721 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200722 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200723 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000724
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200725 'Sane' compilers will generate smaller code if
726 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000727
Sonny Rao046a37b2011-11-02 09:52:08 +0000728- Safe printf() functions
729 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
730 the printf() functions. These are defined in
731 include/vsprintf.h and include snprintf(), vsnprintf() and
732 so on. Code size increase is approximately 300-500 bytes.
733 If this option is not given then these functions will
734 silently discard their buffer size argument - this means
735 you are not getting any overflow checking in this case.
736
wdenkc6097192002-11-03 00:24:07 +0000737- Boot Delay: CONFIG_BOOTDELAY - in seconds
738 Delay before automatically booting the default image;
739 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000740 set to -2 to autoboot with no delay and not check for abort
741 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000742
743 See doc/README.autoboot for these options that
744 work with CONFIG_BOOTDELAY. None are required.
745 CONFIG_BOOT_RETRY_TIME
746 CONFIG_BOOT_RETRY_MIN
747 CONFIG_AUTOBOOT_KEYED
748 CONFIG_AUTOBOOT_PROMPT
749 CONFIG_AUTOBOOT_DELAY_STR
750 CONFIG_AUTOBOOT_STOP_STR
751 CONFIG_AUTOBOOT_DELAY_STR2
752 CONFIG_AUTOBOOT_STOP_STR2
753 CONFIG_ZERO_BOOTDELAY_CHECK
754 CONFIG_RESET_TO_RETRY
755
756- Autoboot Command:
757 CONFIG_BOOTCOMMAND
758 Only needed when CONFIG_BOOTDELAY is enabled;
759 define a command string that is automatically executed
760 when no character is read on the console interface
761 within "Boot Delay" after reset.
762
763 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000764 This can be used to pass arguments to the bootm
765 command. The value of CONFIG_BOOTARGS goes into the
766 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000767
768 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000769 The value of these goes into the environment as
770 "ramboot" and "nfsboot" respectively, and can be used
771 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200772 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000773
774- Pre-Boot Commands:
775 CONFIG_PREBOOT
776
777 When this option is #defined, the existence of the
778 environment variable "preboot" will be checked
779 immediately before starting the CONFIG_BOOTDELAY
780 countdown and/or running the auto-boot command resp.
781 entering interactive mode.
782
783 This feature is especially useful when "preboot" is
784 automatically generated or modified. For an example
785 see the LWMON board specific code: here "preboot" is
786 modified when the user holds down a certain
787 combination of keys on the (special) keyboard when
788 booting the systems
789
790- Serial Download Echo Mode:
791 CONFIG_LOADS_ECHO
792 If defined to 1, all characters received during a
793 serial download (using the "loads" command) are
794 echoed back. This might be needed by some terminal
795 emulations (like "cu"), but may as well just take
796 time on others. This setting #define's the initial
797 value of the "loads_echo" environment variable.
798
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500799- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000800 CONFIG_KGDB_BAUDRATE
801 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200802 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000803
804- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805 Monitor commands can be included or excluded
806 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000807 <config_cmd_all.h> and #undef'ing unwanted
808 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 and augmenting with additional #define's
810 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000811
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500812 The default command configuration includes all commands
813 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000814
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500816 CONFIG_CMD_BDI bdinfo
817 CONFIG_CMD_BEDBUG * Include BedBug Debugger
818 CONFIG_CMD_BMP * BMP support
819 CONFIG_CMD_BSP * Board specific commands
820 CONFIG_CMD_BOOTD bootd
821 CONFIG_CMD_CACHE * icache, dcache
822 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500823 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_DATE * support for RTC, date/time...
825 CONFIG_CMD_DHCP * DHCP support
826 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600827 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
828 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
829 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
830 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500831 CONFIG_CMD_DTT * Digital Therm and Thermostat
832 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500833 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 CONFIG_CMD_EEPROM * EEPROM read/write support
835 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600836 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600837 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500838 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000839 CONFIG_CMD_EXT2 * ext2 command support
840 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500841 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500842 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000843 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_FDOS * Dos diskette Support
845 CONFIG_CMD_FLASH flinfo, erase, protect
846 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000847 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500848 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000849 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000850 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500851 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
852 CONFIG_CMD_I2C * I2C serial bus support
853 CONFIG_CMD_IDE * IDE harddisk support
854 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000855 CONFIG_CMD_IMLS List all images found in NOR flash
856 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500857 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500858 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000859 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500860 CONFIG_CMD_IRQ * irqinfo
861 CONFIG_CMD_ITEST Integer/string test of 2 values
862 CONFIG_CMD_JFFS2 * JFFS2 Support
863 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500864 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000865 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
866 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_LOADB loadb
868 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400869 CONFIG_CMD_MD5SUM print md5 message digest
870 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000871 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500872 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000873 loop, loopw
874 CONFIG_CMD_MEMTEST mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500875 CONFIG_CMD_MISC Misc functions like sleep etc
876 CONFIG_CMD_MMC * MMC memory mapped support
877 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100878 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500879 CONFIG_CMD_NAND * NAND support
880 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600881 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000882 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500883 CONFIG_CMD_PCI * pciinfo
884 CONFIG_CMD_PCMCIA * PCMCIA support
885 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
886 host
887 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000888 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500889 CONFIG_CMD_REGINFO * Register dump
890 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000891 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 CONFIG_CMD_SAVES * save S record dump
893 CONFIG_CMD_SCSI * SCSI Support
894 CONFIG_CMD_SDRAM * print SDRAM configuration information
895 (requires CONFIG_CMD_I2C)
896 CONFIG_CMD_SETGETDCR Support for DCR Register access
897 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700898 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100899 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400900 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800901 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200902 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000904 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000905 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000906 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
907 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500908 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500909 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000910 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000934- Regular expression support:
935 CONFIG_REGEX
936 If this variable is defined, U-Boot is linked against
937 the SLRE (Super Light Regular Expression) library,
938 which adds regex support to some commands, as for
939 example "env grep" and "setexpr".
940
Simon Glass45ba8072011-10-15 05:48:20 +0000941- Device tree:
942 CONFIG_OF_CONTROL
943 If this variable is defined, U-Boot will use a device tree
944 to configure its devices, instead of relying on statically
945 compiled #defines in the board file. This option is
946 experimental and only available on a few boards. The device
947 tree is available in the global data as gd->fdt_blob.
948
Simon Glass2c0f79e2011-10-24 19:15:31 +0000949 U-Boot needs to get its device tree from somewhere. This can
950 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000951
952 CONFIG_OF_EMBED
953 If this variable is defined, U-Boot will embed a device tree
954 binary in its image. This device tree file should be in the
955 board directory and called <soc>-<board>.dts. The binary file
956 is then picked up in board_init_f() and made available through
957 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000958
Simon Glass2c0f79e2011-10-24 19:15:31 +0000959 CONFIG_OF_SEPARATE
960 If this variable is defined, U-Boot will build a device tree
961 binary. It will be called u-boot.dtb. Architecture-specific
962 code will locate it at run-time. Generally this works by:
963
964 cat u-boot.bin u-boot.dtb >image.bin
965
966 and in fact, U-Boot does this for you, creating a file called
967 u-boot-dtb.bin which is useful in the common case. You can
968 still use the individual files if you need something more
969 exotic.
970
wdenkc6097192002-11-03 00:24:07 +0000971- Watchdog:
972 CONFIG_WATCHDOG
973 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000974 support for the SoC. There must be support in the SoC
975 specific code for a watchdog. For the 8xx and 8260
976 CPUs, the SIU Watchdog feature is enabled in the SYPCR
977 register. When supported for a specific SoC is
978 available, then no further board specific code should
979 be needed to use it.
980
981 CONFIG_HW_WATCHDOG
982 When using a watchdog circuitry external to the used
983 SoC, then define this variable and provide board
984 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000985
stroesec1551ea2003-04-04 15:53:41 +0000986- U-Boot Version:
987 CONFIG_VERSION_VARIABLE
988 If this variable is defined, an environment variable
989 named "ver" is created by U-Boot showing the U-Boot
990 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200991 Any change to this variable will be reverted at the
992 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000993
wdenkc6097192002-11-03 00:24:07 +0000994- Real-Time Clock:
995
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000997 has to be selected, too. Define exactly one of the
998 following options:
999
1000 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1001 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001002 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001003 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001004 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001005 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001006 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001007 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001008 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001009 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001010 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001011 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1012 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenkb37c7e52003-06-30 16:24:52 +00001014 Note that if the RTC uses I2C, then the I2C interface
1015 must also be configured. See I2C Support, below.
1016
Peter Tysere92739d2008-12-17 16:36:21 -06001017- GPIO Support:
1018 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1019 CONFIG_PCA953X_INFO - enable pca953x info command
1020
Chris Packham5dec49c2010-12-19 10:12:13 +00001021 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1022 chip-ngpio pairs that tell the PCA953X driver the number of
1023 pins supported by a particular chip.
1024
Peter Tysere92739d2008-12-17 16:36:21 -06001025 Note that if the GPIO device uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
wdenkc6097192002-11-03 00:24:07 +00001028- Timestamp Support:
1029
wdenk43d96162003-03-06 00:02:04 +00001030 When CONFIG_TIMESTAMP is selected, the timestamp
1031 (date and time) of an image is printed by image
1032 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001033 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001034
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001035- Partition Labels (disklabels) Supported:
1036 Zero or more of the following:
1037 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1038 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1039 Intel architecture, USB sticks, etc.
1040 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1041 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1042 bootloader. Note 2TB partition limit; see
1043 disk/part_efi.c
1044 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001045
Wolfgang Denk218ca722008-03-26 10:40:12 +01001046 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1047 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001048 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001049
1050- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001051 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1052 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001053
wdenk4d13cba2004-03-14 14:09:05 +00001054 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1055 be performed by calling the function
1056 ide_set_reset(int reset)
1057 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001058
1059- ATAPI Support:
1060 CONFIG_ATAPI
1061
1062 Set this to enable ATAPI support.
1063
wdenkc40b2952004-03-13 23:29:43 +00001064- LBA48 Support
1065 CONFIG_LBA48
1066
1067 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001068 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001069 Whithout these , LBA48 support uses 32bit variables and will 'only'
1070 support disks up to 2.1TB.
1071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001073 When enabled, makes the IDE subsystem use 64bit sector addresses.
1074 Default is 32bit.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- SCSI Support:
1077 At the moment only there is only support for the
1078 SYM53C8XX SCSI controller; define
1079 CONFIG_SCSI_SYM53C8XX to enable it.
1080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001081 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1082 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1083 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001084 maximum numbers of LUNs, SCSI ID's and target
1085 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001086 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001087
Stefan Reinauer447c0312012-10-29 05:23:48 +00001088 The environment variable 'scsidevs' is set to the number of
1089 SCSI devices found during the last scan.
1090
wdenkc6097192002-11-03 00:24:07 +00001091- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001092 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001093 Support for Intel 8254x/8257x gigabit chips.
1094
1095 CONFIG_E1000_SPI
1096 Utility code for direct access to the SPI bus on Intel 8257x.
1097 This does not do anything useful unless you set at least one
1098 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1099
1100 CONFIG_E1000_SPI_GENERIC
1101 Allow generic access to the SPI bus on the Intel 8257x, for
1102 example with the "sspi" command.
1103
1104 CONFIG_CMD_E1000
1105 Management command for E1000 devices. When used on devices
1106 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001107
Andre Schwarzac3315c2008-03-06 16:45:44 +01001108 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001109 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001110
wdenkc6097192002-11-03 00:24:07 +00001111 CONFIG_EEPRO100
1112 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001113 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001114 write routine for first time initialisation.
1115
1116 CONFIG_TULIP
1117 Support for Digital 2114x chips.
1118 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1119 modem chip initialisation (KS8761/QS6611).
1120
1121 CONFIG_NATSEMI
1122 Support for National dp83815 chips.
1123
1124 CONFIG_NS8382X
1125 Support for National dp8382[01] gigabit chips.
1126
wdenk45219c42003-05-12 21:50:16 +00001127- NETWORK Support (other):
1128
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001129 CONFIG_DRIVER_AT91EMAC
1130 Support for AT91RM9200 EMAC.
1131
1132 CONFIG_RMII
1133 Define this to use reduced MII inteface
1134
1135 CONFIG_DRIVER_AT91EMAC_QUIET
1136 If this defined, the driver is quiet.
1137 The driver doen't show link status messages.
1138
Rob Herringefdd7312011-12-15 11:15:49 +00001139 CONFIG_CALXEDA_XGMAC
1140 Support for the Calxeda XGMAC device
1141
Ashok3bb46d22012-10-15 06:20:47 +00001142 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001143 Support for SMSC's LAN91C96 chips.
1144
1145 CONFIG_LAN91C96_BASE
1146 Define this to hold the physical address
1147 of the LAN91C96's I/O space
1148
1149 CONFIG_LAN91C96_USE_32_BIT
1150 Define this to enable 32 bit addressing
1151
Ashok3bb46d22012-10-15 06:20:47 +00001152 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001153 Support for SMSC's LAN91C111 chip
1154
1155 CONFIG_SMC91111_BASE
1156 Define this to hold the physical address
1157 of the device (I/O space)
1158
1159 CONFIG_SMC_USE_32_BIT
1160 Define this if data bus is 32 bits
1161
1162 CONFIG_SMC_USE_IOFUNCS
1163 Define this to use i/o functions instead of macros
1164 (some hardware wont work with macros)
1165
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001166 CONFIG_DRIVER_TI_EMAC
1167 Support for davinci emac
1168
1169 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1170 Define this if you have more then 3 PHYs.
1171
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001172 CONFIG_FTGMAC100
1173 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1174
1175 CONFIG_FTGMAC100_EGIGA
1176 Define this to use GE link update with gigabit PHY.
1177 Define this if FTGMAC100 is connected to gigabit PHY.
1178 If your system has 10/100 PHY only, it might not occur
1179 wrong behavior. Because PHY usually return timeout or
1180 useless data when polling gigabit status and gigabit
1181 control registers. This behavior won't affect the
1182 correctnessof 10/100 link speed update.
1183
Mike Rapoportc2fff332009-11-11 10:03:03 +02001184 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001185 Support for SMSC's LAN911x and LAN921x chips
1186
Mike Rapoportc2fff332009-11-11 10:03:03 +02001187 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001188 Define this to hold the physical address
1189 of the device (I/O space)
1190
Mike Rapoportc2fff332009-11-11 10:03:03 +02001191 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001192 Define this if data bus is 32 bits
1193
Mike Rapoportc2fff332009-11-11 10:03:03 +02001194 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001195 Define this if data bus is 16 bits. If your processor
1196 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001197 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001198
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001199 CONFIG_SH_ETHER
1200 Support for Renesas on-chip Ethernet controller
1201
1202 CONFIG_SH_ETHER_USE_PORT
1203 Define the number of ports to be used
1204
1205 CONFIG_SH_ETHER_PHY_ADDR
1206 Define the ETH PHY's address
1207
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001208 CONFIG_SH_ETHER_CACHE_WRITEBACK
1209 If this option is set, the driver enables cache flush.
1210
Vadim Bendebury5e124722011-10-17 08:36:14 +00001211- TPM Support:
1212 CONFIG_GENERIC_LPC_TPM
1213 Support for generic parallel port TPM devices. Only one device
1214 per system is supported at this time.
1215
1216 CONFIG_TPM_TIS_BASE_ADDRESS
1217 Base address where the generic TPM device is mapped
1218 to. Contemporary x86 systems usually map it at
1219 0xfed40000.
1220
wdenkc6097192002-11-03 00:24:07 +00001221- USB Support:
1222 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001223 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001224 CONFIG_USB_UHCI to enable it.
1225 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001226 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001227 storage devices.
1228 Note:
1229 Supported are USB Keyboards and USB Floppy drives
1230 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001231 MPC5200 USB requires additional defines:
1232 CONFIG_USB_CLOCK
1233 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001234 CONFIG_PSC3_USB
1235 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001236 CONFIG_USB_CONFIG
1237 for differential drivers: 0x00001000
1238 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001239 for differential drivers on PSC3: 0x00000100
1240 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001242 May be defined to allow interrupt polling
1243 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001244
Simon Glass9ab4ce22012-02-27 10:52:47 +00001245 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1246 txfilltuning field in the EHCI controller on reset.
1247
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001248- USB Device:
1249 Define the below if you wish to use the USB console.
1250 Once firmware is rebuilt from a serial console issue the
1251 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001252 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001253 it has found a new device. The environment variable usbtty
1254 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001255 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001256 Common Device Class Abstract Control Model serial device.
1257 If you select usbtty = gserial you should be able to enumerate
1258 a Linux host by
1259 # modprobe usbserial vendor=0xVendorID product=0xProductID
1260 else if using cdc_acm, simply setting the environment
1261 variable usbtty to be cdc_acm should suffice. The following
1262 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001263
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001264 CONFIG_USB_DEVICE
1265 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001266
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001267 CONFIG_USB_TTY
1268 Define this to have a tty type of device available to
1269 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001270
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301271 CONFIG_USBD_HS
1272 Define this to enable the high speed support for usb
1273 device and usbtty. If this feature is enabled, a routine
1274 int is_usbd_high_speed(void)
1275 also needs to be defined by the driver to dynamically poll
1276 whether the enumeration has succeded at high speed or full
1277 speed.
1278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001279 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001280 Define this if you want stdin, stdout &/or stderr to
1281 be set to usbtty.
1282
1283 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001284 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001285 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001286 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001288 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001289 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001290 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001291
Wolfgang Denk386eda02006-06-14 18:14:56 +02001292 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001293 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001294 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001295 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1296 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1297 should pretend to be a Linux device to it's target host.
1298
1299 CONFIG_USBD_MANUFACTURER
1300 Define this string as the name of your company for
1301 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001302
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001303 CONFIG_USBD_PRODUCT_NAME
1304 Define this string as the name of your product
1305 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1306
1307 CONFIG_USBD_VENDORID
1308 Define this as your assigned Vendor ID from the USB
1309 Implementors Forum. This *must* be a genuine Vendor ID
1310 to avoid polluting the USB namespace.
1311 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001312
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001313 CONFIG_USBD_PRODUCTID
1314 Define this as the unique Product ID
1315 for your device
1316 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001317
Igor Grinbergd70a5602011-12-12 12:08:35 +02001318- ULPI Layer Support:
1319 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1320 the generic ULPI layer. The generic layer accesses the ULPI PHY
1321 via the platform viewport, so you need both the genric layer and
1322 the viewport enabled. Currently only Chipidea/ARC based
1323 viewport is supported.
1324 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1325 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001326 If your ULPI phy needs a different reference clock than the
1327 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1328 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001329
1330- MMC Support:
1331 The MMC controller on the Intel PXA is supported. To
1332 enable this define CONFIG_MMC. The MMC can be
1333 accessed from the boot prompt by mapping the device
1334 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001335 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1336 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001337
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001338 CONFIG_SH_MMCIF
1339 Support for Renesas on-chip MMCIF controller
1340
1341 CONFIG_SH_MMCIF_ADDR
1342 Define the base address of MMCIF registers
1343
1344 CONFIG_SH_MMCIF_CLK
1345 Define the clock frequency for MMCIF
1346
Tom Rinib3ba6e92013-03-14 05:32:47 +00001347- USB Device Firmware Update (DFU) class support:
1348 CONFIG_DFU_FUNCTION
1349 This enables the USB portion of the DFU USB class
1350
1351 CONFIG_CMD_DFU
1352 This enables the command "dfu" which is used to have
1353 U-Boot create a DFU class device via USB. This command
1354 requires that the "dfu_alt_info" environment variable be
1355 set and define the alt settings to expose to the host.
1356
1357 CONFIG_DFU_MMC
1358 This enables support for exposing (e)MMC devices via DFU.
1359
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001360 CONFIG_DFU_NAND
1361 This enables support for exposing NAND devices via DFU.
1362
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001363 CONFIG_SYS_DFU_MAX_FILE_SIZE
1364 When updating files rather than the raw storage device,
1365 we use a static buffer to copy the file into and then write
1366 the buffer once we've been given the whole file. Define
1367 this to the maximum filesize (in bytes) for the buffer.
1368 Default is 4 MiB if undefined.
1369
wdenk6705d812004-08-02 23:22:59 +00001370- Journaling Flash filesystem support:
1371 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1372 CONFIG_JFFS2_NAND_DEV
1373 Define these for a default partition on a NAND device
1374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001375 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1376 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001377 Define these for a default partition on a NOR device
1378
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001379 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001380 Define this to create an own partition. You have to provide a
1381 function struct part_info* jffs2_part_info(int part_num)
1382
1383 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001384 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001385 to disable the command chpart. This is the default when you
1386 have not defined a custom partition
1387
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001388- FAT(File Allocation Table) filesystem write function support:
1389 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001390
1391 Define this to enable support for saving memory data as a
1392 file in FAT formatted partition.
1393
1394 This will also enable the command "fatwrite" enabling the
1395 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001396
Gabe Black84cd9322012-10-12 14:26:11 +00001397CBFS (Coreboot Filesystem) support
1398 CONFIG_CMD_CBFS
1399
1400 Define this to enable support for reading from a Coreboot
1401 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1402 and cbfsload.
1403
wdenkc6097192002-11-03 00:24:07 +00001404- Keyboard Support:
1405 CONFIG_ISA_KEYBOARD
1406
1407 Define this to enable standard (PC-Style) keyboard
1408 support
1409
1410 CONFIG_I8042_KBD
1411 Standard PC keyboard driver with US (is default) and
1412 GERMAN key layout (switch via environment 'keymap=de') support.
1413 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1414 for cfb_console. Supports cursor blinking.
1415
1416- Video support:
1417 CONFIG_VIDEO
1418
1419 Define this to enable video support (for output to
1420 video).
1421
1422 CONFIG_VIDEO_CT69000
1423
1424 Enable Chips & Technologies 69000 Video chip
1425
1426 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001427 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001428 video output is selected via environment 'videoout'
1429 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1430 assumed.
wdenkc6097192002-11-03 00:24:07 +00001431
wdenkb79a11c2004-03-25 15:14:43 +00001432 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001433 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001434 are possible:
1435 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001436 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001437
1438 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1439 -------------+---------------------------------------------
1440 8 bits | 0x301* 0x303 0x305 0x161 0x307
1441 15 bits | 0x310 0x313 0x316 0x162 0x319
1442 16 bits | 0x311 0x314 0x317 0x163 0x31A
1443 24 bits | 0x312 0x315 0x318 ? 0x31B
1444 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001445 (i.e. setenv videomode 317; saveenv; reset;)
1446
wdenkb79a11c2004-03-25 15:14:43 +00001447 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001448 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001449
1450
stroesec1551ea2003-04-04 15:53:41 +00001451 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001452 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001453 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1454 or CONFIG_VIDEO_SED13806_16BPP
1455
Timur Tabi7d3053f2011-02-15 17:09:19 -06001456 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001457 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001458 SOCs that have a DIU should define this macro to enable DIU
1459 support, and should also define these other macros:
1460
1461 CONFIG_SYS_DIU_ADDR
1462 CONFIG_VIDEO
1463 CONFIG_CMD_BMP
1464 CONFIG_CFB_CONSOLE
1465 CONFIG_VIDEO_SW_CURSOR
1466 CONFIG_VGA_AS_SINGLE_DEVICE
1467 CONFIG_VIDEO_LOGO
1468 CONFIG_VIDEO_BMP_LOGO
1469
Timur Tabiba8e76b2011-04-11 14:18:22 -05001470 The DIU driver will look for the 'video-mode' environment
1471 variable, and if defined, enable the DIU as a console during
1472 boot. See the documentation file README.video for a
1473 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001474
Simon Glass058d59b2012-12-03 13:59:47 +00001475 CONFIG_VIDEO_VGA
1476
1477 Enable the VGA video / BIOS for x86. The alternative if you
1478 are using coreboot is to use the coreboot frame buffer
1479 driver.
1480
1481
wdenk682011f2003-06-03 23:54:09 +00001482- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001483 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001484
wdenk8bde7f72003-06-27 21:31:46 +00001485 Define this to enable a custom keyboard support.
1486 This simply calls drv_keyboard_init() which must be
1487 defined in your board-specific files.
1488 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001489
wdenkc6097192002-11-03 00:24:07 +00001490- LCD Support: CONFIG_LCD
1491
1492 Define this to enable LCD support (for output to LCD
1493 display); also select one of the supported displays
1494 by defining one of these:
1495
Stelian Pop39cf4802008-05-09 21:57:18 +02001496 CONFIG_ATMEL_LCD:
1497
1498 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1499
wdenkfd3103b2003-11-25 16:55:19 +00001500 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001501
wdenkfd3103b2003-11-25 16:55:19 +00001502 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001503
wdenkfd3103b2003-11-25 16:55:19 +00001504 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001505
wdenkfd3103b2003-11-25 16:55:19 +00001506 NEC NL6448BC20-08. 6.5", 640x480.
1507 Active, color, single scan.
1508
1509 CONFIG_NEC_NL6448BC33_54
1510
1511 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001512 Active, color, single scan.
1513
1514 CONFIG_SHARP_16x9
1515
1516 Sharp 320x240. Active, color, single scan.
1517 It isn't 16x9, and I am not sure what it is.
1518
1519 CONFIG_SHARP_LQ64D341
1520
1521 Sharp LQ64D341 display, 640x480.
1522 Active, color, single scan.
1523
1524 CONFIG_HLD1045
1525
1526 HLD1045 display, 640x480.
1527 Active, color, single scan.
1528
1529 CONFIG_OPTREX_BW
1530
1531 Optrex CBL50840-2 NF-FW 99 22 M5
1532 or
1533 Hitachi LMG6912RPFC-00T
1534 or
1535 Hitachi SP14Q002
1536
1537 320x240. Black & white.
1538
1539 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001540 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001541
Simon Glass676d3192012-10-17 13:24:54 +00001542 CONFIG_LCD_ALIGNMENT
1543
1544 Normally the LCD is page-aligned (tyically 4KB). If this is
1545 defined then the LCD will be aligned to this value instead.
1546 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1547 here, since it is cheaper to change data cache settings on
1548 a per-section basis.
1549
Simon Glass0d89efe2012-10-17 13:24:59 +00001550 CONFIG_CONSOLE_SCROLL_LINES
1551
1552 When the console need to be scrolled, this is the number of
1553 lines to scroll by. It defaults to 1. Increasing this makes
1554 the console jump but can help speed up operation when scrolling
1555 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001556
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001557 CONFIG_LCD_BMP_RLE8
1558
1559 Support drawing of RLE8-compressed bitmaps on the LCD.
1560
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001561 CONFIG_I2C_EDID
1562
1563 Enables an 'i2c edid' command which can read EDID
1564 information over I2C from an attached LCD display.
1565
wdenk7152b1d2003-09-05 23:19:14 +00001566- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001567
wdenk8bde7f72003-06-27 21:31:46 +00001568 If this option is set, the environment is checked for
1569 a variable "splashimage". If found, the usual display
1570 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001571 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001572 specified in "splashimage" is loaded instead. The
1573 console is redirected to the "nulldev", too. This
1574 allows for a "silent" boot where a splash screen is
1575 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001576
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001577 CONFIG_SPLASHIMAGE_GUARD
1578
1579 If this option is set, then U-Boot will prevent the environment
1580 variable "splashimage" from being set to a problematic address
1581 (see README.displaying-bmps and README.arm-unaligned-accesses).
1582 This option is useful for targets where, due to alignment
1583 restrictions, an improperly aligned BMP image will cause a data
1584 abort. If you think you will not have problems with unaligned
1585 accesses (for example because your toolchain prevents them)
1586 there is no need to set this option.
1587
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001588 CONFIG_SPLASH_SCREEN_ALIGN
1589
1590 If this option is set the splash image can be freely positioned
1591 on the screen. Environment variable "splashpos" specifies the
1592 position as "x,y". If a positive number is given it is used as
1593 number of pixel from left/top. If a negative number is given it
1594 is used as number of pixel from right/bottom. You can also
1595 specify 'm' for centering the image.
1596
1597 Example:
1598 setenv splashpos m,m
1599 => image at center of screen
1600
1601 setenv splashpos 30,20
1602 => image at x = 30 and y = 20
1603
1604 setenv splashpos -10,m
1605 => vertically centered image
1606 at x = dspWidth - bmpWidth - 9
1607
Nikita Kiryanov581bb412013-01-30 21:39:57 +00001608 CONFIG_SPLASH_SCREEN_PREPARE
1609
1610 If this option is set then the board_splash_screen_prepare()
1611 function, which must be defined in your code, is called as part
1612 of the splash screen display sequence. It gives the board an
1613 opportunity to prepare the splash image data before it is
1614 processed and sent to the frame buffer by U-Boot.
1615
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001616- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1617
1618 If this option is set, additionally to standard BMP
1619 images, gzipped BMP images can be displayed via the
1620 splashscreen support or the bmp command.
1621
Anatolij Gustschind5011762010-03-15 14:50:25 +01001622- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1623
1624 If this option is set, 8-bit RLE compressed BMP images
1625 can be displayed via the splashscreen support or the
1626 bmp command.
1627
Lei Wenf2b96df2012-09-28 04:26:47 +00001628- Do compresssing for memory range:
1629 CONFIG_CMD_ZIP
1630
1631 If this option is set, it would use zlib deflate method
1632 to compress the specified memory at its best effort.
1633
wdenkc29fdfc2003-08-29 20:57:53 +00001634- Compression support:
1635 CONFIG_BZIP2
1636
1637 If this option is set, support for bzip2 compressed
1638 images is included. If not, only uncompressed and gzip
1639 compressed images are supported.
1640
wdenk42d1f032003-10-15 23:53:47 +00001641 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001642 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001643 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001644
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001645 CONFIG_LZMA
1646
1647 If this option is set, support for lzma compressed
1648 images is included.
1649
1650 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1651 requires an amount of dynamic memory that is given by the
1652 formula:
1653
1654 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1655
1656 Where lc and lp stand for, respectively, Literal context bits
1657 and Literal pos bits.
1658
1659 This value is upper-bounded by 14MB in the worst case. Anyway,
1660 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1661 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1662 a very small buffer.
1663
1664 Use the lzmainfo tool to determinate the lc and lp values and
1665 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001666 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001667
wdenk17ea1172004-06-06 21:51:03 +00001668- MII/PHY support:
1669 CONFIG_PHY_ADDR
1670
1671 The address of PHY on MII bus.
1672
1673 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1674
1675 The clock frequency of the MII bus
1676
1677 CONFIG_PHY_GIGE
1678
1679 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001680 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001681
1682 CONFIG_PHY_RESET_DELAY
1683
1684 Some PHY like Intel LXT971A need extra delay after
1685 reset before any MII register access is possible.
1686 For such PHY, set this option to the usec delay
1687 required. (minimum 300usec for LXT971A)
1688
1689 CONFIG_PHY_CMD_DELAY (ppc4xx)
1690
1691 Some PHY like Intel LXT971A need extra delay after
1692 command issued before MII status register can be read
1693
wdenkc6097192002-11-03 00:24:07 +00001694- Ethernet address:
1695 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001696 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001697 CONFIG_ETH2ADDR
1698 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001699 CONFIG_ETH4ADDR
1700 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001701
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001702 Define a default value for Ethernet address to use
1703 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001704 is not determined automatically.
1705
1706- IP address:
1707 CONFIG_IPADDR
1708
1709 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001710 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001711 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001712 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001713
1714- Server IP address:
1715 CONFIG_SERVERIP
1716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001717 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001718 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001719 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001720
Robin Getz97cfe862009-07-21 12:15:28 -04001721 CONFIG_KEEP_SERVERADDR
1722
1723 Keeps the server's MAC address, in the env 'serveraddr'
1724 for passing to bootargs (like Linux's netconsole option)
1725
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001726- Gateway IP address:
1727 CONFIG_GATEWAYIP
1728
1729 Defines a default value for the IP address of the
1730 default router where packets to other networks are
1731 sent to.
1732 (Environment variable "gatewayip")
1733
1734- Subnet mask:
1735 CONFIG_NETMASK
1736
1737 Defines a default value for the subnet mask (or
1738 routing prefix) which is used to determine if an IP
1739 address belongs to the local subnet or needs to be
1740 forwarded through a router.
1741 (Environment variable "netmask")
1742
David Updegraff53a5c422007-06-11 10:41:07 -05001743- Multicast TFTP Mode:
1744 CONFIG_MCAST_TFTP
1745
1746 Defines whether you want to support multicast TFTP as per
1747 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001748 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001749 driver in use must provide a function: mcast() to join/leave a
1750 multicast group.
1751
wdenkc6097192002-11-03 00:24:07 +00001752- BOOTP Recovery Mode:
1753 CONFIG_BOOTP_RANDOM_DELAY
1754
1755 If you have many targets in a network that try to
1756 boot using BOOTP, you may want to avoid that all
1757 systems send out BOOTP requests at precisely the same
1758 moment (which would happen for instance at recovery
1759 from a power failure, when all systems will try to
1760 boot, thus flooding the BOOTP server. Defining
1761 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1762 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001763 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001764
1765 1st BOOTP request: delay 0 ... 1 sec
1766 2nd BOOTP request: delay 0 ... 2 sec
1767 3rd BOOTP request: delay 0 ... 4 sec
1768 4th and following
1769 BOOTP requests: delay 0 ... 8 sec
1770
stroesefe389a82003-08-28 14:17:32 +00001771- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001772 You can fine tune the DHCP functionality by defining
1773 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001774
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001775 CONFIG_BOOTP_SUBNETMASK
1776 CONFIG_BOOTP_GATEWAY
1777 CONFIG_BOOTP_HOSTNAME
1778 CONFIG_BOOTP_NISDOMAIN
1779 CONFIG_BOOTP_BOOTPATH
1780 CONFIG_BOOTP_BOOTFILESIZE
1781 CONFIG_BOOTP_DNS
1782 CONFIG_BOOTP_DNS2
1783 CONFIG_BOOTP_SEND_HOSTNAME
1784 CONFIG_BOOTP_NTPSERVER
1785 CONFIG_BOOTP_TIMEOFFSET
1786 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001787 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001788
Wilson Callan5d110f02007-07-28 10:56:13 -04001789 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1790 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001791
Joe Hershberger2c00e092012-05-23 07:59:19 +00001792 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1793 after the configured retry count, the call will fail
1794 instead of starting over. This can be used to fail over
1795 to Link-local IP address configuration if the DHCP server
1796 is not available.
1797
stroesefe389a82003-08-28 14:17:32 +00001798 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1799 serverip from a DHCP server, it is possible that more
1800 than one DNS serverip is offered to the client.
1801 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1802 serverip will be stored in the additional environment
1803 variable "dnsip2". The first DNS serverip is always
1804 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001805 is defined.
stroesefe389a82003-08-28 14:17:32 +00001806
1807 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1808 to do a dynamic update of a DNS server. To do this, they
1809 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001810 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001811 of the "hostname" environment variable is passed as
1812 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001813
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001814 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1815
1816 A 32bit value in microseconds for a delay between
1817 receiving a "DHCP Offer" and sending the "DHCP Request".
1818 This fixes a problem with certain DHCP servers that don't
1819 respond 100% of the time to a "DHCP request". E.g. On an
1820 AT91RM9200 processor running at 180MHz, this delay needed
1821 to be *at least* 15,000 usec before a Windows Server 2003
1822 DHCP server would reply 100% of the time. I recommend at
1823 least 50,000 usec to be safe. The alternative is to hope
1824 that one of the retries will be successful but note that
1825 the DHCP timeout and retry process takes a longer than
1826 this delay.
1827
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001828 - Link-local IP address negotiation:
1829 Negotiate with other link-local clients on the local network
1830 for an address that doesn't require explicit configuration.
1831 This is especially useful if a DHCP server cannot be guaranteed
1832 to exist in all environments that the device must operate.
1833
1834 See doc/README.link-local for more information.
1835
wdenka3d991b2004-04-15 21:48:45 +00001836 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001837 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001838
1839 The device id used in CDP trigger frames.
1840
1841 CONFIG_CDP_DEVICE_ID_PREFIX
1842
1843 A two character string which is prefixed to the MAC address
1844 of the device.
1845
1846 CONFIG_CDP_PORT_ID
1847
1848 A printf format string which contains the ascii name of
1849 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001850 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001851
1852 CONFIG_CDP_CAPABILITIES
1853
1854 A 32bit integer which indicates the device capabilities;
1855 0x00000010 for a normal host which does not forwards.
1856
1857 CONFIG_CDP_VERSION
1858
1859 An ascii string containing the version of the software.
1860
1861 CONFIG_CDP_PLATFORM
1862
1863 An ascii string containing the name of the platform.
1864
1865 CONFIG_CDP_TRIGGER
1866
1867 A 32bit integer sent on the trigger.
1868
1869 CONFIG_CDP_POWER_CONSUMPTION
1870
1871 A 16bit integer containing the power consumption of the
1872 device in .1 of milliwatts.
1873
1874 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1875
1876 A byte containing the id of the VLAN.
1877
wdenkc6097192002-11-03 00:24:07 +00001878- Status LED: CONFIG_STATUS_LED
1879
1880 Several configurations allow to display the current
1881 status using a LED. For instance, the LED will blink
1882 fast while running U-Boot code, stop blinking as
1883 soon as a reply to a BOOTP request was received, and
1884 start blinking slow once the Linux kernel is running
1885 (supported by a status LED driver in the Linux
1886 kernel). Defining CONFIG_STATUS_LED enables this
1887 feature in U-Boot.
1888
1889- CAN Support: CONFIG_CAN_DRIVER
1890
1891 Defining CONFIG_CAN_DRIVER enables CAN driver support
1892 on those systems that support this (optional)
1893 feature, like the TQM8xxL modules.
1894
1895- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1896
wdenkb37c7e52003-06-30 16:24:52 +00001897 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001898 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001899 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001900
wdenk945af8d2003-07-16 21:53:01 +00001901 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001902 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001903 CONFIG_COMMANDS) and communicate with i2c based realtime
1904 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001905 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001906
Ben Warrenbb99ad62006-09-07 16:50:54 -04001907 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001908
wdenk945af8d2003-07-16 21:53:01 +00001909 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001910 bit-banging) driver instead of CPM or similar hardware
1911 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001912
wdenk945af8d2003-07-16 21:53:01 +00001913 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001914 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001916 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001917 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001918 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001919 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001920
Peter Tyser8d321b82010-04-12 22:28:21 -05001921 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001922 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001923 and so its address should therefore be cleared to 0 (See,
1924 eg, MPC823e User's Manual p.16-473). So, set
1925 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001926
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001927 CONFIG_SYS_I2C_INIT_MPC5XXX
1928
1929 When a board is reset during an i2c bus transfer
1930 chips might think that the current transfer is still
1931 in progress. Reset the slave devices by sending start
1932 commands until the slave device responds.
1933
wdenk945af8d2003-07-16 21:53:01 +00001934 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001935
1936 If you use the software i2c interface (CONFIG_SOFT_I2C)
1937 then the following macros need to be defined (examples are
1938 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001939
1940 I2C_INIT
1941
wdenkb37c7e52003-06-30 16:24:52 +00001942 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001943 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001944
wdenkba56f622004-02-06 23:19:44 +00001945 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001946
wdenkc6097192002-11-03 00:24:07 +00001947 I2C_PORT
1948
wdenk43d96162003-03-06 00:02:04 +00001949 (Only for MPC8260 CPU). The I/O port to use (the code
1950 assumes both bits are on the same port). Valid values
1951 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001952
1953 I2C_ACTIVE
1954
1955 The code necessary to make the I2C data line active
1956 (driven). If the data line is open collector, this
1957 define can be null.
1958
wdenkb37c7e52003-06-30 16:24:52 +00001959 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1960
wdenkc6097192002-11-03 00:24:07 +00001961 I2C_TRISTATE
1962
1963 The code necessary to make the I2C data line tri-stated
1964 (inactive). If the data line is open collector, this
1965 define can be null.
1966
wdenkb37c7e52003-06-30 16:24:52 +00001967 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1968
wdenkc6097192002-11-03 00:24:07 +00001969 I2C_READ
1970
York Sun472d5462013-04-01 11:29:11 -07001971 Code that returns true if the I2C data line is high,
1972 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001973
wdenkb37c7e52003-06-30 16:24:52 +00001974 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1975
wdenkc6097192002-11-03 00:24:07 +00001976 I2C_SDA(bit)
1977
York Sun472d5462013-04-01 11:29:11 -07001978 If <bit> is true, sets the I2C data line high. If it
1979 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001980
wdenkb37c7e52003-06-30 16:24:52 +00001981 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001982 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001983 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001984
wdenkc6097192002-11-03 00:24:07 +00001985 I2C_SCL(bit)
1986
York Sun472d5462013-04-01 11:29:11 -07001987 If <bit> is true, sets the I2C clock line high. If it
1988 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001989
wdenkb37c7e52003-06-30 16:24:52 +00001990 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001991 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001992 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001993
wdenkc6097192002-11-03 00:24:07 +00001994 I2C_DELAY
1995
1996 This delay is invoked four times per clock cycle so this
1997 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001998 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001999 like:
2000
wdenkb37c7e52003-06-30 16:24:52 +00002001 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002002
Mike Frysinger793b5722010-07-21 13:38:02 -04002003 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2004
2005 If your arch supports the generic GPIO framework (asm/gpio.h),
2006 then you may alternatively define the two GPIOs that are to be
2007 used as SCL / SDA. Any of the previous I2C_xxx macros will
2008 have GPIO-based defaults assigned to them as appropriate.
2009
2010 You should define these to the GPIO value as given directly to
2011 the generic GPIO functions.
2012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002013 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002014
wdenk8bde7f72003-06-27 21:31:46 +00002015 When a board is reset during an i2c bus transfer
2016 chips might think that the current transfer is still
2017 in progress. On some boards it is possible to access
2018 the i2c SCLK line directly, either by using the
2019 processor pin as a GPIO or by having a second pin
2020 connected to the bus. If this option is defined a
2021 custom i2c_init_board() routine in boards/xxx/board.c
2022 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002023
Richard Retanubun26a33502010-04-12 15:08:17 -04002024 CONFIG_SYS_I2C_BOARD_LATE_INIT
2025
2026 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2027 defined a custom i2c_board_late_init() routine in
2028 boards/xxx/board.c is run AFTER the operations in i2c_init()
2029 is completed. This callpoint can be used to unreset i2c bus
2030 using CPU i2c controller register accesses for CPUs whose i2c
2031 controller provide such a method. It is called at the end of
2032 i2c_init() to allow i2c_init operations to setup the i2c bus
2033 controller on the CPU (e.g. setting bus speed & slave address).
2034
wdenk17ea1172004-06-06 21:51:03 +00002035 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2036
2037 This option enables configuration of bi_iic_fast[] flags
2038 in u-boot bd_info structure based on u-boot environment
2039 variable "i2cfast". (see also i2cfast)
2040
Ben Warrenbb99ad62006-09-07 16:50:54 -04002041 CONFIG_I2C_MULTI_BUS
2042
2043 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002044 must have a controller. At any point in time, only one bus is
2045 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002046 Note that bus numbering is zero-based.
2047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002048 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002049
2050 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002051 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002052 is set, specify a list of bus-device pairs. Otherwise, specify
2053 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002054
2055 e.g.
2056 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002057 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002058
2059 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2060
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002061 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002062 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002063
2064 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002066 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002067
2068 If defined, then this indicates the I2C bus number for DDR SPD.
2069 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002071 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002072
2073 If defined, then this indicates the I2C bus number for the RTC.
2074 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002076 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002077
2078 If defined, then this indicates the I2C bus number for the DTT.
2079 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002081 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002082
2083 If defined, specifies the I2C address of the DTT device.
2084 If not defined, then U-Boot uses predefined value for
2085 specified DTT device.
2086
Timur Tabibe5e6182006-11-03 19:15:00 -06002087 CONFIG_FSL_I2C
2088
2089 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002090 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002091
Heiko Schocher67b23a32008-10-15 09:39:47 +02002092 CONFIG_I2C_MUX
2093
2094 Define this option if you have I2C devices reached over 1 .. n
2095 I2C Muxes like the pca9544a. This option addes a new I2C
2096 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2097 new I2C Bus to the existing I2C Busses. If you select the
2098 new Bus with "i2c dev", u-bbot sends first the commandos for
2099 the muxes to activate this new "bus".
2100
2101 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2102 feature!
2103
2104 Example:
2105 Adding a new I2C Bus reached over 2 pca9544a muxes
2106 The First mux with address 70 and channel 6
2107 The Second mux with address 71 and channel 4
2108
2109 => i2c bus pca9544a:70:6:pca9544a:71:4
2110
2111 Use the "i2c bus" command without parameter, to get a list
2112 of I2C Busses with muxes:
2113
2114 => i2c bus
2115 Busses reached over muxes:
2116 Bus ID: 2
2117 reached over Mux(es):
2118 pca9544a@70 ch: 4
2119 Bus ID: 3
2120 reached over Mux(es):
2121 pca9544a@70 ch: 6
2122 pca9544a@71 ch: 4
2123 =>
2124
2125 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002126 u-boot first sends the command to the mux@70 to enable
2127 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002128 the channel 4.
2129
2130 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002131 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002132 the 2 muxes.
2133
2134 This option is actually implemented for the bitbanging
2135 algorithm in common/soft_i2c.c and for the Hardware I2C
2136 Bus on the MPC8260. But it should be not so difficult
2137 to add this option to other architectures.
2138
Andrew Dyer2ac69852008-12-29 17:36:01 -06002139 CONFIG_SOFT_I2C_READ_REPEATED_START
2140
2141 defining this will force the i2c_read() function in
2142 the soft_i2c driver to perform an I2C repeated start
2143 between writing the address pointer and reading the
2144 data. If this define is omitted the default behaviour
2145 of doing a stop-start sequence will be used. Most I2C
2146 devices can use either method, but some require one or
2147 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002148
wdenkc6097192002-11-03 00:24:07 +00002149- SPI Support: CONFIG_SPI
2150
2151 Enables SPI driver (so far only tested with
2152 SPI EEPROM, also an instance works with Crystal A/D and
2153 D/As on the SACSng board)
2154
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002155 CONFIG_SH_SPI
2156
2157 Enables the driver for SPI controller on SuperH. Currently
2158 only SH7757 is supported.
2159
wdenkc6097192002-11-03 00:24:07 +00002160 CONFIG_SPI_X
2161
2162 Enables extended (16-bit) SPI EEPROM addressing.
2163 (symmetrical to CONFIG_I2C_X)
2164
2165 CONFIG_SOFT_SPI
2166
wdenk43d96162003-03-06 00:02:04 +00002167 Enables a software (bit-bang) SPI driver rather than
2168 using hardware support. This is a general purpose
2169 driver that only requires three general I/O port pins
2170 (two outputs, one input) to function. If this is
2171 defined, the board configuration must define several
2172 SPI configuration items (port pins to use, etc). For
2173 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002174
Ben Warren04a9e112008-01-16 22:37:35 -05002175 CONFIG_HARD_SPI
2176
2177 Enables a hardware SPI driver for general-purpose reads
2178 and writes. As with CONFIG_SOFT_SPI, the board configuration
2179 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002180 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002181 example, see include/configs/mpc8349emds.h.
2182
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002183 CONFIG_MXC_SPI
2184
2185 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002186 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002187
Matthias Fuchs01335022007-12-27 17:12:34 +01002188- FPGA Support: CONFIG_FPGA
2189
2190 Enables FPGA subsystem.
2191
2192 CONFIG_FPGA_<vendor>
2193
2194 Enables support for specific chip vendors.
2195 (ALTERA, XILINX)
2196
2197 CONFIG_FPGA_<family>
2198
2199 Enables support for FPGA family.
2200 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2201
2202 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002203
wdenk43d96162003-03-06 00:02:04 +00002204 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002206 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002207
wdenk8bde7f72003-06-27 21:31:46 +00002208 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002210 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002211
wdenk43d96162003-03-06 00:02:04 +00002212 Enable checks on FPGA configuration interface busy
2213 status by the configuration function. This option
2214 will require a board or device specific function to
2215 be written.
wdenkc6097192002-11-03 00:24:07 +00002216
2217 CONFIG_FPGA_DELAY
2218
2219 If defined, a function that provides delays in the FPGA
2220 configuration driver.
2221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002222 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002223 Allow Control-C to interrupt FPGA configuration
2224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002225 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk43d96162003-03-06 00:02:04 +00002227 Check for configuration errors during FPGA bitfile
2228 loading. For example, abort during Virtex II
2229 configuration if the INIT_B line goes low (which
2230 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002232 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002233
wdenk43d96162003-03-06 00:02:04 +00002234 Maximum time to wait for the INIT_B line to deassert
2235 after PROB_B has been deasserted during a Virtex II
2236 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002237 ms.
wdenkc6097192002-11-03 00:24:07 +00002238
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002239 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002240
wdenk43d96162003-03-06 00:02:04 +00002241 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002242 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002244 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002245
wdenk43d96162003-03-06 00:02:04 +00002246 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002247 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002248
2249- Configuration Management:
2250 CONFIG_IDENT_STRING
2251
wdenk43d96162003-03-06 00:02:04 +00002252 If defined, this string will be added to the U-Boot
2253 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002254
2255- Vendor Parameter Protection:
2256
wdenk43d96162003-03-06 00:02:04 +00002257 U-Boot considers the values of the environment
2258 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002259 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002260 are set once by the board vendor / manufacturer, and
2261 protects these variables from casual modification by
2262 the user. Once set, these variables are read-only,
2263 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002264 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002265
2266 If CONFIG_ENV_OVERWRITE is #defined in your config
2267 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002268 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002269 these parameters.
2270
2271 Alternatively, if you #define _both_ CONFIG_ETHADDR
2272 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002273 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002274 which can be changed exactly ONCE by the user. [The
2275 serial# is unaffected by this, i. e. it remains
2276 read-only.]
2277
Joe Hershberger25980902012-12-11 22:16:31 -06002278 The same can be accomplished in a more flexible way
2279 for any variable by configuring the type of access
2280 to allow for those variables in the ".flags" variable
2281 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2282
wdenkc6097192002-11-03 00:24:07 +00002283- Protected RAM:
2284 CONFIG_PRAM
2285
2286 Define this variable to enable the reservation of
2287 "protected RAM", i. e. RAM which is not overwritten
2288 by U-Boot. Define CONFIG_PRAM to hold the number of
2289 kB you want to reserve for pRAM. You can overwrite
2290 this default value by defining an environment
2291 variable "pram" to the number of kB you want to
2292 reserve. Note that the board info structure will
2293 still show the full amount of RAM. If pRAM is
2294 reserved, a new environment variable "mem" will
2295 automatically be defined to hold the amount of
2296 remaining RAM in a form that can be passed as boot
2297 argument to Linux, for instance like that:
2298
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002299 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002300 saveenv
2301
2302 This way you can tell Linux not to use this memory,
2303 either, which results in a memory region that will
2304 not be affected by reboots.
2305
2306 *WARNING* If your board configuration uses automatic
2307 detection of the RAM size, you must make sure that
2308 this memory test is non-destructive. So far, the
2309 following board configurations are known to be
2310 "pRAM-clean":
2311
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002312 IVMS8, IVML24, SPD8xx, TQM8xxL,
2313 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002314 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002315
Gabe Black40fef042012-12-02 04:55:18 +00002316- Access to physical memory region (> 4GB)
2317 Some basic support is provided for operations on memory not
2318 normally accessible to U-Boot - e.g. some architectures
2319 support access to more than 4GB of memory on 32-bit
2320 machines using physical address extension or similar.
2321 Define CONFIG_PHYSMEM to access this basic support, which
2322 currently only supports clearing the memory.
2323
wdenkc6097192002-11-03 00:24:07 +00002324- Error Recovery:
2325 CONFIG_PANIC_HANG
2326
2327 Define this variable to stop the system in case of a
2328 fatal error, so that you have to reset it manually.
2329 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002330 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002331 automatically as fast as possible, but it may be
2332 useful during development since you can try to debug
2333 the conditions that lead to the situation.
2334
2335 CONFIG_NET_RETRY_COUNT
2336
wdenk43d96162003-03-06 00:02:04 +00002337 This variable defines the number of retries for
2338 network operations like ARP, RARP, TFTP, or BOOTP
2339 before giving up the operation. If not defined, a
2340 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002341
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002342 CONFIG_ARP_TIMEOUT
2343
2344 Timeout waiting for an ARP reply in milliseconds.
2345
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002346 CONFIG_NFS_TIMEOUT
2347
2348 Timeout in milliseconds used in NFS protocol.
2349 If you encounter "ERROR: Cannot umount" in nfs command,
2350 try longer timeout such as
2351 #define CONFIG_NFS_TIMEOUT 10000UL
2352
wdenkc6097192002-11-03 00:24:07 +00002353- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002354 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002355
2356 Enable auto completion of commands using TAB.
2357
Wolfgang Denka9398e02006-11-27 15:32:42 +01002358 Note that this feature has NOT been implemented yet
2359 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002360
2361
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002362 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002363
2364 Define this variable to enable the "hush" shell (from
2365 Busybox) as command line interpreter, thus enabling
2366 powerful command line syntax like
2367 if...then...else...fi conditionals or `&&' and '||'
2368 constructs ("shell scripts").
2369
2370 If undefined, you get the old, much simpler behaviour
2371 with a somewhat smaller memory footprint.
2372
2373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002374 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002375
2376 This defines the secondary prompt string, which is
2377 printed when the command interpreter needs more input
2378 to complete a command. Usually "> ".
2379
2380 Note:
2381
wdenk8bde7f72003-06-27 21:31:46 +00002382 In the current implementation, the local variables
2383 space and global environment variables space are
2384 separated. Local variables are those you define by
2385 simply typing `name=value'. To access a local
2386 variable later on, you have write `$name' or
2387 `${name}'; to execute the contents of a variable
2388 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002389
wdenk43d96162003-03-06 00:02:04 +00002390 Global environment variables are those you use
2391 setenv/printenv to work with. To run a command stored
2392 in such a variable, you need to use the run command,
2393 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002394
2395 To store commands and special characters in a
2396 variable, please use double quotation marks
2397 surrounding the whole text of the variable, instead
2398 of the backslashes before semicolons and special
2399 symbols.
2400
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002401- Commandline Editing and History:
2402 CONFIG_CMDLINE_EDITING
2403
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002404 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002405 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002406
wdenka8c7c702003-12-06 19:49:23 +00002407- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002408 CONFIG_EXTRA_ENV_SETTINGS
2409
wdenk43d96162003-03-06 00:02:04 +00002410 Define this to contain any number of null terminated
2411 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002412 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002413
wdenk43d96162003-03-06 00:02:04 +00002414 For example, place something like this in your
2415 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002416
2417 #define CONFIG_EXTRA_ENV_SETTINGS \
2418 "myvar1=value1\0" \
2419 "myvar2=value2\0"
2420
wdenk43d96162003-03-06 00:02:04 +00002421 Warning: This method is based on knowledge about the
2422 internal format how the environment is stored by the
2423 U-Boot code. This is NOT an official, exported
2424 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002425 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002426 You better know what you are doing here.
2427
wdenk43d96162003-03-06 00:02:04 +00002428 Note: overly (ab)use of the default environment is
2429 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002430 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002431 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002432
Stephen Warren5e724ca2012-05-22 09:21:54 +00002433 CONFIG_ENV_VARS_UBOOT_CONFIG
2434
2435 Define this in order to add variables describing the
2436 U-Boot build configuration to the default environment.
2437 These will be named arch, cpu, board, vendor, and soc.
2438
2439 Enabling this option will cause the following to be defined:
2440
2441 - CONFIG_SYS_ARCH
2442 - CONFIG_SYS_CPU
2443 - CONFIG_SYS_BOARD
2444 - CONFIG_SYS_VENDOR
2445 - CONFIG_SYS_SOC
2446
Tom Rini7e27f892012-10-24 07:28:16 +00002447 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2448
2449 Define this in order to add variables describing certain
2450 run-time determined information about the hardware to the
2451 environment. These will be named board_name, board_rev.
2452
Simon Glass06fd8532012-11-30 13:01:17 +00002453 CONFIG_DELAY_ENVIRONMENT
2454
2455 Normally the environment is loaded when the board is
2456 intialised so that it is available to U-Boot. This inhibits
2457 that so that the environment is not available until
2458 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2459 this is instead controlled by the value of
2460 /config/load-environment.
2461
wdenka8c7c702003-12-06 19:49:23 +00002462- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002463 CONFIG_HAS_DATAFLASH
2464
wdenk8bde7f72003-06-27 21:31:46 +00002465 Defining this option enables DataFlash features and
2466 allows to read/write in Dataflash via the standard
2467 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002468
Eric Nelsonf61ec452012-01-31 10:52:08 -07002469- Serial Flash support
2470 CONFIG_CMD_SF
2471
2472 Defining this option enables SPI flash commands
2473 'sf probe/read/write/erase/update'.
2474
2475 Usage requires an initial 'probe' to define the serial
2476 flash parameters, followed by read/write/erase/update
2477 commands.
2478
2479 The following defaults may be provided by the platform
2480 to handle the common case when only a single serial
2481 flash is present on the system.
2482
2483 CONFIG_SF_DEFAULT_BUS Bus identifier
2484 CONFIG_SF_DEFAULT_CS Chip-select
2485 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2486 CONFIG_SF_DEFAULT_SPEED in Hz
2487
Simon Glass24007272012-10-08 13:16:02 +00002488 CONFIG_CMD_SF_TEST
2489
2490 Define this option to include a destructive SPI flash
2491 test ('sf test').
2492
wdenk3f85ce22004-02-23 16:11:30 +00002493- SystemACE Support:
2494 CONFIG_SYSTEMACE
2495
2496 Adding this option adds support for Xilinx SystemACE
2497 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002498 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002500
2501 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002502 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002503
2504 When SystemACE support is added, the "ace" device type
2505 becomes available to the fat commands, i.e. fatls.
2506
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002507- TFTP Fixed UDP Port:
2508 CONFIG_TFTP_PORT
2509
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002510 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002511 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002512 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002513 number generator is used.
2514
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002515 Also, the environment variable tftpdstp is used to supply
2516 the TFTP UDP destination port value. If tftpdstp isn't
2517 defined, the normal port 69 is used.
2518
2519 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002520 blindly start the TFTP transfer using the pre-configured
2521 target IP address and UDP port. This has the effect of
2522 "punching through" the (Windows XP) firewall, allowing
2523 the remainder of the TFTP transfer to proceed normally.
2524 A better solution is to properly configure the firewall,
2525 but sometimes that is not allowed.
2526
Simon Glassbf36c5d2012-12-05 14:46:38 +00002527- Hashing support:
2528 CONFIG_CMD_HASH
2529
2530 This enables a generic 'hash' command which can produce
2531 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2532
2533 CONFIG_HASH_VERIFY
2534
2535 Enable the hash verify command (hash -v). This adds to code
2536 size a little.
2537
2538 CONFIG_SHA1 - support SHA1 hashing
2539 CONFIG_SHA256 - support SHA256 hashing
2540
2541 Note: There is also a sha1sum command, which should perhaps
2542 be deprecated in favour of 'hash sha1'.
2543
wdenka8c7c702003-12-06 19:49:23 +00002544- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002545 CONFIG_SHOW_BOOT_PROGRESS
2546
wdenk43d96162003-03-06 00:02:04 +00002547 Defining this option allows to add some board-
2548 specific code (calling a user-provided function
2549 "show_boot_progress(int)") that enables you to show
2550 the system's boot progress on some display (for
2551 example, some LED's) on your board. At the moment,
2552 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002553
Simon Glass3a608ca2012-02-13 13:51:19 +00002554- Detailed boot stage timing
2555 CONFIG_BOOTSTAGE
2556 Define this option to get detailed timing of each stage
2557 of the boot process.
2558
2559 CONFIG_BOOTSTAGE_USER_COUNT
2560 This is the number of available user bootstage records.
2561 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2562 a new ID will be allocated from this stash. If you exceed
2563 the limit, recording will stop.
2564
2565 CONFIG_BOOTSTAGE_REPORT
2566 Define this to print a report before boot, similar to this:
2567
2568 Timer summary in microseconds:
2569 Mark Elapsed Stage
2570 0 0 reset
2571 3,575,678 3,575,678 board_init_f start
2572 3,575,695 17 arch_cpu_init A9
2573 3,575,777 82 arch_cpu_init done
2574 3,659,598 83,821 board_init_r start
2575 3,910,375 250,777 main_loop
2576 29,916,167 26,005,792 bootm_start
2577 30,361,327 445,160 start_kernel
2578
Simon Glass2eba38c2012-09-28 08:56:39 +00002579 CONFIG_CMD_BOOTSTAGE
2580 Add a 'bootstage' command which supports printing a report
2581 and un/stashing of bootstage data.
2582
Simon Glass94fd1312012-09-28 08:56:37 +00002583 CONFIG_BOOTSTAGE_FDT
2584 Stash the bootstage information in the FDT. A root 'bootstage'
2585 node is created with each bootstage id as a child. Each child
2586 has a 'name' property and either 'mark' containing the
2587 mark time in microsecond, or 'accum' containing the
2588 accumulated time for that bootstage id in microseconds.
2589 For example:
2590
2591 bootstage {
2592 154 {
2593 name = "board_init_f";
2594 mark = <3575678>;
2595 };
2596 170 {
2597 name = "lcd";
2598 accum = <33482>;
2599 };
2600 };
2601
2602 Code in the Linux kernel can find this in /proc/devicetree.
2603
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002604Legacy uImage format:
2605
wdenkc6097192002-11-03 00:24:07 +00002606 Arg Where When
2607 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002608 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002609 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002610 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002611 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002612 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002613 4 common/cmd_bootm.c Image data has correct checksum
2614 -4 common/cmd_bootm.c Image is for unsupported architecture
2615 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002616 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002617 6 common/cmd_bootm.c Image Type check OK
2618 -6 common/cmd_bootm.c gunzip uncompression error
2619 -7 common/cmd_bootm.c Unimplemented compression type
2620 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002621 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002622 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002623
2624 9 common/image.c Start initial ramdisk verification
2625 -10 common/image.c Ramdisk header has bad magic number
2626 -11 common/image.c Ramdisk header has bad checksum
2627 10 common/image.c Ramdisk header is OK
2628 -12 common/image.c Ramdisk data has bad checksum
2629 11 common/image.c Ramdisk data has correct checksum
2630 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002631 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002632 13 common/image.c Start multifile image verification
2633 14 common/image.c No initial ramdisk, no multifile, continue.
2634
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002635 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002636
Stefan Roesea47a12b2010-04-15 16:07:28 +02002637 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002638 -31 post/post.c POST test failed, detected by post_output_backlog()
2639 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002640
Heiko Schocher566a4942007-06-22 19:11:54 +02002641 34 common/cmd_doc.c before loading a Image from a DOC device
2642 -35 common/cmd_doc.c Bad usage of "doc" command
2643 35 common/cmd_doc.c correct usage of "doc" command
2644 -36 common/cmd_doc.c No boot device
2645 36 common/cmd_doc.c correct boot device
2646 -37 common/cmd_doc.c Unknown Chip ID on boot device
2647 37 common/cmd_doc.c correct chip ID found, device available
2648 -38 common/cmd_doc.c Read Error on boot device
2649 38 common/cmd_doc.c reading Image header from DOC device OK
2650 -39 common/cmd_doc.c Image header has bad magic number
2651 39 common/cmd_doc.c Image header has correct magic number
2652 -40 common/cmd_doc.c Error reading Image from DOC device
2653 40 common/cmd_doc.c Image header has correct magic number
2654 41 common/cmd_ide.c before loading a Image from a IDE device
2655 -42 common/cmd_ide.c Bad usage of "ide" command
2656 42 common/cmd_ide.c correct usage of "ide" command
2657 -43 common/cmd_ide.c No boot device
2658 43 common/cmd_ide.c boot device found
2659 -44 common/cmd_ide.c Device not available
2660 44 common/cmd_ide.c Device available
2661 -45 common/cmd_ide.c wrong partition selected
2662 45 common/cmd_ide.c partition selected
2663 -46 common/cmd_ide.c Unknown partition table
2664 46 common/cmd_ide.c valid partition table found
2665 -47 common/cmd_ide.c Invalid partition type
2666 47 common/cmd_ide.c correct partition type
2667 -48 common/cmd_ide.c Error reading Image Header on boot device
2668 48 common/cmd_ide.c reading Image Header from IDE device OK
2669 -49 common/cmd_ide.c Image header has bad magic number
2670 49 common/cmd_ide.c Image header has correct magic number
2671 -50 common/cmd_ide.c Image header has bad checksum
2672 50 common/cmd_ide.c Image header has correct checksum
2673 -51 common/cmd_ide.c Error reading Image from IDE device
2674 51 common/cmd_ide.c reading Image from IDE device OK
2675 52 common/cmd_nand.c before loading a Image from a NAND device
2676 -53 common/cmd_nand.c Bad usage of "nand" command
2677 53 common/cmd_nand.c correct usage of "nand" command
2678 -54 common/cmd_nand.c No boot device
2679 54 common/cmd_nand.c boot device found
2680 -55 common/cmd_nand.c Unknown Chip ID on boot device
2681 55 common/cmd_nand.c correct chip ID found, device available
2682 -56 common/cmd_nand.c Error reading Image Header on boot device
2683 56 common/cmd_nand.c reading Image Header from NAND device OK
2684 -57 common/cmd_nand.c Image header has bad magic number
2685 57 common/cmd_nand.c Image header has correct magic number
2686 -58 common/cmd_nand.c Error reading Image from NAND device
2687 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002688
Heiko Schocher566a4942007-06-22 19:11:54 +02002689 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002690
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002691 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002692 -64 net/eth.c no Ethernet found.
2693 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002694
Heiko Schocher566a4942007-06-22 19:11:54 +02002695 -80 common/cmd_net.c usage wrong
2696 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002697 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002698 81 common/cmd_net.c NetLoop() back without error
2699 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2700 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002701 83 common/cmd_net.c running "source" command
2702 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002703 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002704
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002705FIT uImage format:
2706
2707 Arg Where When
2708 100 common/cmd_bootm.c Kernel FIT Image has correct format
2709 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2710 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2711 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2712 102 common/cmd_bootm.c Kernel unit name specified
2713 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002714 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002715 104 common/cmd_bootm.c Got kernel subimage node offset
2716 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2717 105 common/cmd_bootm.c Kernel subimage hash verification OK
2718 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2719 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002720 -106 common/cmd_bootm.c Kernel subimage has wrong type
2721 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002722 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2723 108 common/cmd_bootm.c Got kernel subimage data/size
2724 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2725 -109 common/cmd_bootm.c Can't get kernel subimage type
2726 -110 common/cmd_bootm.c Can't get kernel subimage comp
2727 -111 common/cmd_bootm.c Can't get kernel subimage os
2728 -112 common/cmd_bootm.c Can't get kernel subimage load address
2729 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2730
2731 120 common/image.c Start initial ramdisk verification
2732 -120 common/image.c Ramdisk FIT image has incorrect format
2733 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002734 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002735 -122 common/image.c Can't get configuration for ramdisk subimage
2736 123 common/image.c Ramdisk unit name specified
2737 -124 common/image.c Can't get ramdisk subimage node offset
2738 125 common/image.c Got ramdisk subimage node offset
2739 -125 common/image.c Ramdisk subimage hash verification failed
2740 126 common/image.c Ramdisk subimage hash verification OK
2741 -126 common/image.c Ramdisk subimage for unsupported architecture
2742 127 common/image.c Architecture check OK
2743 -127 common/image.c Can't get ramdisk subimage data/size
2744 128 common/image.c Got ramdisk subimage data/size
2745 129 common/image.c Can't get ramdisk load address
2746 -129 common/image.c Got ramdisk load address
2747
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002748 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002749 131 common/cmd_doc.c FIT image format OK
2750
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002751 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002752 141 common/cmd_ide.c FIT image format OK
2753
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002754 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002755 151 common/cmd_nand.c FIT image format OK
2756
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002757- FIT image support:
2758 CONFIG_FIT
2759 Enable support for the FIT uImage format.
2760
2761 CONFIG_FIT_BEST_MATCH
2762 When no configuration is explicitly selected, default to the
2763 one whose fdt's compatibility field best matches that of
2764 U-Boot itself. A match is considered "best" if it matches the
2765 most specific compatibility entry of U-Boot's fdt's root node.
2766 The order of entries in the configuration's fdt is ignored.
2767
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002768- Standalone program support:
2769 CONFIG_STANDALONE_LOAD_ADDR
2770
Wolfgang Denk6feff892011-10-09 21:06:34 +02002771 This option defines a board specific value for the
2772 address where standalone program gets loaded, thus
2773 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002774 settings.
2775
2776- Frame Buffer Address:
2777 CONFIG_FB_ADDR
2778
2779 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002780 address for frame buffer. This is typically the case
2781 when using a graphics controller has separate video
2782 memory. U-Boot will then place the frame buffer at
2783 the given address instead of dynamically reserving it
2784 in system RAM by calling lcd_setmem(), which grabs
2785 the memory for the frame buffer depending on the
2786 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002787
2788 Please see board_init_f function.
2789
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002790- Automatic software updates via TFTP server
2791 CONFIG_UPDATE_TFTP
2792 CONFIG_UPDATE_TFTP_CNT_MAX
2793 CONFIG_UPDATE_TFTP_MSEC_MAX
2794
2795 These options enable and control the auto-update feature;
2796 for a more detailed description refer to doc/README.update.
2797
2798- MTD Support (mtdparts command, UBI support)
2799 CONFIG_MTD_DEVICE
2800
2801 Adds the MTD device infrastructure from the Linux kernel.
2802 Needed for mtdparts command support.
2803
2804 CONFIG_MTD_PARTITIONS
2805
2806 Adds the MTD partitioning infrastructure from the Linux
2807 kernel. Needed for UBI support.
2808
Joe Hershberger70c219c2013-04-08 10:32:48 +00002809- UBI support
2810 CONFIG_CMD_UBI
2811
2812 Adds commands for interacting with MTD partitions formatted
2813 with the UBI flash translation layer
2814
2815 Requires also defining CONFIG_RBTREE
2816
Joe Hershberger147162d2013-04-08 10:32:49 +00002817 CONFIG_UBI_SILENCE_MSG
2818
2819 Make the verbose messages from UBI stop printing. This leaves
2820 warnings and errors enabled.
2821
Joe Hershberger70c219c2013-04-08 10:32:48 +00002822- UBIFS support
2823 CONFIG_CMD_UBIFS
2824
2825 Adds commands for interacting with UBI volumes formatted as
2826 UBIFS. UBIFS is read-only in u-boot.
2827
2828 Requires UBI support as well as CONFIG_LZO
2829
Joe Hershberger147162d2013-04-08 10:32:49 +00002830 CONFIG_UBIFS_SILENCE_MSG
2831
2832 Make the verbose messages from UBIFS stop printing. This leaves
2833 warnings and errors enabled.
2834
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002835- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002836 CONFIG_SPL
2837 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002838
Tom Rini95579792012-02-14 07:29:40 +00002839 CONFIG_SPL_LDSCRIPT
2840 LDSCRIPT for linking the SPL binary.
2841
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002842 CONFIG_SPL_MAX_FOOTPRINT
2843 Maximum size in memory allocated to the SPL, BSS included.
2844 When defined, the linker checks that the actual memory
2845 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002846 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002847 must not be both defined at the same time.
2848
Tom Rini95579792012-02-14 07:29:40 +00002849 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002850 Maximum size of the SPL image (text, data, rodata, and
2851 linker lists sections), BSS excluded.
2852 When defined, the linker checks that the actual size does
2853 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002854
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002855 CONFIG_SPL_TEXT_BASE
2856 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002857
Scott Wood94a45bb2012-09-20 19:05:12 -05002858 CONFIG_SPL_RELOC_TEXT_BASE
2859 Address to relocate to. If unspecified, this is equal to
2860 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2861
Tom Rini95579792012-02-14 07:29:40 +00002862 CONFIG_SPL_BSS_START_ADDR
2863 Link address for the BSS within the SPL binary.
2864
2865 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002866 Maximum size in memory allocated to the SPL BSS.
2867 When defined, the linker checks that the actual memory used
2868 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002869 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002870 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002871
2872 CONFIG_SPL_STACK
2873 Adress of the start of the stack SPL will use
2874
Scott Wood94a45bb2012-09-20 19:05:12 -05002875 CONFIG_SPL_RELOC_STACK
2876 Adress of the start of the stack SPL will use after
2877 relocation. If unspecified, this is equal to
2878 CONFIG_SPL_STACK.
2879
Tom Rini95579792012-02-14 07:29:40 +00002880 CONFIG_SYS_SPL_MALLOC_START
2881 Starting address of the malloc pool used in SPL.
2882
2883 CONFIG_SYS_SPL_MALLOC_SIZE
2884 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002885
Tom Rini47f7bca2012-08-13 12:03:19 -07002886 CONFIG_SPL_FRAMEWORK
2887 Enable the SPL framework under common/. This framework
2888 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2889 NAND loading of the Linux Kernel.
2890
Tom Rini861a86f2012-08-13 11:37:56 -07002891 CONFIG_SPL_DISPLAY_PRINT
2892 For ARM, enable an optional function to print more information
2893 about the running system.
2894
Scott Wood4b919722012-09-20 16:35:21 -05002895 CONFIG_SPL_INIT_MINIMAL
2896 Arch init code should be built for a very small image
2897
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002898 CONFIG_SPL_LIBCOMMON_SUPPORT
2899 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002900
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002901 CONFIG_SPL_LIBDISK_SUPPORT
2902 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002903
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002904 CONFIG_SPL_I2C_SUPPORT
2905 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002906
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002907 CONFIG_SPL_GPIO_SUPPORT
2908 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002909
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002910 CONFIG_SPL_MMC_SUPPORT
2911 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002912
Tom Rini95579792012-02-14 07:29:40 +00002913 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2914 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2915 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2916 Address, size and partition on the MMC to load U-Boot from
2917 when the MMC is being used in raw mode.
2918
2919 CONFIG_SPL_FAT_SUPPORT
2920 Support for fs/fat/libfat.o in SPL binary
2921
2922 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2923 Filename to read to load U-Boot when reading from FAT
2924
Scott Wood06f60ae2012-12-06 13:33:17 +00002925 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2926 Set this for NAND SPL on PPC mpc83xx targets, so that
2927 start.S waits for the rest of the SPL to load before
2928 continuing (the hardware starts execution after just
2929 loading the first page rather than the full 4K).
2930
Scott Wood6f2f01b2012-09-20 19:09:07 -05002931 CONFIG_SPL_NAND_BASE
2932 Include nand_base.c in the SPL. Requires
2933 CONFIG_SPL_NAND_DRIVERS.
2934
2935 CONFIG_SPL_NAND_DRIVERS
2936 SPL uses normal NAND drivers, not minimal drivers.
2937
2938 CONFIG_SPL_NAND_ECC
2939 Include standard software ECC in the SPL
2940
Tom Rini95579792012-02-14 07:29:40 +00002941 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002942 Support for NAND boot using simple NAND drivers that
2943 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002944
2945 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2946 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2947 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2948 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2949 CONFIG_SYS_NAND_ECCBYTES
2950 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002951 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002952
2953 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002954 Location in NAND to read U-Boot from
2955
2956 CONFIG_SYS_NAND_U_BOOT_DST
2957 Location in memory to load U-Boot to
2958
2959 CONFIG_SYS_NAND_U_BOOT_SIZE
2960 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002961
2962 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002963 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002964
2965 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2966 Define this if you need to first read the OOB and then the
2967 data. This is used for example on davinci plattforms.
2968
2969 CONFIG_SPL_OMAP3_ID_NAND
2970 Support for an OMAP3-specific set of functions to return the
2971 ID and MFR of the first attached NAND chip, if present.
2972
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002973 CONFIG_SPL_SERIAL_SUPPORT
2974 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002975
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002976 CONFIG_SPL_SPI_FLASH_SUPPORT
2977 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002978
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002979 CONFIG_SPL_SPI_SUPPORT
2980 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002981
Pavel Machekc57b9532012-08-30 22:42:11 +02002982 CONFIG_SPL_RAM_DEVICE
2983 Support for running image already present in ram, in SPL binary
2984
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002985 CONFIG_SPL_LIBGENERIC_SUPPORT
2986 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002987
Scott Wood74752ba2012-12-06 13:33:16 +00002988 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00002989 Image offset to which the SPL should be padded before appending
2990 the SPL payload. By default, this is defined as
2991 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2992 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2993 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00002994
Scott Woodca2fca22012-09-21 16:27:32 -05002995 CONFIG_SPL_TARGET
2996 Final target image containing SPL and payload. Some SPLs
2997 use an arch-specific makefile fragment instead, for
2998 example if more than one image needs to be produced.
2999
Simon Glass87ebee32013-05-08 08:05:59 +00003000 CONFIG_FIT_SPL_PRINT
3001 Printing information about a FIT image adds quite a bit of
3002 code to SPL. So this is normally disabled in SPL. Use this
3003 option to re-enable it. This will affect the output of the
3004 bootm command when booting a FIT image.
3005
wdenkc6097192002-11-03 00:24:07 +00003006Modem Support:
3007--------------
3008
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003009[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003010
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003011- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003012 CONFIG_MODEM_SUPPORT
3013
3014- RTS/CTS Flow control enable:
3015 CONFIG_HWFLOW
3016
3017- Modem debug support:
3018 CONFIG_MODEM_SUPPORT_DEBUG
3019
wdenk43d96162003-03-06 00:02:04 +00003020 Enables debugging stuff (char screen[1024], dbg())
3021 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003022
wdenka8c7c702003-12-06 19:49:23 +00003023- Interrupt support (PPC):
3024
wdenkd4ca31c2004-01-02 14:00:00 +00003025 There are common interrupt_init() and timer_interrupt()
3026 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003027 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003028 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003029 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003030 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003031 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003032 specific handling. If board has watchdog / status_led
3033 / other_activity_monitor it works automatically from
3034 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003035
wdenkc6097192002-11-03 00:24:07 +00003036- General:
3037
wdenk43d96162003-03-06 00:02:04 +00003038 In the target system modem support is enabled when a
3039 specific key (key combination) is pressed during
3040 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003041 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003042 board_init(). Currently key_pressed() is a dummy
3043 function, returning 1 and thus enabling modem
3044 initialization.
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk43d96162003-03-06 00:02:04 +00003046 If there are no modem init strings in the
3047 environment, U-Boot proceed to autoboot; the
3048 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003049 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003050
3051 See also: doc/README.Modem
3052
Helmut Raiger9660e442011-10-20 04:19:47 +00003053Board initialization settings:
3054------------------------------
3055
3056During Initialization u-boot calls a number of board specific functions
3057to allow the preparation of board specific prerequisites, e.g. pin setup
3058before drivers are initialized. To enable these callbacks the
3059following configuration macros have to be defined. Currently this is
3060architecture specific, so please check arch/your_architecture/lib/board.c
3061typically in board_init_f() and board_init_r().
3062
3063- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3064- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3065- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3066- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003067
wdenkc6097192002-11-03 00:24:07 +00003068Configuration Settings:
3069-----------------------
3070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003071- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003072 undefine this when you're short of memory.
3073
Peter Tyser2fb26042009-01-27 18:03:12 -06003074- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3075 width of the commands listed in the 'help' command output.
3076
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003077- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003078 prompt for user input.
3079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003080- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003081
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003082- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003083
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003085
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003086- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003087 the application (usually a Linux kernel) when it is
3088 booted
3089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003090- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003091 List of legal baudrate settings for this board.
3092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003093- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003094 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003095
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003096- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003097 If the board specific function
3098 extern int overwrite_console (void);
3099 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003100 serial port, else the settings in the environment are used.
3101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003102- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003103 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003104
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003105- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003106 Enable overwrite of previous console environment settings.
3107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003108- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003109 Begin and End addresses of the area used by the
3110 simple memory test.
3111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003113 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003116 Scratch address used by the alternate memory test
3117 You only need to set this if address zero isn't writeable
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3120 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003121 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003122 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003123 fixing up gd->ram_size the Linux kernel should gets passed
3124 the now "corrected" memory size and won't touch it either.
3125 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003126 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003127 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003128 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003129
3130 This option can be used as a workaround for the 440EPx/GRx
3131 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3132 be touched.
3133
3134 WARNING: Please make sure that this value is a multiple of
3135 the Linux page size (normally 4k). If this is not the case,
3136 then the end address of the Linux memory will be located at a
3137 non page size aligned address and this could cause major
3138 problems.
3139
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003140- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003141 Enable temporary baudrate change while serial download
3142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003143- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003144 Physical start address of SDRAM. _Must_ be 0 here.
3145
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003146- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003147 Physical start address of Motherboard I/O (if using a
3148 Cogent motherboard)
3149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003150- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003151 Physical start address of Flash memory.
3152
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003153- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003154 Physical start address of boot monitor code (set by
3155 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003156 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003157 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003158
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003159- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003160 Size of memory reserved for monitor code, used to
3161 determine _at_compile_time_ (!) if the environment is
3162 embedded within the U-Boot image, or in a separate
3163 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003165- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003166 Size of DRAM reserved for malloc() use.
3167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003168- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003169 Normally compressed uImages are limited to an
3170 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003171 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003172 to adjust this setting to your needs.
3173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003174- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003175 Maximum size of memory mapped by the startup code of
3176 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003177 the Linux kernel (bd_info, boot arguments, FDT blob if
3178 used) must be put below this limit, unless "bootm_low"
3179 enviroment variable is defined and non-zero. In such case
3180 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003181 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003182 variable "bootm_mapsize" will override the value of
3183 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3184 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003185
John Rigbyfca43cc2010-10-13 13:57:35 -06003186- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3187 Enable initrd_high functionality. If defined then the
3188 initrd_high feature is enabled and the bootm ramdisk subcommand
3189 is enabled.
3190
3191- CONFIG_SYS_BOOT_GET_CMDLINE:
3192 Enables allocating and saving kernel cmdline in space between
3193 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3194
3195- CONFIG_SYS_BOOT_GET_KBD:
3196 Enables allocating and saving a kernel copy of the bd_info in
3197 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003199- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003200 Max number of Flash memory banks
3201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003202- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003203 Max number of sectors on a Flash chip
3204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003205- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003206 Timeout for Flash erase operations (in ms)
3207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003208- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003209 Timeout for Flash write operations (in ms)
3210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003211- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003212 Timeout for Flash set sector lock bit operation (in ms)
3213
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003214- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003215 Timeout for Flash clear lock bits operation (in ms)
3216
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003217- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003218 If defined, hardware flash sectors protection is used
3219 instead of U-Boot software protection.
3220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003221- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003222
3223 Enable TFTP transfers directly to flash memory;
3224 without this option such a download has to be
3225 performed in two steps: (1) download to RAM, and (2)
3226 copy from RAM to flash.
3227
3228 The two-step approach is usually more reliable, since
3229 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003230 the flash, but in some situations (when system RAM is
3231 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003232 downloaded image) this option may be very useful.
3233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003235 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003236 common flash structure for storing flash geometry.
3237
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003238- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003239 This option also enables the building of the cfi_flash driver
3240 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003241
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003242- CONFIG_FLASH_CFI_MTD
3243 This option enables the building of the cfi_mtd driver
3244 in the drivers directory. The driver exports CFI flash
3245 to the MTD layer.
3246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003247- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003248 Use buffered writes to flash.
3249
3250- CONFIG_FLASH_SPANSION_S29WS_N
3251 s29ws-n MirrorBit flash has non-standard addresses for buffered
3252 write commands.
3253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003254- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003255 If this option is defined, the common CFI flash doesn't
3256 print it's warning upon not recognized FLASH banks. This
3257 is useful, if some of the configured banks are only
3258 optionally available.
3259
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003260- CONFIG_FLASH_SHOW_PROGRESS
3261 If defined (must be an integer), print out countdown
3262 digits and dots. Recommended value: 45 (9..1) for 80
3263 column displays, 15 (3..1) for 40 column displays.
3264
Stefan Roese352ef3f2013-04-04 15:53:14 +02003265- CONFIG_FLASH_VERIFY
3266 If defined, the content of the flash (destination) is compared
3267 against the source after the write operation. An error message
3268 will be printed when the contents are not identical.
3269 Please note that this option is useless in nearly all cases,
3270 since such flash programming errors usually are detected earlier
3271 while unprotecting/erasing/programming. Please only enable
3272 this option if you really know what you are doing.
3273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003274- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003275 Defines the number of Ethernet receive buffers. On some
3276 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003277 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3278 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003279 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003280 Defaults to 4 if not defined.
3281
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003282- CONFIG_ENV_MAX_ENTRIES
3283
Wolfgang Denk071bc922010-10-27 22:48:30 +02003284 Maximum number of entries in the hash table that is used
3285 internally to store the environment settings. The default
3286 setting is supposed to be generous and should work in most
3287 cases. This setting can be used to tune behaviour; see
3288 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003289
Joe Hershberger25980902012-12-11 22:16:31 -06003290- CONFIG_ENV_FLAGS_LIST_DEFAULT
3291- CONFIG_ENV_FLAGS_LIST_STATIC
3292 Enable validation of the values given to enviroment variables when
3293 calling env set. Variables can be restricted to only decimal,
3294 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3295 the variables can also be restricted to IP address or MAC address.
3296
3297 The format of the list is:
3298 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003299 access_atribute = [a|r|o|c]
3300 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003301 entry = variable_name[:attributes]
3302 list = entry[,list]
3303
3304 The type attributes are:
3305 s - String (default)
3306 d - Decimal
3307 x - Hexadecimal
3308 b - Boolean ([1yYtT|0nNfF])
3309 i - IP address
3310 m - MAC address
3311
Joe Hershberger267541f2012-12-11 22:16:34 -06003312 The access attributes are:
3313 a - Any (default)
3314 r - Read-only
3315 o - Write-once
3316 c - Change-default
3317
Joe Hershberger25980902012-12-11 22:16:31 -06003318 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3319 Define this to a list (string) to define the ".flags"
3320 envirnoment variable in the default or embedded environment.
3321
3322 - CONFIG_ENV_FLAGS_LIST_STATIC
3323 Define this to a list (string) to define validation that
3324 should be done if an entry is not found in the ".flags"
3325 environment variable. To override a setting in the static
3326 list, simply add an entry for the same variable name to the
3327 ".flags" variable.
3328
Joe Hershberger267541f2012-12-11 22:16:34 -06003329- CONFIG_ENV_ACCESS_IGNORE_FORCE
3330 If defined, don't allow the -f switch to env set override variable
3331 access flags.
3332
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003333- CONFIG_SYS_GENERIC_BOARD
3334 This selects the architecture-generic board system instead of the
3335 architecture-specific board files. It is intended to move boards
3336 to this new framework over time. Defining this will disable the
3337 arch/foo/lib/board.c file and use common/board_f.c and
3338 common/board_r.c instead. To use this option your architecture
3339 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3340 its config.mk file). If you find problems enabling this option on
3341 your board please report the problem and send patches!
3342
Simon Glass632efa72013-03-11 07:06:48 +00003343- CONFIG_SYS_SYM_OFFSETS
3344 This is set by architectures that use offsets for link symbols
3345 instead of absolute values. So bss_start is obtained using an
3346 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3347 directly. You should not need to touch this setting.
3348
3349
wdenkc6097192002-11-03 00:24:07 +00003350The following definitions that deal with the placement and management
3351of environment data (variable area); in general, we support the
3352following configurations:
3353
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003354- CONFIG_BUILD_ENVCRC:
3355
3356 Builds up envcrc with the target environment so that external utils
3357 may easily extract it and embed it in final U-Boot images.
3358
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003359- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003360
3361 Define this if the environment is in flash memory.
3362
3363 a) The environment occupies one whole flash sector, which is
3364 "embedded" in the text segment with the U-Boot code. This
3365 happens usually with "bottom boot sector" or "top boot
3366 sector" type flash chips, which have several smaller
3367 sectors at the start or the end. For instance, such a
3368 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3369 such a case you would place the environment in one of the
3370 4 kB sectors - with U-Boot code before and after it. With
3371 "top boot sector" type flash chips, you would put the
3372 environment in one of the last sectors, leaving a gap
3373 between U-Boot and the environment.
3374
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003375 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003376
3377 Offset of environment data (variable area) to the
3378 beginning of flash memory; for instance, with bottom boot
3379 type flash chips the second sector can be used: the offset
3380 for this sector is given here.
3381
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003382 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003383
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003384 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003385
3386 This is just another way to specify the start address of
3387 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003388 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003389
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003390 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003391
3392 Size of the sector containing the environment.
3393
3394
3395 b) Sometimes flash chips have few, equal sized, BIG sectors.
3396 In such a case you don't want to spend a whole sector for
3397 the environment.
3398
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003399 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003400
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003401 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003402 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003403 of this flash sector for the environment. This saves
3404 memory for the RAM copy of the environment.
3405
3406 It may also save flash memory if you decide to use this
3407 when your environment is "embedded" within U-Boot code,
3408 since then the remainder of the flash sector could be used
3409 for U-Boot code. It should be pointed out that this is
3410 STRONGLY DISCOURAGED from a robustness point of view:
3411 updating the environment in flash makes it always
3412 necessary to erase the WHOLE sector. If something goes
3413 wrong before the contents has been restored from a copy in
3414 RAM, your target system will be dead.
3415
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003416 - CONFIG_ENV_ADDR_REDUND
3417 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk43d96162003-03-06 00:02:04 +00003419 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003420 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003421 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003422 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003423
3424BE CAREFUL! Any changes to the flash layout, and some changes to the
3425source code will make it necessary to adapt <board>/u-boot.lds*
3426accordingly!
3427
3428
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003429- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003430
3431 Define this if you have some non-volatile memory device
3432 (NVRAM, battery buffered SRAM) which you want to use for the
3433 environment.
3434
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003435 - CONFIG_ENV_ADDR:
3436 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003437
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003438 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003439 want to use for environment. It is assumed that this memory
3440 can just be read and written to, without any special
3441 provision.
3442
3443BE CAREFUL! The first access to the environment happens quite early
3444in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003445console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003446U-Boot will hang.
3447
3448Please note that even with NVRAM we still use a copy of the
3449environment in RAM: we could work on NVRAM directly, but we want to
3450keep settings there always unmodified except somebody uses "saveenv"
3451to save the current settings.
3452
3453
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003454- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003455
3456 Use this if you have an EEPROM or similar serial access
3457 device and a driver for it.
3458
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003459 - CONFIG_ENV_OFFSET:
3460 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003461
3462 These two #defines specify the offset and size of the
3463 environment area within the total memory of your EEPROM.
3464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003465 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003466 If defined, specified the chip address of the EEPROM device.
3467 The default address is zero.
3468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003469 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003470 If defined, the number of bits used to address bytes in a
3471 single page in the EEPROM device. A 64 byte page, for example
3472 would require six bits.
3473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003474 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003475 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003476 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003478 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003479 The length in bytes of the EEPROM memory array address. Note
3480 that this is NOT the chip address length!
3481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003482 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003483 EEPROM chips that implement "address overflow" are ones
3484 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3485 address and the extra bits end up in the "chip address" bit
3486 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3487 byte chips.
3488
3489 Note that we consider the length of the address field to
3490 still be one byte because the extra address bits are hidden
3491 in the chip address.
3492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003493 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003494 The size in bytes of the EEPROM device.
3495
Heiko Schocher548738b2010-01-07 08:55:40 +01003496 - CONFIG_ENV_EEPROM_IS_ON_I2C
3497 define this, if you have I2C and SPI activated, and your
3498 EEPROM, which holds the environment, is on the I2C bus.
3499
3500 - CONFIG_I2C_ENV_EEPROM_BUS
3501 if you have an Environment on an EEPROM reached over
3502 I2C muxes, you can define here, how to reach this
3503 EEPROM. For example:
3504
Wolfgang Denka9046b92010-06-13 17:48:15 +02003505 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003506
3507 EEPROM which holds the environment, is reached over
3508 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003509
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003510- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003511
wdenkd4ca31c2004-01-02 14:00:00 +00003512 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003513 want to use for the environment.
3514
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003515 - CONFIG_ENV_OFFSET:
3516 - CONFIG_ENV_ADDR:
3517 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003518
3519 These three #defines specify the offset and size of the
3520 environment area within the total memory of your DataFlash placed
3521 at the specified address.
3522
Liu Gang0a85a9e2012-03-08 00:33:20 +00003523- CONFIG_ENV_IS_IN_REMOTE:
3524
3525 Define this if you have a remote memory space which you
3526 want to use for the local device's environment.
3527
3528 - CONFIG_ENV_ADDR:
3529 - CONFIG_ENV_SIZE:
3530
3531 These two #defines specify the address and size of the
3532 environment area within the remote memory space. The
3533 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003534 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003535
3536BE CAREFUL! For some special cases, the local device can not use
3537"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003538environment stored in a remote NOR flash by SRIO or PCIE link,
3539but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003540
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003541- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003542
3543 Define this if you have a NAND device which you want to use
3544 for the environment.
3545
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003546 - CONFIG_ENV_OFFSET:
3547 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003548
3549 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003550 area within the first NAND device. CONFIG_ENV_OFFSET must be
3551 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003552
Scott Woodfdd813d2010-09-17 14:38:37 -05003553 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003554
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003555 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003556 size used to hold a redundant copy of the environment data, so
3557 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003558 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003559 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003560
Scott Woodfdd813d2010-09-17 14:38:37 -05003561 - CONFIG_ENV_RANGE (optional):
3562
3563 Specifies the length of the region in which the environment
3564 can be written. This should be a multiple of the NAND device's
3565 block size. Specifying a range with more erase blocks than
3566 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3567 the range to be avoided.
3568
3569 - CONFIG_ENV_OFFSET_OOB (optional):
3570
3571 Enables support for dynamically retrieving the offset of the
3572 environment from block zero's out-of-band data. The
3573 "nand env.oob" command can be used to record this offset.
3574 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3575 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003576
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003577- CONFIG_NAND_ENV_DST
3578
3579 Defines address in RAM to which the nand_spl code should copy the
3580 environment. If redundant environment is used, it will be copied to
3581 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3582
Joe Hershberger2b744332013-04-08 10:32:51 +00003583- CONFIG_ENV_IS_IN_UBI:
3584
3585 Define this if you have an UBI volume that you want to use for the
3586 environment. This has the benefit of wear-leveling the environment
3587 accesses, which is important on NAND.
3588
3589 - CONFIG_ENV_UBI_PART:
3590
3591 Define this to a string that is the mtd partition containing the UBI.
3592
3593 - CONFIG_ENV_UBI_VOLUME:
3594
3595 Define this to the name of the volume that you want to store the
3596 environment in.
3597
Joe Hershberger785881f2013-04-08 10:32:52 +00003598 - CONFIG_ENV_UBI_VOLUME_REDUND:
3599
3600 Define this to the name of another volume to store a second copy of
3601 the environment in. This will enable redundant environments in UBI.
3602 It is assumed that both volumes are in the same MTD partition.
3603
Joe Hershberger2b744332013-04-08 10:32:51 +00003604 - CONFIG_UBI_SILENCE_MSG
3605 - CONFIG_UBIFS_SILENCE_MSG
3606
3607 You will probably want to define these to avoid a really noisy system
3608 when storing the env in UBI.
3609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003610- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003611
3612 Defines offset to the initial SPI buffer area in DPRAM. The
3613 area is used at an early stage (ROM part) if the environment
3614 is configured to reside in the SPI EEPROM: We need a 520 byte
3615 scratch DPRAM area. It is used between the two initialization
3616 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3617 to be a good choice since it makes it far enough from the
3618 start of the data area as well as from the stack pointer.
3619
Bruce Adlere881cb52007-11-02 13:15:42 -07003620Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003621has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003622created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003623until then to read environment variables.
3624
wdenk85ec0bc2003-03-31 16:34:49 +00003625The environment is protected by a CRC32 checksum. Before the monitor
3626is relocated into RAM, as a result of a bad CRC you will be working
3627with the compiled-in default environment - *silently*!!! [This is
3628necessary, because the first environment variable we need is the
3629"baudrate" setting for the console - if we have a bad CRC, we don't
3630have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003631
3632Note: once the monitor has been relocated, then it will complain if
3633the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003634use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003636- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003637 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003639 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003640 also needs to be defined.
3641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003642- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003643 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003644
Ron Madridf5675aa2009-02-18 14:30:44 -08003645- CONFIG_NS16550_MIN_FUNCTIONS:
3646 Define this if you desire to only have use of the NS16550_init
3647 and NS16550_putc functions for the serial driver located at
3648 drivers/serial/ns16550.c. This option is useful for saving
3649 space for already greatly restricted images, including but not
3650 limited to NAND_SPL configurations.
3651
Simon Glassb2b92f52012-11-30 13:01:18 +00003652- CONFIG_DISPLAY_BOARDINFO
3653 Display information about the board that U-Boot is running on
3654 when U-Boot starts up. The board function checkboard() is called
3655 to do this.
3656
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003657- CONFIG_DISPLAY_BOARDINFO_LATE
3658 Similar to the previous option, but display this information
3659 later, once stdio is running and output goes to the LCD, if
3660 present.
3661
wdenkc6097192002-11-03 00:24:07 +00003662Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003663---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003665- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003666 Cache Line Size of the CPU.
3667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003668- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003669 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003670
wdenk42d1f032003-10-15 23:53:47 +00003671 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3672 and RPXsuper) to be able to adjust the position of
3673 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003674
Timur Tabie46fedf2011-08-04 18:03:41 -05003675- CONFIG_SYS_CCSRBAR_DEFAULT:
3676 Default (power-on reset) physical address of CCSR on Freescale
3677 PowerPC SOCs.
3678
3679- CONFIG_SYS_CCSRBAR:
3680 Virtual address of CCSR. On a 32-bit build, this is typically
3681 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3682
3683 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3684 for cross-platform code that uses that macro instead.
3685
3686- CONFIG_SYS_CCSRBAR_PHYS:
3687 Physical address of CCSR. CCSR can be relocated to a new
3688 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003689 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003690 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3691 is typically relocated on 36-bit builds. It is recommended
3692 that this macro be defined via the _HIGH and _LOW macros:
3693
3694 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3695 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3696
3697- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003698 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3699 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003700 used in assembly code, so it must not contain typecasts or
3701 integer size suffixes (e.g. "ULL").
3702
3703- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3704 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3705 used in assembly code, so it must not contain typecasts or
3706 integer size suffixes (e.g. "ULL").
3707
3708- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3709 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3710 forced to a value that ensures that CCSR is not relocated.
3711
wdenk7f6c2cb2002-11-10 22:06:23 +00003712- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003713 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003714
3715 the default drive number (default value 0)
3716
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003717 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003718
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003719 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003720 (default value 1)
3721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003722 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003723
wdenk43d96162003-03-06 00:02:04 +00003724 defines the offset of register from address. It
3725 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003726 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003728 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3729 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003730 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003731
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003732 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003733 fdc_hw_init() is called at the beginning of the FDC
3734 setup. fdc_hw_init() must be provided by the board
3735 source code. It is used to make hardware dependant
3736 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003737
Macpaul Lin0abddf82011-04-11 20:45:32 +00003738- CONFIG_IDE_AHB:
3739 Most IDE controllers were designed to be connected with PCI
3740 interface. Only few of them were designed for AHB interface.
3741 When software is doing ATA command and data transfer to
3742 IDE devices through IDE-AHB controller, some additional
3743 registers accessing to these kind of IDE-AHB controller
3744 is requierd.
3745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003746- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003747 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003748 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003750- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk7152b1d2003-09-05 23:19:14 +00003752 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003753 initial data and stack; please note that this must be
3754 writable memory that is working WITHOUT special
3755 initialization, i. e. you CANNOT use normal RAM which
3756 will become available only after programming the
3757 memory controller and running certain initialization
3758 sequences.
3759
3760 U-Boot uses the following memory types:
3761 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3762 - MPC824X: data cache
3763 - PPC4xx: data cache
3764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003765- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003766
3767 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003768 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3769 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003770 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003771 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003772 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3773 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3774 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003775
3776 Note:
3777 On the MPC824X (or other systems that use the data
3778 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003779 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003780 point to an otherwise UNUSED address space between
3781 the top of RAM and the start of the PCI space.
3782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003783- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003785- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003787- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003789- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003791- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003793- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003795- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003796 SDRAM timing
3797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003798- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003799 periodic timer for refresh
3800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003801- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003803- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3804 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3805 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3806 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003807 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3808
3809- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3811 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003812 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003814- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3815 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003816 Machine Mode Register and Memory Periodic Timer
3817 Prescaler definitions (SDRAM timing)
3818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003819- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003820 enable I2C microcode relocation patch (MPC8xx);
3821 define relocation offset in DPRAM [DSP2]
3822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003823- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003824 enable SMC microcode relocation patch (MPC8xx);
3825 define relocation offset in DPRAM [SMC1]
3826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003827- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003828 enable SPI microcode relocation patch (MPC8xx);
3829 define relocation offset in DPRAM [SCC4]
3830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003831- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003832 Use OSCM clock mode on MBX8xx board. Be careful,
3833 wrong setting might damage your board. Read
3834 doc/README.MBX before setting this variable!
3835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003836- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003837 Offset of the bootmode word in DPRAM used by post
3838 (Power On Self Tests). This definition overrides
3839 #define'd default value in commproc.h resp.
3840 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003842- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3843 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3844 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3845 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3846 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3847 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3848 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3849 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003850 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003851
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003852- CONFIG_PCI_DISABLE_PCIE:
3853 Disable PCI-Express on systems where it is supported but not
3854 required.
3855
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003856- CONFIG_PCI_ENUM_ONLY
3857 Only scan through and get the devices on the busses.
3858 Don't do any setup work, presumably because someone or
3859 something has already done it, and we don't need to do it
3860 a second time. Useful for platforms that are pre-booted
3861 by coreboot or similar.
3862
Kumar Galaa09b9b62010-12-30 12:09:53 -06003863- CONFIG_SYS_SRIO:
3864 Chip has SRIO or not
3865
3866- CONFIG_SRIO1:
3867 Board has SRIO 1 port available
3868
3869- CONFIG_SRIO2:
3870 Board has SRIO 2 port available
3871
3872- CONFIG_SYS_SRIOn_MEM_VIRT:
3873 Virtual Address of SRIO port 'n' memory region
3874
3875- CONFIG_SYS_SRIOn_MEM_PHYS:
3876 Physical Address of SRIO port 'n' memory region
3877
3878- CONFIG_SYS_SRIOn_MEM_SIZE:
3879 Size of SRIO port 'n' memory region
3880
Fabio Estevam66bd1842013-04-11 09:35:34 +00003881- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3882 Defined to tell the NAND controller that the NAND chip is using
3883 a 16 bit bus.
3884 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003885 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003886 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003887 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003888
3889- CONFIG_SYS_NDFC_EBC0_CFG
3890 Sets the EBC0_CFG register for the NDFC. If not defined
3891 a default value will be used.
3892
Ben Warrenbb99ad62006-09-07 16:50:54 -04003893- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003894 Get DDR timing information from an I2C EEPROM. Common
3895 with pluggable memory modules such as SODIMMs
3896
Ben Warrenbb99ad62006-09-07 16:50:54 -04003897 SPD_EEPROM_ADDRESS
3898 I2C address of the SPD EEPROM
3899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003900- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003901 If SPD EEPROM is on an I2C bus other than the first
3902 one, specify here. Note that the value must resolve
3903 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003904
York Sun1b3e3c42011-06-07 09:42:16 +08003905- CONFIG_SYS_DDR_RAW_TIMING
3906 Get DDR timing information from other than SPD. Common with
3907 soldered DDR chips onboard without SPD. DDR raw timing
3908 parameters are extracted from datasheet and hard-coded into
3909 header files or board specific files.
3910
York Sun6f5e1dc2011-09-16 13:21:35 -07003911- CONFIG_FSL_DDR_INTERACTIVE
3912 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003915 Only for 83xx systems. If specified, then DDR should
3916 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003917
wdenkc26e4542004-04-18 10:13:26 +00003918- CONFIG_ETHER_ON_FEC[12]
3919 Define to enable FEC[12] on a 8xx series processor.
3920
3921- CONFIG_FEC[12]_PHY
3922 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003923 to the given FEC; i. e.
3924 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003925 means that the PHY with address 4 is connected to FEC1
3926
3927 When set to -1, means to probe for first available.
3928
3929- CONFIG_FEC[12]_PHY_NORXERR
3930 The PHY does not have a RXERR line (RMII only).
3931 (so program the FEC to ignore it).
3932
3933- CONFIG_RMII
3934 Enable RMII mode for all FECs.
3935 Note that this is a global option, we can't
3936 have one FEC in standard MII mode and another in RMII mode.
3937
wdenk5cf91d62004-04-23 20:32:05 +00003938- CONFIG_CRC32_VERIFY
3939 Add a verify option to the crc32 command.
3940 The syntax is:
3941
3942 => crc32 -v <address> <count> <crc32>
3943
3944 Where address/count indicate a memory area
3945 and crc32 is the correct crc32 which the
3946 area should have.
3947
wdenk56523f12004-07-11 17:40:54 +00003948- CONFIG_LOOPW
3949 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003950 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003951
stroese7b466642004-12-16 18:46:55 +00003952- CONFIG_MX_CYCLIC
3953 Add the "mdc" and "mwc" memory commands. These are cyclic
3954 "md/mw" commands.
3955 Examples:
3956
wdenkefe2a4d2004-12-16 21:44:03 +00003957 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003958 This command will print 4 bytes (10,11,12,13) each 500 ms.
3959
wdenkefe2a4d2004-12-16 21:44:03 +00003960 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003961 This command will write 12345678 to address 100 all 10 ms.
3962
wdenkefe2a4d2004-12-16 21:44:03 +00003963 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003964 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003965
wdenk8aa1a2d2005-04-04 12:44:11 +00003966- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003967 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003968 low level initializations (like setting up the memory
3969 controller) are omitted and/or U-Boot does not
3970 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003971
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003972 Normally this variable MUST NOT be defined. The only
3973 exception is when U-Boot is loaded (to RAM) by some
3974 other boot loader or by a debugger which performs
3975 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003976
Aneesh V401bb302011-07-13 05:11:07 +00003977- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003978 Modifies the behaviour of start.S when compiling a loader
3979 that is executed before the actual U-Boot. E.g. when
3980 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003981
Simon Glass4213fc22013-02-24 17:33:14 +00003982- CONFIG_ARCH_MAP_SYSMEM
3983 Generally U-Boot (and in particular the md command) uses
3984 effective address. It is therefore not necessary to regard
3985 U-Boot address as virtual addresses that need to be translated
3986 to physical addresses. However, sandbox requires this, since
3987 it maintains its own little RAM buffer which contains all
3988 addressable memory. This option causes some memory accesses
3989 to be mapped through map_sysmem() / unmap_sysmem().
3990
Matthias Weisserd8834a12011-03-10 21:36:32 +00003991- CONFIG_USE_ARCH_MEMCPY
3992 CONFIG_USE_ARCH_MEMSET
3993 If these options are used a optimized version of memcpy/memset will
3994 be used if available. These functions may be faster under some
3995 conditions but may increase the binary size.
3996
Simon Glass588a13f2013-02-14 04:18:54 +00003997- CONFIG_X86_RESET_VECTOR
3998 If defined, the x86 reset vector code is included. This is not
3999 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004000
Mark Jacksonfc337052013-03-04 01:27:20 +00004001- CONFIG_SYS_MPUCLK
4002 Defines the MPU clock speed (in MHz).
4003
4004 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004005
Timur Tabif2717b42011-11-22 09:21:25 -06004006Freescale QE/FMAN Firmware Support:
4007-----------------------------------
4008
4009The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4010loading of "firmware", which is encoded in the QE firmware binary format.
4011This firmware often needs to be loaded during U-Boot booting, so macros
4012are used to identify the storage device (NOR flash, SPI, etc) and the address
4013within that device.
4014
4015- CONFIG_SYS_QE_FMAN_FW_ADDR
4016 The address in the storage device where the firmware is located. The
4017 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4018 is also specified.
4019
4020- CONFIG_SYS_QE_FMAN_FW_LENGTH
4021 The maximum possible size of the firmware. The firmware binary format
4022 has a field that specifies the actual size of the firmware, but it
4023 might not be possible to read any part of the firmware unless some
4024 local storage is allocated to hold the entire firmware first.
4025
4026- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4027 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4028 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4029 virtual address in NOR flash.
4030
4031- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4032 Specifies that QE/FMAN firmware is located in NAND flash.
4033 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4034
4035- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4036 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4037 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4038
4039- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4040 Specifies that QE/FMAN firmware is located on the primary SPI
4041 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4042
Liu Gang292dc6c2012-03-08 00:33:18 +00004043- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4044 Specifies that QE/FMAN firmware is located in the remote (master)
4045 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004046 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4047 window->master inbound window->master LAW->the ucode address in
4048 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004049
wdenkc6097192002-11-03 00:24:07 +00004050Building the Software:
4051======================
4052
Wolfgang Denk218ca722008-03-26 10:40:12 +01004053Building U-Boot has been tested in several native build environments
4054and in many different cross environments. Of course we cannot support
4055all possibly existing versions of cross development tools in all
4056(potentially obsolete) versions. In case of tool chain problems we
4057recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4058which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004059
Wolfgang Denk218ca722008-03-26 10:40:12 +01004060If you are not using a native environment, it is assumed that you
4061have GNU cross compiling tools available in your path. In this case,
4062you must set the environment variable CROSS_COMPILE in your shell.
4063Note that no changes to the Makefile or any other source files are
4064necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004065
Wolfgang Denk218ca722008-03-26 10:40:12 +01004066 $ CROSS_COMPILE=ppc_4xx-
4067 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004068
Peter Tyser2f8d3962009-03-13 18:54:51 -05004069Note: If you wish to generate Windows versions of the utilities in
4070 the tools directory you can use the MinGW toolchain
4071 (http://www.mingw.org). Set your HOST tools to the MinGW
4072 toolchain and execute 'make tools'. For example:
4073
4074 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4075
4076 Binaries such as tools/mkimage.exe will be created which can
4077 be executed on computers running Windows.
4078
Wolfgang Denk218ca722008-03-26 10:40:12 +01004079U-Boot is intended to be simple to build. After installing the
4080sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004081is done by typing:
4082
4083 make NAME_config
4084
Wolfgang Denk218ca722008-03-26 10:40:12 +01004085where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004086rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004087
wdenk2729af92004-05-03 20:45:30 +00004088Note: for some board special configuration names may exist; check if
4089 additional information is available from the board vendor; for
4090 instance, the TQM823L systems are available without (standard)
4091 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004092 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004093
wdenk2729af92004-05-03 20:45:30 +00004094 make TQM823L_config
4095 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004096
wdenk2729af92004-05-03 20:45:30 +00004097 make TQM823L_LCD_config
4098 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004099
wdenk2729af92004-05-03 20:45:30 +00004100 etc.
wdenkc6097192002-11-03 00:24:07 +00004101
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103Finally, type "make all", and you should get some working U-Boot
4104images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004105
wdenk2729af92004-05-03 20:45:30 +00004106- "u-boot.bin" is a raw binary image
4107- "u-boot" is an image in ELF binary format
4108- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004109
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004110By default the build is performed locally and the objects are saved
4111in the source directory. One of the two methods can be used to change
4112this behavior and build U-Boot to some external directory:
4113
41141. Add O= to the make command line invocations:
4115
4116 make O=/tmp/build distclean
4117 make O=/tmp/build NAME_config
4118 make O=/tmp/build all
4119
41202. Set environment variable BUILD_DIR to point to the desired location:
4121
4122 export BUILD_DIR=/tmp/build
4123 make distclean
4124 make NAME_config
4125 make all
4126
4127Note that the command line "O=" setting overrides the BUILD_DIR environment
4128variable.
4129
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131Please be aware that the Makefiles assume you are using GNU make, so
4132for instance on NetBSD you might need to use "gmake" instead of
4133native "make".
wdenkc6097192002-11-03 00:24:07 +00004134
wdenkc6097192002-11-03 00:24:07 +00004135
wdenk2729af92004-05-03 20:45:30 +00004136If the system board that you have is not listed, then you will need
4137to port U-Boot to your hardware platform. To do this, follow these
4138steps:
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk2729af92004-05-03 20:45:30 +000041401. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004141 "boards.cfg" file, using the existing entries as examples.
4142 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000041432. Create a new directory to hold your board specific code. Add any
4144 files you need. In your board directory, you will need at least
4145 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
41463. Create a new configuration file "include/configs/<board>.h" for
4147 your board
41483. If you're porting U-Boot to a new CPU, then also create a new
4149 directory to hold your CPU specific code. Add any files you need.
41504. Run "make <board>_config" with your new name.
41515. Type "make", and you should get a working "u-boot.srec" file
4152 to be installed on your target system.
41536. Debug and solve any problems that might arise.
4154 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004155
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4158==============================================================
wdenkc6097192002-11-03 00:24:07 +00004159
Wolfgang Denk218ca722008-03-26 10:40:12 +01004160If you have modified U-Boot sources (for instance added a new board
4161or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004162provide feedback to the other developers. The feedback normally takes
4163the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004164official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004165
Wolfgang Denk218ca722008-03-26 10:40:12 +01004166But before you submit such a patch, please verify that your modifi-
4167cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004168the supported boards compile WITHOUT ANY compiler warnings. To do so,
4169just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004170for ALL supported system. Be warned, this will take a while. You can
4171select which (cross) compiler to use by passing a `CROSS_COMPILE'
4172environment variable to the script, i. e. to use the ELDK cross tools
4173you can type
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk2729af92004-05-03 20:45:30 +00004175 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004176
wdenk2729af92004-05-03 20:45:30 +00004177or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004180
Wolfgang Denk218ca722008-03-26 10:40:12 +01004181When using the MAKEALL script, the default behaviour is to build
4182U-Boot in the source directory. This location can be changed by
4183setting the BUILD_DIR environment variable. Also, for each target
4184built, the MAKEALL script saves two log files (<target>.ERR and
4185<target>.MAKEALL) in the <source dir>/LOG directory. This default
4186location can be changed by setting the MAKEALL_LOGDIR environment
4187variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004188
4189 export BUILD_DIR=/tmp/build
4190 export MAKEALL_LOGDIR=/tmp/log
4191 CROSS_COMPILE=ppc_8xx- MAKEALL
4192
Wolfgang Denk218ca722008-03-26 10:40:12 +01004193With the above settings build objects are saved in the /tmp/build,
4194log files are saved in the /tmp/log and the source tree remains clean
4195during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004196
4197
wdenk2729af92004-05-03 20:45:30 +00004198See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004199
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201Monitor Commands - Overview:
4202============================
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk2729af92004-05-03 20:45:30 +00004204go - start application at address 'addr'
4205run - run commands in an environment variable
4206bootm - boot application image from memory
4207bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004208bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004209tftpboot- boot image via network using TFTP protocol
4210 and env variables "ipaddr" and "serverip"
4211 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004212tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004213rarpboot- boot image via network using RARP/TFTP protocol
4214diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4215loads - load S-Record file over serial line
4216loadb - load binary file over serial line (kermit mode)
4217md - memory display
4218mm - memory modify (auto-incrementing)
4219nm - memory modify (constant address)
4220mw - memory write (fill)
4221cp - memory copy
4222cmp - memory compare
4223crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004224i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004225sspi - SPI utility commands
4226base - print or set address offset
4227printenv- print environment variables
4228setenv - set environment variables
4229saveenv - save environment variables to persistent storage
4230protect - enable or disable FLASH write protection
4231erase - erase FLASH memory
4232flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004233nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004234bdinfo - print Board Info structure
4235iminfo - print header information for application image
4236coninfo - print console devices and informations
4237ide - IDE sub-system
4238loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004239loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004240mtest - simple RAM test
4241icache - enable or disable instruction cache
4242dcache - enable or disable data cache
4243reset - Perform RESET of the CPU
4244echo - echo args to console
4245version - print monitor version
4246help - print online help
4247? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004248
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250Monitor Commands - Detailed Description:
4251========================================
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253TODO.
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk2729af92004-05-03 20:45:30 +00004255For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004256
4257
wdenk2729af92004-05-03 20:45:30 +00004258Environment Variables:
4259======================
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261U-Boot supports user configuration using Environment Variables which
4262can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264Environment Variables are set using "setenv", printed using
4265"printenv", and saved to Flash using "saveenv". Using "setenv"
4266without a value can be used to delete a variable from the
4267environment. As long as you don't save the environment you are
4268working with an in-memory copy. In case the Flash area containing the
4269environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004270
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004271Some configuration options can be set using Environment Variables.
4272
4273List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004274
wdenk2729af92004-05-03 20:45:30 +00004275 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004284
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004285 bootm_low - Memory range available for image processing in the bootm
4286 command can be restricted. This variable is given as
4287 a hexadecimal number and defines lowest address allowed
4288 for use by the bootm command. See also "bootm_size"
4289 environment variable. Address defined by "bootm_low" is
4290 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004291 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4292 bootm_mapsize.
4293
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004294 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004295 This variable is given as a hexadecimal number and it
4296 defines the size of the memory region starting at base
4297 address bootm_low that is accessible by the Linux kernel
4298 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4299 as the default value if it is defined, and bootm_size is
4300 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004301
4302 bootm_size - Memory range available for image processing in the bootm
4303 command can be restricted. This variable is given as
4304 a hexadecimal number and defines the size of the region
4305 allowed for use by the bootm command. See also "bootm_low"
4306 environment variable.
4307
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004308 updatefile - Location of the software update file on a TFTP server, used
4309 by the automatic software update feature. Please refer to
4310 documentation in doc/README.update for more details.
4311
wdenk2729af92004-05-03 20:45:30 +00004312 autoload - if set to "no" (any string beginning with 'n'),
4313 "bootp" will just load perform a lookup of the
4314 configuration from the BOOTP server, but not try to
4315 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317 autostart - if set to "yes", an image loaded using the "bootp",
4318 "rarpboot", "tftpboot" or "diskboot" commands will
4319 be automatically started (by internally calling
4320 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004321
wdenk2729af92004-05-03 20:45:30 +00004322 If set to "no", a standalone image passed to the
4323 "bootm" command will be copied to the load address
4324 (and eventually uncompressed), but NOT be started.
4325 This can be used to load and uncompress arbitrary
4326 data.
wdenkc6097192002-11-03 00:24:07 +00004327
David A. Longa28afca2011-07-09 16:40:19 -04004328 fdt_high - if set this restricts the maximum address that the
4329 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004330 For example, if you have a system with 1 GB memory
4331 at physical address 0x10000000, while Linux kernel
4332 only recognizes the first 704 MB as low memory, you
4333 may need to set fdt_high as 0x3C000000 to have the
4334 device tree blob be copied to the maximum address
4335 of the 704 MB low memory, so that Linux kernel can
4336 access it during the boot procedure.
4337
David A. Longa28afca2011-07-09 16:40:19 -04004338 If this is set to the special value 0xFFFFFFFF then
4339 the fdt will not be copied at all on boot. For this
4340 to work it must reside in writable memory, have
4341 sufficient padding on the end of it for u-boot to
4342 add the information it needs into it, and the memory
4343 must be accessible by the kernel.
4344
Simon Glasseea63e02011-10-24 19:15:34 +00004345 fdtcontroladdr- if set this is the address of the control flattened
4346 device tree used by U-Boot when CONFIG_OF_CONTROL is
4347 defined.
4348
wdenk17ea1172004-06-06 21:51:03 +00004349 i2cfast - (PPC405GP|PPC405EP only)
4350 if set to 'y' configures Linux I2C driver for fast
4351 mode (400kHZ). This environment variable is used in
4352 initialization code. So, for changes to be effective
4353 it must be saved and board must be reset.
4354
wdenk2729af92004-05-03 20:45:30 +00004355 initrd_high - restrict positioning of initrd images:
4356 If this variable is not set, initrd images will be
4357 copied to the highest possible address in RAM; this
4358 is usually what you want since it allows for
4359 maximum initrd size. If for some reason you want to
4360 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004361 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004362 variable to a value of "no" or "off" or "0".
4363 Alternatively, you can set it to a maximum upper
4364 address to use (U-Boot will still check that it
4365 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk2729af92004-05-03 20:45:30 +00004367 For instance, when you have a system with 16 MB
4368 RAM, and want to reserve 4 MB from use by Linux,
4369 you can do this by adding "mem=12M" to the value of
4370 the "bootargs" variable. However, now you must make
4371 sure that the initrd image is placed in the first
4372 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk2729af92004-05-03 20:45:30 +00004376 If you set initrd_high to 0xFFFFFFFF, this is an
4377 indication to U-Boot that all addresses are legal
4378 for the Linux kernel, including addresses in flash
4379 memory. In this case U-Boot will NOT COPY the
4380 ramdisk at all. This may be useful to reduce the
4381 boot time on your system, but requires that this
4382 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386 loadaddr - Default load address for commands like "bootp",
4387 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk2729af92004-05-03 20:45:30 +00004391 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004398
Mike Frysingere2a53452011-10-02 10:01:27 +00004399 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004400
Mike Frysingere2a53452011-10-02 10:01:27 +00004401 ethact - controls which interface is currently active.
4402 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004403
Heiko Schocher48690d82010-07-20 17:45:02 +02004404 => setenv ethact FEC
4405 => ping 192.168.0.1 # traffic sent on FEC
4406 => setenv ethact SCC
4407 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004408
Matthias Fuchse1692572008-01-17 07:45:05 +01004409 ethrotate - When set to "no" U-Boot does not go through all
4410 available network interfaces.
4411 It just stays at the currently selected interface.
4412
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004413 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004414 either succeed or fail without retrying.
4415 When set to "once" the network operation will
4416 fail when all the available network interfaces
4417 are tried once without success.
4418 Useful on scripts which control the retry operation
4419 themselves.
wdenkc6097192002-11-03 00:24:07 +00004420
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004421 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004422
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004423 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004424 UDP source port.
4425
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004426 tftpdstport - If this is set, the value is used for TFTP's UDP
4427 destination port instead of the Well Know Port 69.
4428
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004429 tftpblocksize - Block size to use for TFTP transfers; if not set,
4430 we use the TFTP server's default block size
4431
4432 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4433 seconds, minimum value is 1000 = 1 second). Defines
4434 when a packet is considered to be lost so it has to
4435 be retransmitted. The default is 5000 = 5 seconds.
4436 Lowering this value may make downloads succeed
4437 faster in networks with high packet loss rates or
4438 with unreliable TFTP servers.
4439
4440 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004441 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004442 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004443
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004444The following image location variables contain the location of images
4445used in booting. The "Image" column gives the role of the image and is
4446not an environment variable name. The other columns are environment
4447variable names. "File Name" gives the name of the file on a TFTP
4448server, "RAM Address" gives the location in RAM the image will be
4449loaded to, and "Flash Location" gives the image's address in NOR
4450flash or offset in NAND flash.
4451
4452*Note* - these variables don't have to be defined for all boards, some
4453boards currenlty use other variables for these purposes, and some
4454boards use these variables for other purposes.
4455
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004456Image File Name RAM Address Flash Location
4457----- --------- ----------- --------------
4458u-boot u-boot u-boot_addr_r u-boot_addr
4459Linux kernel bootfile kernel_addr_r kernel_addr
4460device tree blob fdtfile fdt_addr_r fdt_addr
4461ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004462
wdenk2729af92004-05-03 20:45:30 +00004463The following environment variables may be used and automatically
4464updated by the network boot commands ("bootp" and "rarpboot"),
4465depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467 bootfile - see above
4468 dnsip - IP address of your Domain Name Server
4469 dnsip2 - IP address of your secondary Domain Name Server
4470 gatewayip - IP address of the Gateway (Router) to use
4471 hostname - Target hostname
4472 ipaddr - see above
4473 netmask - Subnet Mask
4474 rootpath - Pathname of the root filesystem on the NFS server
4475 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004476
wdenka3d991b2004-04-15 21:48:45 +00004477
wdenk2729af92004-05-03 20:45:30 +00004478There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004479
wdenk2729af92004-05-03 20:45:30 +00004480 serial# - contains hardware identification information such
4481 as type string and/or serial number
4482 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004483
wdenk2729af92004-05-03 20:45:30 +00004484These variables can be set only once (usually during manufacturing of
4485the board). U-Boot refuses to delete or overwrite these variables
4486once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004487
4488
wdenk2729af92004-05-03 20:45:30 +00004489Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491 ver - Contains the U-Boot version string as printed
4492 with the "version" command. This variable is
4493 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004494
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496Please note that changes to some configuration parameters may take
4497only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004498
stroesec1551ea2003-04-04 15:53:41 +00004499
Joe Hershberger170ab112012-12-11 22:16:24 -06004500Callback functions for environment variables:
4501---------------------------------------------
4502
4503For some environment variables, the behavior of u-boot needs to change
4504when their values are changed. This functionailty allows functions to
4505be associated with arbitrary variables. On creation, overwrite, or
4506deletion, the callback will provide the opportunity for some side
4507effect to happen or for the change to be rejected.
4508
4509The callbacks are named and associated with a function using the
4510U_BOOT_ENV_CALLBACK macro in your board or driver code.
4511
4512These callbacks are associated with variables in one of two ways. The
4513static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4514in the board configuration to a string that defines a list of
4515associations. The list must be in the following format:
4516
4517 entry = variable_name[:callback_name]
4518 list = entry[,list]
4519
4520If the callback name is not specified, then the callback is deleted.
4521Spaces are also allowed anywhere in the list.
4522
4523Callbacks can also be associated by defining the ".callbacks" variable
4524with the same list format above. Any association in ".callbacks" will
4525override any association in the static list. You can define
4526CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4527".callbacks" envirnoment variable in the default or embedded environment.
4528
4529
wdenk2729af92004-05-03 20:45:30 +00004530Command Line Parsing:
4531=====================
stroesec1551ea2003-04-04 15:53:41 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533There are two different command line parsers available with U-Boot:
4534the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536Old, simple command line parser:
4537--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk2729af92004-05-03 20:45:30 +00004539- supports environment variables (through setenv / saveenv commands)
4540- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004541- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004542- special characters ('$', ';') can be escaped by prefixing with '\',
4543 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004544 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004545- You can also escape text by enclosing in single apostrophes, for example:
4546 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004547
wdenk2729af92004-05-03 20:45:30 +00004548Hush shell:
4549-----------
wdenkf07771c2003-05-28 08:06:31 +00004550
wdenk2729af92004-05-03 20:45:30 +00004551- similar to Bourne shell, with control structures like
4552 if...then...else...fi, for...do...done; while...do...done,
4553 until...do...done, ...
4554- supports environment ("global") variables (through setenv / saveenv
4555 commands) and local shell variables (through standard shell syntax
4556 "name=value"); only environment variables can be used with "run"
4557 command
wdenkf07771c2003-05-28 08:06:31 +00004558
wdenk2729af92004-05-03 20:45:30 +00004559General rules:
4560--------------
wdenkf07771c2003-05-28 08:06:31 +00004561
wdenk2729af92004-05-03 20:45:30 +00004562(1) If a command line (or an environment variable executed by a "run"
4563 command) contains several commands separated by semicolon, and
4564 one of these commands fails, then the remaining commands will be
4565 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004566
wdenk2729af92004-05-03 20:45:30 +00004567(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004568 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004569 command will cause "run" to terminate, i. e. the remaining
4570 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004571
wdenk2729af92004-05-03 20:45:30 +00004572Note for Redundant Ethernet Interfaces:
4573=======================================
wdenkf07771c2003-05-28 08:06:31 +00004574
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004575Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004576such configurations and is capable of automatic selection of a
4577"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004578
wdenk2729af92004-05-03 20:45:30 +00004579Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4580MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4581"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583If the network interface stores some valid MAC address (for instance
4584in SROM), this is used as default address if there is NO correspon-
4585ding setting in the environment; if the corresponding environment
4586variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004587
wdenk2729af92004-05-03 20:45:30 +00004588o If the SROM has a valid MAC address, and there is no address in the
4589 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004590
wdenk2729af92004-05-03 20:45:30 +00004591o If there is no valid address in the SROM, and a definition in the
4592 environment exists, then the value from the environment variable is
4593 used.
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk2729af92004-05-03 20:45:30 +00004595o If both the SROM and the environment contain a MAC address, and
4596 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598o If both the SROM and the environment contain a MAC address, and the
4599 addresses differ, the value from the environment is used and a
4600 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004601
wdenk2729af92004-05-03 20:45:30 +00004602o If neither SROM nor the environment contain a MAC address, an error
4603 is raised.
wdenkc6097192002-11-03 00:24:07 +00004604
Ben Warrenecee9322010-04-26 11:11:46 -07004605If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004606will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004607may be skipped by setting the appropriate 'ethmacskip' environment variable.
4608The naming convention is as follows:
4609"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk2729af92004-05-03 20:45:30 +00004611Image Formats:
4612==============
wdenkc6097192002-11-03 00:24:07 +00004613
Marian Balakowicz3310c542008-03-12 12:13:13 +01004614U-Boot is capable of booting (and performing other auxiliary operations on)
4615images in two formats:
4616
4617New uImage format (FIT)
4618-----------------------
4619
4620Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4621to Flattened Device Tree). It allows the use of images with multiple
4622components (several kernels, ramdisks, etc.), with contents protected by
4623SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4624
4625
4626Old uImage format
4627-----------------
4628
4629Old image format is based on binary files which can be basically anything,
4630preceded by a special header; see the definitions in include/image.h for
4631details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4634 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004635 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4636 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4637 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004638* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004639 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4640 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004641* Compression Type (uncompressed, gzip, bzip2)
4642* Load Address
4643* Entry Point
4644* Image Name
4645* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004646
wdenk2729af92004-05-03 20:45:30 +00004647The header is marked by a special Magic Number, and both the header
4648and the data portions of the image are secured against corruption by
4649CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004650
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk2729af92004-05-03 20:45:30 +00004652Linux Support:
4653==============
wdenkc6097192002-11-03 00:24:07 +00004654
wdenk2729af92004-05-03 20:45:30 +00004655Although U-Boot should support any OS or standalone application
4656easily, the main focus has always been on Linux during the design of
4657U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk2729af92004-05-03 20:45:30 +00004659U-Boot includes many features that so far have been part of some
4660special "boot loader" code within the Linux kernel. Also, any
4661"initrd" images to be used are no longer part of one big Linux image;
4662instead, kernel and "initrd" are separate images. This implementation
4663serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004664
wdenk2729af92004-05-03 20:45:30 +00004665- the same features can be used for other OS or standalone
4666 applications (for instance: using compressed images to reduce the
4667 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004668
wdenk2729af92004-05-03 20:45:30 +00004669- it becomes much easier to port new Linux kernel versions because
4670 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672- the same Linux kernel image can now be used with different "initrd"
4673 images; of course this also means that different kernel images can
4674 be run with the same "initrd". This makes testing easier (you don't
4675 have to build a new "zImage.initrd" Linux image when you just
4676 change a file in your "initrd"). Also, a field-upgrade of the
4677 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004678
wdenkc6097192002-11-03 00:24:07 +00004679
wdenk2729af92004-05-03 20:45:30 +00004680Linux HOWTO:
4681============
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk2729af92004-05-03 20:45:30 +00004683Porting Linux to U-Boot based systems:
4684---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686U-Boot cannot save you from doing all the necessary modifications to
4687configure the Linux device drivers for use with your target hardware
4688(no, we don't intend to provide a full virtual machine interface to
4689Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004690
Stefan Roesea47a12b2010-04-15 16:07:28 +02004691But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk2729af92004-05-03 20:45:30 +00004693Just make sure your machine specific header file (for instance
4694include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004695Information structure as we define in include/asm-<arch>/u-boot.h,
4696and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004697as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004698
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk2729af92004-05-03 20:45:30 +00004700Configuring the Linux kernel:
4701-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703No specific requirements for U-Boot. Make sure you have some root
4704device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004705
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk2729af92004-05-03 20:45:30 +00004707Building a Linux Image:
4708-----------------------
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk2729af92004-05-03 20:45:30 +00004710With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4711not used. If you use recent kernel source, a new build target
4712"uImage" will exist which automatically builds an image usable by
4713U-Boot. Most older kernels also have support for a "pImage" target,
4714which was introduced for our predecessor project PPCBoot and uses a
4715100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk2729af92004-05-03 20:45:30 +00004717Example:
wdenkc6097192002-11-03 00:24:07 +00004718
wdenk2729af92004-05-03 20:45:30 +00004719 make TQM850L_config
4720 make oldconfig
4721 make dep
4722 make uImage
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk2729af92004-05-03 20:45:30 +00004724The "uImage" build target uses a special tool (in 'tools/mkimage') to
4725encapsulate a compressed Linux kernel image with header information,
4726CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk2729af92004-05-03 20:45:30 +00004728* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004729
wdenk2729af92004-05-03 20:45:30 +00004730* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732 ${CROSS_COMPILE}-objcopy -O binary \
4733 -R .note -R .comment \
4734 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004735
wdenk2729af92004-05-03 20:45:30 +00004736* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk2729af92004-05-03 20:45:30 +00004740* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004741
wdenk2729af92004-05-03 20:45:30 +00004742 mkimage -A ppc -O linux -T kernel -C gzip \
4743 -a 0 -e 0 -n "Linux Kernel Image" \
4744 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004745
wdenk24ee89b2002-11-03 17:56:27 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747The "mkimage" tool can also be used to create ramdisk images for use
4748with U-Boot, either separated from the Linux kernel image, or
4749combined into one file. "mkimage" encapsulates the images with a 64
4750byte header containing information about target architecture,
4751operating system, image type, compression method, entry points, time
4752stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004753
wdenk2729af92004-05-03 20:45:30 +00004754"mkimage" can be called in two ways: to verify existing images and
4755print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004756
wdenk2729af92004-05-03 20:45:30 +00004757In the first form (with "-l" option) mkimage lists the information
4758contained in the header of an existing U-Boot image; this includes
4759checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761 tools/mkimage -l image
4762 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004763
wdenk2729af92004-05-03 20:45:30 +00004764The second form (with "-d" option) is used to build a U-Boot image
4765from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4768 -n name -d data_file image
4769 -A ==> set architecture to 'arch'
4770 -O ==> set operating system to 'os'
4771 -T ==> set image type to 'type'
4772 -C ==> set compression type 'comp'
4773 -a ==> set load address to 'addr' (hex)
4774 -e ==> set entry point to 'ep' (hex)
4775 -n ==> set image name to 'name'
4776 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004777
wdenk69459792004-05-29 16:53:29 +00004778Right now, all Linux kernels for PowerPC systems use the same load
4779address (0x00000000), but the entry point address depends on the
4780kernel version:
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk2729af92004-05-03 20:45:30 +00004782- 2.2.x kernels have the entry point at 0x0000000C,
4783- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004784
wdenk2729af92004-05-03 20:45:30 +00004785So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004786
wdenk2729af92004-05-03 20:45:30 +00004787 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4788 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004789 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004790 > examples/uImage.TQM850L
4791 Image Name: 2.4.4 kernel for TQM850L
4792 Created: Wed Jul 19 02:34:59 2000
4793 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4794 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4795 Load Address: 0x00000000
4796 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004797
wdenk2729af92004-05-03 20:45:30 +00004798To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004799
wdenk2729af92004-05-03 20:45:30 +00004800 -> tools/mkimage -l examples/uImage.TQM850L
4801 Image Name: 2.4.4 kernel for TQM850L
4802 Created: Wed Jul 19 02:34:59 2000
4803 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4804 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4805 Load Address: 0x00000000
4806 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk2729af92004-05-03 20:45:30 +00004808NOTE: for embedded systems where boot time is critical you can trade
4809speed for memory and install an UNCOMPRESSED image instead: this
4810needs more space in Flash, but boots much faster since it does not
4811need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004812
Stefan Roesea47a12b2010-04-15 16:07:28 +02004813 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004814 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4815 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004816 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004817 > examples/uImage.TQM850L-uncompressed
4818 Image Name: 2.4.4 kernel for TQM850L
4819 Created: Wed Jul 19 02:34:59 2000
4820 Image Type: PowerPC Linux Kernel Image (uncompressed)
4821 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4822 Load Address: 0x00000000
4823 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004824
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4827when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829 -> tools/mkimage -n 'Simple Ramdisk Image' \
4830 > -A ppc -O linux -T ramdisk -C gzip \
4831 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4832 Image Name: Simple Ramdisk Image
4833 Created: Wed Jan 12 14:01:50 2000
4834 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4835 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4836 Load Address: 0x00000000
4837 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004838
wdenkdb01a2e2004-04-15 23:14:49 +00004839
wdenk2729af92004-05-03 20:45:30 +00004840Installing a Linux Image:
4841-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843To downloading a U-Boot image over the serial (console) interface,
4844you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004845
wdenk2729af92004-05-03 20:45:30 +00004846 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848The 'objcopy' does not understand the information in the U-Boot
4849image header, so the resulting S-Record file will be relative to
4850address 0x00000000. To load it to a given address, you need to
4851specify the target address as 'offset' parameter with the 'loads'
4852command.
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk2729af92004-05-03 20:45:30 +00004854Example: install the image to address 0x40100000 (which on the
4855TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk2729af92004-05-03 20:45:30 +00004859 .......... done
4860 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004861
wdenk2729af92004-05-03 20:45:30 +00004862 => loads 40100000
4863 ## Ready for S-Record download ...
4864 ~>examples/image.srec
4865 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4866 ...
4867 15989 15990 15991 15992
4868 [file transfer complete]
4869 [connected]
4870 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004871
4872
wdenk2729af92004-05-03 20:45:30 +00004873You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004874this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004875corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk2729af92004-05-03 20:45:30 +00004877 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk2729af92004-05-03 20:45:30 +00004879 ## Checking Image at 40100000 ...
4880 Image Name: 2.2.13 for initrd on TQM850L
4881 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4882 Data Size: 335725 Bytes = 327 kB = 0 MB
4883 Load Address: 00000000
4884 Entry Point: 0000000c
4885 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004886
4887
wdenk2729af92004-05-03 20:45:30 +00004888Boot Linux:
4889-----------
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891The "bootm" command is used to boot an application that is stored in
4892memory (RAM or Flash). In case of a Linux kernel image, the contents
4893of the "bootargs" environment variable is passed to the kernel as
4894parameters. You can check and modify this variable using the
4895"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004896
4897
wdenk2729af92004-05-03 20:45:30 +00004898 => printenv bootargs
4899 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk2729af92004-05-03 20:45:30 +00004901 => 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 +00004902
wdenk2729af92004-05-03 20:45:30 +00004903 => printenv bootargs
4904 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 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906 => bootm 40020000
4907 ## Booting Linux kernel at 40020000 ...
4908 Image Name: 2.2.13 for NFS on TQM850L
4909 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4910 Data Size: 381681 Bytes = 372 kB = 0 MB
4911 Load Address: 00000000
4912 Entry Point: 0000000c
4913 Verifying Checksum ... OK
4914 Uncompressing Kernel Image ... OK
4915 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
4916 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4917 time_init: decrementer frequency = 187500000/60
4918 Calibrating delay loop... 49.77 BogoMIPS
4919 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4920 ...
wdenkc6097192002-11-03 00:24:07 +00004921
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004922If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004923the memory addresses of both the kernel and the initrd image (PPBCOOT
4924format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk2729af92004-05-03 20:45:30 +00004928 ## Checking Image at 40100000 ...
4929 Image Name: 2.2.13 for initrd on TQM850L
4930 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4931 Data Size: 335725 Bytes = 327 kB = 0 MB
4932 Load Address: 00000000
4933 Entry Point: 0000000c
4934 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936 ## Checking Image at 40200000 ...
4937 Image Name: Simple Ramdisk Image
4938 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4939 Data Size: 566530 Bytes = 553 kB = 0 MB
4940 Load Address: 00000000
4941 Entry Point: 00000000
4942 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk2729af92004-05-03 20:45:30 +00004944 => bootm 40100000 40200000
4945 ## Booting Linux kernel at 40100000 ...
4946 Image Name: 2.2.13 for initrd on TQM850L
4947 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4948 Data Size: 335725 Bytes = 327 kB = 0 MB
4949 Load Address: 00000000
4950 Entry Point: 0000000c
4951 Verifying Checksum ... OK
4952 Uncompressing Kernel Image ... OK
4953 ## Loading RAMDisk Image at 40200000 ...
4954 Image Name: Simple Ramdisk Image
4955 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4956 Data Size: 566530 Bytes = 553 kB = 0 MB
4957 Load Address: 00000000
4958 Entry Point: 00000000
4959 Verifying Checksum ... OK
4960 Loading Ramdisk ... OK
4961 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
4962 Boot arguments: root=/dev/ram
4963 time_init: decrementer frequency = 187500000/60
4964 Calibrating delay loop... 49.77 BogoMIPS
4965 ...
4966 RAMDISK: Compressed image found at block 0
4967 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk2729af92004-05-03 20:45:30 +00004969 bash#
wdenkc6097192002-11-03 00:24:07 +00004970
Matthew McClintock02677682006-06-28 10:41:37 -05004971Boot Linux and pass a flat device tree:
4972-----------
4973
4974First, U-Boot must be compiled with the appropriate defines. See the section
4975titled "Linux Kernel Interface" above for a more in depth explanation. The
4976following is an example of how to start a kernel and pass an updated
4977flat device tree:
4978
4979=> print oftaddr
4980oftaddr=0x300000
4981=> print oft
4982oft=oftrees/mpc8540ads.dtb
4983=> tftp $oftaddr $oft
4984Speed: 1000, full duplex
4985Using TSEC0 device
4986TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4987Filename 'oftrees/mpc8540ads.dtb'.
4988Load address: 0x300000
4989Loading: #
4990done
4991Bytes transferred = 4106 (100a hex)
4992=> tftp $loadaddr $bootfile
4993Speed: 1000, full duplex
4994Using TSEC0 device
4995TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4996Filename 'uImage'.
4997Load address: 0x200000
4998Loading:############
4999done
5000Bytes transferred = 1029407 (fb51f hex)
5001=> print loadaddr
5002loadaddr=200000
5003=> print oftaddr
5004oftaddr=0x300000
5005=> bootm $loadaddr - $oftaddr
5006## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005007 Image Name: Linux-2.6.17-dirty
5008 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5009 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005010 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005011 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005012 Verifying Checksum ... OK
5013 Uncompressing Kernel Image ... OK
5014Booting using flat device tree at 0x300000
5015Using MPC85xx ADS machine description
5016Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5017[snip]
5018
5019
wdenk2729af92004-05-03 20:45:30 +00005020More About U-Boot Image Types:
5021------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005022
wdenk2729af92004-05-03 20:45:30 +00005023U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025 "Standalone Programs" are directly runnable in the environment
5026 provided by U-Boot; it is expected that (if they behave
5027 well) you can continue to work in U-Boot after return from
5028 the Standalone Program.
5029 "OS Kernel Images" are usually images of some Embedded OS which
5030 will take over control completely. Usually these programs
5031 will install their own set of exception handlers, device
5032 drivers, set up the MMU, etc. - this means, that you cannot
5033 expect to re-enter U-Boot except by resetting the CPU.
5034 "RAMDisk Images" are more or less just data blocks, and their
5035 parameters (address, size) are passed to an OS kernel that is
5036 being started.
5037 "Multi-File Images" contain several images, typically an OS
5038 (Linux) kernel image and one or more data images like
5039 RAMDisks. This construct is useful for instance when you want
5040 to boot over the network using BOOTP etc., where the boot
5041 server provides just a single image file, but you want to get
5042 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044 "Multi-File Images" start with a list of image sizes, each
5045 image size (in bytes) specified by an "uint32_t" in network
5046 byte order. This list is terminated by an "(uint32_t)0".
5047 Immediately after the terminating 0 follow the images, one by
5048 one, all aligned on "uint32_t" boundaries (size rounded up to
5049 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051 "Firmware Images" are binary images containing firmware (like
5052 U-Boot or FPGA images) which usually will be programmed to
5053 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055 "Script files" are command sequences that will be executed by
5056 U-Boot's command interpreter; this feature is especially
5057 useful when you configure U-Boot to use a real shell (hush)
5058 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005059
Marek Vasut44f074c2012-03-14 21:52:45 +00005060Booting the Linux zImage:
5061-------------------------
5062
5063On some platforms, it's possible to boot Linux zImage. This is done
5064using the "bootz" command. The syntax of "bootz" command is the same
5065as the syntax of "bootm" command.
5066
Marek Vasut017e1f32012-03-18 11:47:58 +00005067Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
5068kernel with raw initrd images. The syntax is slightly different, the
5069address of the initrd must be augmented by it's size, in the following
5070format: "<initrd addres>:<initrd size>".
5071
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk2729af92004-05-03 20:45:30 +00005073Standalone HOWTO:
5074=================
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk2729af92004-05-03 20:45:30 +00005076One of the features of U-Boot is that you can dynamically load and
5077run "standalone" applications, which can use some resources of
5078U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005081
wdenk2729af92004-05-03 20:45:30 +00005082"Hello World" Demo:
5083-------------------
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085'examples/hello_world.c' contains a small "Hello World" Demo
5086application; it is automatically compiled when you build U-Boot.
5087It's configured to run at address 0x00040004, so you can play with it
5088like that:
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk2729af92004-05-03 20:45:30 +00005090 => loads
5091 ## Ready for S-Record download ...
5092 ~>examples/hello_world.srec
5093 1 2 3 4 5 6 7 8 9 10 11 ...
5094 [file transfer complete]
5095 [connected]
5096 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098 => go 40004 Hello World! This is a test.
5099 ## Starting application at 0x00040004 ...
5100 Hello World
5101 argc = 7
5102 argv[0] = "40004"
5103 argv[1] = "Hello"
5104 argv[2] = "World!"
5105 argv[3] = "This"
5106 argv[4] = "is"
5107 argv[5] = "a"
5108 argv[6] = "test."
5109 argv[7] = "<NULL>"
5110 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk2729af92004-05-03 20:45:30 +00005114Another example, which demonstrates how to register a CPM interrupt
5115handler with the U-Boot code, can be found in 'examples/timer.c'.
5116Here, a CPM timer is set up to generate an interrupt every second.
5117The interrupt service routine is trivial, just printing a '.'
5118character, but this is just a demo program. The application can be
5119controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk2729af92004-05-03 20:45:30 +00005121 ? - print current values og the CPM Timer registers
5122 b - enable interrupts and start timer
5123 e - stop timer and disable interrupts
5124 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk2729af92004-05-03 20:45:30 +00005126 => loads
5127 ## Ready for S-Record download ...
5128 ~>examples/timer.srec
5129 1 2 3 4 5 6 7 8 9 10 11 ...
5130 [file transfer complete]
5131 [connected]
5132 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk2729af92004-05-03 20:45:30 +00005134 => go 40004
5135 ## Starting application at 0x00040004 ...
5136 TIMERS=0xfff00980
5137 Using timer 1
5138 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk2729af92004-05-03 20:45:30 +00005140Hit 'b':
5141 [q, b, e, ?] Set interval 1000000 us
5142 Enabling timer
5143Hit '?':
5144 [q, b, e, ?] ........
5145 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5146Hit '?':
5147 [q, b, e, ?] .
5148 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5149Hit '?':
5150 [q, b, e, ?] .
5151 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5152Hit '?':
5153 [q, b, e, ?] .
5154 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5155Hit 'e':
5156 [q, b, e, ?] ...Stopping timer
5157Hit 'q':
5158 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005159
5160
wdenk2729af92004-05-03 20:45:30 +00005161Minicom warning:
5162================
wdenk85ec0bc2003-03-31 16:34:49 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164Over time, many people have reported problems when trying to use the
5165"minicom" terminal emulation program for serial download. I (wd)
5166consider minicom to be broken, and recommend not to use it. Under
5167Unix, I recommend to use C-Kermit for general purpose use (and
5168especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005169use "cu" for S-Record download ("loads" command). See
5170http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5171for help with kermit.
5172
wdenk85ec0bc2003-03-31 16:34:49 +00005173
wdenk2729af92004-05-03 20:45:30 +00005174Nevertheless, if you absolutely want to use it try adding this
5175configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177 Name Program Name U/D FullScr IO-Red. Multi
5178 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5179 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005180
5181
wdenk2729af92004-05-03 20:45:30 +00005182NetBSD Notes:
5183=============
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185Starting at version 0.9.2, U-Boot supports NetBSD both as host
5186(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk2729af92004-05-03 20:45:30 +00005188Building requires a cross environment; it is known to work on
5189NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5190need gmake since the Makefiles are not compatible with BSD make).
5191Note that the cross-powerpc package does not install include files;
5192attempting to build U-Boot will fail because <machine/ansi.h> is
5193missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195 # cd /usr/pkg/cross/powerpc-netbsd/include
5196 # mkdir powerpc
5197 # ln -s powerpc machine
5198 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5199 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk2729af92004-05-03 20:45:30 +00005201Native builds *don't* work due to incompatibilities between native
5202and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204Booting assumes that (the first part of) the image booted is a
5205stage-2 loader which in turn loads and then invokes the kernel
5206proper. Loader sources will eventually appear in the NetBSD source
5207tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005208meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005209
5210
wdenk2729af92004-05-03 20:45:30 +00005211Implementation Internals:
5212=========================
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk2729af92004-05-03 20:45:30 +00005214The following is not intended to be a complete description of every
5215implementation detail. However, it should help to understand the
5216inner workings of U-Boot and make it easier to port it to custom
5217hardware.
wdenkc6097192002-11-03 00:24:07 +00005218
5219
wdenk2729af92004-05-03 20:45:30 +00005220Initial Stack, Global Data:
5221---------------------------
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk2729af92004-05-03 20:45:30 +00005223The implementation of U-Boot is complicated by the fact that U-Boot
5224starts running out of ROM (flash memory), usually without access to
5225system RAM (because the memory controller is not initialized yet).
5226This means that we don't have writable Data or BSS segments, and BSS
5227is not initialized as zero. To be able to get a C environment working
5228at all, we have to allocate at least a minimal stack. Implementation
5229options for this are defined and restricted by the CPU used: Some CPU
5230models provide on-chip memory (like the IMMR area on MPC8xx and
5231MPC826x processors), on others (parts of) the data cache can be
5232locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005233
Wolfgang Denk218ca722008-03-26 10:40:12 +01005234 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005235 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005236
wdenk2729af92004-05-03 20:45:30 +00005237 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5238 From: "Chris Hallinan" <clh@net1plus.com>
5239 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5240 ...
wdenk43d96162003-03-06 00:02:04 +00005241
wdenk2729af92004-05-03 20:45:30 +00005242 Correct me if I'm wrong, folks, but the way I understand it
5243 is this: Using DCACHE as initial RAM for Stack, etc, does not
5244 require any physical RAM backing up the cache. The cleverness
5245 is that the cache is being used as a temporary supply of
5246 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005247 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005248 can see how this works by studying the cache architecture and
5249 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005250
wdenk2729af92004-05-03 20:45:30 +00005251 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5252 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005253 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005254 option should work for you. Using CS 4 should be fine if your
5255 board designers haven't used it for something that would
5256 cause you grief during the initial boot! It is frequently not
5257 used.
wdenk43d96162003-03-06 00:02:04 +00005258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005259 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005260 with your processor/board/system design. The default value
5261 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005262 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005263 than your SDRAM module. If you have a 64MB SDRAM module, set
5264 it above 400_0000. Just make sure your board has no resources
5265 that are supposed to respond to that address! That code in
5266 start.S has been around a while and should work as is when
5267 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269 -Chris Hallinan
5270 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005271
wdenk2729af92004-05-03 20:45:30 +00005272It is essential to remember this, since it has some impact on the C
5273code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk2729af92004-05-03 20:45:30 +00005275* Initialized global data (data segment) is read-only. Do not attempt
5276 to write it.
wdenkc6097192002-11-03 00:24:07 +00005277
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005278* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005279 as zero data - BSS segment) at all - this is undefined, initiali-
5280 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk2729af92004-05-03 20:45:30 +00005282* Stack space is very limited. Avoid big data buffers or things like
5283 that.
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285Having only the stack as writable memory limits means we cannot use
5286normal global data to share information beween the code. But it
5287turned out that the implementation of U-Boot can be greatly
5288simplified by making a global data structure (gd_t) available to all
5289functions. We could pass a pointer to this data as argument to _all_
5290functions, but this would bloat the code. Instead we use a feature of
5291the GCC compiler (Global Register Variables) to share the data: we
5292place a pointer (gd) to the global data into a register which we
5293reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk2729af92004-05-03 20:45:30 +00005295When choosing a register for such a purpose we are restricted by the
5296relevant (E)ABI specifications for the current architecture, and by
5297GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk2729af92004-05-03 20:45:30 +00005299For PowerPC, the following registers have specific use:
5300 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005301 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005302 R3-R4: parameter passing and return values
5303 R5-R10: parameter passing
5304 R13: small data area pointer
5305 R30: GOT pointer
5306 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005307
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005308 (U-Boot also uses R12 as internal GOT pointer. r12
5309 is a volatile register so r12 needs to be reset when
5310 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005311
Wolfgang Denke7670f62008-02-14 22:43:22 +01005312 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314 Note: on PPC, we could use a static initializer (since the
5315 address of the global data structure is known at compile time),
5316 but it turned out that reserving a register results in somewhat
5317 smaller code - although the code savings are not that big (on
5318 average for all boards 752 bytes for the whole U-Boot image,
5319 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005320
Robin Getzc4db3352009-08-17 15:23:02 +00005321On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005322 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5323
Robin Getzc4db3352009-08-17 15:23:02 +00005324 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005325
wdenk2729af92004-05-03 20:45:30 +00005326On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328 R0: function argument word/integer result
5329 R1-R3: function argument word
5330 R9: GOT pointer
5331 R10: stack limit (used only if stack checking if enabled)
5332 R11: argument (frame) pointer
5333 R12: temporary workspace
5334 R13: stack pointer
5335 R14: link register
5336 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk2729af92004-05-03 20:45:30 +00005338 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005339
Thomas Chou0df01fd2010-05-21 11:08:03 +08005340On Nios II, the ABI is documented here:
5341 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5342
5343 ==> U-Boot will use gp to hold a pointer to the global data
5344
5345 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5346 to access small data sections, so gp is free.
5347
Macpaul Linafc1ce82011-10-19 20:41:11 +00005348On NDS32, the following registers are used:
5349
5350 R0-R1: argument/return
5351 R2-R5: argument
5352 R15: temporary register for assembler
5353 R16: trampoline register
5354 R28: frame pointer (FP)
5355 R29: global pointer (GP)
5356 R30: link register (LP)
5357 R31: stack pointer (SP)
5358 PC: program counter (PC)
5359
5360 ==> U-Boot will use R10 to hold a pointer to the global data
5361
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005362NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5363or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk2729af92004-05-03 20:45:30 +00005365Memory Management:
5366------------------
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk2729af92004-05-03 20:45:30 +00005368U-Boot runs in system state and uses physical addresses, i.e. the
5369MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk2729af92004-05-03 20:45:30 +00005371The available memory is mapped to fixed addresses using the memory
5372controller. In this process, a contiguous block is formed for each
5373memory type (Flash, SDRAM, SRAM), even when it consists of several
5374physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376U-Boot is installed in the first 128 kB of the first Flash bank (on
5377TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5378booting and sizing and initializing DRAM, the code relocates itself
5379to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005380memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005381configuration setting]. Below that, a structure with global Board
5382Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005383
wdenk2729af92004-05-03 20:45:30 +00005384Additionally, some exception handler code is copied to the low 8 kB
5385of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk2729af92004-05-03 20:45:30 +00005387So a typical memory configuration with 16 MB of DRAM could look like
5388this:
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk2729af92004-05-03 20:45:30 +00005390 0x0000 0000 Exception Vector code
5391 :
5392 0x0000 1FFF
5393 0x0000 2000 Free for Application Use
5394 :
5395 :
wdenkc6097192002-11-03 00:24:07 +00005396
wdenk2729af92004-05-03 20:45:30 +00005397 :
5398 :
5399 0x00FB FF20 Monitor Stack (Growing downward)
5400 0x00FB FFAC Board Info Data and permanent copy of global data
5401 0x00FC 0000 Malloc Arena
5402 :
5403 0x00FD FFFF
5404 0x00FE 0000 RAM Copy of Monitor Code
5405 ... eventually: LCD or video framebuffer
5406 ... eventually: pRAM (Protected RAM - unchanged by reset)
5407 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005408
5409
wdenk2729af92004-05-03 20:45:30 +00005410System Initialization:
5411----------------------
wdenkc6097192002-11-03 00:24:07 +00005412
wdenk2729af92004-05-03 20:45:30 +00005413In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005414(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005415configuration for CS0# this is a mirror of the onboard Flash memory.
5416To be able to re-map memory U-Boot then jumps to its link address.
5417To be able to implement the initialization code in C, a (small!)
5418initial stack is set up in the internal Dual Ported RAM (in case CPUs
5419which provide such a feature like MPC8xx or MPC8260), or in a locked
5420part of the data cache. After that, U-Boot initializes the CPU core,
5421the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423Next, all (potentially) available memory banks are mapped using a
5424preliminary mapping. For example, we put them on 512 MB boundaries
5425(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5426on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5427programmed for SDRAM access. Using the temporary configuration, a
5428simple memory test is run that determines the size of the SDRAM
5429banks.
wdenkc6097192002-11-03 00:24:07 +00005430
wdenk2729af92004-05-03 20:45:30 +00005431When there is more than one SDRAM bank, and the banks are of
5432different size, the largest is mapped first. For equal size, the first
5433bank (CS2#) is mapped first. The first mapping is always for address
54340x00000000, with any additional banks following immediately to create
5435contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005436
wdenk2729af92004-05-03 20:45:30 +00005437Then, the monitor installs itself at the upper end of the SDRAM area
5438and allocates memory for use by malloc() and for the global Board
5439Info data; also, the exception vector code is copied to the low RAM
5440pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442Only after this relocation will you have a "normal" C environment;
5443until that you are restricted in several ways, mostly because you are
5444running from ROM, and because the code will have to be relocated to a
5445new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005446
5447
wdenk2729af92004-05-03 20:45:30 +00005448U-Boot Porting Guide:
5449----------------------
wdenkc6097192002-11-03 00:24:07 +00005450
wdenk2729af92004-05-03 20:45:30 +00005451[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5452list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005453
5454
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005455int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005456{
5457 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005458
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005459 signal(SIGALRM, no_more_time);
5460 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005461
wdenk2729af92004-05-03 20:45:30 +00005462 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005463 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005464 return 0;
5465 }
5466
wdenk2729af92004-05-03 20:45:30 +00005467 Download latest U-Boot source;
5468
Wolfgang Denk06682362008-12-30 22:56:11 +01005469 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005470
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005471 if (clueless)
5472 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474 while (learning) {
5475 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005476 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5477 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005478 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005479 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005480 }
wdenkc6097192002-11-03 00:24:07 +00005481
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005482 if (available_money > toLocalCurrency ($2500))
5483 Buy a BDI3000;
5484 else
wdenk2729af92004-05-03 20:45:30 +00005485 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005486
5487 if (a similar board exists) { /* hopefully... */
5488 cp -a board/<similar> board/<myboard>
5489 cp include/configs/<similar>.h include/configs/<myboard>.h
5490 } else {
5491 Create your own board support subdirectory;
5492 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005493 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005494 Edit new board/<myboard> files
5495 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005496
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005497 while (!accepted) {
5498 while (!running) {
5499 do {
5500 Add / modify source code;
5501 } until (compiles);
5502 Debug;
5503 if (clueless)
5504 email("Hi, I am having problems...");
5505 }
5506 Send patch file to the U-Boot email list;
5507 if (reasonable critiques)
5508 Incorporate improvements from email list code review;
5509 else
5510 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005511 }
wdenkc6097192002-11-03 00:24:07 +00005512
wdenk2729af92004-05-03 20:45:30 +00005513 return 0;
5514}
5515
5516void no_more_time (int sig)
5517{
5518 hire_a_guru();
5519}
wdenkc6097192002-11-03 00:24:07 +00005520
5521
wdenk2729af92004-05-03 20:45:30 +00005522Coding Standards:
5523-----------------
wdenkc6097192002-11-03 00:24:07 +00005524
wdenk2729af92004-05-03 20:45:30 +00005525All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005526coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005527"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005528
Detlev Zundel2c051652006-09-01 15:39:02 +02005529Source files originating from a different project (for example the
5530MTD subsystem) are generally exempt from these guidelines and are not
5531reformated to ease subsequent migration to newer versions of those
5532sources.
5533
5534Please note that U-Boot is implemented in C (and to some small parts in
5535Assembler); no C++ is used, so please do not use C++ style comments (//)
5536in your code.
wdenk2729af92004-05-03 20:45:30 +00005537
5538Please also stick to the following formatting rules:
5539- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005540- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005541- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005542- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005543- do not add trailing empty lines to source files
5544
5545Submissions which do not conform to the standards may be returned
5546with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005547
5548
wdenk2729af92004-05-03 20:45:30 +00005549Submitting Patches:
5550-------------------
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk2729af92004-05-03 20:45:30 +00005552Since the number of patches for U-Boot is growing, we need to
5553establish some rules. Submissions which do not conform to these rules
5554may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005555
Magnus Lilja0d28f342008-08-06 19:32:33 +02005556Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005557
Wolfgang Denk06682362008-12-30 22:56:11 +01005558Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5559see http://lists.denx.de/mailman/listinfo/u-boot
5560
wdenk2729af92004-05-03 20:45:30 +00005561When you send a patch, please include the following information with
5562it:
wdenkc6097192002-11-03 00:24:07 +00005563
wdenk2729af92004-05-03 20:45:30 +00005564* For bug fixes: a description of the bug and how your patch fixes
5565 this bug. Please try to include a way of demonstrating that the
5566 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk2729af92004-05-03 20:45:30 +00005568* For new features: a description of the feature and your
5569 implementation.
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571* A CHANGELOG entry as plaintext (separate from the patch)
5572
5573* For major contributions, your entry to the CREDITS file
5574
5575* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005576 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005577
5578* If your patch adds new configuration options, don't forget to
5579 document these in the README file.
5580
Wolfgang Denk218ca722008-03-26 10:40:12 +01005581* The patch itself. If you are using git (which is *strongly*
5582 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005583 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005584 the U-Boot mailing list, you will avoid most of the common problems
5585 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005586
Wolfgang Denk218ca722008-03-26 10:40:12 +01005587 If you cannot use git, use "diff -purN OLD NEW". If your version of
5588 diff does not support these options, then get the latest version of
5589 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005590
Wolfgang Denk218ca722008-03-26 10:40:12 +01005591 The current directory when running this command shall be the parent
5592 directory of the U-Boot source tree (i. e. please make sure that
5593 your patch includes sufficient directory information for the
5594 affected files).
5595
5596 We prefer patches as plain text. MIME attachments are discouraged,
5597 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005598
5599* If one logical set of modifications affects or creates several
5600 files, all these changes shall be submitted in a SINGLE patch file.
5601
5602* Changesets that contain different, unrelated modifications shall be
5603 submitted as SEPARATE patches, one patch per changeset.
5604
5605
5606Notes:
5607
5608* Before sending the patch, run the MAKEALL script on your patched
5609 source tree and make sure that no errors or warnings are reported
5610 for any of the boards.
5611
5612* Keep your modifications to the necessary minimum: A patch
5613 containing several unrelated changes or arbitrary reformats will be
5614 returned with a request to re-formatting / split it.
5615
5616* If you modify existing code, make sure that your new code does not
5617 add to the memory footprint of the code ;-) Small is beautiful!
5618 When adding new features, these should compile conditionally only
5619 (using #ifdef), and the resulting code with the new feature
5620 disabled must not need more memory than the old code without your
5621 modification.
wdenk90dc6702005-05-03 14:12:25 +00005622
Wolfgang Denk06682362008-12-30 22:56:11 +01005623* Remember that there is a size limit of 100 kB per message on the
5624 u-boot mailing list. Bigger patches will be moderated. If they are
5625 reasonable and not too big, they will be acknowledged. But patches
5626 bigger than the size limit should be avoided.