blob: 453189156c818d0fa49c2468dc49157cabbf4d44 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk8c831282012-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
wdenkce4832c2004-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 Denkb240aef2008-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. Day974ed2f2012-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschin08337f32008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000126
wdenk24ee89b2002-11-03 17:56:27 +0000127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
129
wdenkc6097192002-11-03 00:24:07 +0000130
wdenk7474aca2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000140
Thomas Webere89e6282010-09-28 08:06:25 +0200141Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-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
wdenk7474aca2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-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 Russcbfce1d2011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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 Roese88fbf932010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-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-VILLARD03836942008-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 Ziswilerabd8dcb2008-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000298
Kim Phillips203fee32007-08-10 13:28:25 -0500299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200300
301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200322 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000323 a "rotator" |\-/|\-/
324
wdenk2bb11052003-07-17 23:16:40 +0000325- Board flavour: (if CONFIG_MPC8260ADS is defined)
326 CONFIG_ADSTYPE
327 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk2bb11052003-07-17 23:16:40 +0000332
Lei Wen20014762011-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)
wdenk9b7f3842003-10-09 20:09:04 +0000339 Define exactly one of
340 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000341
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200342- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
344 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000345 e.g. if there is no 32KHz
346 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200351 CONFIG_SYS_8xx_CPUCLK_MIN
352 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000353 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000354 See doc/README.MPC866
355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200356 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000357
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200363 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000364
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600370- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Kushwahaa6a30622012-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 Wood80806962012-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 Schwierzeckd8a49ca2012-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 Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100428- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-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-VILLARD03836942008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200436
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100437 Defines the Monahans turbo mode to oscillator
438 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200439 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100440 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200441
Daniel Schwierzeckd52a6232011-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 Riesch48c2d6d2012-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 Vb8e40802012-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 Warrenc63c3502013-03-04 13:29:40 +0000488 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-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 Warren445d56c2013-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
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000520 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
521
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200522 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400526 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200527
528 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500535 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400536
Marcel Ziswilerb29bc712009-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 Denk27a5b0b2005-10-13 01:45:54 +0200541 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600542 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200543
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200544 boards with QUICC Engines require OF_QE to set UCC MAC
545 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500546
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000551
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500552 CONFIG_OF_BOOT_CPU
553
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200554 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500555 param header, the default value is zero if undefined.
556
Heiko Schocherffb293a2009-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 Grinberg06890672011-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 Giger0ab978d2008-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 V960f5c02011-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 V686a0752011-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
wdenkda04a8b2004-08-02 23:22:59 +0000605- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200606 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000607
608 Define this if you want support for Amba PrimeCell PL010 UARTs.
609
Andreas Engel0813b122008-09-08 14:30:53 +0200610 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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 Rigby34e21ee2011-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
wdenkda04a8b2004-08-02 23:22:59 +0000637
wdenkc6097192002-11-03 00:24:07 +0000638- Console Interface:
wdenk4a5c8a72003-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 Denkf6e50a42011-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)
wdenk544e9732004-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)
wdenk544e9732004-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-VILLARD03836942008-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 Loeligerc1da5c92007-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
wdenk9dd2b882002-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200684 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000685 the logo
686
Pali Rohár4a57da32012-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
wdenk4a5c8a72003-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
wdenk1ebf41e2004-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.
wdenk3da587e2003-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-VILLARD03836942008-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 Schocher327480a2009-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 Schocher362447f2009-02-10 09:31:47 +0100709 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-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 Russ3c28f482011-09-01 00:48:27 +0000714- Pre-Console Buffer:
Wolfgang Denkd590fb12011-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 Denk23f78482011-10-09 21:06:34 +0200722 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200723 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000724
Wolfgang Denkd590fb12011-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 Russ3c28f482011-09-01 00:48:27 +0000727
Sonny Raocd55bde2011-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 Hershberger96ccaf32012-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
wdenk4a5c8a72003-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
wdenk4a5c8a72003-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 Ziswilerabd8dcb2008-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 Loeligerc1da5c92007-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-VILLARD03836942008-10-16 15:01:15 +0200802 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000803
804- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500805 Monitor commands can be included or excluded
806 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000807 <config_cmd_all.h> and #undef'ing unwanted
808 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500809 and augmenting with additional #define's
810 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000811
Jon Loeligerc1da5c92007-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 Loeligerc1da5c92007-06-11 19:03:39 -0500815 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-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 Frysinger321ab9e2010-12-21 14:19:51 -0500823 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-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 Tyser15258042008-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 Loeligerc1da5c92007-06-11 19:03:39 -0500831 CONFIG_CMD_DTT * Digital Therm and Thermostat
832 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500833 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_EEPROM * EEPROM read/write support
835 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600836 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600837 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500838 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000839 CONFIG_CMD_EXT2 * ext2 command support
840 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500841 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500842 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000843 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-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 Staafd1390c82012-12-05 14:46:29 +0000847 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500848 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000849 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000850 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-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 Kumar3df41b12012-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 Loeligerc1da5c92007-06-11 19:03:39 -0500857 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500858 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000859 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-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 Frysingerfc6508a2010-12-26 12:34:49 -0500864 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000865 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
866 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_LOADB loadb
868 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400869 CONFIG_CMD_MD5SUM print md5 message digest
870 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000871 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500872 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000873 loop, loopw
874 CONFIG_CMD_MEMTEST mtest
Jon Loeligerc1da5c92007-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 Roeseb1423dd2009-03-19 13:30:36 +0100878 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500879 CONFIG_CMD_NAND * NAND support
880 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600881 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000882 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-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 Watersc889fb42012-12-05 14:46:30 +0000888 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500889 CONFIG_CMD_REGINFO * Register dump
890 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000891 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-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 Nelson97f5f8f2012-01-31 10:52:08 -0700898 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100899 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400900 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200901 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500902 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000903 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000904 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000905 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
906 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500907 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000909 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000910
wdenkc6097192002-11-03 00:24:07 +0000911
912 EXAMPLE: If you want all functions except of network
913 support you can write:
914
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500915 #include "config_cmd_all.h"
916 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000917
Gerald Van Barend6abef42007-03-31 12:23:51 -0400918 Other Commands:
919 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000920
921 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500922 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000923 what you (and your U-Boot users) are doing. Data
924 cache cannot be enabled on systems like the 8xx or
925 8260 (where accesses to the IMMR region must be
926 uncached), and it cannot be disabled on all other
927 systems where we (mis-) use the data cache to hold an
928 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000929
930
931 XXX - this list needs to get updated!
932
Simon Glass3d686442011-10-15 05:48:20 +0000933- Device tree:
934 CONFIG_OF_CONTROL
935 If this variable is defined, U-Boot will use a device tree
936 to configure its devices, instead of relying on statically
937 compiled #defines in the board file. This option is
938 experimental and only available on a few boards. The device
939 tree is available in the global data as gd->fdt_blob.
940
Simon Glass5cb34db2011-10-24 19:15:31 +0000941 U-Boot needs to get its device tree from somewhere. This can
942 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000943
944 CONFIG_OF_EMBED
945 If this variable is defined, U-Boot will embed a device tree
946 binary in its image. This device tree file should be in the
947 board directory and called <soc>-<board>.dts. The binary file
948 is then picked up in board_init_f() and made available through
949 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000950
Simon Glass5cb34db2011-10-24 19:15:31 +0000951 CONFIG_OF_SEPARATE
952 If this variable is defined, U-Boot will build a device tree
953 binary. It will be called u-boot.dtb. Architecture-specific
954 code will locate it at run-time. Generally this works by:
955
956 cat u-boot.bin u-boot.dtb >image.bin
957
958 and in fact, U-Boot does this for you, creating a file called
959 u-boot-dtb.bin which is useful in the common case. You can
960 still use the individual files if you need something more
961 exotic.
962
wdenkc6097192002-11-03 00:24:07 +0000963- Watchdog:
964 CONFIG_WATCHDOG
965 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000966 support for the SoC. There must be support in the SoC
967 specific code for a watchdog. For the 8xx and 8260
968 CPUs, the SIU Watchdog feature is enabled in the SYPCR
969 register. When supported for a specific SoC is
970 available, then no further board specific code should
971 be needed to use it.
972
973 CONFIG_HW_WATCHDOG
974 When using a watchdog circuitry external to the used
975 SoC, then define this variable and provide board
976 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000977
stroeseb9c17c52003-04-04 15:53:41 +0000978- U-Boot Version:
979 CONFIG_VERSION_VARIABLE
980 If this variable is defined, an environment variable
981 named "ver" is created by U-Boot showing the U-Boot
982 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200983 Any change to this variable will be reverted at the
984 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000985
wdenkc6097192002-11-03 00:24:07 +0000986- Real-Time Clock:
987
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500988 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000989 has to be selected, too. Define exactly one of the
990 following options:
991
992 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
993 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000994 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000995 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000996 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000997 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000998 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000999 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001000 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001001 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001002 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001003 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1004 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001005
wdenkb9bbd242003-06-30 16:24:52 +00001006 Note that if the RTC uses I2C, then the I2C interface
1007 must also be configured. See I2C Support, below.
1008
Peter Tyser9902e422008-12-17 16:36:21 -06001009- GPIO Support:
1010 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1011 CONFIG_PCA953X_INFO - enable pca953x info command
1012
Chris Packham9b383202010-12-19 10:12:13 +00001013 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1014 chip-ngpio pairs that tell the PCA953X driver the number of
1015 pins supported by a particular chip.
1016
Peter Tyser9902e422008-12-17 16:36:21 -06001017 Note that if the GPIO device uses I2C, then the I2C interface
1018 must also be configured. See I2C Support, below.
1019
wdenkc6097192002-11-03 00:24:07 +00001020- Timestamp Support:
1021
wdenk4a5c8a72003-03-06 00:02:04 +00001022 When CONFIG_TIMESTAMP is selected, the timestamp
1023 (date and time) of an image is printed by image
1024 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001025 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001026
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001027- Partition Labels (disklabels) Supported:
1028 Zero or more of the following:
1029 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1030 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1031 Intel architecture, USB sticks, etc.
1032 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1033 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1034 bootloader. Note 2TB partition limit; see
1035 disk/part_efi.c
1036 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001037
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001038 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1039 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001040 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001041
1042- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001043 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1044 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001045
wdenk369d43d2004-03-14 14:09:05 +00001046 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1047 be performed by calling the function
1048 ide_set_reset(int reset)
1049 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001050
1051- ATAPI Support:
1052 CONFIG_ATAPI
1053
1054 Set this to enable ATAPI support.
1055
wdenkf602aa02004-03-13 23:29:43 +00001056- LBA48 Support
1057 CONFIG_LBA48
1058
1059 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001060 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001061 Whithout these , LBA48 support uses 32bit variables and will 'only'
1062 support disks up to 2.1TB.
1063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001064 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001065 When enabled, makes the IDE subsystem use 64bit sector addresses.
1066 Default is 32bit.
1067
wdenkc6097192002-11-03 00:24:07 +00001068- SCSI Support:
1069 At the moment only there is only support for the
1070 SYM53C8XX SCSI controller; define
1071 CONFIG_SCSI_SYM53C8XX to enable it.
1072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001073 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1074 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1075 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001076 maximum numbers of LUNs, SCSI ID's and target
1077 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001078 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001079
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001080 The environment variable 'scsidevs' is set to the number of
1081 SCSI devices found during the last scan.
1082
wdenkc6097192002-11-03 00:24:07 +00001083- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001084 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001085 Support for Intel 8254x/8257x gigabit chips.
1086
1087 CONFIG_E1000_SPI
1088 Utility code for direct access to the SPI bus on Intel 8257x.
1089 This does not do anything useful unless you set at least one
1090 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1091
1092 CONFIG_E1000_SPI_GENERIC
1093 Allow generic access to the SPI bus on the Intel 8257x, for
1094 example with the "sspi" command.
1095
1096 CONFIG_CMD_E1000
1097 Management command for E1000 devices. When used on devices
1098 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001099
Andre Schwarz68c2a302008-03-06 16:45:44 +01001100 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001101 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001102
wdenkc6097192002-11-03 00:24:07 +00001103 CONFIG_EEPRO100
1104 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001105 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001106 write routine for first time initialisation.
1107
1108 CONFIG_TULIP
1109 Support for Digital 2114x chips.
1110 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1111 modem chip initialisation (KS8761/QS6611).
1112
1113 CONFIG_NATSEMI
1114 Support for National dp83815 chips.
1115
1116 CONFIG_NS8382X
1117 Support for National dp8382[01] gigabit chips.
1118
wdenkaa603362003-05-12 21:50:16 +00001119- NETWORK Support (other):
1120
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001121 CONFIG_DRIVER_AT91EMAC
1122 Support for AT91RM9200 EMAC.
1123
1124 CONFIG_RMII
1125 Define this to use reduced MII inteface
1126
1127 CONFIG_DRIVER_AT91EMAC_QUIET
1128 If this defined, the driver is quiet.
1129 The driver doen't show link status messages.
1130
Rob Herringc9830dc2011-12-15 11:15:49 +00001131 CONFIG_CALXEDA_XGMAC
1132 Support for the Calxeda XGMAC device
1133
Ashok93fb8722012-10-15 06:20:47 +00001134 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001135 Support for SMSC's LAN91C96 chips.
1136
1137 CONFIG_LAN91C96_BASE
1138 Define this to hold the physical address
1139 of the LAN91C96's I/O space
1140
1141 CONFIG_LAN91C96_USE_32_BIT
1142 Define this to enable 32 bit addressing
1143
Ashok93fb8722012-10-15 06:20:47 +00001144 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001145 Support for SMSC's LAN91C111 chip
1146
1147 CONFIG_SMC91111_BASE
1148 Define this to hold the physical address
1149 of the device (I/O space)
1150
1151 CONFIG_SMC_USE_32_BIT
1152 Define this if data bus is 32 bits
1153
1154 CONFIG_SMC_USE_IOFUNCS
1155 Define this to use i/o functions instead of macros
1156 (some hardware wont work with macros)
1157
Heiko Schocher7d037f72011-11-15 10:00:04 -05001158 CONFIG_DRIVER_TI_EMAC
1159 Support for davinci emac
1160
1161 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1162 Define this if you have more then 3 PHYs.
1163
Macpaul Lin199c6252010-12-21 16:59:46 +08001164 CONFIG_FTGMAC100
1165 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1166
1167 CONFIG_FTGMAC100_EGIGA
1168 Define this to use GE link update with gigabit PHY.
1169 Define this if FTGMAC100 is connected to gigabit PHY.
1170 If your system has 10/100 PHY only, it might not occur
1171 wrong behavior. Because PHY usually return timeout or
1172 useless data when polling gigabit status and gigabit
1173 control registers. This behavior won't affect the
1174 correctnessof 10/100 link speed update.
1175
Mike Rapoportf4761af2009-11-11 10:03:03 +02001176 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001177 Support for SMSC's LAN911x and LAN921x chips
1178
Mike Rapoportf4761af2009-11-11 10:03:03 +02001179 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001180 Define this to hold the physical address
1181 of the device (I/O space)
1182
Mike Rapoportf4761af2009-11-11 10:03:03 +02001183 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001184 Define this if data bus is 32 bits
1185
Mike Rapoportf4761af2009-11-11 10:03:03 +02001186 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001187 Define this if data bus is 16 bits. If your processor
1188 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001189 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001190
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001191 CONFIG_SH_ETHER
1192 Support for Renesas on-chip Ethernet controller
1193
1194 CONFIG_SH_ETHER_USE_PORT
1195 Define the number of ports to be used
1196
1197 CONFIG_SH_ETHER_PHY_ADDR
1198 Define the ETH PHY's address
1199
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001200 CONFIG_SH_ETHER_CACHE_WRITEBACK
1201 If this option is set, the driver enables cache flush.
1202
Vadim Bendeburydac69642011-10-17 08:36:14 +00001203- TPM Support:
1204 CONFIG_GENERIC_LPC_TPM
1205 Support for generic parallel port TPM devices. Only one device
1206 per system is supported at this time.
1207
1208 CONFIG_TPM_TIS_BASE_ADDRESS
1209 Base address where the generic TPM device is mapped
1210 to. Contemporary x86 systems usually map it at
1211 0xfed40000.
1212
wdenkc6097192002-11-03 00:24:07 +00001213- USB Support:
1214 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001215 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001216 CONFIG_USB_UHCI to enable it.
1217 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001218 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001219 storage devices.
1220 Note:
1221 Supported are USB Keyboards and USB Floppy drives
1222 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001223 MPC5200 USB requires additional defines:
1224 CONFIG_USB_CLOCK
1225 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001226 CONFIG_PSC3_USB
1227 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001228 CONFIG_USB_CONFIG
1229 for differential drivers: 0x00001000
1230 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001231 for differential drivers on PSC3: 0x00000100
1232 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001233 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001234 May be defined to allow interrupt polling
1235 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001236
Simon Glass5978cdb2012-02-27 10:52:47 +00001237 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1238 txfilltuning field in the EHCI controller on reset.
1239
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001240- USB Device:
1241 Define the below if you wish to use the USB console.
1242 Once firmware is rebuilt from a serial console issue the
1243 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001244 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001245 it has found a new device. The environment variable usbtty
1246 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001247 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001248 Common Device Class Abstract Control Model serial device.
1249 If you select usbtty = gserial you should be able to enumerate
1250 a Linux host by
1251 # modprobe usbserial vendor=0xVendorID product=0xProductID
1252 else if using cdc_acm, simply setting the environment
1253 variable usbtty to be cdc_acm should suffice. The following
1254 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001255
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001256 CONFIG_USB_DEVICE
1257 Define this to build a UDC device
1258
1259 CONFIG_USB_TTY
1260 Define this to have a tty type of device available to
1261 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001262
Vipin KUMARbdb17702012-03-26 15:38:06 +05301263 CONFIG_USBD_HS
1264 Define this to enable the high speed support for usb
1265 device and usbtty. If this feature is enabled, a routine
1266 int is_usbd_high_speed(void)
1267 also needs to be defined by the driver to dynamically poll
1268 whether the enumeration has succeded at high speed or full
1269 speed.
1270
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001271 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001272 Define this if you want stdin, stdout &/or stderr to
1273 be set to usbtty.
1274
1275 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001276 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001277 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001278 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001279
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001280 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001281 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001282 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001283
Wolfgang Denke2601822006-06-14 18:14:56 +02001284 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001285 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001286 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001287 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1288 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1289 should pretend to be a Linux device to it's target host.
1290
1291 CONFIG_USBD_MANUFACTURER
1292 Define this string as the name of your company for
1293 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001294
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001295 CONFIG_USBD_PRODUCT_NAME
1296 Define this string as the name of your product
1297 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001298
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001299 CONFIG_USBD_VENDORID
1300 Define this as your assigned Vendor ID from the USB
1301 Implementors Forum. This *must* be a genuine Vendor ID
1302 to avoid polluting the USB namespace.
1303 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001304
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001305 CONFIG_USBD_PRODUCTID
1306 Define this as the unique Product ID
1307 for your device
1308 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001309
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001310- ULPI Layer Support:
1311 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1312 the generic ULPI layer. The generic layer accesses the ULPI PHY
1313 via the platform viewport, so you need both the genric layer and
1314 the viewport enabled. Currently only Chipidea/ARC based
1315 viewport is supported.
1316 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1317 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001318 If your ULPI phy needs a different reference clock than the
1319 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1320 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001321
wdenk7a428cc2003-06-15 22:40:42 +00001322- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001323 The MMC controller on the Intel PXA is supported. To
1324 enable this define CONFIG_MMC. The MMC can be
1325 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001326 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001327 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1328 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001329
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001330 CONFIG_SH_MMCIF
1331 Support for Renesas on-chip MMCIF controller
1332
1333 CONFIG_SH_MMCIF_ADDR
1334 Define the base address of MMCIF registers
1335
1336 CONFIG_SH_MMCIF_CLK
1337 Define the clock frequency for MMCIF
1338
Tom Rini58a8d322013-03-14 05:32:47 +00001339- USB Device Firmware Update (DFU) class support:
1340 CONFIG_DFU_FUNCTION
1341 This enables the USB portion of the DFU USB class
1342
1343 CONFIG_CMD_DFU
1344 This enables the command "dfu" which is used to have
1345 U-Boot create a DFU class device via USB. This command
1346 requires that the "dfu_alt_info" environment variable be
1347 set and define the alt settings to expose to the host.
1348
1349 CONFIG_DFU_MMC
1350 This enables support for exposing (e)MMC devices via DFU.
1351
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001352 CONFIG_DFU_NAND
1353 This enables support for exposing NAND devices via DFU.
1354
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001355 CONFIG_SYS_DFU_MAX_FILE_SIZE
1356 When updating files rather than the raw storage device,
1357 we use a static buffer to copy the file into and then write
1358 the buffer once we've been given the whole file. Define
1359 this to the maximum filesize (in bytes) for the buffer.
1360 Default is 4 MiB if undefined.
1361
wdenkda04a8b2004-08-02 23:22:59 +00001362- Journaling Flash filesystem support:
1363 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1364 CONFIG_JFFS2_NAND_DEV
1365 Define these for a default partition on a NAND device
1366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001367 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1368 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001369 Define these for a default partition on a NOR device
1370
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001371 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001372 Define this to create an own partition. You have to provide a
1373 function struct part_info* jffs2_part_info(int part_num)
1374
1375 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001376 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001377 to disable the command chpart. This is the default when you
1378 have not defined a custom partition
1379
Donggeun Kim8f814002011-10-24 21:15:28 +00001380- FAT(File Allocation Table) filesystem write function support:
1381 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001382
1383 Define this to enable support for saving memory data as a
1384 file in FAT formatted partition.
1385
1386 This will also enable the command "fatwrite" enabling the
1387 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001388
Gabe Black7f8574c2012-10-12 14:26:11 +00001389CBFS (Coreboot Filesystem) support
1390 CONFIG_CMD_CBFS
1391
1392 Define this to enable support for reading from a Coreboot
1393 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1394 and cbfsload.
1395
wdenkc6097192002-11-03 00:24:07 +00001396- Keyboard Support:
1397 CONFIG_ISA_KEYBOARD
1398
1399 Define this to enable standard (PC-Style) keyboard
1400 support
1401
1402 CONFIG_I8042_KBD
1403 Standard PC keyboard driver with US (is default) and
1404 GERMAN key layout (switch via environment 'keymap=de') support.
1405 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1406 for cfb_console. Supports cursor blinking.
1407
1408- Video support:
1409 CONFIG_VIDEO
1410
1411 Define this to enable video support (for output to
1412 video).
1413
1414 CONFIG_VIDEO_CT69000
1415
1416 Enable Chips & Technologies 69000 Video chip
1417
1418 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001419 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001420 video output is selected via environment 'videoout'
1421 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1422 assumed.
wdenkc6097192002-11-03 00:24:07 +00001423
wdenkd3602132004-03-25 15:14:43 +00001424 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001425 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001426 are possible:
1427 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001428 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001429
1430 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1431 -------------+---------------------------------------------
1432 8 bits | 0x301* 0x303 0x305 0x161 0x307
1433 15 bits | 0x310 0x313 0x316 0x162 0x319
1434 16 bits | 0x311 0x314 0x317 0x163 0x31A
1435 24 bits | 0x312 0x315 0x318 ? 0x31B
1436 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001437 (i.e. setenv videomode 317; saveenv; reset;)
1438
wdenkd3602132004-03-25 15:14:43 +00001439 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001440 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001441
1442
stroeseb9c17c52003-04-04 15:53:41 +00001443 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001444 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001445 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1446 or CONFIG_VIDEO_SED13806_16BPP
1447
Timur Tabi020edd22011-02-15 17:09:19 -06001448 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001449 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001450 SOCs that have a DIU should define this macro to enable DIU
1451 support, and should also define these other macros:
1452
1453 CONFIG_SYS_DIU_ADDR
1454 CONFIG_VIDEO
1455 CONFIG_CMD_BMP
1456 CONFIG_CFB_CONSOLE
1457 CONFIG_VIDEO_SW_CURSOR
1458 CONFIG_VGA_AS_SINGLE_DEVICE
1459 CONFIG_VIDEO_LOGO
1460 CONFIG_VIDEO_BMP_LOGO
1461
Timur Tabi32f709e2011-04-11 14:18:22 -05001462 The DIU driver will look for the 'video-mode' environment
1463 variable, and if defined, enable the DIU as a console during
1464 boot. See the documentation file README.video for a
1465 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001466
Simon Glass54df8ce2012-12-03 13:59:47 +00001467 CONFIG_VIDEO_VGA
1468
1469 Enable the VGA video / BIOS for x86. The alternative if you
1470 are using coreboot is to use the coreboot frame buffer
1471 driver.
1472
1473
wdenk4e112c12003-06-03 23:54:09 +00001474- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001475 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001476
wdenk57b2d802003-06-27 21:31:46 +00001477 Define this to enable a custom keyboard support.
1478 This simply calls drv_keyboard_init() which must be
1479 defined in your board-specific files.
1480 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001481
wdenkc6097192002-11-03 00:24:07 +00001482- LCD Support: CONFIG_LCD
1483
1484 Define this to enable LCD support (for output to LCD
1485 display); also select one of the supported displays
1486 by defining one of these:
1487
Stelian Popf6f86652008-05-09 21:57:18 +02001488 CONFIG_ATMEL_LCD:
1489
1490 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1491
wdenkc0d54ae2003-11-25 16:55:19 +00001492 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001493
wdenkc0d54ae2003-11-25 16:55:19 +00001494 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001495
wdenkc0d54ae2003-11-25 16:55:19 +00001496 CONFIG_NEC_NL6448BC20
1497
1498 NEC NL6448BC20-08. 6.5", 640x480.
1499 Active, color, single scan.
1500
1501 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001502
wdenkc0d54ae2003-11-25 16:55:19 +00001503 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001504 Active, color, single scan.
1505
1506 CONFIG_SHARP_16x9
1507
1508 Sharp 320x240. Active, color, single scan.
1509 It isn't 16x9, and I am not sure what it is.
1510
1511 CONFIG_SHARP_LQ64D341
1512
1513 Sharp LQ64D341 display, 640x480.
1514 Active, color, single scan.
1515
1516 CONFIG_HLD1045
1517
1518 HLD1045 display, 640x480.
1519 Active, color, single scan.
1520
1521 CONFIG_OPTREX_BW
1522
1523 Optrex CBL50840-2 NF-FW 99 22 M5
1524 or
1525 Hitachi LMG6912RPFC-00T
1526 or
1527 Hitachi SP14Q002
1528
1529 320x240. Black & white.
1530
1531 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001532 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001533
Simon Glass599a4df2012-10-17 13:24:54 +00001534 CONFIG_LCD_ALIGNMENT
1535
1536 Normally the LCD is page-aligned (tyically 4KB). If this is
1537 defined then the LCD will be aligned to this value instead.
1538 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1539 here, since it is cheaper to change data cache settings on
1540 a per-section basis.
1541
Simon Glassaf3e2802012-10-17 13:24:59 +00001542 CONFIG_CONSOLE_SCROLL_LINES
1543
1544 When the console need to be scrolled, this is the number of
1545 lines to scroll by. It defaults to 1. Increasing this makes
1546 the console jump but can help speed up operation when scrolling
1547 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001548
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001549 CONFIG_LCD_BMP_RLE8
1550
1551 Support drawing of RLE8-compressed bitmaps on the LCD.
1552
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001553 CONFIG_I2C_EDID
1554
1555 Enables an 'i2c edid' command which can read EDID
1556 information over I2C from an attached LCD display.
1557
wdenkeb20ad32003-09-05 23:19:14 +00001558- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001559
wdenk57b2d802003-06-27 21:31:46 +00001560 If this option is set, the environment is checked for
1561 a variable "splashimage". If found, the usual display
1562 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001563 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001564 specified in "splashimage" is loaded instead. The
1565 console is redirected to the "nulldev", too. This
1566 allows for a "silent" boot where a splash screen is
1567 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001568
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001569 CONFIG_SPLASHIMAGE_GUARD
1570
1571 If this option is set, then U-Boot will prevent the environment
1572 variable "splashimage" from being set to a problematic address
1573 (see README.displaying-bmps and README.arm-unaligned-accesses).
1574 This option is useful for targets where, due to alignment
1575 restrictions, an improperly aligned BMP image will cause a data
1576 abort. If you think you will not have problems with unaligned
1577 accesses (for example because your toolchain prevents them)
1578 there is no need to set this option.
1579
Matthias Weisser53884182009-07-09 16:07:30 +02001580 CONFIG_SPLASH_SCREEN_ALIGN
1581
1582 If this option is set the splash image can be freely positioned
1583 on the screen. Environment variable "splashpos" specifies the
1584 position as "x,y". If a positive number is given it is used as
1585 number of pixel from left/top. If a negative number is given it
1586 is used as number of pixel from right/bottom. You can also
1587 specify 'm' for centering the image.
1588
1589 Example:
1590 setenv splashpos m,m
1591 => image at center of screen
1592
1593 setenv splashpos 30,20
1594 => image at x = 30 and y = 20
1595
1596 setenv splashpos -10,m
1597 => vertically centered image
1598 at x = dspWidth - bmpWidth - 9
1599
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001600 CONFIG_SPLASH_SCREEN_PREPARE
1601
1602 If this option is set then the board_splash_screen_prepare()
1603 function, which must be defined in your code, is called as part
1604 of the splash screen display sequence. It gives the board an
1605 opportunity to prepare the splash image data before it is
1606 processed and sent to the frame buffer by U-Boot.
1607
Stefan Roesed9d97742005-09-22 09:04:17 +02001608- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1609
1610 If this option is set, additionally to standard BMP
1611 images, gzipped BMP images can be displayed via the
1612 splashscreen support or the bmp command.
1613
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001614- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1615
1616 If this option is set, 8-bit RLE compressed BMP images
1617 can be displayed via the splashscreen support or the
1618 bmp command.
1619
Lei Wene4e248d2012-09-28 04:26:47 +00001620- Do compresssing for memory range:
1621 CONFIG_CMD_ZIP
1622
1623 If this option is set, it would use zlib deflate method
1624 to compress the specified memory at its best effort.
1625
wdenk710e3502003-08-29 20:57:53 +00001626- Compression support:
1627 CONFIG_BZIP2
1628
1629 If this option is set, support for bzip2 compressed
1630 images is included. If not, only uncompressed and gzip
1631 compressed images are supported.
1632
wdenk9c53f402003-10-15 23:53:47 +00001633 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001634 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001635 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001636
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001637 CONFIG_LZMA
1638
1639 If this option is set, support for lzma compressed
1640 images is included.
1641
1642 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1643 requires an amount of dynamic memory that is given by the
1644 formula:
1645
1646 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1647
1648 Where lc and lp stand for, respectively, Literal context bits
1649 and Literal pos bits.
1650
1651 This value is upper-bounded by 14MB in the worst case. Anyway,
1652 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1653 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1654 a very small buffer.
1655
1656 Use the lzmainfo tool to determinate the lc and lp values and
1657 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001658 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001659
wdenk0e2bd9c2004-06-06 21:51:03 +00001660- MII/PHY support:
1661 CONFIG_PHY_ADDR
1662
1663 The address of PHY on MII bus.
1664
1665 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1666
1667 The clock frequency of the MII bus
1668
1669 CONFIG_PHY_GIGE
1670
1671 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001672 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001673
1674 CONFIG_PHY_RESET_DELAY
1675
1676 Some PHY like Intel LXT971A need extra delay after
1677 reset before any MII register access is possible.
1678 For such PHY, set this option to the usec delay
1679 required. (minimum 300usec for LXT971A)
1680
1681 CONFIG_PHY_CMD_DELAY (ppc4xx)
1682
1683 Some PHY like Intel LXT971A need extra delay after
1684 command issued before MII status register can be read
1685
wdenkc6097192002-11-03 00:24:07 +00001686- Ethernet address:
1687 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001688 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001689 CONFIG_ETH2ADDR
1690 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001691 CONFIG_ETH4ADDR
1692 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001693
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001694 Define a default value for Ethernet address to use
1695 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001696 is not determined automatically.
1697
1698- IP address:
1699 CONFIG_IPADDR
1700
1701 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001702 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001703 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001704 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001705
1706- Server IP address:
1707 CONFIG_SERVERIP
1708
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001709 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001710 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001711 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001712
Robin Getz470a6d42009-07-21 12:15:28 -04001713 CONFIG_KEEP_SERVERADDR
1714
1715 Keeps the server's MAC address, in the env 'serveraddr'
1716 for passing to bootargs (like Linux's netconsole option)
1717
Wolfgang Denk26da2992011-10-26 10:21:22 +00001718- Gateway IP address:
1719 CONFIG_GATEWAYIP
1720
1721 Defines a default value for the IP address of the
1722 default router where packets to other networks are
1723 sent to.
1724 (Environment variable "gatewayip")
1725
1726- Subnet mask:
1727 CONFIG_NETMASK
1728
1729 Defines a default value for the subnet mask (or
1730 routing prefix) which is used to determine if an IP
1731 address belongs to the local subnet or needs to be
1732 forwarded through a router.
1733 (Environment variable "netmask")
1734
David Updegraff7280da72007-06-11 10:41:07 -05001735- Multicast TFTP Mode:
1736 CONFIG_MCAST_TFTP
1737
1738 Defines whether you want to support multicast TFTP as per
1739 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001740 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001741 driver in use must provide a function: mcast() to join/leave a
1742 multicast group.
1743
wdenkc6097192002-11-03 00:24:07 +00001744- BOOTP Recovery Mode:
1745 CONFIG_BOOTP_RANDOM_DELAY
1746
1747 If you have many targets in a network that try to
1748 boot using BOOTP, you may want to avoid that all
1749 systems send out BOOTP requests at precisely the same
1750 moment (which would happen for instance at recovery
1751 from a power failure, when all systems will try to
1752 boot, thus flooding the BOOTP server. Defining
1753 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1754 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001755 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001756
1757 1st BOOTP request: delay 0 ... 1 sec
1758 2nd BOOTP request: delay 0 ... 2 sec
1759 3rd BOOTP request: delay 0 ... 4 sec
1760 4th and following
1761 BOOTP requests: delay 0 ... 8 sec
1762
stroesee0aadfb2003-08-28 14:17:32 +00001763- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001764 You can fine tune the DHCP functionality by defining
1765 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001766
Jon Loeliger5336a762007-07-09 22:08:34 -05001767 CONFIG_BOOTP_SUBNETMASK
1768 CONFIG_BOOTP_GATEWAY
1769 CONFIG_BOOTP_HOSTNAME
1770 CONFIG_BOOTP_NISDOMAIN
1771 CONFIG_BOOTP_BOOTPATH
1772 CONFIG_BOOTP_BOOTFILESIZE
1773 CONFIG_BOOTP_DNS
1774 CONFIG_BOOTP_DNS2
1775 CONFIG_BOOTP_SEND_HOSTNAME
1776 CONFIG_BOOTP_NTPSERVER
1777 CONFIG_BOOTP_TIMEOFFSET
1778 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001779 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001780
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001781 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1782 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001783
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001784 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1785 after the configured retry count, the call will fail
1786 instead of starting over. This can be used to fail over
1787 to Link-local IP address configuration if the DHCP server
1788 is not available.
1789
stroesee0aadfb2003-08-28 14:17:32 +00001790 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1791 serverip from a DHCP server, it is possible that more
1792 than one DNS serverip is offered to the client.
1793 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1794 serverip will be stored in the additional environment
1795 variable "dnsip2". The first DNS serverip is always
1796 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001797 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001798
1799 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1800 to do a dynamic update of a DNS server. To do this, they
1801 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001802 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001803 of the "hostname" environment variable is passed as
1804 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001805
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001806 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1807
1808 A 32bit value in microseconds for a delay between
1809 receiving a "DHCP Offer" and sending the "DHCP Request".
1810 This fixes a problem with certain DHCP servers that don't
1811 respond 100% of the time to a "DHCP request". E.g. On an
1812 AT91RM9200 processor running at 180MHz, this delay needed
1813 to be *at least* 15,000 usec before a Windows Server 2003
1814 DHCP server would reply 100% of the time. I recommend at
1815 least 50,000 usec to be safe. The alternative is to hope
1816 that one of the retries will be successful but note that
1817 the DHCP timeout and retry process takes a longer than
1818 this delay.
1819
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001820 - Link-local IP address negotiation:
1821 Negotiate with other link-local clients on the local network
1822 for an address that doesn't require explicit configuration.
1823 This is especially useful if a DHCP server cannot be guaranteed
1824 to exist in all environments that the device must operate.
1825
1826 See doc/README.link-local for more information.
1827
wdenk145d2c12004-04-15 21:48:45 +00001828 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001829 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001830
1831 The device id used in CDP trigger frames.
1832
1833 CONFIG_CDP_DEVICE_ID_PREFIX
1834
1835 A two character string which is prefixed to the MAC address
1836 of the device.
1837
1838 CONFIG_CDP_PORT_ID
1839
1840 A printf format string which contains the ascii name of
1841 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001842 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001843
1844 CONFIG_CDP_CAPABILITIES
1845
1846 A 32bit integer which indicates the device capabilities;
1847 0x00000010 for a normal host which does not forwards.
1848
1849 CONFIG_CDP_VERSION
1850
1851 An ascii string containing the version of the software.
1852
1853 CONFIG_CDP_PLATFORM
1854
1855 An ascii string containing the name of the platform.
1856
1857 CONFIG_CDP_TRIGGER
1858
1859 A 32bit integer sent on the trigger.
1860
1861 CONFIG_CDP_POWER_CONSUMPTION
1862
1863 A 16bit integer containing the power consumption of the
1864 device in .1 of milliwatts.
1865
1866 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1867
1868 A byte containing the id of the VLAN.
1869
wdenkc6097192002-11-03 00:24:07 +00001870- Status LED: CONFIG_STATUS_LED
1871
1872 Several configurations allow to display the current
1873 status using a LED. For instance, the LED will blink
1874 fast while running U-Boot code, stop blinking as
1875 soon as a reply to a BOOTP request was received, and
1876 start blinking slow once the Linux kernel is running
1877 (supported by a status LED driver in the Linux
1878 kernel). Defining CONFIG_STATUS_LED enables this
1879 feature in U-Boot.
1880
1881- CAN Support: CONFIG_CAN_DRIVER
1882
1883 Defining CONFIG_CAN_DRIVER enables CAN driver support
1884 on those systems that support this (optional)
1885 feature, like the TQM8xxL modules.
1886
1887- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1888
wdenkb9bbd242003-06-30 16:24:52 +00001889 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001890 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001891 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001892
wdenk21136db2003-07-16 21:53:01 +00001893 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001894 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001895 CONFIG_COMMANDS) and communicate with i2c based realtime
1896 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001897 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001898
Ben Warren45657152006-09-07 16:50:54 -04001899 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001900
wdenk21136db2003-07-16 21:53:01 +00001901 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001902 bit-banging) driver instead of CPM or similar hardware
1903 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001904
wdenk21136db2003-07-16 21:53:01 +00001905 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001906 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001908 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001909 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001910 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001911 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001912
Peter Tysere4d1abc2010-04-12 22:28:21 -05001913 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001914 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001915 and so its address should therefore be cleared to 0 (See,
1916 eg, MPC823e User's Manual p.16-473). So, set
1917 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001918
Eric Millbrandt12990a42009-09-03 08:09:44 -05001919 CONFIG_SYS_I2C_INIT_MPC5XXX
1920
1921 When a board is reset during an i2c bus transfer
1922 chips might think that the current transfer is still
1923 in progress. Reset the slave devices by sending start
1924 commands until the slave device responds.
1925
wdenk21136db2003-07-16 21:53:01 +00001926 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001927
wdenkb9bbd242003-06-30 16:24:52 +00001928 If you use the software i2c interface (CONFIG_SOFT_I2C)
1929 then the following macros need to be defined (examples are
1930 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001931
1932 I2C_INIT
1933
wdenkb9bbd242003-06-30 16:24:52 +00001934 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001935 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001936
wdenk544e9732004-02-06 23:19:44 +00001937 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001938
wdenkc6097192002-11-03 00:24:07 +00001939 I2C_PORT
1940
wdenk4a5c8a72003-03-06 00:02:04 +00001941 (Only for MPC8260 CPU). The I/O port to use (the code
1942 assumes both bits are on the same port). Valid values
1943 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001944
1945 I2C_ACTIVE
1946
1947 The code necessary to make the I2C data line active
1948 (driven). If the data line is open collector, this
1949 define can be null.
1950
wdenkb9bbd242003-06-30 16:24:52 +00001951 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1952
wdenkc6097192002-11-03 00:24:07 +00001953 I2C_TRISTATE
1954
1955 The code necessary to make the I2C data line tri-stated
1956 (inactive). If the data line is open collector, this
1957 define can be null.
1958
wdenkb9bbd242003-06-30 16:24:52 +00001959 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1960
wdenkc6097192002-11-03 00:24:07 +00001961 I2C_READ
1962
York Sun4a598092013-04-01 11:29:11 -07001963 Code that returns true if the I2C data line is high,
1964 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001965
wdenkb9bbd242003-06-30 16:24:52 +00001966 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1967
wdenkc6097192002-11-03 00:24:07 +00001968 I2C_SDA(bit)
1969
York Sun4a598092013-04-01 11:29:11 -07001970 If <bit> is true, sets the I2C data line high. If it
1971 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001972
wdenkb9bbd242003-06-30 16:24:52 +00001973 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001974 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001975 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001976
wdenkc6097192002-11-03 00:24:07 +00001977 I2C_SCL(bit)
1978
York Sun4a598092013-04-01 11:29:11 -07001979 If <bit> is true, sets the I2C clock line high. If it
1980 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001981
wdenkb9bbd242003-06-30 16:24:52 +00001982 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001983 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001984 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001985
wdenkc6097192002-11-03 00:24:07 +00001986 I2C_DELAY
1987
1988 This delay is invoked four times per clock cycle so this
1989 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001990 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001991 like:
1992
wdenkb9bbd242003-06-30 16:24:52 +00001993 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001994
Mike Frysingeree12d542010-07-21 13:38:02 -04001995 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1996
1997 If your arch supports the generic GPIO framework (asm/gpio.h),
1998 then you may alternatively define the two GPIOs that are to be
1999 used as SCL / SDA. Any of the previous I2C_xxx macros will
2000 have GPIO-based defaults assigned to them as appropriate.
2001
2002 You should define these to the GPIO value as given directly to
2003 the generic GPIO functions.
2004
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002005 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002006
wdenk57b2d802003-06-27 21:31:46 +00002007 When a board is reset during an i2c bus transfer
2008 chips might think that the current transfer is still
2009 in progress. On some boards it is possible to access
2010 the i2c SCLK line directly, either by using the
2011 processor pin as a GPIO or by having a second pin
2012 connected to the bus. If this option is defined a
2013 custom i2c_init_board() routine in boards/xxx/board.c
2014 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002015
Richard Retanubundf0149c2010-04-12 15:08:17 -04002016 CONFIG_SYS_I2C_BOARD_LATE_INIT
2017
2018 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2019 defined a custom i2c_board_late_init() routine in
2020 boards/xxx/board.c is run AFTER the operations in i2c_init()
2021 is completed. This callpoint can be used to unreset i2c bus
2022 using CPU i2c controller register accesses for CPUs whose i2c
2023 controller provide such a method. It is called at the end of
2024 i2c_init() to allow i2c_init operations to setup the i2c bus
2025 controller on the CPU (e.g. setting bus speed & slave address).
2026
wdenk0e2bd9c2004-06-06 21:51:03 +00002027 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2028
2029 This option enables configuration of bi_iic_fast[] flags
2030 in u-boot bd_info structure based on u-boot environment
2031 variable "i2cfast". (see also i2cfast)
2032
Ben Warren45657152006-09-07 16:50:54 -04002033 CONFIG_I2C_MULTI_BUS
2034
2035 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002036 must have a controller. At any point in time, only one bus is
2037 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002038 Note that bus numbering is zero-based.
2039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002040 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002041
2042 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002043 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002044 is set, specify a list of bus-device pairs. Otherwise, specify
2045 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002046
2047 e.g.
2048 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002049 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002050
2051 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2052
Wolfgang Denk092ae952011-10-26 10:21:21 +00002053 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002054 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002055
2056 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002058 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002059
2060 If defined, then this indicates the I2C bus number for DDR SPD.
2061 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002063 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002064
2065 If defined, then this indicates the I2C bus number for the RTC.
2066 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002068 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002069
2070 If defined, then this indicates the I2C bus number for the DTT.
2071 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002073 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002074
2075 If defined, specifies the I2C address of the DTT device.
2076 If not defined, then U-Boot uses predefined value for
2077 specified DTT device.
2078
Timur Tabiab347542006-11-03 19:15:00 -06002079 CONFIG_FSL_I2C
2080
2081 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002082 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002083
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002084 CONFIG_I2C_MUX
2085
2086 Define this option if you have I2C devices reached over 1 .. n
2087 I2C Muxes like the pca9544a. This option addes a new I2C
2088 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2089 new I2C Bus to the existing I2C Busses. If you select the
2090 new Bus with "i2c dev", u-bbot sends first the commandos for
2091 the muxes to activate this new "bus".
2092
2093 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2094 feature!
2095
2096 Example:
2097 Adding a new I2C Bus reached over 2 pca9544a muxes
2098 The First mux with address 70 and channel 6
2099 The Second mux with address 71 and channel 4
2100
2101 => i2c bus pca9544a:70:6:pca9544a:71:4
2102
2103 Use the "i2c bus" command without parameter, to get a list
2104 of I2C Busses with muxes:
2105
2106 => i2c bus
2107 Busses reached over muxes:
2108 Bus ID: 2
2109 reached over Mux(es):
2110 pca9544a@70 ch: 4
2111 Bus ID: 3
2112 reached over Mux(es):
2113 pca9544a@70 ch: 6
2114 pca9544a@71 ch: 4
2115 =>
2116
2117 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002118 u-boot first sends the command to the mux@70 to enable
2119 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002120 the channel 4.
2121
2122 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002123 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002124 the 2 muxes.
2125
2126 This option is actually implemented for the bitbanging
2127 algorithm in common/soft_i2c.c and for the Hardware I2C
2128 Bus on the MPC8260. But it should be not so difficult
2129 to add this option to other architectures.
2130
Andrew Dyer58c41f92008-12-29 17:36:01 -06002131 CONFIG_SOFT_I2C_READ_REPEATED_START
2132
2133 defining this will force the i2c_read() function in
2134 the soft_i2c driver to perform an I2C repeated start
2135 between writing the address pointer and reading the
2136 data. If this define is omitted the default behaviour
2137 of doing a stop-start sequence will be used. Most I2C
2138 devices can use either method, but some require one or
2139 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002140
wdenkc6097192002-11-03 00:24:07 +00002141- SPI Support: CONFIG_SPI
2142
2143 Enables SPI driver (so far only tested with
2144 SPI EEPROM, also an instance works with Crystal A/D and
2145 D/As on the SACSng board)
2146
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002147 CONFIG_SH_SPI
2148
2149 Enables the driver for SPI controller on SuperH. Currently
2150 only SH7757 is supported.
2151
wdenkc6097192002-11-03 00:24:07 +00002152 CONFIG_SPI_X
2153
2154 Enables extended (16-bit) SPI EEPROM addressing.
2155 (symmetrical to CONFIG_I2C_X)
2156
2157 CONFIG_SOFT_SPI
2158
wdenk4a5c8a72003-03-06 00:02:04 +00002159 Enables a software (bit-bang) SPI driver rather than
2160 using hardware support. This is a general purpose
2161 driver that only requires three general I/O port pins
2162 (two outputs, one input) to function. If this is
2163 defined, the board configuration must define several
2164 SPI configuration items (port pins to use, etc). For
2165 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002166
Ben Warren7efe9272008-01-16 22:37:35 -05002167 CONFIG_HARD_SPI
2168
2169 Enables a hardware SPI driver for general-purpose reads
2170 and writes. As with CONFIG_SOFT_SPI, the board configuration
2171 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002172 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002173 example, see include/configs/mpc8349emds.h.
2174
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002175 CONFIG_MXC_SPI
2176
2177 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002178 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002179
Matthias Fuchsa4400872007-12-27 17:12:34 +01002180- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002181
Matthias Fuchsa4400872007-12-27 17:12:34 +01002182 Enables FPGA subsystem.
2183
2184 CONFIG_FPGA_<vendor>
2185
2186 Enables support for specific chip vendors.
2187 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002188
Matthias Fuchsa4400872007-12-27 17:12:34 +01002189 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002190
Matthias Fuchsa4400872007-12-27 17:12:34 +01002191 Enables support for FPGA family.
2192 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2193
2194 CONFIG_FPGA_COUNT
2195
2196 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002198 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002199
wdenk57b2d802003-06-27 21:31:46 +00002200 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002202 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002203
wdenk4a5c8a72003-03-06 00:02:04 +00002204 Enable checks on FPGA configuration interface busy
2205 status by the configuration function. This option
2206 will require a board or device specific function to
2207 be written.
wdenkc6097192002-11-03 00:24:07 +00002208
2209 CONFIG_FPGA_DELAY
2210
2211 If defined, a function that provides delays in the FPGA
2212 configuration driver.
2213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002214 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002215 Allow Control-C to interrupt FPGA configuration
2216
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002217 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002218
wdenk4a5c8a72003-03-06 00:02:04 +00002219 Check for configuration errors during FPGA bitfile
2220 loading. For example, abort during Virtex II
2221 configuration if the INIT_B line goes low (which
2222 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002223
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002224 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002225
wdenk4a5c8a72003-03-06 00:02:04 +00002226 Maximum time to wait for the INIT_B line to deassert
2227 after PROB_B has been deasserted during a Virtex II
2228 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002229 ms.
wdenkc6097192002-11-03 00:24:07 +00002230
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002231 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002232
wdenk4a5c8a72003-03-06 00:02:04 +00002233 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002234 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002236 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002237
wdenk4a5c8a72003-03-06 00:02:04 +00002238 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002239 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002240
2241- Configuration Management:
2242 CONFIG_IDENT_STRING
2243
wdenk4a5c8a72003-03-06 00:02:04 +00002244 If defined, this string will be added to the U-Boot
2245 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002246
2247- Vendor Parameter Protection:
2248
wdenk4a5c8a72003-03-06 00:02:04 +00002249 U-Boot considers the values of the environment
2250 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002251 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002252 are set once by the board vendor / manufacturer, and
2253 protects these variables from casual modification by
2254 the user. Once set, these variables are read-only,
2255 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002256 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002257
2258 If CONFIG_ENV_OVERWRITE is #defined in your config
2259 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002260 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002261 these parameters.
2262
2263 Alternatively, if you #define _both_ CONFIG_ETHADDR
2264 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002265 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002266 which can be changed exactly ONCE by the user. [The
2267 serial# is unaffected by this, i. e. it remains
2268 read-only.]
2269
Joe Hershberger71497d02012-12-11 22:16:31 -06002270 The same can be accomplished in a more flexible way
2271 for any variable by configuring the type of access
2272 to allow for those variables in the ".flags" variable
2273 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2274
wdenkc6097192002-11-03 00:24:07 +00002275- Protected RAM:
2276 CONFIG_PRAM
2277
2278 Define this variable to enable the reservation of
2279 "protected RAM", i. e. RAM which is not overwritten
2280 by U-Boot. Define CONFIG_PRAM to hold the number of
2281 kB you want to reserve for pRAM. You can overwrite
2282 this default value by defining an environment
2283 variable "pram" to the number of kB you want to
2284 reserve. Note that the board info structure will
2285 still show the full amount of RAM. If pRAM is
2286 reserved, a new environment variable "mem" will
2287 automatically be defined to hold the amount of
2288 remaining RAM in a form that can be passed as boot
2289 argument to Linux, for instance like that:
2290
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002291 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002292 saveenv
2293
2294 This way you can tell Linux not to use this memory,
2295 either, which results in a memory region that will
2296 not be affected by reboots.
2297
2298 *WARNING* If your board configuration uses automatic
2299 detection of the RAM size, you must make sure that
2300 this memory test is non-destructive. So far, the
2301 following board configurations are known to be
2302 "pRAM-clean":
2303
Wolfgang Denk90326762012-10-24 02:36:15 +00002304 IVMS8, IVML24, SPD8xx, TQM8xxL,
2305 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002306 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002307
Gabe Blacka2f3a932012-12-02 04:55:18 +00002308- Access to physical memory region (> 4GB)
2309 Some basic support is provided for operations on memory not
2310 normally accessible to U-Boot - e.g. some architectures
2311 support access to more than 4GB of memory on 32-bit
2312 machines using physical address extension or similar.
2313 Define CONFIG_PHYSMEM to access this basic support, which
2314 currently only supports clearing the memory.
2315
wdenkc6097192002-11-03 00:24:07 +00002316- Error Recovery:
2317 CONFIG_PANIC_HANG
2318
2319 Define this variable to stop the system in case of a
2320 fatal error, so that you have to reset it manually.
2321 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002322 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002323 automatically as fast as possible, but it may be
2324 useful during development since you can try to debug
2325 the conditions that lead to the situation.
2326
2327 CONFIG_NET_RETRY_COUNT
2328
wdenk4a5c8a72003-03-06 00:02:04 +00002329 This variable defines the number of retries for
2330 network operations like ARP, RARP, TFTP, or BOOTP
2331 before giving up the operation. If not defined, a
2332 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002333
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002334 CONFIG_ARP_TIMEOUT
2335
2336 Timeout waiting for an ARP reply in milliseconds.
2337
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002338 CONFIG_NFS_TIMEOUT
2339
2340 Timeout in milliseconds used in NFS protocol.
2341 If you encounter "ERROR: Cannot umount" in nfs command,
2342 try longer timeout such as
2343 #define CONFIG_NFS_TIMEOUT 10000UL
2344
wdenkc6097192002-11-03 00:24:07 +00002345- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002346 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002347
2348 Enable auto completion of commands using TAB.
2349
Wolfgang Denk018147d2006-11-27 15:32:42 +01002350 Note that this feature has NOT been implemented yet
2351 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002352
2353
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002354 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002355
2356 Define this variable to enable the "hush" shell (from
2357 Busybox) as command line interpreter, thus enabling
2358 powerful command line syntax like
2359 if...then...else...fi conditionals or `&&' and '||'
2360 constructs ("shell scripts").
2361
2362 If undefined, you get the old, much simpler behaviour
2363 with a somewhat smaller memory footprint.
2364
2365
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002366 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002367
2368 This defines the secondary prompt string, which is
2369 printed when the command interpreter needs more input
2370 to complete a command. Usually "> ".
2371
2372 Note:
2373
wdenk57b2d802003-06-27 21:31:46 +00002374 In the current implementation, the local variables
2375 space and global environment variables space are
2376 separated. Local variables are those you define by
2377 simply typing `name=value'. To access a local
2378 variable later on, you have write `$name' or
2379 `${name}'; to execute the contents of a variable
2380 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002381
wdenk4a5c8a72003-03-06 00:02:04 +00002382 Global environment variables are those you use
2383 setenv/printenv to work with. To run a command stored
2384 in such a variable, you need to use the run command,
2385 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002386
2387 To store commands and special characters in a
2388 variable, please use double quotation marks
2389 surrounding the whole text of the variable, instead
2390 of the backslashes before semicolons and special
2391 symbols.
2392
Wolfgang Denk2039a072006-07-21 11:35:21 +02002393- Commandline Editing and History:
2394 CONFIG_CMDLINE_EDITING
2395
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002396 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002397 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002398
wdenkc0aa5c52003-12-06 19:49:23 +00002399- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002400 CONFIG_EXTRA_ENV_SETTINGS
2401
wdenk4a5c8a72003-03-06 00:02:04 +00002402 Define this to contain any number of null terminated
2403 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002404 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002405
wdenk4a5c8a72003-03-06 00:02:04 +00002406 For example, place something like this in your
2407 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002408
2409 #define CONFIG_EXTRA_ENV_SETTINGS \
2410 "myvar1=value1\0" \
2411 "myvar2=value2\0"
2412
wdenk4a5c8a72003-03-06 00:02:04 +00002413 Warning: This method is based on knowledge about the
2414 internal format how the environment is stored by the
2415 U-Boot code. This is NOT an official, exported
2416 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002417 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002418 You better know what you are doing here.
2419
wdenk4a5c8a72003-03-06 00:02:04 +00002420 Note: overly (ab)use of the default environment is
2421 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002422 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002423 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002424
Stephen Warren1465d5f2012-05-22 09:21:54 +00002425 CONFIG_ENV_VARS_UBOOT_CONFIG
2426
2427 Define this in order to add variables describing the
2428 U-Boot build configuration to the default environment.
2429 These will be named arch, cpu, board, vendor, and soc.
2430
2431 Enabling this option will cause the following to be defined:
2432
2433 - CONFIG_SYS_ARCH
2434 - CONFIG_SYS_CPU
2435 - CONFIG_SYS_BOARD
2436 - CONFIG_SYS_VENDOR
2437 - CONFIG_SYS_SOC
2438
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002439 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2440
2441 Define this in order to add variables describing certain
2442 run-time determined information about the hardware to the
2443 environment. These will be named board_name, board_rev.
2444
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002445 CONFIG_DELAY_ENVIRONMENT
2446
2447 Normally the environment is loaded when the board is
2448 intialised so that it is available to U-Boot. This inhibits
2449 that so that the environment is not available until
2450 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2451 this is instead controlled by the value of
2452 /config/load-environment.
2453
wdenkc0aa5c52003-12-06 19:49:23 +00002454- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002455 CONFIG_HAS_DATAFLASH
2456
wdenk57b2d802003-06-27 21:31:46 +00002457 Defining this option enables DataFlash features and
2458 allows to read/write in Dataflash via the standard
2459 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002460
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002461- Serial Flash support
2462 CONFIG_CMD_SF
2463
2464 Defining this option enables SPI flash commands
2465 'sf probe/read/write/erase/update'.
2466
2467 Usage requires an initial 'probe' to define the serial
2468 flash parameters, followed by read/write/erase/update
2469 commands.
2470
2471 The following defaults may be provided by the platform
2472 to handle the common case when only a single serial
2473 flash is present on the system.
2474
2475 CONFIG_SF_DEFAULT_BUS Bus identifier
2476 CONFIG_SF_DEFAULT_CS Chip-select
2477 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2478 CONFIG_SF_DEFAULT_SPEED in Hz
2479
Simon Glass4b5545e2012-10-08 13:16:02 +00002480 CONFIG_CMD_SF_TEST
2481
2482 Define this option to include a destructive SPI flash
2483 test ('sf test').
2484
wdenkef893942004-02-23 16:11:30 +00002485- SystemACE Support:
2486 CONFIG_SYSTEMACE
2487
2488 Adding this option adds support for Xilinx SystemACE
2489 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002490 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002491 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002492
2493 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002495
2496 When SystemACE support is added, the "ace" device type
2497 becomes available to the fat commands, i.e. fatls.
2498
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002499- TFTP Fixed UDP Port:
2500 CONFIG_TFTP_PORT
2501
Wolfgang Denk227b5192005-09-24 23:25:46 +02002502 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002503 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002504 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002505 number generator is used.
2506
Wolfgang Denk227b5192005-09-24 23:25:46 +02002507 Also, the environment variable tftpdstp is used to supply
2508 the TFTP UDP destination port value. If tftpdstp isn't
2509 defined, the normal port 69 is used.
2510
2511 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002512 blindly start the TFTP transfer using the pre-configured
2513 target IP address and UDP port. This has the effect of
2514 "punching through" the (Windows XP) firewall, allowing
2515 the remainder of the TFTP transfer to proceed normally.
2516 A better solution is to properly configure the firewall,
2517 but sometimes that is not allowed.
2518
Simon Glass058bb8d2012-12-05 14:46:38 +00002519- Hashing support:
2520 CONFIG_CMD_HASH
2521
2522 This enables a generic 'hash' command which can produce
2523 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2524
2525 CONFIG_HASH_VERIFY
2526
2527 Enable the hash verify command (hash -v). This adds to code
2528 size a little.
2529
2530 CONFIG_SHA1 - support SHA1 hashing
2531 CONFIG_SHA256 - support SHA256 hashing
2532
2533 Note: There is also a sha1sum command, which should perhaps
2534 be deprecated in favour of 'hash sha1'.
2535
wdenkc0aa5c52003-12-06 19:49:23 +00002536- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002537 CONFIG_SHOW_BOOT_PROGRESS
2538
wdenk4a5c8a72003-03-06 00:02:04 +00002539 Defining this option allows to add some board-
2540 specific code (calling a user-provided function
2541 "show_boot_progress(int)") that enables you to show
2542 the system's boot progress on some display (for
2543 example, some LED's) on your board. At the moment,
2544 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002545
Simon Glass31a870e2012-02-13 13:51:19 +00002546- Detailed boot stage timing
2547 CONFIG_BOOTSTAGE
2548 Define this option to get detailed timing of each stage
2549 of the boot process.
2550
2551 CONFIG_BOOTSTAGE_USER_COUNT
2552 This is the number of available user bootstage records.
2553 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2554 a new ID will be allocated from this stash. If you exceed
2555 the limit, recording will stop.
2556
2557 CONFIG_BOOTSTAGE_REPORT
2558 Define this to print a report before boot, similar to this:
2559
2560 Timer summary in microseconds:
2561 Mark Elapsed Stage
2562 0 0 reset
2563 3,575,678 3,575,678 board_init_f start
2564 3,575,695 17 arch_cpu_init A9
2565 3,575,777 82 arch_cpu_init done
2566 3,659,598 83,821 board_init_r start
2567 3,910,375 250,777 main_loop
2568 29,916,167 26,005,792 bootm_start
2569 30,361,327 445,160 start_kernel
2570
Simon Glass4afd88e2012-09-28 08:56:39 +00002571 CONFIG_CMD_BOOTSTAGE
2572 Add a 'bootstage' command which supports printing a report
2573 and un/stashing of bootstage data.
2574
Simon Glass0fa36a42012-09-28 08:56:37 +00002575 CONFIG_BOOTSTAGE_FDT
2576 Stash the bootstage information in the FDT. A root 'bootstage'
2577 node is created with each bootstage id as a child. Each child
2578 has a 'name' property and either 'mark' containing the
2579 mark time in microsecond, or 'accum' containing the
2580 accumulated time for that bootstage id in microseconds.
2581 For example:
2582
2583 bootstage {
2584 154 {
2585 name = "board_init_f";
2586 mark = <3575678>;
2587 };
2588 170 {
2589 name = "lcd";
2590 accum = <33482>;
2591 };
2592 };
2593
2594 Code in the Linux kernel can find this in /proc/devicetree.
2595
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002596Legacy uImage format:
2597
wdenkc6097192002-11-03 00:24:07 +00002598 Arg Where When
2599 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002600 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002601 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002602 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002603 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002604 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002605 4 common/cmd_bootm.c Image data has correct checksum
2606 -4 common/cmd_bootm.c Image is for unsupported architecture
2607 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002608 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002609 6 common/cmd_bootm.c Image Type check OK
2610 -6 common/cmd_bootm.c gunzip uncompression error
2611 -7 common/cmd_bootm.c Unimplemented compression type
2612 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002613 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002614 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002615
2616 9 common/image.c Start initial ramdisk verification
2617 -10 common/image.c Ramdisk header has bad magic number
2618 -11 common/image.c Ramdisk header has bad checksum
2619 10 common/image.c Ramdisk header is OK
2620 -12 common/image.c Ramdisk data has bad checksum
2621 11 common/image.c Ramdisk data has correct checksum
2622 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002623 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002624 13 common/image.c Start multifile image verification
2625 14 common/image.c No initial ramdisk, no multifile, continue.
2626
Wolfgang Denk092ae952011-10-26 10:21:21 +00002627 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002628
Stefan Roese88fbf932010-04-15 16:07:28 +02002629 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002630 -31 post/post.c POST test failed, detected by post_output_backlog()
2631 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002632
Heiko Schocher633e03a2007-06-22 19:11:54 +02002633 34 common/cmd_doc.c before loading a Image from a DOC device
2634 -35 common/cmd_doc.c Bad usage of "doc" command
2635 35 common/cmd_doc.c correct usage of "doc" command
2636 -36 common/cmd_doc.c No boot device
2637 36 common/cmd_doc.c correct boot device
2638 -37 common/cmd_doc.c Unknown Chip ID on boot device
2639 37 common/cmd_doc.c correct chip ID found, device available
2640 -38 common/cmd_doc.c Read Error on boot device
2641 38 common/cmd_doc.c reading Image header from DOC device OK
2642 -39 common/cmd_doc.c Image header has bad magic number
2643 39 common/cmd_doc.c Image header has correct magic number
2644 -40 common/cmd_doc.c Error reading Image from DOC device
2645 40 common/cmd_doc.c Image header has correct magic number
2646 41 common/cmd_ide.c before loading a Image from a IDE device
2647 -42 common/cmd_ide.c Bad usage of "ide" command
2648 42 common/cmd_ide.c correct usage of "ide" command
2649 -43 common/cmd_ide.c No boot device
2650 43 common/cmd_ide.c boot device found
2651 -44 common/cmd_ide.c Device not available
2652 44 common/cmd_ide.c Device available
2653 -45 common/cmd_ide.c wrong partition selected
2654 45 common/cmd_ide.c partition selected
2655 -46 common/cmd_ide.c Unknown partition table
2656 46 common/cmd_ide.c valid partition table found
2657 -47 common/cmd_ide.c Invalid partition type
2658 47 common/cmd_ide.c correct partition type
2659 -48 common/cmd_ide.c Error reading Image Header on boot device
2660 48 common/cmd_ide.c reading Image Header from IDE device OK
2661 -49 common/cmd_ide.c Image header has bad magic number
2662 49 common/cmd_ide.c Image header has correct magic number
2663 -50 common/cmd_ide.c Image header has bad checksum
2664 50 common/cmd_ide.c Image header has correct checksum
2665 -51 common/cmd_ide.c Error reading Image from IDE device
2666 51 common/cmd_ide.c reading Image from IDE device OK
2667 52 common/cmd_nand.c before loading a Image from a NAND device
2668 -53 common/cmd_nand.c Bad usage of "nand" command
2669 53 common/cmd_nand.c correct usage of "nand" command
2670 -54 common/cmd_nand.c No boot device
2671 54 common/cmd_nand.c boot device found
2672 -55 common/cmd_nand.c Unknown Chip ID on boot device
2673 55 common/cmd_nand.c correct chip ID found, device available
2674 -56 common/cmd_nand.c Error reading Image Header on boot device
2675 56 common/cmd_nand.c reading Image Header from NAND device OK
2676 -57 common/cmd_nand.c Image header has bad magic number
2677 57 common/cmd_nand.c Image header has correct magic number
2678 -58 common/cmd_nand.c Error reading Image from NAND device
2679 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002680
Heiko Schocher633e03a2007-06-22 19:11:54 +02002681 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002682
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002683 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002684 -64 net/eth.c no Ethernet found.
2685 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002686
Heiko Schocher633e03a2007-06-22 19:11:54 +02002687 -80 common/cmd_net.c usage wrong
2688 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002689 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002690 81 common/cmd_net.c NetLoop() back without error
2691 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2692 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002693 83 common/cmd_net.c running "source" command
2694 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002695 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002696
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002697FIT uImage format:
2698
2699 Arg Where When
2700 100 common/cmd_bootm.c Kernel FIT Image has correct format
2701 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2702 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2703 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2704 102 common/cmd_bootm.c Kernel unit name specified
2705 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002706 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002707 104 common/cmd_bootm.c Got kernel subimage node offset
2708 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2709 105 common/cmd_bootm.c Kernel subimage hash verification OK
2710 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2711 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002712 -106 common/cmd_bootm.c Kernel subimage has wrong type
2713 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002714 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2715 108 common/cmd_bootm.c Got kernel subimage data/size
2716 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2717 -109 common/cmd_bootm.c Can't get kernel subimage type
2718 -110 common/cmd_bootm.c Can't get kernel subimage comp
2719 -111 common/cmd_bootm.c Can't get kernel subimage os
2720 -112 common/cmd_bootm.c Can't get kernel subimage load address
2721 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2722
2723 120 common/image.c Start initial ramdisk verification
2724 -120 common/image.c Ramdisk FIT image has incorrect format
2725 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002726 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002727 -122 common/image.c Can't get configuration for ramdisk subimage
2728 123 common/image.c Ramdisk unit name specified
2729 -124 common/image.c Can't get ramdisk subimage node offset
2730 125 common/image.c Got ramdisk subimage node offset
2731 -125 common/image.c Ramdisk subimage hash verification failed
2732 126 common/image.c Ramdisk subimage hash verification OK
2733 -126 common/image.c Ramdisk subimage for unsupported architecture
2734 127 common/image.c Architecture check OK
2735 -127 common/image.c Can't get ramdisk subimage data/size
2736 128 common/image.c Got ramdisk subimage data/size
2737 129 common/image.c Can't get ramdisk load address
2738 -129 common/image.c Got ramdisk load address
2739
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002740 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002741 131 common/cmd_doc.c FIT image format OK
2742
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002743 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002744 141 common/cmd_ide.c FIT image format OK
2745
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002746 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002747 151 common/cmd_nand.c FIT image format OK
2748
Gabe Blackd572e162012-10-25 16:31:10 +00002749- FIT image support:
2750 CONFIG_FIT
2751 Enable support for the FIT uImage format.
2752
2753 CONFIG_FIT_BEST_MATCH
2754 When no configuration is explicitly selected, default to the
2755 one whose fdt's compatibility field best matches that of
2756 U-Boot itself. A match is considered "best" if it matches the
2757 most specific compatibility entry of U-Boot's fdt's root node.
2758 The order of entries in the configuration's fdt is ignored.
2759
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002760- Standalone program support:
2761 CONFIG_STANDALONE_LOAD_ADDR
2762
Wolfgang Denk23f78482011-10-09 21:06:34 +02002763 This option defines a board specific value for the
2764 address where standalone program gets loaded, thus
2765 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002766 settings.
2767
2768- Frame Buffer Address:
2769 CONFIG_FB_ADDR
2770
2771 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002772 address for frame buffer. This is typically the case
2773 when using a graphics controller has separate video
2774 memory. U-Boot will then place the frame buffer at
2775 the given address instead of dynamically reserving it
2776 in system RAM by calling lcd_setmem(), which grabs
2777 the memory for the frame buffer depending on the
2778 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002779
2780 Please see board_init_f function.
2781
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002782- Automatic software updates via TFTP server
2783 CONFIG_UPDATE_TFTP
2784 CONFIG_UPDATE_TFTP_CNT_MAX
2785 CONFIG_UPDATE_TFTP_MSEC_MAX
2786
2787 These options enable and control the auto-update feature;
2788 for a more detailed description refer to doc/README.update.
2789
2790- MTD Support (mtdparts command, UBI support)
2791 CONFIG_MTD_DEVICE
2792
2793 Adds the MTD device infrastructure from the Linux kernel.
2794 Needed for mtdparts command support.
2795
2796 CONFIG_MTD_PARTITIONS
2797
2798 Adds the MTD partitioning infrastructure from the Linux
2799 kernel. Needed for UBI support.
2800
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002801- UBI support
2802 CONFIG_CMD_UBI
2803
2804 Adds commands for interacting with MTD partitions formatted
2805 with the UBI flash translation layer
2806
2807 Requires also defining CONFIG_RBTREE
2808
Joe Hershberger47550fc2013-04-08 10:32:49 +00002809 CONFIG_UBI_SILENCE_MSG
2810
2811 Make the verbose messages from UBI stop printing. This leaves
2812 warnings and errors enabled.
2813
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002814- UBIFS support
2815 CONFIG_CMD_UBIFS
2816
2817 Adds commands for interacting with UBI volumes formatted as
2818 UBIFS. UBIFS is read-only in u-boot.
2819
2820 Requires UBI support as well as CONFIG_LZO
2821
Joe Hershberger47550fc2013-04-08 10:32:49 +00002822 CONFIG_UBIFS_SILENCE_MSG
2823
2824 Make the verbose messages from UBIFS stop printing. This leaves
2825 warnings and errors enabled.
2826
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002827- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002828 CONFIG_SPL
2829 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002830
Tom Rini36853852012-02-14 07:29:40 +00002831 CONFIG_SPL_LDSCRIPT
2832 LDSCRIPT for linking the SPL binary.
2833
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002834 CONFIG_SPL_MAX_FOOTPRINT
2835 Maximum size in memory allocated to the SPL, BSS included.
2836 When defined, the linker checks that the actual memory
2837 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002838 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002839 must not be both defined at the same time.
2840
Tom Rini36853852012-02-14 07:29:40 +00002841 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002842 Maximum size of the SPL image (text, data, rodata, and
2843 linker lists sections), BSS excluded.
2844 When defined, the linker checks that the actual size does
2845 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002846
Wolfgang Denk825223d2011-09-11 21:24:09 +02002847 CONFIG_SPL_TEXT_BASE
2848 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002849
Scott Woodc4f0d002012-09-20 19:05:12 -05002850 CONFIG_SPL_RELOC_TEXT_BASE
2851 Address to relocate to. If unspecified, this is equal to
2852 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2853
Tom Rini36853852012-02-14 07:29:40 +00002854 CONFIG_SPL_BSS_START_ADDR
2855 Link address for the BSS within the SPL binary.
2856
2857 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002858 Maximum size in memory allocated to the SPL BSS.
2859 When defined, the linker checks that the actual memory used
2860 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002861 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002862 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002863
2864 CONFIG_SPL_STACK
2865 Adress of the start of the stack SPL will use
2866
Scott Woodc4f0d002012-09-20 19:05:12 -05002867 CONFIG_SPL_RELOC_STACK
2868 Adress of the start of the stack SPL will use after
2869 relocation. If unspecified, this is equal to
2870 CONFIG_SPL_STACK.
2871
Tom Rini36853852012-02-14 07:29:40 +00002872 CONFIG_SYS_SPL_MALLOC_START
2873 Starting address of the malloc pool used in SPL.
2874
2875 CONFIG_SYS_SPL_MALLOC_SIZE
2876 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002877
Tom Rini28591df2012-08-13 12:03:19 -07002878 CONFIG_SPL_FRAMEWORK
2879 Enable the SPL framework under common/. This framework
2880 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2881 NAND loading of the Linux Kernel.
2882
Tom Rinife3b0c72012-08-13 11:37:56 -07002883 CONFIG_SPL_DISPLAY_PRINT
2884 For ARM, enable an optional function to print more information
2885 about the running system.
2886
Scott Wood7c810902012-09-20 16:35:21 -05002887 CONFIG_SPL_INIT_MINIMAL
2888 Arch init code should be built for a very small image
2889
Wolfgang Denk825223d2011-09-11 21:24:09 +02002890 CONFIG_SPL_LIBCOMMON_SUPPORT
2891 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002892
Wolfgang Denk825223d2011-09-11 21:24:09 +02002893 CONFIG_SPL_LIBDISK_SUPPORT
2894 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002895
Wolfgang Denk825223d2011-09-11 21:24:09 +02002896 CONFIG_SPL_I2C_SUPPORT
2897 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002898
Wolfgang Denk825223d2011-09-11 21:24:09 +02002899 CONFIG_SPL_GPIO_SUPPORT
2900 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002901
Wolfgang Denk825223d2011-09-11 21:24:09 +02002902 CONFIG_SPL_MMC_SUPPORT
2903 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002904
Tom Rini36853852012-02-14 07:29:40 +00002905 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2906 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2907 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2908 Address, size and partition on the MMC to load U-Boot from
2909 when the MMC is being used in raw mode.
2910
2911 CONFIG_SPL_FAT_SUPPORT
2912 Support for fs/fat/libfat.o in SPL binary
2913
2914 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2915 Filename to read to load U-Boot when reading from FAT
2916
Scott Wood2b36fbb2012-12-06 13:33:17 +00002917 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2918 Set this for NAND SPL on PPC mpc83xx targets, so that
2919 start.S waits for the rest of the SPL to load before
2920 continuing (the hardware starts execution after just
2921 loading the first page rather than the full 4K).
2922
Scott Woodc352a0c2012-09-20 19:09:07 -05002923 CONFIG_SPL_NAND_BASE
2924 Include nand_base.c in the SPL. Requires
2925 CONFIG_SPL_NAND_DRIVERS.
2926
2927 CONFIG_SPL_NAND_DRIVERS
2928 SPL uses normal NAND drivers, not minimal drivers.
2929
2930 CONFIG_SPL_NAND_ECC
2931 Include standard software ECC in the SPL
2932
Tom Rini36853852012-02-14 07:29:40 +00002933 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002934 Support for NAND boot using simple NAND drivers that
2935 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002936
2937 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2938 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2939 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2940 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2941 CONFIG_SYS_NAND_ECCBYTES
2942 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002943 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002944
2945 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002946 Location in NAND to read U-Boot from
2947
2948 CONFIG_SYS_NAND_U_BOOT_DST
2949 Location in memory to load U-Boot to
2950
2951 CONFIG_SYS_NAND_U_BOOT_SIZE
2952 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002953
2954 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002955 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002956
2957 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2958 Define this if you need to first read the OOB and then the
2959 data. This is used for example on davinci plattforms.
2960
2961 CONFIG_SPL_OMAP3_ID_NAND
2962 Support for an OMAP3-specific set of functions to return the
2963 ID and MFR of the first attached NAND chip, if present.
2964
Wolfgang Denk825223d2011-09-11 21:24:09 +02002965 CONFIG_SPL_SERIAL_SUPPORT
2966 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002967
Wolfgang Denk825223d2011-09-11 21:24:09 +02002968 CONFIG_SPL_SPI_FLASH_SUPPORT
2969 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002970
Wolfgang Denk825223d2011-09-11 21:24:09 +02002971 CONFIG_SPL_SPI_SUPPORT
2972 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002973
Pavel Machekde997252012-08-30 22:42:11 +02002974 CONFIG_SPL_RAM_DEVICE
2975 Support for running image already present in ram, in SPL binary
2976
Wolfgang Denk825223d2011-09-11 21:24:09 +02002977 CONFIG_SPL_LIBGENERIC_SUPPORT
2978 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002979
Scott Woodeb7bd972012-12-06 13:33:16 +00002980 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002981 Image offset to which the SPL should be padded before appending
2982 the SPL payload. By default, this is defined as
2983 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2984 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2985 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002986
Scott Woodf147eb72012-09-21 16:27:32 -05002987 CONFIG_SPL_TARGET
2988 Final target image containing SPL and payload. Some SPLs
2989 use an arch-specific makefile fragment instead, for
2990 example if more than one image needs to be produced.
2991
wdenkc6097192002-11-03 00:24:07 +00002992Modem Support:
2993--------------
2994
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002995[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002996
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002997- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002998 CONFIG_MODEM_SUPPORT
2999
3000- RTS/CTS Flow control enable:
3001 CONFIG_HWFLOW
3002
3003- Modem debug support:
3004 CONFIG_MODEM_SUPPORT_DEBUG
3005
wdenk4a5c8a72003-03-06 00:02:04 +00003006 Enables debugging stuff (char screen[1024], dbg())
3007 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003008
wdenkc0aa5c52003-12-06 19:49:23 +00003009- Interrupt support (PPC):
3010
wdenk1ebf41e2004-01-02 14:00:00 +00003011 There are common interrupt_init() and timer_interrupt()
3012 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003013 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003014 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003015 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003016 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003017 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003018 specific handling. If board has watchdog / status_led
3019 / other_activity_monitor it works automatically from
3020 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003021
wdenkc6097192002-11-03 00:24:07 +00003022- General:
3023
wdenk4a5c8a72003-03-06 00:02:04 +00003024 In the target system modem support is enabled when a
3025 specific key (key combination) is pressed during
3026 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003027 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003028 board_init(). Currently key_pressed() is a dummy
3029 function, returning 1 and thus enabling modem
3030 initialization.
wdenkc6097192002-11-03 00:24:07 +00003031
wdenk4a5c8a72003-03-06 00:02:04 +00003032 If there are no modem init strings in the
3033 environment, U-Boot proceed to autoboot; the
3034 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003035 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003036
3037 See also: doc/README.Modem
3038
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003039Board initialization settings:
3040------------------------------
3041
3042During Initialization u-boot calls a number of board specific functions
3043to allow the preparation of board specific prerequisites, e.g. pin setup
3044before drivers are initialized. To enable these callbacks the
3045following configuration macros have to be defined. Currently this is
3046architecture specific, so please check arch/your_architecture/lib/board.c
3047typically in board_init_f() and board_init_r().
3048
3049- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3050- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3051- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3052- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003053
wdenkc6097192002-11-03 00:24:07 +00003054Configuration Settings:
3055-----------------------
3056
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003057- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003058 undefine this when you're short of memory.
3059
Peter Tyserdfb72b82009-01-27 18:03:12 -06003060- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3061 width of the commands listed in the 'help' command output.
3062
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003063- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003064 prompt for user input.
3065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003066- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003068- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003070- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003072- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003073 the application (usually a Linux kernel) when it is
3074 booted
3075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003076- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003077 List of legal baudrate settings for this board.
3078
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003079- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003080 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003082- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003083 If the board specific function
3084 extern int overwrite_console (void);
3085 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003086 serial port, else the settings in the environment are used.
3087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003088- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003089 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003090
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003091- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003092 Enable overwrite of previous console environment settings.
3093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003094- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003095 Begin and End addresses of the area used by the
3096 simple memory test.
3097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003098- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003099 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003101- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003102 Scratch address used by the alternate memory test
3103 You only need to set this if address zero isn't writeable
3104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3106 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003107 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003108 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003109 fixing up gd->ram_size the Linux kernel should gets passed
3110 the now "corrected" memory size and won't touch it either.
3111 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003112 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003113 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003114 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003115
3116 This option can be used as a workaround for the 440EPx/GRx
3117 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3118 be touched.
3119
3120 WARNING: Please make sure that this value is a multiple of
3121 the Linux page size (normally 4k). If this is not the case,
3122 then the end address of the Linux memory will be located at a
3123 non page size aligned address and this could cause major
3124 problems.
3125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003126- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003127 Enable temporary baudrate change while serial download
3128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003129- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003130 Physical start address of SDRAM. _Must_ be 0 here.
3131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003132- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003133 Physical start address of Motherboard I/O (if using a
3134 Cogent motherboard)
3135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003136- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003137 Physical start address of Flash memory.
3138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003139- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003140 Physical start address of boot monitor code (set by
3141 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003142 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003143 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003144
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003145- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003146 Size of memory reserved for monitor code, used to
3147 determine _at_compile_time_ (!) if the environment is
3148 embedded within the U-Boot image, or in a separate
3149 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003150
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003151- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003152 Size of DRAM reserved for malloc() use.
3153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003154- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003155 Normally compressed uImages are limited to an
3156 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003157 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003158 to adjust this setting to your needs.
3159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003160- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003161 Maximum size of memory mapped by the startup code of
3162 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003163 the Linux kernel (bd_info, boot arguments, FDT blob if
3164 used) must be put below this limit, unless "bootm_low"
3165 enviroment variable is defined and non-zero. In such case
3166 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003167 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003168 variable "bootm_mapsize" will override the value of
3169 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3170 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003171
John Rigbyeea8e692010-10-13 13:57:35 -06003172- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3173 Enable initrd_high functionality. If defined then the
3174 initrd_high feature is enabled and the bootm ramdisk subcommand
3175 is enabled.
3176
3177- CONFIG_SYS_BOOT_GET_CMDLINE:
3178 Enables allocating and saving kernel cmdline in space between
3179 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3180
3181- CONFIG_SYS_BOOT_GET_KBD:
3182 Enables allocating and saving a kernel copy of the bd_info in
3183 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3184
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003185- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003186 Max number of Flash memory banks
3187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003188- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003189 Max number of sectors on a Flash chip
3190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003191- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003192 Timeout for Flash erase operations (in ms)
3193
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003194- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003195 Timeout for Flash write operations (in ms)
3196
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003197- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003198 Timeout for Flash set sector lock bit operation (in ms)
3199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003200- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003201 Timeout for Flash clear lock bits operation (in ms)
3202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003203- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003204 If defined, hardware flash sectors protection is used
3205 instead of U-Boot software protection.
3206
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003207- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003208
3209 Enable TFTP transfers directly to flash memory;
3210 without this option such a download has to be
3211 performed in two steps: (1) download to RAM, and (2)
3212 copy from RAM to flash.
3213
3214 The two-step approach is usually more reliable, since
3215 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003216 the flash, but in some situations (when system RAM is
3217 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003218 downloaded image) this option may be very useful.
3219
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003220- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003221 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003222 common flash structure for storing flash geometry.
3223
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003224- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003225 This option also enables the building of the cfi_flash driver
3226 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003227
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003228- CONFIG_FLASH_CFI_MTD
3229 This option enables the building of the cfi_mtd driver
3230 in the drivers directory. The driver exports CFI flash
3231 to the MTD layer.
3232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003233- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003234 Use buffered writes to flash.
3235
3236- CONFIG_FLASH_SPANSION_S29WS_N
3237 s29ws-n MirrorBit flash has non-standard addresses for buffered
3238 write commands.
3239
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003240- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003241 If this option is defined, the common CFI flash doesn't
3242 print it's warning upon not recognized FLASH banks. This
3243 is useful, if some of the configured banks are only
3244 optionally available.
3245
Jerry Van Barenaae73572008-03-08 13:48:01 -05003246- CONFIG_FLASH_SHOW_PROGRESS
3247 If defined (must be an integer), print out countdown
3248 digits and dots. Recommended value: 45 (9..1) for 80
3249 column displays, 15 (3..1) for 40 column displays.
3250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003251- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003252 Defines the number of Ethernet receive buffers. On some
3253 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003254 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3255 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003256 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003257 Defaults to 4 if not defined.
3258
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003259- CONFIG_ENV_MAX_ENTRIES
3260
Wolfgang Denk1136f692010-10-27 22:48:30 +02003261 Maximum number of entries in the hash table that is used
3262 internally to store the environment settings. The default
3263 setting is supposed to be generous and should work in most
3264 cases. This setting can be used to tune behaviour; see
3265 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003266
Joe Hershberger71497d02012-12-11 22:16:31 -06003267- CONFIG_ENV_FLAGS_LIST_DEFAULT
3268- CONFIG_ENV_FLAGS_LIST_STATIC
3269 Enable validation of the values given to enviroment variables when
3270 calling env set. Variables can be restricted to only decimal,
3271 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3272 the variables can also be restricted to IP address or MAC address.
3273
3274 The format of the list is:
3275 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003276 access_atribute = [a|r|o|c]
3277 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003278 entry = variable_name[:attributes]
3279 list = entry[,list]
3280
3281 The type attributes are:
3282 s - String (default)
3283 d - Decimal
3284 x - Hexadecimal
3285 b - Boolean ([1yYtT|0nNfF])
3286 i - IP address
3287 m - MAC address
3288
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003289 The access attributes are:
3290 a - Any (default)
3291 r - Read-only
3292 o - Write-once
3293 c - Change-default
3294
Joe Hershberger71497d02012-12-11 22:16:31 -06003295 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3296 Define this to a list (string) to define the ".flags"
3297 envirnoment variable in the default or embedded environment.
3298
3299 - CONFIG_ENV_FLAGS_LIST_STATIC
3300 Define this to a list (string) to define validation that
3301 should be done if an entry is not found in the ".flags"
3302 environment variable. To override a setting in the static
3303 list, simply add an entry for the same variable name to the
3304 ".flags" variable.
3305
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003306- CONFIG_ENV_ACCESS_IGNORE_FORCE
3307 If defined, don't allow the -f switch to env set override variable
3308 access flags.
3309
Simon Glass66828322013-03-08 13:45:27 +00003310- CONFIG_SYS_GENERIC_BOARD
3311 This selects the architecture-generic board system instead of the
3312 architecture-specific board files. It is intended to move boards
3313 to this new framework over time. Defining this will disable the
3314 arch/foo/lib/board.c file and use common/board_f.c and
3315 common/board_r.c instead. To use this option your architecture
3316 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3317 its config.mk file). If you find problems enabling this option on
3318 your board please report the problem and send patches!
3319
Simon Glass9c9f44a2013-03-11 07:06:48 +00003320- CONFIG_SYS_SYM_OFFSETS
3321 This is set by architectures that use offsets for link symbols
3322 instead of absolute values. So bss_start is obtained using an
3323 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3324 directly. You should not need to touch this setting.
3325
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003326- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3327 This is set by OMAP boards for the max time that reset should
3328 be asserted. See doc/README.omap-reset-time for details on how
3329 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003330
wdenkc6097192002-11-03 00:24:07 +00003331The following definitions that deal with the placement and management
3332of environment data (variable area); in general, we support the
3333following configurations:
3334
Mike Frysinger63b8f122011-07-08 10:44:25 +00003335- CONFIG_BUILD_ENVCRC:
3336
3337 Builds up envcrc with the target environment so that external utils
3338 may easily extract it and embed it in final U-Boot images.
3339
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003340- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003341
3342 Define this if the environment is in flash memory.
3343
3344 a) The environment occupies one whole flash sector, which is
3345 "embedded" in the text segment with the U-Boot code. This
3346 happens usually with "bottom boot sector" or "top boot
3347 sector" type flash chips, which have several smaller
3348 sectors at the start or the end. For instance, such a
3349 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3350 such a case you would place the environment in one of the
3351 4 kB sectors - with U-Boot code before and after it. With
3352 "top boot sector" type flash chips, you would put the
3353 environment in one of the last sectors, leaving a gap
3354 between U-Boot and the environment.
3355
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003356 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003357
3358 Offset of environment data (variable area) to the
3359 beginning of flash memory; for instance, with bottom boot
3360 type flash chips the second sector can be used: the offset
3361 for this sector is given here.
3362
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003363 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003364
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003365 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003366
3367 This is just another way to specify the start address of
3368 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003369 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003370
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003371 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003372
3373 Size of the sector containing the environment.
3374
3375
3376 b) Sometimes flash chips have few, equal sized, BIG sectors.
3377 In such a case you don't want to spend a whole sector for
3378 the environment.
3379
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003380 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003381
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003382 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003383 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003384 of this flash sector for the environment. This saves
3385 memory for the RAM copy of the environment.
3386
3387 It may also save flash memory if you decide to use this
3388 when your environment is "embedded" within U-Boot code,
3389 since then the remainder of the flash sector could be used
3390 for U-Boot code. It should be pointed out that this is
3391 STRONGLY DISCOURAGED from a robustness point of view:
3392 updating the environment in flash makes it always
3393 necessary to erase the WHOLE sector. If something goes
3394 wrong before the contents has been restored from a copy in
3395 RAM, your target system will be dead.
3396
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003397 - CONFIG_ENV_ADDR_REDUND
3398 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003399
wdenk4a5c8a72003-03-06 00:02:04 +00003400 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003401 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003402 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003403 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003404
3405BE CAREFUL! Any changes to the flash layout, and some changes to the
3406source code will make it necessary to adapt <board>/u-boot.lds*
3407accordingly!
3408
3409
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003410- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003411
3412 Define this if you have some non-volatile memory device
3413 (NVRAM, battery buffered SRAM) which you want to use for the
3414 environment.
3415
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003416 - CONFIG_ENV_ADDR:
3417 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003418
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003419 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003420 want to use for environment. It is assumed that this memory
3421 can just be read and written to, without any special
3422 provision.
3423
3424BE CAREFUL! The first access to the environment happens quite early
3425in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003426console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003427U-Boot will hang.
3428
3429Please note that even with NVRAM we still use a copy of the
3430environment in RAM: we could work on NVRAM directly, but we want to
3431keep settings there always unmodified except somebody uses "saveenv"
3432to save the current settings.
3433
3434
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003435- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003436
3437 Use this if you have an EEPROM or similar serial access
3438 device and a driver for it.
3439
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003440 - CONFIG_ENV_OFFSET:
3441 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003442
3443 These two #defines specify the offset and size of the
3444 environment area within the total memory of your EEPROM.
3445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003446 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003447 If defined, specified the chip address of the EEPROM device.
3448 The default address is zero.
3449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003450 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003451 If defined, the number of bits used to address bytes in a
3452 single page in the EEPROM device. A 64 byte page, for example
3453 would require six bits.
3454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003455 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003456 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003457 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003458
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003459 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003460 The length in bytes of the EEPROM memory array address. Note
3461 that this is NOT the chip address length!
3462
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003463 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003464 EEPROM chips that implement "address overflow" are ones
3465 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3466 address and the extra bits end up in the "chip address" bit
3467 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3468 byte chips.
3469
3470 Note that we consider the length of the address field to
3471 still be one byte because the extra address bits are hidden
3472 in the chip address.
3473
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003474 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003475 The size in bytes of the EEPROM device.
3476
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003477 - CONFIG_ENV_EEPROM_IS_ON_I2C
3478 define this, if you have I2C and SPI activated, and your
3479 EEPROM, which holds the environment, is on the I2C bus.
3480
3481 - CONFIG_I2C_ENV_EEPROM_BUS
3482 if you have an Environment on an EEPROM reached over
3483 I2C muxes, you can define here, how to reach this
3484 EEPROM. For example:
3485
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003486 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003487
3488 EEPROM which holds the environment, is reached over
3489 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003490
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003491- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003492
wdenk1ebf41e2004-01-02 14:00:00 +00003493 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003494 want to use for the environment.
3495
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003496 - CONFIG_ENV_OFFSET:
3497 - CONFIG_ENV_ADDR:
3498 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003499
3500 These three #defines specify the offset and size of the
3501 environment area within the total memory of your DataFlash placed
3502 at the specified address.
3503
Liu Gang85bcd732012-03-08 00:33:20 +00003504- CONFIG_ENV_IS_IN_REMOTE:
3505
3506 Define this if you have a remote memory space which you
3507 want to use for the local device's environment.
3508
3509 - CONFIG_ENV_ADDR:
3510 - CONFIG_ENV_SIZE:
3511
3512 These two #defines specify the address and size of the
3513 environment area within the remote memory space. The
3514 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003515 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003516
3517BE CAREFUL! For some special cases, the local device can not use
3518"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003519environment stored in a remote NOR flash by SRIO or PCIE link,
3520but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003521
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003522- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003523
3524 Define this if you have a NAND device which you want to use
3525 for the environment.
3526
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003527 - CONFIG_ENV_OFFSET:
3528 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003529
3530 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003531 area within the first NAND device. CONFIG_ENV_OFFSET must be
3532 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003533
Scott Wood08239322010-09-17 14:38:37 -05003534 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003535
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003536 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003537 size used to hold a redundant copy of the environment data, so
3538 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003539 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003540 aligned to an erase block boundary.
3541
3542 - CONFIG_ENV_RANGE (optional):
3543
3544 Specifies the length of the region in which the environment
3545 can be written. This should be a multiple of the NAND device's
3546 block size. Specifying a range with more erase blocks than
3547 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3548 the range to be avoided.
3549
3550 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003551
Scott Wood08239322010-09-17 14:38:37 -05003552 Enables support for dynamically retrieving the offset of the
3553 environment from block zero's out-of-band data. The
3554 "nand env.oob" command can be used to record this offset.
3555 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3556 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003557
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003558- CONFIG_NAND_ENV_DST
3559
3560 Defines address in RAM to which the nand_spl code should copy the
3561 environment. If redundant environment is used, it will be copied to
3562 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3563
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003564- CONFIG_ENV_IS_IN_UBI:
3565
3566 Define this if you have an UBI volume that you want to use for the
3567 environment. This has the benefit of wear-leveling the environment
3568 accesses, which is important on NAND.
3569
3570 - CONFIG_ENV_UBI_PART:
3571
3572 Define this to a string that is the mtd partition containing the UBI.
3573
3574 - CONFIG_ENV_UBI_VOLUME:
3575
3576 Define this to the name of the volume that you want to store the
3577 environment in.
3578
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003579 - CONFIG_ENV_UBI_VOLUME_REDUND:
3580
3581 Define this to the name of another volume to store a second copy of
3582 the environment in. This will enable redundant environments in UBI.
3583 It is assumed that both volumes are in the same MTD partition.
3584
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003585 - CONFIG_UBI_SILENCE_MSG
3586 - CONFIG_UBIFS_SILENCE_MSG
3587
3588 You will probably want to define these to avoid a really noisy system
3589 when storing the env in UBI.
3590
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003591- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003592
3593 Defines offset to the initial SPI buffer area in DPRAM. The
3594 area is used at an early stage (ROM part) if the environment
3595 is configured to reside in the SPI EEPROM: We need a 520 byte
3596 scratch DPRAM area. It is used between the two initialization
3597 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3598 to be a good choice since it makes it far enough from the
3599 start of the data area as well as from the stack pointer.
3600
Bruce Adleredecc942007-11-02 13:15:42 -07003601Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003602has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003603created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003604until then to read environment variables.
3605
wdenk8dba0502003-03-31 16:34:49 +00003606The environment is protected by a CRC32 checksum. Before the monitor
3607is relocated into RAM, as a result of a bad CRC you will be working
3608with the compiled-in default environment - *silently*!!! [This is
3609necessary, because the first environment variable we need is the
3610"baudrate" setting for the console - if we have a bad CRC, we don't
3611have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003612
3613Note: once the monitor has been relocated, then it will complain if
3614the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003615use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003617- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003618 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003620 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003621 also needs to be defined.
3622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003623- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003624 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003625
Ron Madriddfa028a2009-02-18 14:30:44 -08003626- CONFIG_NS16550_MIN_FUNCTIONS:
3627 Define this if you desire to only have use of the NS16550_init
3628 and NS16550_putc functions for the serial driver located at
3629 drivers/serial/ns16550.c. This option is useful for saving
3630 space for already greatly restricted images, including but not
3631 limited to NAND_SPL configurations.
3632
Simon Glass28a9e332012-11-30 13:01:18 +00003633- CONFIG_DISPLAY_BOARDINFO
3634 Display information about the board that U-Boot is running on
3635 when U-Boot starts up. The board function checkboard() is called
3636 to do this.
3637
Simon Glasse8822012012-11-30 13:01:19 +00003638- CONFIG_DISPLAY_BOARDINFO_LATE
3639 Similar to the previous option, but display this information
3640 later, once stdio is running and output goes to the LCD, if
3641 present.
3642
wdenkc6097192002-11-03 00:24:07 +00003643Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003644---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003647 Cache Line Size of the CPU.
3648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003649- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003650 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003651
wdenk9c53f402003-10-15 23:53:47 +00003652 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3653 and RPXsuper) to be able to adjust the position of
3654 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003655
Timur Tabid8f341c2011-08-04 18:03:41 -05003656- CONFIG_SYS_CCSRBAR_DEFAULT:
3657 Default (power-on reset) physical address of CCSR on Freescale
3658 PowerPC SOCs.
3659
3660- CONFIG_SYS_CCSRBAR:
3661 Virtual address of CCSR. On a 32-bit build, this is typically
3662 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3663
3664 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3665 for cross-platform code that uses that macro instead.
3666
3667- CONFIG_SYS_CCSRBAR_PHYS:
3668 Physical address of CCSR. CCSR can be relocated to a new
3669 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003670 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003671 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3672 is typically relocated on 36-bit builds. It is recommended
3673 that this macro be defined via the _HIGH and _LOW macros:
3674
3675 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3676 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3677
3678- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003679 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3680 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003681 used in assembly code, so it must not contain typecasts or
3682 integer size suffixes (e.g. "ULL").
3683
3684- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3685 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3686 used in assembly code, so it must not contain typecasts or
3687 integer size suffixes (e.g. "ULL").
3688
3689- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3690 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3691 forced to a value that ensures that CCSR is not relocated.
3692
wdenk1272e232002-11-10 22:06:23 +00003693- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003694 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003695
3696 the default drive number (default value 0)
3697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003698 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003699
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003700 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003701 (default value 1)
3702
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003703 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003704
wdenk4a5c8a72003-03-06 00:02:04 +00003705 defines the offset of register from address. It
3706 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003707 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003709 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3710 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003711 default value.
wdenk1272e232002-11-10 22:06:23 +00003712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003713 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003714 fdc_hw_init() is called at the beginning of the FDC
3715 setup. fdc_hw_init() must be provided by the board
3716 source code. It is used to make hardware dependant
3717 initializations.
wdenk1272e232002-11-10 22:06:23 +00003718
Macpaul Lind1e49942011-04-11 20:45:32 +00003719- CONFIG_IDE_AHB:
3720 Most IDE controllers were designed to be connected with PCI
3721 interface. Only few of them were designed for AHB interface.
3722 When software is doing ATA command and data transfer to
3723 IDE devices through IDE-AHB controller, some additional
3724 registers accessing to these kind of IDE-AHB controller
3725 is requierd.
3726
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003727- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003728 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003729 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003730
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003731- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003732
wdenkeb20ad32003-09-05 23:19:14 +00003733 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003734 initial data and stack; please note that this must be
3735 writable memory that is working WITHOUT special
3736 initialization, i. e. you CANNOT use normal RAM which
3737 will become available only after programming the
3738 memory controller and running certain initialization
3739 sequences.
3740
3741 U-Boot uses the following memory types:
3742 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3743 - MPC824X: data cache
3744 - PPC4xx: data cache
3745
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003746- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003747
3748 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003749 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3750 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003751 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003752 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003753 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3754 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3755 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003756
3757 Note:
3758 On the MPC824X (or other systems that use the data
3759 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003760 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003761 point to an otherwise UNUSED address space between
3762 the top of RAM and the start of the PCI space.
3763
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003764- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003765
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003766- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003768- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003770- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003772- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003777 SDRAM timing
3778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003780 periodic timer for refresh
3781
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003782- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003783
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003784- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3785 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3786 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3787 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003788 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3789
3790- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003791 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3792 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003793 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3794
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003795- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3796 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003797 Machine Mode Register and Memory Periodic Timer
3798 Prescaler definitions (SDRAM timing)
3799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003800- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003801 enable I2C microcode relocation patch (MPC8xx);
3802 define relocation offset in DPRAM [DSP2]
3803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003804- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003805 enable SMC microcode relocation patch (MPC8xx);
3806 define relocation offset in DPRAM [SMC1]
3807
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003808- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003809 enable SPI microcode relocation patch (MPC8xx);
3810 define relocation offset in DPRAM [SCC4]
3811
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003812- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003813 Use OSCM clock mode on MBX8xx board. Be careful,
3814 wrong setting might damage your board. Read
3815 doc/README.MBX before setting this variable!
3816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003818 Offset of the bootmode word in DPRAM used by post
3819 (Power On Self Tests). This definition overrides
3820 #define'd default value in commproc.h resp.
3821 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003822
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003823- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3824 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3825 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3826 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3827 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3828 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3829 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3830 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003831 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003832
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003833- CONFIG_PCI_DISABLE_PCIE:
3834 Disable PCI-Express on systems where it is supported but not
3835 required.
3836
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003837- CONFIG_PCI_ENUM_ONLY
3838 Only scan through and get the devices on the busses.
3839 Don't do any setup work, presumably because someone or
3840 something has already done it, and we don't need to do it
3841 a second time. Useful for platforms that are pre-booted
3842 by coreboot or similar.
3843
Kumar Gala8975d7a2010-12-30 12:09:53 -06003844- CONFIG_SYS_SRIO:
3845 Chip has SRIO or not
3846
3847- CONFIG_SRIO1:
3848 Board has SRIO 1 port available
3849
3850- CONFIG_SRIO2:
3851 Board has SRIO 2 port available
3852
3853- CONFIG_SYS_SRIOn_MEM_VIRT:
3854 Virtual Address of SRIO port 'n' memory region
3855
3856- CONFIG_SYS_SRIOn_MEM_PHYS:
3857 Physical Address of SRIO port 'n' memory region
3858
3859- CONFIG_SYS_SRIOn_MEM_SIZE:
3860 Size of SRIO port 'n' memory region
3861
Fabio Estevamf17e8782013-04-11 09:35:34 +00003862- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3863 Defined to tell the NAND controller that the NAND chip is using
3864 a 16 bit bus.
3865 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003866 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003867 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003868 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003869
3870- CONFIG_SYS_NDFC_EBC0_CFG
3871 Sets the EBC0_CFG register for the NDFC. If not defined
3872 a default value will be used.
3873
Ben Warren45657152006-09-07 16:50:54 -04003874- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003875 Get DDR timing information from an I2C EEPROM. Common
3876 with pluggable memory modules such as SODIMMs
3877
Ben Warren45657152006-09-07 16:50:54 -04003878 SPD_EEPROM_ADDRESS
3879 I2C address of the SPD EEPROM
3880
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003881- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003882 If SPD EEPROM is on an I2C bus other than the first
3883 one, specify here. Note that the value must resolve
3884 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003885
York Sune73cc042011-06-07 09:42:16 +08003886- CONFIG_SYS_DDR_RAW_TIMING
3887 Get DDR timing information from other than SPD. Common with
3888 soldered DDR chips onboard without SPD. DDR raw timing
3889 parameters are extracted from datasheet and hard-coded into
3890 header files or board specific files.
3891
York Sunbd495cf2011-09-16 13:21:35 -07003892- CONFIG_FSL_DDR_INTERACTIVE
3893 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003895- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003896 Only for 83xx systems. If specified, then DDR should
3897 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003898
wdenk6203e402004-04-18 10:13:26 +00003899- CONFIG_ETHER_ON_FEC[12]
3900 Define to enable FEC[12] on a 8xx series processor.
3901
3902- CONFIG_FEC[12]_PHY
3903 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003904 to the given FEC; i. e.
3905 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003906 means that the PHY with address 4 is connected to FEC1
3907
3908 When set to -1, means to probe for first available.
3909
3910- CONFIG_FEC[12]_PHY_NORXERR
3911 The PHY does not have a RXERR line (RMII only).
3912 (so program the FEC to ignore it).
3913
3914- CONFIG_RMII
3915 Enable RMII mode for all FECs.
3916 Note that this is a global option, we can't
3917 have one FEC in standard MII mode and another in RMII mode.
3918
wdenk20c98a62004-04-23 20:32:05 +00003919- CONFIG_CRC32_VERIFY
3920 Add a verify option to the crc32 command.
3921 The syntax is:
3922
3923 => crc32 -v <address> <count> <crc32>
3924
3925 Where address/count indicate a memory area
3926 and crc32 is the correct crc32 which the
3927 area should have.
3928
wdenk64519362004-07-11 17:40:54 +00003929- CONFIG_LOOPW
3930 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003931 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003932
stroesecc3af832004-12-16 18:46:55 +00003933- CONFIG_MX_CYCLIC
3934 Add the "mdc" and "mwc" memory commands. These are cyclic
3935 "md/mw" commands.
3936 Examples:
3937
wdenk07d7e6b2004-12-16 21:44:03 +00003938 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003939 This command will print 4 bytes (10,11,12,13) each 500 ms.
3940
wdenk07d7e6b2004-12-16 21:44:03 +00003941 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003942 This command will write 12345678 to address 100 all 10 ms.
3943
wdenk07d7e6b2004-12-16 21:44:03 +00003944 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003945 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003946
wdenk3d3d99f2005-04-04 12:44:11 +00003947- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003948 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003949 low level initializations (like setting up the memory
3950 controller) are omitted and/or U-Boot does not
3951 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003952
Wolfgang Denk302141d2010-11-27 23:30:56 +01003953 Normally this variable MUST NOT be defined. The only
3954 exception is when U-Boot is loaded (to RAM) by some
3955 other boot loader or by a debugger which performs
3956 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003957
Aneesh V552a3192011-07-13 05:11:07 +00003958- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003959 Modifies the behaviour of start.S when compiling a loader
3960 that is executed before the actual U-Boot. E.g. when
3961 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003962
Simon Glass17dabf02013-02-24 17:33:14 +00003963- CONFIG_ARCH_MAP_SYSMEM
3964 Generally U-Boot (and in particular the md command) uses
3965 effective address. It is therefore not necessary to regard
3966 U-Boot address as virtual addresses that need to be translated
3967 to physical addresses. However, sandbox requires this, since
3968 it maintains its own little RAM buffer which contains all
3969 addressable memory. This option causes some memory accesses
3970 to be mapped through map_sysmem() / unmap_sysmem().
3971
Matthias Weisser93416c12011-03-10 21:36:32 +00003972- CONFIG_USE_ARCH_MEMCPY
3973 CONFIG_USE_ARCH_MEMSET
3974 If these options are used a optimized version of memcpy/memset will
3975 be used if available. These functions may be faster under some
3976 conditions but may increase the binary size.
3977
Simon Glassbfb59802013-02-14 04:18:54 +00003978- CONFIG_X86_RESET_VECTOR
3979 If defined, the x86 reset vector code is included. This is not
3980 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003981
Mark Jackson52b003c2013-03-04 01:27:20 +00003982- CONFIG_SYS_MPUCLK
3983 Defines the MPU clock speed (in MHz).
3984
3985 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00003986
Timur Tabi275f4bb2011-11-22 09:21:25 -06003987Freescale QE/FMAN Firmware Support:
3988-----------------------------------
3989
3990The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3991loading of "firmware", which is encoded in the QE firmware binary format.
3992This firmware often needs to be loaded during U-Boot booting, so macros
3993are used to identify the storage device (NOR flash, SPI, etc) and the address
3994within that device.
3995
3996- CONFIG_SYS_QE_FMAN_FW_ADDR
3997 The address in the storage device where the firmware is located. The
3998 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3999 is also specified.
4000
4001- CONFIG_SYS_QE_FMAN_FW_LENGTH
4002 The maximum possible size of the firmware. The firmware binary format
4003 has a field that specifies the actual size of the firmware, but it
4004 might not be possible to read any part of the firmware unless some
4005 local storage is allocated to hold the entire firmware first.
4006
4007- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4008 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4009 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4010 virtual address in NOR flash.
4011
4012- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4013 Specifies that QE/FMAN firmware is located in NAND flash.
4014 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4015
4016- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4017 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4018 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4019
4020- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4021 Specifies that QE/FMAN firmware is located on the primary SPI
4022 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4023
Liu Gang1e084582012-03-08 00:33:18 +00004024- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4025 Specifies that QE/FMAN firmware is located in the remote (master)
4026 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004027 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4028 window->master inbound window->master LAW->the ucode address in
4029 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004030
wdenkc6097192002-11-03 00:24:07 +00004031Building the Software:
4032======================
4033
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004034Building U-Boot has been tested in several native build environments
4035and in many different cross environments. Of course we cannot support
4036all possibly existing versions of cross development tools in all
4037(potentially obsolete) versions. In case of tool chain problems we
4038recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4039which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004040
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004041If you are not using a native environment, it is assumed that you
4042have GNU cross compiling tools available in your path. In this case,
4043you must set the environment variable CROSS_COMPILE in your shell.
4044Note that no changes to the Makefile or any other source files are
4045necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004046
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004047 $ CROSS_COMPILE=ppc_4xx-
4048 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004049
Peter Tyserb06976d2009-03-13 18:54:51 -05004050Note: If you wish to generate Windows versions of the utilities in
4051 the tools directory you can use the MinGW toolchain
4052 (http://www.mingw.org). Set your HOST tools to the MinGW
4053 toolchain and execute 'make tools'. For example:
4054
4055 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4056
4057 Binaries such as tools/mkimage.exe will be created which can
4058 be executed on computers running Windows.
4059
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004060U-Boot is intended to be simple to build. After installing the
4061sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004062is done by typing:
4063
4064 make NAME_config
4065
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004066where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004067rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004068
wdenk6c59edc2004-05-03 20:45:30 +00004069Note: for some board special configuration names may exist; check if
4070 additional information is available from the board vendor; for
4071 instance, the TQM823L systems are available without (standard)
4072 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004073 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk6c59edc2004-05-03 20:45:30 +00004075 make TQM823L_config
4076 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk6c59edc2004-05-03 20:45:30 +00004078 make TQM823L_LCD_config
4079 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk6c59edc2004-05-03 20:45:30 +00004081 etc.
wdenkc6097192002-11-03 00:24:07 +00004082
wdenkc6097192002-11-03 00:24:07 +00004083
wdenk6c59edc2004-05-03 20:45:30 +00004084Finally, type "make all", and you should get some working U-Boot
4085images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004086
wdenk6c59edc2004-05-03 20:45:30 +00004087- "u-boot.bin" is a raw binary image
4088- "u-boot" is an image in ELF binary format
4089- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004090
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004091By default the build is performed locally and the objects are saved
4092in the source directory. One of the two methods can be used to change
4093this behavior and build U-Boot to some external directory:
4094
40951. Add O= to the make command line invocations:
4096
4097 make O=/tmp/build distclean
4098 make O=/tmp/build NAME_config
4099 make O=/tmp/build all
4100
41012. Set environment variable BUILD_DIR to point to the desired location:
4102
4103 export BUILD_DIR=/tmp/build
4104 make distclean
4105 make NAME_config
4106 make all
4107
4108Note that the command line "O=" setting overrides the BUILD_DIR environment
4109variable.
4110
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk6c59edc2004-05-03 20:45:30 +00004112Please be aware that the Makefiles assume you are using GNU make, so
4113for instance on NetBSD you might need to use "gmake" instead of
4114native "make".
wdenkc6097192002-11-03 00:24:07 +00004115
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk6c59edc2004-05-03 20:45:30 +00004117If the system board that you have is not listed, then you will need
4118to port U-Boot to your hardware platform. To do this, follow these
4119steps:
wdenkc6097192002-11-03 00:24:07 +00004120
wdenk6c59edc2004-05-03 20:45:30 +000041211. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004122 "boards.cfg" file, using the existing entries as examples.
4123 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000041242. Create a new directory to hold your board specific code. Add any
4125 files you need. In your board directory, you will need at least
4126 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
41273. Create a new configuration file "include/configs/<board>.h" for
4128 your board
41293. If you're porting U-Boot to a new CPU, then also create a new
4130 directory to hold your CPU specific code. Add any files you need.
41314. Run "make <board>_config" with your new name.
41325. Type "make", and you should get a working "u-boot.srec" file
4133 to be installed on your target system.
41346. Debug and solve any problems that might arise.
4135 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004136
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk6c59edc2004-05-03 20:45:30 +00004138Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4139==============================================================
wdenkc6097192002-11-03 00:24:07 +00004140
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004141If you have modified U-Boot sources (for instance added a new board
4142or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004143provide feedback to the other developers. The feedback normally takes
4144the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004145official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004146
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004147But before you submit such a patch, please verify that your modifi-
4148cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004149the supported boards compile WITHOUT ANY compiler warnings. To do so,
4150just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004151for ALL supported system. Be warned, this will take a while. You can
4152select which (cross) compiler to use by passing a `CROSS_COMPILE'
4153environment variable to the script, i. e. to use the ELDK cross tools
4154you can type
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk6c59edc2004-05-03 20:45:30 +00004156 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk6c59edc2004-05-03 20:45:30 +00004158or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk6c59edc2004-05-03 20:45:30 +00004160 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004161
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004162When using the MAKEALL script, the default behaviour is to build
4163U-Boot in the source directory. This location can be changed by
4164setting the BUILD_DIR environment variable. Also, for each target
4165built, the MAKEALL script saves two log files (<target>.ERR and
4166<target>.MAKEALL) in the <source dir>/LOG directory. This default
4167location can be changed by setting the MAKEALL_LOGDIR environment
4168variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004169
4170 export BUILD_DIR=/tmp/build
4171 export MAKEALL_LOGDIR=/tmp/log
4172 CROSS_COMPILE=ppc_8xx- MAKEALL
4173
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004174With the above settings build objects are saved in the /tmp/build,
4175log files are saved in the /tmp/log and the source tree remains clean
4176during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004177
4178
wdenk6c59edc2004-05-03 20:45:30 +00004179See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004180
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk6c59edc2004-05-03 20:45:30 +00004182Monitor Commands - Overview:
4183============================
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk6c59edc2004-05-03 20:45:30 +00004185go - start application at address 'addr'
4186run - run commands in an environment variable
4187bootm - boot application image from memory
4188bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004189bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004190tftpboot- boot image via network using TFTP protocol
4191 and env variables "ipaddr" and "serverip"
4192 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004193tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004194rarpboot- boot image via network using RARP/TFTP protocol
4195diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4196loads - load S-Record file over serial line
4197loadb - load binary file over serial line (kermit mode)
4198md - memory display
4199mm - memory modify (auto-incrementing)
4200nm - memory modify (constant address)
4201mw - memory write (fill)
4202cp - memory copy
4203cmp - memory compare
4204crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004205i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004206sspi - SPI utility commands
4207base - print or set address offset
4208printenv- print environment variables
4209setenv - set environment variables
4210saveenv - save environment variables to persistent storage
4211protect - enable or disable FLASH write protection
4212erase - erase FLASH memory
4213flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004214nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004215bdinfo - print Board Info structure
4216iminfo - print header information for application image
4217coninfo - print console devices and informations
4218ide - IDE sub-system
4219loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004220loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004221mtest - simple RAM test
4222icache - enable or disable instruction cache
4223dcache - enable or disable data cache
4224reset - Perform RESET of the CPU
4225echo - echo args to console
4226version - print monitor version
4227help - print online help
4228? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004229
wdenkc6097192002-11-03 00:24:07 +00004230
wdenk6c59edc2004-05-03 20:45:30 +00004231Monitor Commands - Detailed Description:
4232========================================
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk6c59edc2004-05-03 20:45:30 +00004234TODO.
wdenkc6097192002-11-03 00:24:07 +00004235
wdenk6c59edc2004-05-03 20:45:30 +00004236For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004237
4238
wdenk6c59edc2004-05-03 20:45:30 +00004239Environment Variables:
4240======================
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk6c59edc2004-05-03 20:45:30 +00004242U-Boot supports user configuration using Environment Variables which
4243can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk6c59edc2004-05-03 20:45:30 +00004245Environment Variables are set using "setenv", printed using
4246"printenv", and saved to Flash using "saveenv". Using "setenv"
4247without a value can be used to delete a variable from the
4248environment. As long as you don't save the environment you are
4249working with an in-memory copy. In case the Flash area containing the
4250environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004251
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004252Some configuration options can be set using Environment Variables.
4253
4254List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk6c59edc2004-05-03 20:45:30 +00004256 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk6c59edc2004-05-03 20:45:30 +00004260 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk6c59edc2004-05-03 20:45:30 +00004262 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk6c59edc2004-05-03 20:45:30 +00004264 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004265
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004266 bootm_low - Memory range available for image processing in the bootm
4267 command can be restricted. This variable is given as
4268 a hexadecimal number and defines lowest address allowed
4269 for use by the bootm command. See also "bootm_size"
4270 environment variable. Address defined by "bootm_low" is
4271 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004272 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4273 bootm_mapsize.
4274
Wolfgang Denk092ae952011-10-26 10:21:21 +00004275 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004276 This variable is given as a hexadecimal number and it
4277 defines the size of the memory region starting at base
4278 address bootm_low that is accessible by the Linux kernel
4279 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4280 as the default value if it is defined, and bootm_size is
4281 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004282
4283 bootm_size - Memory range available for image processing in the bootm
4284 command can be restricted. This variable is given as
4285 a hexadecimal number and defines the size of the region
4286 allowed for use by the bootm command. See also "bootm_low"
4287 environment variable.
4288
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004289 updatefile - Location of the software update file on a TFTP server, used
4290 by the automatic software update feature. Please refer to
4291 documentation in doc/README.update for more details.
4292
wdenk6c59edc2004-05-03 20:45:30 +00004293 autoload - if set to "no" (any string beginning with 'n'),
4294 "bootp" will just load perform a lookup of the
4295 configuration from the BOOTP server, but not try to
4296 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk6c59edc2004-05-03 20:45:30 +00004298 autostart - if set to "yes", an image loaded using the "bootp",
4299 "rarpboot", "tftpboot" or "diskboot" commands will
4300 be automatically started (by internally calling
4301 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004302
wdenk6c59edc2004-05-03 20:45:30 +00004303 If set to "no", a standalone image passed to the
4304 "bootm" command will be copied to the load address
4305 (and eventually uncompressed), but NOT be started.
4306 This can be used to load and uncompress arbitrary
4307 data.
wdenkc6097192002-11-03 00:24:07 +00004308
David A. Longd558a4e2011-07-09 16:40:19 -04004309 fdt_high - if set this restricts the maximum address that the
4310 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004311 For example, if you have a system with 1 GB memory
4312 at physical address 0x10000000, while Linux kernel
4313 only recognizes the first 704 MB as low memory, you
4314 may need to set fdt_high as 0x3C000000 to have the
4315 device tree blob be copied to the maximum address
4316 of the 704 MB low memory, so that Linux kernel can
4317 access it during the boot procedure.
4318
David A. Longd558a4e2011-07-09 16:40:19 -04004319 If this is set to the special value 0xFFFFFFFF then
4320 the fdt will not be copied at all on boot. For this
4321 to work it must reside in writable memory, have
4322 sufficient padding on the end of it for u-boot to
4323 add the information it needs into it, and the memory
4324 must be accessible by the kernel.
4325
Simon Glassdc6fa642011-10-24 19:15:34 +00004326 fdtcontroladdr- if set this is the address of the control flattened
4327 device tree used by U-Boot when CONFIG_OF_CONTROL is
4328 defined.
4329
wdenk0e2bd9c2004-06-06 21:51:03 +00004330 i2cfast - (PPC405GP|PPC405EP only)
4331 if set to 'y' configures Linux I2C driver for fast
4332 mode (400kHZ). This environment variable is used in
4333 initialization code. So, for changes to be effective
4334 it must be saved and board must be reset.
4335
wdenk6c59edc2004-05-03 20:45:30 +00004336 initrd_high - restrict positioning of initrd images:
4337 If this variable is not set, initrd images will be
4338 copied to the highest possible address in RAM; this
4339 is usually what you want since it allows for
4340 maximum initrd size. If for some reason you want to
4341 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004342 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004343 variable to a value of "no" or "off" or "0".
4344 Alternatively, you can set it to a maximum upper
4345 address to use (U-Boot will still check that it
4346 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004347
wdenk6c59edc2004-05-03 20:45:30 +00004348 For instance, when you have a system with 16 MB
4349 RAM, and want to reserve 4 MB from use by Linux,
4350 you can do this by adding "mem=12M" to the value of
4351 the "bootargs" variable. However, now you must make
4352 sure that the initrd image is placed in the first
4353 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk6c59edc2004-05-03 20:45:30 +00004355 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004356
wdenk6c59edc2004-05-03 20:45:30 +00004357 If you set initrd_high to 0xFFFFFFFF, this is an
4358 indication to U-Boot that all addresses are legal
4359 for the Linux kernel, including addresses in flash
4360 memory. In this case U-Boot will NOT COPY the
4361 ramdisk at all. This may be useful to reduce the
4362 boot time on your system, but requires that this
4363 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367 loadaddr - Default load address for commands like "bootp",
4368 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004369
wdenk6c59edc2004-05-03 20:45:30 +00004370 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk6c59edc2004-05-03 20:45:30 +00004372 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004373
wdenk6c59edc2004-05-03 20:45:30 +00004374 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk6c59edc2004-05-03 20:45:30 +00004376 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk6c59edc2004-05-03 20:45:30 +00004378 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004379
Mike Frysingera23230c2011-10-02 10:01:27 +00004380 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004381
Mike Frysingera23230c2011-10-02 10:01:27 +00004382 ethact - controls which interface is currently active.
4383 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004384
Heiko Schocherc5e84052010-07-20 17:45:02 +02004385 => setenv ethact FEC
4386 => ping 192.168.0.1 # traffic sent on FEC
4387 => setenv ethact SCC
4388 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004389
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004390 ethrotate - When set to "no" U-Boot does not go through all
4391 available network interfaces.
4392 It just stays at the currently selected interface.
4393
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004394 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004395 either succeed or fail without retrying.
4396 When set to "once" the network operation will
4397 fail when all the available network interfaces
4398 are tried once without success.
4399 Useful on scripts which control the retry operation
4400 themselves.
wdenkc6097192002-11-03 00:24:07 +00004401
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004402 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004403
Wolfgang Denk227b5192005-09-24 23:25:46 +02004404 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004405 UDP source port.
4406
Wolfgang Denk227b5192005-09-24 23:25:46 +02004407 tftpdstport - If this is set, the value is used for TFTP's UDP
4408 destination port instead of the Well Know Port 69.
4409
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004410 tftpblocksize - Block size to use for TFTP transfers; if not set,
4411 we use the TFTP server's default block size
4412
4413 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4414 seconds, minimum value is 1000 = 1 second). Defines
4415 when a packet is considered to be lost so it has to
4416 be retransmitted. The default is 5000 = 5 seconds.
4417 Lowering this value may make downloads succeed
4418 faster in networks with high packet loss rates or
4419 with unreliable TFTP servers.
4420
4421 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004422 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004423 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004424
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004425The following image location variables contain the location of images
4426used in booting. The "Image" column gives the role of the image and is
4427not an environment variable name. The other columns are environment
4428variable names. "File Name" gives the name of the file on a TFTP
4429server, "RAM Address" gives the location in RAM the image will be
4430loaded to, and "Flash Location" gives the image's address in NOR
4431flash or offset in NAND flash.
4432
4433*Note* - these variables don't have to be defined for all boards, some
4434boards currenlty use other variables for these purposes, and some
4435boards use these variables for other purposes.
4436
Wolfgang Denk092ae952011-10-26 10:21:21 +00004437Image File Name RAM Address Flash Location
4438----- --------- ----------- --------------
4439u-boot u-boot u-boot_addr_r u-boot_addr
4440Linux kernel bootfile kernel_addr_r kernel_addr
4441device tree blob fdtfile fdt_addr_r fdt_addr
4442ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004443
wdenk6c59edc2004-05-03 20:45:30 +00004444The following environment variables may be used and automatically
4445updated by the network boot commands ("bootp" and "rarpboot"),
4446depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004447
wdenk6c59edc2004-05-03 20:45:30 +00004448 bootfile - see above
4449 dnsip - IP address of your Domain Name Server
4450 dnsip2 - IP address of your secondary Domain Name Server
4451 gatewayip - IP address of the Gateway (Router) to use
4452 hostname - Target hostname
4453 ipaddr - see above
4454 netmask - Subnet Mask
4455 rootpath - Pathname of the root filesystem on the NFS server
4456 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004457
wdenk145d2c12004-04-15 21:48:45 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk6c59edc2004-05-03 20:45:30 +00004461 serial# - contains hardware identification information such
4462 as type string and/or serial number
4463 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk6c59edc2004-05-03 20:45:30 +00004465These variables can be set only once (usually during manufacturing of
4466the board). U-Boot refuses to delete or overwrite these variables
4467once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004468
4469
wdenk6c59edc2004-05-03 20:45:30 +00004470Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk6c59edc2004-05-03 20:45:30 +00004472 ver - Contains the U-Boot version string as printed
4473 with the "version" command. This variable is
4474 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004475
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk6c59edc2004-05-03 20:45:30 +00004477Please note that changes to some configuration parameters may take
4478only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004479
stroeseb9c17c52003-04-04 15:53:41 +00004480
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004481Callback functions for environment variables:
4482---------------------------------------------
4483
4484For some environment variables, the behavior of u-boot needs to change
4485when their values are changed. This functionailty allows functions to
4486be associated with arbitrary variables. On creation, overwrite, or
4487deletion, the callback will provide the opportunity for some side
4488effect to happen or for the change to be rejected.
4489
4490The callbacks are named and associated with a function using the
4491U_BOOT_ENV_CALLBACK macro in your board or driver code.
4492
4493These callbacks are associated with variables in one of two ways. The
4494static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4495in the board configuration to a string that defines a list of
4496associations. The list must be in the following format:
4497
4498 entry = variable_name[:callback_name]
4499 list = entry[,list]
4500
4501If the callback name is not specified, then the callback is deleted.
4502Spaces are also allowed anywhere in the list.
4503
4504Callbacks can also be associated by defining the ".callbacks" variable
4505with the same list format above. Any association in ".callbacks" will
4506override any association in the static list. You can define
4507CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4508".callbacks" envirnoment variable in the default or embedded environment.
4509
4510
wdenk6c59edc2004-05-03 20:45:30 +00004511Command Line Parsing:
4512=====================
stroeseb9c17c52003-04-04 15:53:41 +00004513
wdenk6c59edc2004-05-03 20:45:30 +00004514There are two different command line parsers available with U-Boot:
4515the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517Old, simple command line parser:
4518--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004519
wdenk6c59edc2004-05-03 20:45:30 +00004520- supports environment variables (through setenv / saveenv commands)
4521- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004522- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004523- special characters ('$', ';') can be escaped by prefixing with '\',
4524 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004525 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004526- You can also escape text by enclosing in single apostrophes, for example:
4527 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529Hush shell:
4530-----------
wdenkf4688a22003-05-28 08:06:31 +00004531
wdenk6c59edc2004-05-03 20:45:30 +00004532- similar to Bourne shell, with control structures like
4533 if...then...else...fi, for...do...done; while...do...done,
4534 until...do...done, ...
4535- supports environment ("global") variables (through setenv / saveenv
4536 commands) and local shell variables (through standard shell syntax
4537 "name=value"); only environment variables can be used with "run"
4538 command
wdenkf4688a22003-05-28 08:06:31 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540General rules:
4541--------------
wdenkf4688a22003-05-28 08:06:31 +00004542
wdenk6c59edc2004-05-03 20:45:30 +00004543(1) If a command line (or an environment variable executed by a "run"
4544 command) contains several commands separated by semicolon, and
4545 one of these commands fails, then the remaining commands will be
4546 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004547
wdenk6c59edc2004-05-03 20:45:30 +00004548(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004549 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004550 command will cause "run" to terminate, i. e. the remaining
4551 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004552
wdenk6c59edc2004-05-03 20:45:30 +00004553Note for Redundant Ethernet Interfaces:
4554=======================================
wdenkf4688a22003-05-28 08:06:31 +00004555
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004556Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004557such configurations and is capable of automatic selection of a
4558"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004559
wdenk6c59edc2004-05-03 20:45:30 +00004560Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4561MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4562"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004563
wdenk6c59edc2004-05-03 20:45:30 +00004564If the network interface stores some valid MAC address (for instance
4565in SROM), this is used as default address if there is NO correspon-
4566ding setting in the environment; if the corresponding environment
4567variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569o If the SROM has a valid MAC address, and there is no address in the
4570 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572o If there is no valid address in the SROM, and a definition in the
4573 environment exists, then the value from the environment variable is
4574 used.
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk6c59edc2004-05-03 20:45:30 +00004576o If both the SROM and the environment contain a MAC address, and
4577 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk6c59edc2004-05-03 20:45:30 +00004579o If both the SROM and the environment contain a MAC address, and the
4580 addresses differ, the value from the environment is used and a
4581 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583o If neither SROM nor the environment contain a MAC address, an error
4584 is raised.
wdenkc6097192002-11-03 00:24:07 +00004585
Ben Warren6db991a2010-04-26 11:11:46 -07004586If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004587will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004588may be skipped by setting the appropriate 'ethmacskip' environment variable.
4589The naming convention is as follows:
4590"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004591
wdenk6c59edc2004-05-03 20:45:30 +00004592Image Formats:
4593==============
wdenkc6097192002-11-03 00:24:07 +00004594
Marian Balakowicz18710b82008-03-12 12:13:13 +01004595U-Boot is capable of booting (and performing other auxiliary operations on)
4596images in two formats:
4597
4598New uImage format (FIT)
4599-----------------------
4600
4601Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4602to Flattened Device Tree). It allows the use of images with multiple
4603components (several kernels, ramdisks, etc.), with contents protected by
4604SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4605
4606
4607Old uImage format
4608-----------------
4609
4610Old image format is based on binary files which can be basically anything,
4611preceded by a special header; see the definitions in include/image.h for
4612details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4615 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004616 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4617 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4618 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004619* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004620 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4621 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004622* Compression Type (uncompressed, gzip, bzip2)
4623* Load Address
4624* Entry Point
4625* Image Name
4626* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004627
wdenk6c59edc2004-05-03 20:45:30 +00004628The header is marked by a special Magic Number, and both the header
4629and the data portions of the image are secured against corruption by
4630CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004631
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633Linux Support:
4634==============
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk6c59edc2004-05-03 20:45:30 +00004636Although U-Boot should support any OS or standalone application
4637easily, the main focus has always been on Linux during the design of
4638U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640U-Boot includes many features that so far have been part of some
4641special "boot loader" code within the Linux kernel. Also, any
4642"initrd" images to be used are no longer part of one big Linux image;
4643instead, kernel and "initrd" are separate images. This implementation
4644serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646- the same features can be used for other OS or standalone
4647 applications (for instance: using compressed images to reduce the
4648 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk6c59edc2004-05-03 20:45:30 +00004650- it becomes much easier to port new Linux kernel versions because
4651 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004652
wdenk6c59edc2004-05-03 20:45:30 +00004653- the same Linux kernel image can now be used with different "initrd"
4654 images; of course this also means that different kernel images can
4655 be run with the same "initrd". This makes testing easier (you don't
4656 have to build a new "zImage.initrd" Linux image when you just
4657 change a file in your "initrd"). Also, a field-upgrade of the
4658 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004659
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661Linux HOWTO:
4662============
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664Porting Linux to U-Boot based systems:
4665---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004666
wdenk6c59edc2004-05-03 20:45:30 +00004667U-Boot cannot save you from doing all the necessary modifications to
4668configure the Linux device drivers for use with your target hardware
4669(no, we don't intend to provide a full virtual machine interface to
4670Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004671
Stefan Roese88fbf932010-04-15 16:07:28 +02004672But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674Just make sure your machine specific header file (for instance
4675include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004676Information structure as we define in include/asm-<arch>/u-boot.h,
4677and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004678as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004679
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk6c59edc2004-05-03 20:45:30 +00004681Configuring the Linux kernel:
4682-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004683
wdenk6c59edc2004-05-03 20:45:30 +00004684No specific requirements for U-Boot. Make sure you have some root
4685device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004686
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688Building a Linux Image:
4689-----------------------
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk6c59edc2004-05-03 20:45:30 +00004691With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4692not used. If you use recent kernel source, a new build target
4693"uImage" will exist which automatically builds an image usable by
4694U-Boot. Most older kernels also have support for a "pImage" target,
4695which was introduced for our predecessor project PPCBoot and uses a
4696100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698Example:
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700 make TQM850L_config
4701 make oldconfig
4702 make dep
4703 make uImage
wdenkc6097192002-11-03 00:24:07 +00004704
wdenk6c59edc2004-05-03 20:45:30 +00004705The "uImage" build target uses a special tool (in 'tools/mkimage') to
4706encapsulate a compressed Linux kernel image with header information,
4707CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk6c59edc2004-05-03 20:45:30 +00004709* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004710
wdenk6c59edc2004-05-03 20:45:30 +00004711* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713 ${CROSS_COMPILE}-objcopy -O binary \
4714 -R .note -R .comment \
4715 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004718
wdenk6c59edc2004-05-03 20:45:30 +00004719 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004720
wdenk6c59edc2004-05-03 20:45:30 +00004721* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723 mkimage -A ppc -O linux -T kernel -C gzip \
4724 -a 0 -e 0 -n "Linux Kernel Image" \
4725 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004726
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728The "mkimage" tool can also be used to create ramdisk images for use
4729with U-Boot, either separated from the Linux kernel image, or
4730combined into one file. "mkimage" encapsulates the images with a 64
4731byte header containing information about target architecture,
4732operating system, image type, compression method, entry points, time
4733stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735"mkimage" can be called in two ways: to verify existing images and
4736print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004737
wdenk6c59edc2004-05-03 20:45:30 +00004738In the first form (with "-l" option) mkimage lists the information
4739contained in the header of an existing U-Boot image; this includes
4740checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742 tools/mkimage -l image
4743 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745The second form (with "-d" option) is used to build a U-Boot image
4746from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004747
wdenk6c59edc2004-05-03 20:45:30 +00004748 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4749 -n name -d data_file image
4750 -A ==> set architecture to 'arch'
4751 -O ==> set operating system to 'os'
4752 -T ==> set image type to 'type'
4753 -C ==> set compression type 'comp'
4754 -a ==> set load address to 'addr' (hex)
4755 -e ==> set entry point to 'ep' (hex)
4756 -n ==> set image name to 'name'
4757 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004758
wdenkcd914452004-05-29 16:53:29 +00004759Right now, all Linux kernels for PowerPC systems use the same load
4760address (0x00000000), but the entry point address depends on the
4761kernel version:
wdenkc6097192002-11-03 00:24:07 +00004762
wdenk6c59edc2004-05-03 20:45:30 +00004763- 2.2.x kernels have the entry point at 0x0000000C,
4764- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004765
wdenk6c59edc2004-05-03 20:45:30 +00004766So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004767
wdenk6c59edc2004-05-03 20:45:30 +00004768 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4769 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004770 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004771 > examples/uImage.TQM850L
4772 Image Name: 2.4.4 kernel for TQM850L
4773 Created: Wed Jul 19 02:34:59 2000
4774 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4775 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4776 Load Address: 0x00000000
4777 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk6c59edc2004-05-03 20:45:30 +00004781 -> tools/mkimage -l examples/uImage.TQM850L
4782 Image Name: 2.4.4 kernel for TQM850L
4783 Created: Wed Jul 19 02:34:59 2000
4784 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4785 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4786 Load Address: 0x00000000
4787 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004788
wdenk6c59edc2004-05-03 20:45:30 +00004789NOTE: for embedded systems where boot time is critical you can trade
4790speed for memory and install an UNCOMPRESSED image instead: this
4791needs more space in Flash, but boots much faster since it does not
4792need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004793
Stefan Roese88fbf932010-04-15 16:07:28 +02004794 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004795 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4796 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004797 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004798 > examples/uImage.TQM850L-uncompressed
4799 Image Name: 2.4.4 kernel for TQM850L
4800 Created: Wed Jul 19 02:34:59 2000
4801 Image Type: PowerPC Linux Kernel Image (uncompressed)
4802 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4803 Load Address: 0x00000000
4804 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004805
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk6c59edc2004-05-03 20:45:30 +00004807Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4808when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk6c59edc2004-05-03 20:45:30 +00004810 -> tools/mkimage -n 'Simple Ramdisk Image' \
4811 > -A ppc -O linux -T ramdisk -C gzip \
4812 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4813 Image Name: Simple Ramdisk Image
4814 Created: Wed Jan 12 14:01:50 2000
4815 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4816 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4817 Load Address: 0x00000000
4818 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004819
wdenkc6097192002-11-03 00:24:07 +00004820
wdenk6c59edc2004-05-03 20:45:30 +00004821Installing a Linux Image:
4822-------------------------
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk6c59edc2004-05-03 20:45:30 +00004824To downloading a U-Boot image over the serial (console) interface,
4825you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004826
wdenk6c59edc2004-05-03 20:45:30 +00004827 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829The 'objcopy' does not understand the information in the U-Boot
4830image header, so the resulting S-Record file will be relative to
4831address 0x00000000. To load it to a given address, you need to
4832specify the target address as 'offset' parameter with the 'loads'
4833command.
wdenkc6097192002-11-03 00:24:07 +00004834
wdenk6c59edc2004-05-03 20:45:30 +00004835Example: install the image to address 0x40100000 (which on the
4836TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004837
wdenk6c59edc2004-05-03 20:45:30 +00004838 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk6c59edc2004-05-03 20:45:30 +00004840 .......... done
4841 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk6c59edc2004-05-03 20:45:30 +00004843 => loads 40100000
4844 ## Ready for S-Record download ...
4845 ~>examples/image.srec
4846 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4847 ...
4848 15989 15990 15991 15992
4849 [file transfer complete]
4850 [connected]
4851 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004852
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk6c59edc2004-05-03 20:45:30 +00004854You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004855this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004856corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004857
wdenk6c59edc2004-05-03 20:45:30 +00004858 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk6c59edc2004-05-03 20:45:30 +00004860 ## Checking Image at 40100000 ...
4861 Image Name: 2.2.13 for initrd on TQM850L
4862 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4863 Data Size: 335725 Bytes = 327 kB = 0 MB
4864 Load Address: 00000000
4865 Entry Point: 0000000c
4866 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004867
4868
wdenk6c59edc2004-05-03 20:45:30 +00004869Boot Linux:
4870-----------
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk6c59edc2004-05-03 20:45:30 +00004872The "bootm" command is used to boot an application that is stored in
4873memory (RAM or Flash). In case of a Linux kernel image, the contents
4874of the "bootargs" environment variable is passed to the kernel as
4875parameters. You can check and modify this variable using the
4876"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004877
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879 => printenv bootargs
4880 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882 => 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 +00004883
wdenk6c59edc2004-05-03 20:45:30 +00004884 => printenv bootargs
4885 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 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887 => bootm 40020000
4888 ## Booting Linux kernel at 40020000 ...
4889 Image Name: 2.2.13 for NFS on TQM850L
4890 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4891 Data Size: 381681 Bytes = 372 kB = 0 MB
4892 Load Address: 00000000
4893 Entry Point: 0000000c
4894 Verifying Checksum ... OK
4895 Uncompressing Kernel Image ... OK
4896 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
4897 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4898 time_init: decrementer frequency = 187500000/60
4899 Calibrating delay loop... 49.77 BogoMIPS
4900 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4901 ...
wdenkc6097192002-11-03 00:24:07 +00004902
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004903If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004904the memory addresses of both the kernel and the initrd image (PPBCOOT
4905format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004906
wdenk6c59edc2004-05-03 20:45:30 +00004907 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909 ## Checking Image at 40100000 ...
4910 Image Name: 2.2.13 for initrd on TQM850L
4911 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4912 Data Size: 335725 Bytes = 327 kB = 0 MB
4913 Load Address: 00000000
4914 Entry Point: 0000000c
4915 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk6c59edc2004-05-03 20:45:30 +00004917 ## Checking Image at 40200000 ...
4918 Image Name: Simple Ramdisk Image
4919 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4920 Data Size: 566530 Bytes = 553 kB = 0 MB
4921 Load Address: 00000000
4922 Entry Point: 00000000
4923 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk6c59edc2004-05-03 20:45:30 +00004925 => bootm 40100000 40200000
4926 ## Booting Linux kernel at 40100000 ...
4927 Image Name: 2.2.13 for initrd on TQM850L
4928 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4929 Data Size: 335725 Bytes = 327 kB = 0 MB
4930 Load Address: 00000000
4931 Entry Point: 0000000c
4932 Verifying Checksum ... OK
4933 Uncompressing Kernel Image ... OK
4934 ## Loading RAMDisk Image at 40200000 ...
4935 Image Name: Simple Ramdisk Image
4936 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4937 Data Size: 566530 Bytes = 553 kB = 0 MB
4938 Load Address: 00000000
4939 Entry Point: 00000000
4940 Verifying Checksum ... OK
4941 Loading Ramdisk ... OK
4942 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
4943 Boot arguments: root=/dev/ram
4944 time_init: decrementer frequency = 187500000/60
4945 Calibrating delay loop... 49.77 BogoMIPS
4946 ...
4947 RAMDISK: Compressed image found at block 0
4948 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk6c59edc2004-05-03 20:45:30 +00004950 bash#
wdenkc6097192002-11-03 00:24:07 +00004951
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004952Boot Linux and pass a flat device tree:
4953-----------
4954
4955First, U-Boot must be compiled with the appropriate defines. See the section
4956titled "Linux Kernel Interface" above for a more in depth explanation. The
4957following is an example of how to start a kernel and pass an updated
4958flat device tree:
4959
4960=> print oftaddr
4961oftaddr=0x300000
4962=> print oft
4963oft=oftrees/mpc8540ads.dtb
4964=> tftp $oftaddr $oft
4965Speed: 1000, full duplex
4966Using TSEC0 device
4967TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4968Filename 'oftrees/mpc8540ads.dtb'.
4969Load address: 0x300000
4970Loading: #
4971done
4972Bytes transferred = 4106 (100a hex)
4973=> tftp $loadaddr $bootfile
4974Speed: 1000, full duplex
4975Using TSEC0 device
4976TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4977Filename 'uImage'.
4978Load address: 0x200000
4979Loading:############
4980done
4981Bytes transferred = 1029407 (fb51f hex)
4982=> print loadaddr
4983loadaddr=200000
4984=> print oftaddr
4985oftaddr=0x300000
4986=> bootm $loadaddr - $oftaddr
4987## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004988 Image Name: Linux-2.6.17-dirty
4989 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4990 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004991 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004992 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004993 Verifying Checksum ... OK
4994 Uncompressing Kernel Image ... OK
4995Booting using flat device tree at 0x300000
4996Using MPC85xx ADS machine description
4997Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4998[snip]
4999
5000
wdenk6c59edc2004-05-03 20:45:30 +00005001More About U-Boot Image Types:
5002------------------------------
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006 "Standalone Programs" are directly runnable in the environment
5007 provided by U-Boot; it is expected that (if they behave
5008 well) you can continue to work in U-Boot after return from
5009 the Standalone Program.
5010 "OS Kernel Images" are usually images of some Embedded OS which
5011 will take over control completely. Usually these programs
5012 will install their own set of exception handlers, device
5013 drivers, set up the MMU, etc. - this means, that you cannot
5014 expect to re-enter U-Boot except by resetting the CPU.
5015 "RAMDisk Images" are more or less just data blocks, and their
5016 parameters (address, size) are passed to an OS kernel that is
5017 being started.
5018 "Multi-File Images" contain several images, typically an OS
5019 (Linux) kernel image and one or more data images like
5020 RAMDisks. This construct is useful for instance when you want
5021 to boot over the network using BOOTP etc., where the boot
5022 server provides just a single image file, but you want to get
5023 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk6c59edc2004-05-03 20:45:30 +00005025 "Multi-File Images" start with a list of image sizes, each
5026 image size (in bytes) specified by an "uint32_t" in network
5027 byte order. This list is terminated by an "(uint32_t)0".
5028 Immediately after the terminating 0 follow the images, one by
5029 one, all aligned on "uint32_t" boundaries (size rounded up to
5030 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005031
wdenk6c59edc2004-05-03 20:45:30 +00005032 "Firmware Images" are binary images containing firmware (like
5033 U-Boot or FPGA images) which usually will be programmed to
5034 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036 "Script files" are command sequences that will be executed by
5037 U-Boot's command interpreter; this feature is especially
5038 useful when you configure U-Boot to use a real shell (hush)
5039 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005040
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005041Booting the Linux zImage:
5042-------------------------
5043
5044On some platforms, it's possible to boot Linux zImage. This is done
5045using the "bootz" command. The syntax of "bootz" command is the same
5046as the syntax of "bootm" command.
5047
Marek Vasut28850d02012-03-18 11:47:58 +00005048Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
5049kernel with raw initrd images. The syntax is slightly different, the
5050address of the initrd must be augmented by it's size, in the following
5051format: "<initrd addres>:<initrd size>".
5052
stroeseb9c17c52003-04-04 15:53:41 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054Standalone HOWTO:
5055=================
stroeseb9c17c52003-04-04 15:53:41 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057One of the features of U-Boot is that you can dynamically load and
5058run "standalone" applications, which can use some resources of
5059U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005060
wdenk6c59edc2004-05-03 20:45:30 +00005061Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005062
wdenk6c59edc2004-05-03 20:45:30 +00005063"Hello World" Demo:
5064-------------------
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066'examples/hello_world.c' contains a small "Hello World" Demo
5067application; it is automatically compiled when you build U-Boot.
5068It's configured to run at address 0x00040004, so you can play with it
5069like that:
wdenkc6097192002-11-03 00:24:07 +00005070
wdenk6c59edc2004-05-03 20:45:30 +00005071 => loads
5072 ## Ready for S-Record download ...
5073 ~>examples/hello_world.srec
5074 1 2 3 4 5 6 7 8 9 10 11 ...
5075 [file transfer complete]
5076 [connected]
5077 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079 => go 40004 Hello World! This is a test.
5080 ## Starting application at 0x00040004 ...
5081 Hello World
5082 argc = 7
5083 argv[0] = "40004"
5084 argv[1] = "Hello"
5085 argv[2] = "World!"
5086 argv[3] = "This"
5087 argv[4] = "is"
5088 argv[5] = "a"
5089 argv[6] = "test."
5090 argv[7] = "<NULL>"
5091 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095Another example, which demonstrates how to register a CPM interrupt
5096handler with the U-Boot code, can be found in 'examples/timer.c'.
5097Here, a CPM timer is set up to generate an interrupt every second.
5098The interrupt service routine is trivial, just printing a '.'
5099character, but this is just a demo program. The application can be
5100controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102 ? - print current values og the CPM Timer registers
5103 b - enable interrupts and start timer
5104 e - stop timer and disable interrupts
5105 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk6c59edc2004-05-03 20:45:30 +00005107 => loads
5108 ## Ready for S-Record download ...
5109 ~>examples/timer.srec
5110 1 2 3 4 5 6 7 8 9 10 11 ...
5111 [file transfer complete]
5112 [connected]
5113 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115 => go 40004
5116 ## Starting application at 0x00040004 ...
5117 TIMERS=0xfff00980
5118 Using timer 1
5119 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121Hit 'b':
5122 [q, b, e, ?] Set interval 1000000 us
5123 Enabling timer
5124Hit '?':
5125 [q, b, e, ?] ........
5126 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5127Hit '?':
5128 [q, b, e, ?] .
5129 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5130Hit '?':
5131 [q, b, e, ?] .
5132 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5133Hit '?':
5134 [q, b, e, ?] .
5135 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5136Hit 'e':
5137 [q, b, e, ?] ...Stopping timer
5138Hit 'q':
5139 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005140
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142Minicom warning:
5143================
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145Over time, many people have reported problems when trying to use the
5146"minicom" terminal emulation program for serial download. I (wd)
5147consider minicom to be broken, and recommend not to use it. Under
5148Unix, I recommend to use C-Kermit for general purpose use (and
5149especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005150use "cu" for S-Record download ("loads" command). See
5151http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5152for help with kermit.
5153
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155Nevertheless, if you absolutely want to use it try adding this
5156configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk6c59edc2004-05-03 20:45:30 +00005158 Name Program Name U/D FullScr IO-Red. Multi
5159 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5160 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005161
wdenk8dba0502003-03-31 16:34:49 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163NetBSD Notes:
5164=============
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166Starting at version 0.9.2, U-Boot supports NetBSD both as host
5167(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169Building requires a cross environment; it is known to work on
5170NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5171need gmake since the Makefiles are not compatible with BSD make).
5172Note that the cross-powerpc package does not install include files;
5173attempting to build U-Boot will fail because <machine/ansi.h> is
5174missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176 # cd /usr/pkg/cross/powerpc-netbsd/include
5177 # mkdir powerpc
5178 # ln -s powerpc machine
5179 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5180 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182Native builds *don't* work due to incompatibilities between native
5183and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk6c59edc2004-05-03 20:45:30 +00005185Booting assumes that (the first part of) the image booted is a
5186stage-2 loader which in turn loads and then invokes the kernel
5187proper. Loader sources will eventually appear in the NetBSD source
5188tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005189meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005190
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk6c59edc2004-05-03 20:45:30 +00005192Implementation Internals:
5193=========================
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195The following is not intended to be a complete description of every
5196implementation detail. However, it should help to understand the
5197inner workings of U-Boot and make it easier to port it to custom
5198hardware.
wdenkc6097192002-11-03 00:24:07 +00005199
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk6c59edc2004-05-03 20:45:30 +00005201Initial Stack, Global Data:
5202---------------------------
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204The implementation of U-Boot is complicated by the fact that U-Boot
5205starts running out of ROM (flash memory), usually without access to
5206system RAM (because the memory controller is not initialized yet).
5207This means that we don't have writable Data or BSS segments, and BSS
5208is not initialized as zero. To be able to get a C environment working
5209at all, we have to allocate at least a minimal stack. Implementation
5210options for this are defined and restricted by the CPU used: Some CPU
5211models provide on-chip memory (like the IMMR area on MPC8xx and
5212MPC826x processors), on others (parts of) the data cache can be
5213locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005215 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005216 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5219 From: "Chris Hallinan" <clh@net1plus.com>
5220 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5221 ...
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223 Correct me if I'm wrong, folks, but the way I understand it
5224 is this: Using DCACHE as initial RAM for Stack, etc, does not
5225 require any physical RAM backing up the cache. The cleverness
5226 is that the cache is being used as a temporary supply of
5227 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005228 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005229 can see how this works by studying the cache architecture and
5230 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5233 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005234 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005235 option should work for you. Using CS 4 should be fine if your
5236 board designers haven't used it for something that would
5237 cause you grief during the initial boot! It is frequently not
5238 used.
wdenkc6097192002-11-03 00:24:07 +00005239
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005240 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005241 with your processor/board/system design. The default value
5242 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005243 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005244 than your SDRAM module. If you have a 64MB SDRAM module, set
5245 it above 400_0000. Just make sure your board has no resources
5246 that are supposed to respond to that address! That code in
5247 start.S has been around a while and should work as is when
5248 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250 -Chris Hallinan
5251 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005252
wdenk6c59edc2004-05-03 20:45:30 +00005253It is essential to remember this, since it has some impact on the C
5254code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256* Initialized global data (data segment) is read-only. Do not attempt
5257 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005258
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005259* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005260 as zero data - BSS segment) at all - this is undefined, initiali-
5261 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263* Stack space is very limited. Avoid big data buffers or things like
5264 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266Having only the stack as writable memory limits means we cannot use
5267normal global data to share information beween the code. But it
5268turned out that the implementation of U-Boot can be greatly
5269simplified by making a global data structure (gd_t) available to all
5270functions. We could pass a pointer to this data as argument to _all_
5271functions, but this would bloat the code. Instead we use a feature of
5272the GCC compiler (Global Register Variables) to share the data: we
5273place a pointer (gd) to the global data into a register which we
5274reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276When choosing a register for such a purpose we are restricted by the
5277relevant (E)ABI specifications for the current architecture, and by
5278GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk6c59edc2004-05-03 20:45:30 +00005280For PowerPC, the following registers have specific use:
5281 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005282 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005283 R3-R4: parameter passing and return values
5284 R5-R10: parameter passing
5285 R13: small data area pointer
5286 R30: GOT pointer
5287 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005288
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005289 (U-Boot also uses R12 as internal GOT pointer. r12
5290 is a volatile register so r12 needs to be reset when
5291 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005292
Wolfgang Denk69c09642008-02-14 22:43:22 +01005293 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 Note: on PPC, we could use a static initializer (since the
5296 address of the global data structure is known at compile time),
5297 but it turned out that reserving a register results in somewhat
5298 smaller code - although the code savings are not that big (on
5299 average for all boards 752 bytes for the whole U-Boot image,
5300 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005301
Robin Getz2773d5f2009-08-17 15:23:02 +00005302On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005303 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5304
Robin Getz2773d5f2009-08-17 15:23:02 +00005305 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005306
wdenk6c59edc2004-05-03 20:45:30 +00005307On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 R0: function argument word/integer result
5310 R1-R3: function argument word
5311 R9: GOT pointer
5312 R10: stack limit (used only if stack checking if enabled)
5313 R11: argument (frame) pointer
5314 R12: temporary workspace
5315 R13: stack pointer
5316 R14: link register
5317 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk6c59edc2004-05-03 20:45:30 +00005319 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005320
Thomas Chou8fa38582010-05-21 11:08:03 +08005321On Nios II, the ABI is documented here:
5322 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5323
5324 ==> U-Boot will use gp to hold a pointer to the global data
5325
5326 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5327 to access small data sections, so gp is free.
5328
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005329On NDS32, the following registers are used:
5330
5331 R0-R1: argument/return
5332 R2-R5: argument
5333 R15: temporary register for assembler
5334 R16: trampoline register
5335 R28: frame pointer (FP)
5336 R29: global pointer (GP)
5337 R30: link register (LP)
5338 R31: stack pointer (SP)
5339 PC: program counter (PC)
5340
5341 ==> U-Boot will use R10 to hold a pointer to the global data
5342
Wolfgang Denk6405a152006-03-31 18:32:53 +02005343NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5344or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346Memory Management:
5347------------------
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349U-Boot runs in system state and uses physical addresses, i.e. the
5350MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005351
wdenk6c59edc2004-05-03 20:45:30 +00005352The available memory is mapped to fixed addresses using the memory
5353controller. In this process, a contiguous block is formed for each
5354memory type (Flash, SDRAM, SRAM), even when it consists of several
5355physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk6c59edc2004-05-03 20:45:30 +00005357U-Boot is installed in the first 128 kB of the first Flash bank (on
5358TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5359booting and sizing and initializing DRAM, the code relocates itself
5360to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005361memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005362configuration setting]. Below that, a structure with global Board
5363Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365Additionally, some exception handler code is copied to the low 8 kB
5366of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk6c59edc2004-05-03 20:45:30 +00005368So a typical memory configuration with 16 MB of DRAM could look like
5369this:
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk6c59edc2004-05-03 20:45:30 +00005371 0x0000 0000 Exception Vector code
5372 :
5373 0x0000 1FFF
5374 0x0000 2000 Free for Application Use
5375 :
5376 :
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378 :
5379 :
5380 0x00FB FF20 Monitor Stack (Growing downward)
5381 0x00FB FFAC Board Info Data and permanent copy of global data
5382 0x00FC 0000 Malloc Arena
5383 :
5384 0x00FD FFFF
5385 0x00FE 0000 RAM Copy of Monitor Code
5386 ... eventually: LCD or video framebuffer
5387 ... eventually: pRAM (Protected RAM - unchanged by reset)
5388 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005389
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391System Initialization:
5392----------------------
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005395(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005396configuration for CS0# this is a mirror of the onboard Flash memory.
5397To be able to re-map memory U-Boot then jumps to its link address.
5398To be able to implement the initialization code in C, a (small!)
5399initial stack is set up in the internal Dual Ported RAM (in case CPUs
5400which provide such a feature like MPC8xx or MPC8260), or in a locked
5401part of the data cache. After that, U-Boot initializes the CPU core,
5402the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404Next, all (potentially) available memory banks are mapped using a
5405preliminary mapping. For example, we put them on 512 MB boundaries
5406(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5407on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5408programmed for SDRAM access. Using the temporary configuration, a
5409simple memory test is run that determines the size of the SDRAM
5410banks.
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412When there is more than one SDRAM bank, and the banks are of
5413different size, the largest is mapped first. For equal size, the first
5414bank (CS2#) is mapped first. The first mapping is always for address
54150x00000000, with any additional banks following immediately to create
5416contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418Then, the monitor installs itself at the upper end of the SDRAM area
5419and allocates memory for use by malloc() and for the global Board
5420Info data; also, the exception vector code is copied to the low RAM
5421pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423Only after this relocation will you have a "normal" C environment;
5424until that you are restricted in several ways, mostly because you are
5425running from ROM, and because the code will have to be relocated to a
5426new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005427
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk6c59edc2004-05-03 20:45:30 +00005429U-Boot Porting Guide:
5430----------------------
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5433list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005434
wdenkc6097192002-11-03 00:24:07 +00005435
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005436int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005437{
5438 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005439
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005440 signal(SIGALRM, no_more_time);
5441 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005444 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005445 return 0;
5446 }
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005449
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005450 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005451
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005452 if (clueless)
5453 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455 while (learning) {
5456 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005457 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5458 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005459 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005460 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005461 }
wdenkc6097192002-11-03 00:24:07 +00005462
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005463 if (available_money > toLocalCurrency ($2500))
5464 Buy a BDI3000;
5465 else
wdenk6c59edc2004-05-03 20:45:30 +00005466 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005467
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005468 if (a similar board exists) { /* hopefully... */
5469 cp -a board/<similar> board/<myboard>
5470 cp include/configs/<similar>.h include/configs/<myboard>.h
5471 } else {
5472 Create your own board support subdirectory;
5473 Create your own board include/configs/<myboard>.h file;
5474 }
5475 Edit new board/<myboard> files
5476 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005477
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005478 while (!accepted) {
5479 while (!running) {
5480 do {
5481 Add / modify source code;
5482 } until (compiles);
5483 Debug;
5484 if (clueless)
5485 email("Hi, I am having problems...");
5486 }
5487 Send patch file to the U-Boot email list;
5488 if (reasonable critiques)
5489 Incorporate improvements from email list code review;
5490 else
5491 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005492 }
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494 return 0;
5495}
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk6c59edc2004-05-03 20:45:30 +00005497void no_more_time (int sig)
5498{
5499 hire_a_guru();
5500}
wdenkc6097192002-11-03 00:24:07 +00005501
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk6c59edc2004-05-03 20:45:30 +00005503Coding Standards:
5504-----------------
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005507coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005508"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005509
5510Source files originating from a different project (for example the
5511MTD subsystem) are generally exempt from these guidelines and are not
5512reformated to ease subsequent migration to newer versions of those
5513sources.
wdenkc6097192002-11-03 00:24:07 +00005514
Detlev Zundelaa63d482006-09-01 15:39:02 +02005515Please note that U-Boot is implemented in C (and to some small parts in
5516Assembler); no C++ is used, so please do not use C++ style comments (//)
5517in your code.
wdenkad276f22004-01-04 16:28:35 +00005518
wdenk6c59edc2004-05-03 20:45:30 +00005519Please also stick to the following formatting rules:
5520- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005521- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005522- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005523- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005524- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526Submissions which do not conform to the standards may be returned
5527with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005528
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530Submitting Patches:
5531-------------------
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533Since the number of patches for U-Boot is growing, we need to
5534establish some rules. Submissions which do not conform to these rules
5535may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005536
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005537Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005538
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005539Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5540see http://lists.denx.de/mailman/listinfo/u-boot
5541
wdenk6c59edc2004-05-03 20:45:30 +00005542When you send a patch, please include the following information with
5543it:
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545* For bug fixes: a description of the bug and how your patch fixes
5546 this bug. Please try to include a way of demonstrating that the
5547 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005548
wdenk6c59edc2004-05-03 20:45:30 +00005549* For new features: a description of the feature and your
5550 implementation.
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005557 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559* If your patch adds new configuration options, don't forget to
5560 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005561
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005562* The patch itself. If you are using git (which is *strongly*
5563 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005564 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005565 the U-Boot mailing list, you will avoid most of the common problems
5566 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005567
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005568 If you cannot use git, use "diff -purN OLD NEW". If your version of
5569 diff does not support these options, then get the latest version of
5570 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005571
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005572 The current directory when running this command shall be the parent
5573 directory of the U-Boot source tree (i. e. please make sure that
5574 your patch includes sufficient directory information for the
5575 affected files).
5576
5577 We prefer patches as plain text. MIME attachments are discouraged,
5578 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580* If one logical set of modifications affects or creates several
5581 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583* Changesets that contain different, unrelated modifications shall be
5584 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005585
wdenkc6097192002-11-03 00:24:07 +00005586
wdenk6c59edc2004-05-03 20:45:30 +00005587Notes:
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589* Before sending the patch, run the MAKEALL script on your patched
5590 source tree and make sure that no errors or warnings are reported
5591 for any of the boards.
5592
5593* Keep your modifications to the necessary minimum: A patch
5594 containing several unrelated changes or arbitrary reformats will be
5595 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597* If you modify existing code, make sure that your new code does not
5598 add to the memory footprint of the code ;-) Small is beautiful!
5599 When adding new features, these should compile conditionally only
5600 (using #ifdef), and the resulting code with the new feature
5601 disabled must not need more memory than the old code without your
5602 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005603
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005604* Remember that there is a size limit of 100 kB per message on the
5605 u-boot mailing list. Bigger patches will be moderated. If they are
5606 reasonable and not too big, they will be acknowledged. But patches
5607 bigger than the size limit should be avoided.