blob: 7f9f547cff48494609ea91d7888fc2bbc1af2aa3 [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
Benoît Thébaudeaua8e88552013-04-23 10:17:40 +0000847 CONFIG_CMD_FUSE Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000848 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500849 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000850 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000851 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
853 CONFIG_CMD_I2C * I2C serial bus support
854 CONFIG_CMD_IDE * IDE harddisk support
855 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000856 CONFIG_CMD_IMLS List all images found in NOR flash
857 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500858 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500859 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000860 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500861 CONFIG_CMD_IRQ * irqinfo
862 CONFIG_CMD_ITEST Integer/string test of 2 values
863 CONFIG_CMD_JFFS2 * JFFS2 Support
864 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500865 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000866 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
867 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500868 CONFIG_CMD_LOADB loadb
869 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400870 CONFIG_CMD_MD5SUM print md5 message digest
871 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000872 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500873 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000874 loop, loopw
875 CONFIG_CMD_MEMTEST mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500876 CONFIG_CMD_MISC Misc functions like sleep etc
877 CONFIG_CMD_MMC * MMC memory mapped support
878 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100879 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500880 CONFIG_CMD_NAND * NAND support
881 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600882 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000883 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500884 CONFIG_CMD_PCI * pciinfo
885 CONFIG_CMD_PCMCIA * PCMCIA support
886 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
887 host
888 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000889 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_REGINFO * Register dump
891 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000892 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500893 CONFIG_CMD_SAVES * save S record dump
894 CONFIG_CMD_SCSI * SCSI Support
895 CONFIG_CMD_SDRAM * print SDRAM configuration information
896 (requires CONFIG_CMD_I2C)
897 CONFIG_CMD_SETGETDCR Support for DCR Register access
898 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700899 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100900 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400901 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200902 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500903 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000904 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000905 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000906 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
907 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000910 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Barend6abef42007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Simon Glass3d686442011-10-15 05:48:20 +0000934- Device tree:
935 CONFIG_OF_CONTROL
936 If this variable is defined, U-Boot will use a device tree
937 to configure its devices, instead of relying on statically
938 compiled #defines in the board file. This option is
939 experimental and only available on a few boards. The device
940 tree is available in the global data as gd->fdt_blob.
941
Simon Glass5cb34db2011-10-24 19:15:31 +0000942 U-Boot needs to get its device tree from somewhere. This can
943 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000944
945 CONFIG_OF_EMBED
946 If this variable is defined, U-Boot will embed a device tree
947 binary in its image. This device tree file should be in the
948 board directory and called <soc>-<board>.dts. The binary file
949 is then picked up in board_init_f() and made available through
950 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000951
Simon Glass5cb34db2011-10-24 19:15:31 +0000952 CONFIG_OF_SEPARATE
953 If this variable is defined, U-Boot will build a device tree
954 binary. It will be called u-boot.dtb. Architecture-specific
955 code will locate it at run-time. Generally this works by:
956
957 cat u-boot.bin u-boot.dtb >image.bin
958
959 and in fact, U-Boot does this for you, creating a file called
960 u-boot-dtb.bin which is useful in the common case. You can
961 still use the individual files if you need something more
962 exotic.
963
wdenkc6097192002-11-03 00:24:07 +0000964- Watchdog:
965 CONFIG_WATCHDOG
966 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000967 support for the SoC. There must be support in the SoC
968 specific code for a watchdog. For the 8xx and 8260
969 CPUs, the SIU Watchdog feature is enabled in the SYPCR
970 register. When supported for a specific SoC is
971 available, then no further board specific code should
972 be needed to use it.
973
974 CONFIG_HW_WATCHDOG
975 When using a watchdog circuitry external to the used
976 SoC, then define this variable and provide board
977 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000978
stroeseb9c17c52003-04-04 15:53:41 +0000979- U-Boot Version:
980 CONFIG_VERSION_VARIABLE
981 If this variable is defined, an environment variable
982 named "ver" is created by U-Boot showing the U-Boot
983 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200984 Any change to this variable will be reverted at the
985 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000986
wdenkc6097192002-11-03 00:24:07 +0000987- Real-Time Clock:
988
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000990 has to be selected, too. Define exactly one of the
991 following options:
992
993 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
994 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +0000995 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000996 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000997 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000998 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000999 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001000 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001001 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001002 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001003 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001004 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1005 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001006
wdenkb9bbd242003-06-30 16:24:52 +00001007 Note that if the RTC uses I2C, then the I2C interface
1008 must also be configured. See I2C Support, below.
1009
Peter Tyser9902e422008-12-17 16:36:21 -06001010- GPIO Support:
1011 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1012 CONFIG_PCA953X_INFO - enable pca953x info command
1013
Chris Packham9b383202010-12-19 10:12:13 +00001014 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1015 chip-ngpio pairs that tell the PCA953X driver the number of
1016 pins supported by a particular chip.
1017
Peter Tyser9902e422008-12-17 16:36:21 -06001018 Note that if the GPIO device uses I2C, then the I2C interface
1019 must also be configured. See I2C Support, below.
1020
wdenkc6097192002-11-03 00:24:07 +00001021- Timestamp Support:
1022
wdenk4a5c8a72003-03-06 00:02:04 +00001023 When CONFIG_TIMESTAMP is selected, the timestamp
1024 (date and time) of an image is printed by image
1025 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001026 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001027
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001028- Partition Labels (disklabels) Supported:
1029 Zero or more of the following:
1030 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1031 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1032 Intel architecture, USB sticks, etc.
1033 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1034 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1035 bootloader. Note 2TB partition limit; see
1036 disk/part_efi.c
1037 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001038
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001039 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1040 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001041 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001042
1043- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001044 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1045 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001046
wdenk369d43d2004-03-14 14:09:05 +00001047 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1048 be performed by calling the function
1049 ide_set_reset(int reset)
1050 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001051
1052- ATAPI Support:
1053 CONFIG_ATAPI
1054
1055 Set this to enable ATAPI support.
1056
wdenkf602aa02004-03-13 23:29:43 +00001057- LBA48 Support
1058 CONFIG_LBA48
1059
1060 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001061 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001062 Whithout these , LBA48 support uses 32bit variables and will 'only'
1063 support disks up to 2.1TB.
1064
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001065 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001066 When enabled, makes the IDE subsystem use 64bit sector addresses.
1067 Default is 32bit.
1068
wdenkc6097192002-11-03 00:24:07 +00001069- SCSI Support:
1070 At the moment only there is only support for the
1071 SYM53C8XX SCSI controller; define
1072 CONFIG_SCSI_SYM53C8XX to enable it.
1073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001074 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1075 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1076 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001077 maximum numbers of LUNs, SCSI ID's and target
1078 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001079 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001080
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001081 The environment variable 'scsidevs' is set to the number of
1082 SCSI devices found during the last scan.
1083
wdenkc6097192002-11-03 00:24:07 +00001084- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001085 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001086 Support for Intel 8254x/8257x gigabit chips.
1087
1088 CONFIG_E1000_SPI
1089 Utility code for direct access to the SPI bus on Intel 8257x.
1090 This does not do anything useful unless you set at least one
1091 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1092
1093 CONFIG_E1000_SPI_GENERIC
1094 Allow generic access to the SPI bus on the Intel 8257x, for
1095 example with the "sspi" command.
1096
1097 CONFIG_CMD_E1000
1098 Management command for E1000 devices. When used on devices
1099 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001100
Andre Schwarz68c2a302008-03-06 16:45:44 +01001101 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001102 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001103
wdenkc6097192002-11-03 00:24:07 +00001104 CONFIG_EEPRO100
1105 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001106 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001107 write routine for first time initialisation.
1108
1109 CONFIG_TULIP
1110 Support for Digital 2114x chips.
1111 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1112 modem chip initialisation (KS8761/QS6611).
1113
1114 CONFIG_NATSEMI
1115 Support for National dp83815 chips.
1116
1117 CONFIG_NS8382X
1118 Support for National dp8382[01] gigabit chips.
1119
wdenkaa603362003-05-12 21:50:16 +00001120- NETWORK Support (other):
1121
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001122 CONFIG_DRIVER_AT91EMAC
1123 Support for AT91RM9200 EMAC.
1124
1125 CONFIG_RMII
1126 Define this to use reduced MII inteface
1127
1128 CONFIG_DRIVER_AT91EMAC_QUIET
1129 If this defined, the driver is quiet.
1130 The driver doen't show link status messages.
1131
Rob Herringc9830dc2011-12-15 11:15:49 +00001132 CONFIG_CALXEDA_XGMAC
1133 Support for the Calxeda XGMAC device
1134
Ashok93fb8722012-10-15 06:20:47 +00001135 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001136 Support for SMSC's LAN91C96 chips.
1137
1138 CONFIG_LAN91C96_BASE
1139 Define this to hold the physical address
1140 of the LAN91C96's I/O space
1141
1142 CONFIG_LAN91C96_USE_32_BIT
1143 Define this to enable 32 bit addressing
1144
Ashok93fb8722012-10-15 06:20:47 +00001145 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001146 Support for SMSC's LAN91C111 chip
1147
1148 CONFIG_SMC91111_BASE
1149 Define this to hold the physical address
1150 of the device (I/O space)
1151
1152 CONFIG_SMC_USE_32_BIT
1153 Define this if data bus is 32 bits
1154
1155 CONFIG_SMC_USE_IOFUNCS
1156 Define this to use i/o functions instead of macros
1157 (some hardware wont work with macros)
1158
Heiko Schocher7d037f72011-11-15 10:00:04 -05001159 CONFIG_DRIVER_TI_EMAC
1160 Support for davinci emac
1161
1162 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1163 Define this if you have more then 3 PHYs.
1164
Macpaul Lin199c6252010-12-21 16:59:46 +08001165 CONFIG_FTGMAC100
1166 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1167
1168 CONFIG_FTGMAC100_EGIGA
1169 Define this to use GE link update with gigabit PHY.
1170 Define this if FTGMAC100 is connected to gigabit PHY.
1171 If your system has 10/100 PHY only, it might not occur
1172 wrong behavior. Because PHY usually return timeout or
1173 useless data when polling gigabit status and gigabit
1174 control registers. This behavior won't affect the
1175 correctnessof 10/100 link speed update.
1176
Mike Rapoportf4761af2009-11-11 10:03:03 +02001177 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001178 Support for SMSC's LAN911x and LAN921x chips
1179
Mike Rapoportf4761af2009-11-11 10:03:03 +02001180 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001181 Define this to hold the physical address
1182 of the device (I/O space)
1183
Mike Rapoportf4761af2009-11-11 10:03:03 +02001184 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001185 Define this if data bus is 32 bits
1186
Mike Rapoportf4761af2009-11-11 10:03:03 +02001187 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001188 Define this if data bus is 16 bits. If your processor
1189 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001190 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001191
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001192 CONFIG_SH_ETHER
1193 Support for Renesas on-chip Ethernet controller
1194
1195 CONFIG_SH_ETHER_USE_PORT
1196 Define the number of ports to be used
1197
1198 CONFIG_SH_ETHER_PHY_ADDR
1199 Define the ETH PHY's address
1200
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001201 CONFIG_SH_ETHER_CACHE_WRITEBACK
1202 If this option is set, the driver enables cache flush.
1203
Vadim Bendeburydac69642011-10-17 08:36:14 +00001204- TPM Support:
1205 CONFIG_GENERIC_LPC_TPM
1206 Support for generic parallel port TPM devices. Only one device
1207 per system is supported at this time.
1208
1209 CONFIG_TPM_TIS_BASE_ADDRESS
1210 Base address where the generic TPM device is mapped
1211 to. Contemporary x86 systems usually map it at
1212 0xfed40000.
1213
wdenkc6097192002-11-03 00:24:07 +00001214- USB Support:
1215 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001216 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001217 CONFIG_USB_UHCI to enable it.
1218 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001219 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001220 storage devices.
1221 Note:
1222 Supported are USB Keyboards and USB Floppy drives
1223 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001224 MPC5200 USB requires additional defines:
1225 CONFIG_USB_CLOCK
1226 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001227 CONFIG_PSC3_USB
1228 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001229 CONFIG_USB_CONFIG
1230 for differential drivers: 0x00001000
1231 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001232 for differential drivers on PSC3: 0x00000100
1233 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001234 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001235 May be defined to allow interrupt polling
1236 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001237
Simon Glass5978cdb2012-02-27 10:52:47 +00001238 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1239 txfilltuning field in the EHCI controller on reset.
1240
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001241- USB Device:
1242 Define the below if you wish to use the USB console.
1243 Once firmware is rebuilt from a serial console issue the
1244 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001245 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001246 it has found a new device. The environment variable usbtty
1247 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001248 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001249 Common Device Class Abstract Control Model serial device.
1250 If you select usbtty = gserial you should be able to enumerate
1251 a Linux host by
1252 # modprobe usbserial vendor=0xVendorID product=0xProductID
1253 else if using cdc_acm, simply setting the environment
1254 variable usbtty to be cdc_acm should suffice. The following
1255 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001256
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001257 CONFIG_USB_DEVICE
1258 Define this to build a UDC device
1259
1260 CONFIG_USB_TTY
1261 Define this to have a tty type of device available to
1262 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001263
Vipin KUMARbdb17702012-03-26 15:38:06 +05301264 CONFIG_USBD_HS
1265 Define this to enable the high speed support for usb
1266 device and usbtty. If this feature is enabled, a routine
1267 int is_usbd_high_speed(void)
1268 also needs to be defined by the driver to dynamically poll
1269 whether the enumeration has succeded at high speed or full
1270 speed.
1271
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001272 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001273 Define this if you want stdin, stdout &/or stderr to
1274 be set to usbtty.
1275
1276 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001277 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001278 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001279 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001281 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001282 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001283 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001284
Wolfgang Denke2601822006-06-14 18:14:56 +02001285 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001286 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001287 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001288 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1289 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1290 should pretend to be a Linux device to it's target host.
1291
1292 CONFIG_USBD_MANUFACTURER
1293 Define this string as the name of your company for
1294 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001295
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001296 CONFIG_USBD_PRODUCT_NAME
1297 Define this string as the name of your product
1298 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001299
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001300 CONFIG_USBD_VENDORID
1301 Define this as your assigned Vendor ID from the USB
1302 Implementors Forum. This *must* be a genuine Vendor ID
1303 to avoid polluting the USB namespace.
1304 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001305
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001306 CONFIG_USBD_PRODUCTID
1307 Define this as the unique Product ID
1308 for your device
1309 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001310
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001311- ULPI Layer Support:
1312 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1313 the generic ULPI layer. The generic layer accesses the ULPI PHY
1314 via the platform viewport, so you need both the genric layer and
1315 the viewport enabled. Currently only Chipidea/ARC based
1316 viewport is supported.
1317 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1318 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001319 If your ULPI phy needs a different reference clock than the
1320 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1321 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001322
wdenk7a428cc2003-06-15 22:40:42 +00001323- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001324 The MMC controller on the Intel PXA is supported. To
1325 enable this define CONFIG_MMC. The MMC can be
1326 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001327 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001328 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1329 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001330
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001331 CONFIG_SH_MMCIF
1332 Support for Renesas on-chip MMCIF controller
1333
1334 CONFIG_SH_MMCIF_ADDR
1335 Define the base address of MMCIF registers
1336
1337 CONFIG_SH_MMCIF_CLK
1338 Define the clock frequency for MMCIF
1339
Tom Rini58a8d322013-03-14 05:32:47 +00001340- USB Device Firmware Update (DFU) class support:
1341 CONFIG_DFU_FUNCTION
1342 This enables the USB portion of the DFU USB class
1343
1344 CONFIG_CMD_DFU
1345 This enables the command "dfu" which is used to have
1346 U-Boot create a DFU class device via USB. This command
1347 requires that the "dfu_alt_info" environment variable be
1348 set and define the alt settings to expose to the host.
1349
1350 CONFIG_DFU_MMC
1351 This enables support for exposing (e)MMC devices via DFU.
1352
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001353 CONFIG_DFU_NAND
1354 This enables support for exposing NAND devices via DFU.
1355
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001356 CONFIG_SYS_DFU_MAX_FILE_SIZE
1357 When updating files rather than the raw storage device,
1358 we use a static buffer to copy the file into and then write
1359 the buffer once we've been given the whole file. Define
1360 this to the maximum filesize (in bytes) for the buffer.
1361 Default is 4 MiB if undefined.
1362
wdenkda04a8b2004-08-02 23:22:59 +00001363- Journaling Flash filesystem support:
1364 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1365 CONFIG_JFFS2_NAND_DEV
1366 Define these for a default partition on a NAND device
1367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001368 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1369 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001370 Define these for a default partition on a NOR device
1371
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001372 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001373 Define this to create an own partition. You have to provide a
1374 function struct part_info* jffs2_part_info(int part_num)
1375
1376 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001377 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001378 to disable the command chpart. This is the default when you
1379 have not defined a custom partition
1380
Donggeun Kim8f814002011-10-24 21:15:28 +00001381- FAT(File Allocation Table) filesystem write function support:
1382 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001383
1384 Define this to enable support for saving memory data as a
1385 file in FAT formatted partition.
1386
1387 This will also enable the command "fatwrite" enabling the
1388 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001389
Gabe Black7f8574c2012-10-12 14:26:11 +00001390CBFS (Coreboot Filesystem) support
1391 CONFIG_CMD_CBFS
1392
1393 Define this to enable support for reading from a Coreboot
1394 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1395 and cbfsload.
1396
wdenkc6097192002-11-03 00:24:07 +00001397- Keyboard Support:
1398 CONFIG_ISA_KEYBOARD
1399
1400 Define this to enable standard (PC-Style) keyboard
1401 support
1402
1403 CONFIG_I8042_KBD
1404 Standard PC keyboard driver with US (is default) and
1405 GERMAN key layout (switch via environment 'keymap=de') support.
1406 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1407 for cfb_console. Supports cursor blinking.
1408
1409- Video support:
1410 CONFIG_VIDEO
1411
1412 Define this to enable video support (for output to
1413 video).
1414
1415 CONFIG_VIDEO_CT69000
1416
1417 Enable Chips & Technologies 69000 Video chip
1418
1419 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001420 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001421 video output is selected via environment 'videoout'
1422 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1423 assumed.
wdenkc6097192002-11-03 00:24:07 +00001424
wdenkd3602132004-03-25 15:14:43 +00001425 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001426 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001427 are possible:
1428 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001429 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001430
1431 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1432 -------------+---------------------------------------------
1433 8 bits | 0x301* 0x303 0x305 0x161 0x307
1434 15 bits | 0x310 0x313 0x316 0x162 0x319
1435 16 bits | 0x311 0x314 0x317 0x163 0x31A
1436 24 bits | 0x312 0x315 0x318 ? 0x31B
1437 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001438 (i.e. setenv videomode 317; saveenv; reset;)
1439
wdenkd3602132004-03-25 15:14:43 +00001440 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001441 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001442
1443
stroeseb9c17c52003-04-04 15:53:41 +00001444 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001445 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001446 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1447 or CONFIG_VIDEO_SED13806_16BPP
1448
Timur Tabi020edd22011-02-15 17:09:19 -06001449 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001450 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001451 SOCs that have a DIU should define this macro to enable DIU
1452 support, and should also define these other macros:
1453
1454 CONFIG_SYS_DIU_ADDR
1455 CONFIG_VIDEO
1456 CONFIG_CMD_BMP
1457 CONFIG_CFB_CONSOLE
1458 CONFIG_VIDEO_SW_CURSOR
1459 CONFIG_VGA_AS_SINGLE_DEVICE
1460 CONFIG_VIDEO_LOGO
1461 CONFIG_VIDEO_BMP_LOGO
1462
Timur Tabi32f709e2011-04-11 14:18:22 -05001463 The DIU driver will look for the 'video-mode' environment
1464 variable, and if defined, enable the DIU as a console during
1465 boot. See the documentation file README.video for a
1466 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001467
Simon Glass54df8ce2012-12-03 13:59:47 +00001468 CONFIG_VIDEO_VGA
1469
1470 Enable the VGA video / BIOS for x86. The alternative if you
1471 are using coreboot is to use the coreboot frame buffer
1472 driver.
1473
1474
wdenk4e112c12003-06-03 23:54:09 +00001475- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001476 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001477
wdenk57b2d802003-06-27 21:31:46 +00001478 Define this to enable a custom keyboard support.
1479 This simply calls drv_keyboard_init() which must be
1480 defined in your board-specific files.
1481 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001482
wdenkc6097192002-11-03 00:24:07 +00001483- LCD Support: CONFIG_LCD
1484
1485 Define this to enable LCD support (for output to LCD
1486 display); also select one of the supported displays
1487 by defining one of these:
1488
Stelian Popf6f86652008-05-09 21:57:18 +02001489 CONFIG_ATMEL_LCD:
1490
1491 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1492
wdenkc0d54ae2003-11-25 16:55:19 +00001493 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001494
wdenkc0d54ae2003-11-25 16:55:19 +00001495 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001496
wdenkc0d54ae2003-11-25 16:55:19 +00001497 CONFIG_NEC_NL6448BC20
1498
1499 NEC NL6448BC20-08. 6.5", 640x480.
1500 Active, color, single scan.
1501
1502 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001503
wdenkc0d54ae2003-11-25 16:55:19 +00001504 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001505 Active, color, single scan.
1506
1507 CONFIG_SHARP_16x9
1508
1509 Sharp 320x240. Active, color, single scan.
1510 It isn't 16x9, and I am not sure what it is.
1511
1512 CONFIG_SHARP_LQ64D341
1513
1514 Sharp LQ64D341 display, 640x480.
1515 Active, color, single scan.
1516
1517 CONFIG_HLD1045
1518
1519 HLD1045 display, 640x480.
1520 Active, color, single scan.
1521
1522 CONFIG_OPTREX_BW
1523
1524 Optrex CBL50840-2 NF-FW 99 22 M5
1525 or
1526 Hitachi LMG6912RPFC-00T
1527 or
1528 Hitachi SP14Q002
1529
1530 320x240. Black & white.
1531
1532 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001533 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001534
Simon Glass599a4df2012-10-17 13:24:54 +00001535 CONFIG_LCD_ALIGNMENT
1536
1537 Normally the LCD is page-aligned (tyically 4KB). If this is
1538 defined then the LCD will be aligned to this value instead.
1539 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1540 here, since it is cheaper to change data cache settings on
1541 a per-section basis.
1542
Simon Glassaf3e2802012-10-17 13:24:59 +00001543 CONFIG_CONSOLE_SCROLL_LINES
1544
1545 When the console need to be scrolled, this is the number of
1546 lines to scroll by. It defaults to 1. Increasing this makes
1547 the console jump but can help speed up operation when scrolling
1548 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001549
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001550 CONFIG_LCD_BMP_RLE8
1551
1552 Support drawing of RLE8-compressed bitmaps on the LCD.
1553
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001554 CONFIG_I2C_EDID
1555
1556 Enables an 'i2c edid' command which can read EDID
1557 information over I2C from an attached LCD display.
1558
wdenkeb20ad32003-09-05 23:19:14 +00001559- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001560
wdenk57b2d802003-06-27 21:31:46 +00001561 If this option is set, the environment is checked for
1562 a variable "splashimage". If found, the usual display
1563 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001564 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001565 specified in "splashimage" is loaded instead. The
1566 console is redirected to the "nulldev", too. This
1567 allows for a "silent" boot where a splash screen is
1568 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001569
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001570 CONFIG_SPLASHIMAGE_GUARD
1571
1572 If this option is set, then U-Boot will prevent the environment
1573 variable "splashimage" from being set to a problematic address
1574 (see README.displaying-bmps and README.arm-unaligned-accesses).
1575 This option is useful for targets where, due to alignment
1576 restrictions, an improperly aligned BMP image will cause a data
1577 abort. If you think you will not have problems with unaligned
1578 accesses (for example because your toolchain prevents them)
1579 there is no need to set this option.
1580
Matthias Weisser53884182009-07-09 16:07:30 +02001581 CONFIG_SPLASH_SCREEN_ALIGN
1582
1583 If this option is set the splash image can be freely positioned
1584 on the screen. Environment variable "splashpos" specifies the
1585 position as "x,y". If a positive number is given it is used as
1586 number of pixel from left/top. If a negative number is given it
1587 is used as number of pixel from right/bottom. You can also
1588 specify 'm' for centering the image.
1589
1590 Example:
1591 setenv splashpos m,m
1592 => image at center of screen
1593
1594 setenv splashpos 30,20
1595 => image at x = 30 and y = 20
1596
1597 setenv splashpos -10,m
1598 => vertically centered image
1599 at x = dspWidth - bmpWidth - 9
1600
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001601 CONFIG_SPLASH_SCREEN_PREPARE
1602
1603 If this option is set then the board_splash_screen_prepare()
1604 function, which must be defined in your code, is called as part
1605 of the splash screen display sequence. It gives the board an
1606 opportunity to prepare the splash image data before it is
1607 processed and sent to the frame buffer by U-Boot.
1608
Stefan Roesed9d97742005-09-22 09:04:17 +02001609- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1610
1611 If this option is set, additionally to standard BMP
1612 images, gzipped BMP images can be displayed via the
1613 splashscreen support or the bmp command.
1614
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001615- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1616
1617 If this option is set, 8-bit RLE compressed BMP images
1618 can be displayed via the splashscreen support or the
1619 bmp command.
1620
Lei Wene4e248d2012-09-28 04:26:47 +00001621- Do compresssing for memory range:
1622 CONFIG_CMD_ZIP
1623
1624 If this option is set, it would use zlib deflate method
1625 to compress the specified memory at its best effort.
1626
wdenk710e3502003-08-29 20:57:53 +00001627- Compression support:
1628 CONFIG_BZIP2
1629
1630 If this option is set, support for bzip2 compressed
1631 images is included. If not, only uncompressed and gzip
1632 compressed images are supported.
1633
wdenk9c53f402003-10-15 23:53:47 +00001634 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001635 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001636 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001637
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001638 CONFIG_LZMA
1639
1640 If this option is set, support for lzma compressed
1641 images is included.
1642
1643 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1644 requires an amount of dynamic memory that is given by the
1645 formula:
1646
1647 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1648
1649 Where lc and lp stand for, respectively, Literal context bits
1650 and Literal pos bits.
1651
1652 This value is upper-bounded by 14MB in the worst case. Anyway,
1653 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1654 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1655 a very small buffer.
1656
1657 Use the lzmainfo tool to determinate the lc and lp values and
1658 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001659 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001660
wdenk0e2bd9c2004-06-06 21:51:03 +00001661- MII/PHY support:
1662 CONFIG_PHY_ADDR
1663
1664 The address of PHY on MII bus.
1665
1666 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1667
1668 The clock frequency of the MII bus
1669
1670 CONFIG_PHY_GIGE
1671
1672 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001673 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001674
1675 CONFIG_PHY_RESET_DELAY
1676
1677 Some PHY like Intel LXT971A need extra delay after
1678 reset before any MII register access is possible.
1679 For such PHY, set this option to the usec delay
1680 required. (minimum 300usec for LXT971A)
1681
1682 CONFIG_PHY_CMD_DELAY (ppc4xx)
1683
1684 Some PHY like Intel LXT971A need extra delay after
1685 command issued before MII status register can be read
1686
wdenkc6097192002-11-03 00:24:07 +00001687- Ethernet address:
1688 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001689 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001690 CONFIG_ETH2ADDR
1691 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001692 CONFIG_ETH4ADDR
1693 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001694
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001695 Define a default value for Ethernet address to use
1696 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001697 is not determined automatically.
1698
1699- IP address:
1700 CONFIG_IPADDR
1701
1702 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001703 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001704 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001705 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001706
1707- Server IP address:
1708 CONFIG_SERVERIP
1709
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001710 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001711 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001712 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001713
Robin Getz470a6d42009-07-21 12:15:28 -04001714 CONFIG_KEEP_SERVERADDR
1715
1716 Keeps the server's MAC address, in the env 'serveraddr'
1717 for passing to bootargs (like Linux's netconsole option)
1718
Wolfgang Denk26da2992011-10-26 10:21:22 +00001719- Gateway IP address:
1720 CONFIG_GATEWAYIP
1721
1722 Defines a default value for the IP address of the
1723 default router where packets to other networks are
1724 sent to.
1725 (Environment variable "gatewayip")
1726
1727- Subnet mask:
1728 CONFIG_NETMASK
1729
1730 Defines a default value for the subnet mask (or
1731 routing prefix) which is used to determine if an IP
1732 address belongs to the local subnet or needs to be
1733 forwarded through a router.
1734 (Environment variable "netmask")
1735
David Updegraff7280da72007-06-11 10:41:07 -05001736- Multicast TFTP Mode:
1737 CONFIG_MCAST_TFTP
1738
1739 Defines whether you want to support multicast TFTP as per
1740 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001741 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001742 driver in use must provide a function: mcast() to join/leave a
1743 multicast group.
1744
wdenkc6097192002-11-03 00:24:07 +00001745- BOOTP Recovery Mode:
1746 CONFIG_BOOTP_RANDOM_DELAY
1747
1748 If you have many targets in a network that try to
1749 boot using BOOTP, you may want to avoid that all
1750 systems send out BOOTP requests at precisely the same
1751 moment (which would happen for instance at recovery
1752 from a power failure, when all systems will try to
1753 boot, thus flooding the BOOTP server. Defining
1754 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1755 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001756 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001757
1758 1st BOOTP request: delay 0 ... 1 sec
1759 2nd BOOTP request: delay 0 ... 2 sec
1760 3rd BOOTP request: delay 0 ... 4 sec
1761 4th and following
1762 BOOTP requests: delay 0 ... 8 sec
1763
stroesee0aadfb2003-08-28 14:17:32 +00001764- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001765 You can fine tune the DHCP functionality by defining
1766 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001767
Jon Loeliger5336a762007-07-09 22:08:34 -05001768 CONFIG_BOOTP_SUBNETMASK
1769 CONFIG_BOOTP_GATEWAY
1770 CONFIG_BOOTP_HOSTNAME
1771 CONFIG_BOOTP_NISDOMAIN
1772 CONFIG_BOOTP_BOOTPATH
1773 CONFIG_BOOTP_BOOTFILESIZE
1774 CONFIG_BOOTP_DNS
1775 CONFIG_BOOTP_DNS2
1776 CONFIG_BOOTP_SEND_HOSTNAME
1777 CONFIG_BOOTP_NTPSERVER
1778 CONFIG_BOOTP_TIMEOFFSET
1779 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001780 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001781
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001782 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1783 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001784
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001785 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1786 after the configured retry count, the call will fail
1787 instead of starting over. This can be used to fail over
1788 to Link-local IP address configuration if the DHCP server
1789 is not available.
1790
stroesee0aadfb2003-08-28 14:17:32 +00001791 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1792 serverip from a DHCP server, it is possible that more
1793 than one DNS serverip is offered to the client.
1794 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1795 serverip will be stored in the additional environment
1796 variable "dnsip2". The first DNS serverip is always
1797 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001798 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001799
1800 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1801 to do a dynamic update of a DNS server. To do this, they
1802 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001803 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001804 of the "hostname" environment variable is passed as
1805 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001806
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001807 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1808
1809 A 32bit value in microseconds for a delay between
1810 receiving a "DHCP Offer" and sending the "DHCP Request".
1811 This fixes a problem with certain DHCP servers that don't
1812 respond 100% of the time to a "DHCP request". E.g. On an
1813 AT91RM9200 processor running at 180MHz, this delay needed
1814 to be *at least* 15,000 usec before a Windows Server 2003
1815 DHCP server would reply 100% of the time. I recommend at
1816 least 50,000 usec to be safe. The alternative is to hope
1817 that one of the retries will be successful but note that
1818 the DHCP timeout and retry process takes a longer than
1819 this delay.
1820
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001821 - Link-local IP address negotiation:
1822 Negotiate with other link-local clients on the local network
1823 for an address that doesn't require explicit configuration.
1824 This is especially useful if a DHCP server cannot be guaranteed
1825 to exist in all environments that the device must operate.
1826
1827 See doc/README.link-local for more information.
1828
wdenk145d2c12004-04-15 21:48:45 +00001829 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001830 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001831
1832 The device id used in CDP trigger frames.
1833
1834 CONFIG_CDP_DEVICE_ID_PREFIX
1835
1836 A two character string which is prefixed to the MAC address
1837 of the device.
1838
1839 CONFIG_CDP_PORT_ID
1840
1841 A printf format string which contains the ascii name of
1842 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001843 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001844
1845 CONFIG_CDP_CAPABILITIES
1846
1847 A 32bit integer which indicates the device capabilities;
1848 0x00000010 for a normal host which does not forwards.
1849
1850 CONFIG_CDP_VERSION
1851
1852 An ascii string containing the version of the software.
1853
1854 CONFIG_CDP_PLATFORM
1855
1856 An ascii string containing the name of the platform.
1857
1858 CONFIG_CDP_TRIGGER
1859
1860 A 32bit integer sent on the trigger.
1861
1862 CONFIG_CDP_POWER_CONSUMPTION
1863
1864 A 16bit integer containing the power consumption of the
1865 device in .1 of milliwatts.
1866
1867 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1868
1869 A byte containing the id of the VLAN.
1870
wdenkc6097192002-11-03 00:24:07 +00001871- Status LED: CONFIG_STATUS_LED
1872
1873 Several configurations allow to display the current
1874 status using a LED. For instance, the LED will blink
1875 fast while running U-Boot code, stop blinking as
1876 soon as a reply to a BOOTP request was received, and
1877 start blinking slow once the Linux kernel is running
1878 (supported by a status LED driver in the Linux
1879 kernel). Defining CONFIG_STATUS_LED enables this
1880 feature in U-Boot.
1881
1882- CAN Support: CONFIG_CAN_DRIVER
1883
1884 Defining CONFIG_CAN_DRIVER enables CAN driver support
1885 on those systems that support this (optional)
1886 feature, like the TQM8xxL modules.
1887
1888- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1889
wdenkb9bbd242003-06-30 16:24:52 +00001890 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001891 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001892 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001893
wdenk21136db2003-07-16 21:53:01 +00001894 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001895 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001896 CONFIG_COMMANDS) and communicate with i2c based realtime
1897 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001898 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001899
Ben Warren45657152006-09-07 16:50:54 -04001900 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001901
wdenk21136db2003-07-16 21:53:01 +00001902 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001903 bit-banging) driver instead of CPM or similar hardware
1904 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001905
wdenk21136db2003-07-16 21:53:01 +00001906 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001907 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001909 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001910 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001911 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001912 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001913
Peter Tysere4d1abc2010-04-12 22:28:21 -05001914 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001915 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001916 and so its address should therefore be cleared to 0 (See,
1917 eg, MPC823e User's Manual p.16-473). So, set
1918 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001919
Eric Millbrandt12990a42009-09-03 08:09:44 -05001920 CONFIG_SYS_I2C_INIT_MPC5XXX
1921
1922 When a board is reset during an i2c bus transfer
1923 chips might think that the current transfer is still
1924 in progress. Reset the slave devices by sending start
1925 commands until the slave device responds.
1926
wdenk21136db2003-07-16 21:53:01 +00001927 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001928
wdenkb9bbd242003-06-30 16:24:52 +00001929 If you use the software i2c interface (CONFIG_SOFT_I2C)
1930 then the following macros need to be defined (examples are
1931 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001932
1933 I2C_INIT
1934
wdenkb9bbd242003-06-30 16:24:52 +00001935 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001936 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001937
wdenk544e9732004-02-06 23:19:44 +00001938 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001939
wdenkc6097192002-11-03 00:24:07 +00001940 I2C_PORT
1941
wdenk4a5c8a72003-03-06 00:02:04 +00001942 (Only for MPC8260 CPU). The I/O port to use (the code
1943 assumes both bits are on the same port). Valid values
1944 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001945
1946 I2C_ACTIVE
1947
1948 The code necessary to make the I2C data line active
1949 (driven). If the data line is open collector, this
1950 define can be null.
1951
wdenkb9bbd242003-06-30 16:24:52 +00001952 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1953
wdenkc6097192002-11-03 00:24:07 +00001954 I2C_TRISTATE
1955
1956 The code necessary to make the I2C data line tri-stated
1957 (inactive). If the data line is open collector, this
1958 define can be null.
1959
wdenkb9bbd242003-06-30 16:24:52 +00001960 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1961
wdenkc6097192002-11-03 00:24:07 +00001962 I2C_READ
1963
York Sun4a598092013-04-01 11:29:11 -07001964 Code that returns true if the I2C data line is high,
1965 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001966
wdenkb9bbd242003-06-30 16:24:52 +00001967 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1968
wdenkc6097192002-11-03 00:24:07 +00001969 I2C_SDA(bit)
1970
York Sun4a598092013-04-01 11:29:11 -07001971 If <bit> is true, sets the I2C data line high. If it
1972 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001973
wdenkb9bbd242003-06-30 16:24:52 +00001974 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001975 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001976 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001977
wdenkc6097192002-11-03 00:24:07 +00001978 I2C_SCL(bit)
1979
York Sun4a598092013-04-01 11:29:11 -07001980 If <bit> is true, sets the I2C clock line high. If it
1981 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001982
wdenkb9bbd242003-06-30 16:24:52 +00001983 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001984 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001985 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001986
wdenkc6097192002-11-03 00:24:07 +00001987 I2C_DELAY
1988
1989 This delay is invoked four times per clock cycle so this
1990 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001991 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001992 like:
1993
wdenkb9bbd242003-06-30 16:24:52 +00001994 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001995
Mike Frysingeree12d542010-07-21 13:38:02 -04001996 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1997
1998 If your arch supports the generic GPIO framework (asm/gpio.h),
1999 then you may alternatively define the two GPIOs that are to be
2000 used as SCL / SDA. Any of the previous I2C_xxx macros will
2001 have GPIO-based defaults assigned to them as appropriate.
2002
2003 You should define these to the GPIO value as given directly to
2004 the generic GPIO functions.
2005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002006 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002007
wdenk57b2d802003-06-27 21:31:46 +00002008 When a board is reset during an i2c bus transfer
2009 chips might think that the current transfer is still
2010 in progress. On some boards it is possible to access
2011 the i2c SCLK line directly, either by using the
2012 processor pin as a GPIO or by having a second pin
2013 connected to the bus. If this option is defined a
2014 custom i2c_init_board() routine in boards/xxx/board.c
2015 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002016
Richard Retanubundf0149c2010-04-12 15:08:17 -04002017 CONFIG_SYS_I2C_BOARD_LATE_INIT
2018
2019 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2020 defined a custom i2c_board_late_init() routine in
2021 boards/xxx/board.c is run AFTER the operations in i2c_init()
2022 is completed. This callpoint can be used to unreset i2c bus
2023 using CPU i2c controller register accesses for CPUs whose i2c
2024 controller provide such a method. It is called at the end of
2025 i2c_init() to allow i2c_init operations to setup the i2c bus
2026 controller on the CPU (e.g. setting bus speed & slave address).
2027
wdenk0e2bd9c2004-06-06 21:51:03 +00002028 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2029
2030 This option enables configuration of bi_iic_fast[] flags
2031 in u-boot bd_info structure based on u-boot environment
2032 variable "i2cfast". (see also i2cfast)
2033
Ben Warren45657152006-09-07 16:50:54 -04002034 CONFIG_I2C_MULTI_BUS
2035
2036 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002037 must have a controller. At any point in time, only one bus is
2038 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002039 Note that bus numbering is zero-based.
2040
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002041 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002042
2043 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002044 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002045 is set, specify a list of bus-device pairs. Otherwise, specify
2046 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002047
2048 e.g.
2049 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002050 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002051
2052 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2053
Wolfgang Denk092ae952011-10-26 10:21:21 +00002054 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002055 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002056
2057 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002059 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002060
2061 If defined, then this indicates the I2C bus number for DDR SPD.
2062 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002064 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002065
2066 If defined, then this indicates the I2C bus number for the RTC.
2067 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002069 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002070
2071 If defined, then this indicates the I2C bus number for the DTT.
2072 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002074 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002075
2076 If defined, specifies the I2C address of the DTT device.
2077 If not defined, then U-Boot uses predefined value for
2078 specified DTT device.
2079
Timur Tabiab347542006-11-03 19:15:00 -06002080 CONFIG_FSL_I2C
2081
2082 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002083 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002084
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002085 CONFIG_I2C_MUX
2086
2087 Define this option if you have I2C devices reached over 1 .. n
2088 I2C Muxes like the pca9544a. This option addes a new I2C
2089 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2090 new I2C Bus to the existing I2C Busses. If you select the
2091 new Bus with "i2c dev", u-bbot sends first the commandos for
2092 the muxes to activate this new "bus".
2093
2094 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2095 feature!
2096
2097 Example:
2098 Adding a new I2C Bus reached over 2 pca9544a muxes
2099 The First mux with address 70 and channel 6
2100 The Second mux with address 71 and channel 4
2101
2102 => i2c bus pca9544a:70:6:pca9544a:71:4
2103
2104 Use the "i2c bus" command without parameter, to get a list
2105 of I2C Busses with muxes:
2106
2107 => i2c bus
2108 Busses reached over muxes:
2109 Bus ID: 2
2110 reached over Mux(es):
2111 pca9544a@70 ch: 4
2112 Bus ID: 3
2113 reached over Mux(es):
2114 pca9544a@70 ch: 6
2115 pca9544a@71 ch: 4
2116 =>
2117
2118 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002119 u-boot first sends the command to the mux@70 to enable
2120 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002121 the channel 4.
2122
2123 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002124 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002125 the 2 muxes.
2126
2127 This option is actually implemented for the bitbanging
2128 algorithm in common/soft_i2c.c and for the Hardware I2C
2129 Bus on the MPC8260. But it should be not so difficult
2130 to add this option to other architectures.
2131
Andrew Dyer58c41f92008-12-29 17:36:01 -06002132 CONFIG_SOFT_I2C_READ_REPEATED_START
2133
2134 defining this will force the i2c_read() function in
2135 the soft_i2c driver to perform an I2C repeated start
2136 between writing the address pointer and reading the
2137 data. If this define is omitted the default behaviour
2138 of doing a stop-start sequence will be used. Most I2C
2139 devices can use either method, but some require one or
2140 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002141
wdenkc6097192002-11-03 00:24:07 +00002142- SPI Support: CONFIG_SPI
2143
2144 Enables SPI driver (so far only tested with
2145 SPI EEPROM, also an instance works with Crystal A/D and
2146 D/As on the SACSng board)
2147
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002148 CONFIG_SH_SPI
2149
2150 Enables the driver for SPI controller on SuperH. Currently
2151 only SH7757 is supported.
2152
wdenkc6097192002-11-03 00:24:07 +00002153 CONFIG_SPI_X
2154
2155 Enables extended (16-bit) SPI EEPROM addressing.
2156 (symmetrical to CONFIG_I2C_X)
2157
2158 CONFIG_SOFT_SPI
2159
wdenk4a5c8a72003-03-06 00:02:04 +00002160 Enables a software (bit-bang) SPI driver rather than
2161 using hardware support. This is a general purpose
2162 driver that only requires three general I/O port pins
2163 (two outputs, one input) to function. If this is
2164 defined, the board configuration must define several
2165 SPI configuration items (port pins to use, etc). For
2166 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002167
Ben Warren7efe9272008-01-16 22:37:35 -05002168 CONFIG_HARD_SPI
2169
2170 Enables a hardware SPI driver for general-purpose reads
2171 and writes. As with CONFIG_SOFT_SPI, the board configuration
2172 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002173 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002174 example, see include/configs/mpc8349emds.h.
2175
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002176 CONFIG_MXC_SPI
2177
2178 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002179 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002180
Matthias Fuchsa4400872007-12-27 17:12:34 +01002181- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002182
Matthias Fuchsa4400872007-12-27 17:12:34 +01002183 Enables FPGA subsystem.
2184
2185 CONFIG_FPGA_<vendor>
2186
2187 Enables support for specific chip vendors.
2188 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002189
Matthias Fuchsa4400872007-12-27 17:12:34 +01002190 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002191
Matthias Fuchsa4400872007-12-27 17:12:34 +01002192 Enables support for FPGA family.
2193 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2194
2195 CONFIG_FPGA_COUNT
2196
2197 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002199 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002200
wdenk57b2d802003-06-27 21:31:46 +00002201 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002203 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002204
wdenk4a5c8a72003-03-06 00:02:04 +00002205 Enable checks on FPGA configuration interface busy
2206 status by the configuration function. This option
2207 will require a board or device specific function to
2208 be written.
wdenkc6097192002-11-03 00:24:07 +00002209
2210 CONFIG_FPGA_DELAY
2211
2212 If defined, a function that provides delays in the FPGA
2213 configuration driver.
2214
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002215 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002216 Allow Control-C to interrupt FPGA configuration
2217
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002218 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002219
wdenk4a5c8a72003-03-06 00:02:04 +00002220 Check for configuration errors during FPGA bitfile
2221 loading. For example, abort during Virtex II
2222 configuration if the INIT_B line goes low (which
2223 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002224
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002225 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk4a5c8a72003-03-06 00:02:04 +00002227 Maximum time to wait for the INIT_B line to deassert
2228 after PROB_B has been deasserted during a Virtex II
2229 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002230 ms.
wdenkc6097192002-11-03 00:24:07 +00002231
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002232 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002233
wdenk4a5c8a72003-03-06 00:02:04 +00002234 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002235 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002237 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk4a5c8a72003-03-06 00:02:04 +00002239 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002240 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002241
2242- Configuration Management:
2243 CONFIG_IDENT_STRING
2244
wdenk4a5c8a72003-03-06 00:02:04 +00002245 If defined, this string will be added to the U-Boot
2246 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002247
2248- Vendor Parameter Protection:
2249
wdenk4a5c8a72003-03-06 00:02:04 +00002250 U-Boot considers the values of the environment
2251 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002252 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002253 are set once by the board vendor / manufacturer, and
2254 protects these variables from casual modification by
2255 the user. Once set, these variables are read-only,
2256 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002257 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002258
2259 If CONFIG_ENV_OVERWRITE is #defined in your config
2260 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002261 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002262 these parameters.
2263
2264 Alternatively, if you #define _both_ CONFIG_ETHADDR
2265 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002266 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002267 which can be changed exactly ONCE by the user. [The
2268 serial# is unaffected by this, i. e. it remains
2269 read-only.]
2270
Joe Hershberger71497d02012-12-11 22:16:31 -06002271 The same can be accomplished in a more flexible way
2272 for any variable by configuring the type of access
2273 to allow for those variables in the ".flags" variable
2274 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2275
wdenkc6097192002-11-03 00:24:07 +00002276- Protected RAM:
2277 CONFIG_PRAM
2278
2279 Define this variable to enable the reservation of
2280 "protected RAM", i. e. RAM which is not overwritten
2281 by U-Boot. Define CONFIG_PRAM to hold the number of
2282 kB you want to reserve for pRAM. You can overwrite
2283 this default value by defining an environment
2284 variable "pram" to the number of kB you want to
2285 reserve. Note that the board info structure will
2286 still show the full amount of RAM. If pRAM is
2287 reserved, a new environment variable "mem" will
2288 automatically be defined to hold the amount of
2289 remaining RAM in a form that can be passed as boot
2290 argument to Linux, for instance like that:
2291
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002292 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002293 saveenv
2294
2295 This way you can tell Linux not to use this memory,
2296 either, which results in a memory region that will
2297 not be affected by reboots.
2298
2299 *WARNING* If your board configuration uses automatic
2300 detection of the RAM size, you must make sure that
2301 this memory test is non-destructive. So far, the
2302 following board configurations are known to be
2303 "pRAM-clean":
2304
Wolfgang Denk90326762012-10-24 02:36:15 +00002305 IVMS8, IVML24, SPD8xx, TQM8xxL,
2306 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002307 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002308
Gabe Blacka2f3a932012-12-02 04:55:18 +00002309- Access to physical memory region (> 4GB)
2310 Some basic support is provided for operations on memory not
2311 normally accessible to U-Boot - e.g. some architectures
2312 support access to more than 4GB of memory on 32-bit
2313 machines using physical address extension or similar.
2314 Define CONFIG_PHYSMEM to access this basic support, which
2315 currently only supports clearing the memory.
2316
wdenkc6097192002-11-03 00:24:07 +00002317- Error Recovery:
2318 CONFIG_PANIC_HANG
2319
2320 Define this variable to stop the system in case of a
2321 fatal error, so that you have to reset it manually.
2322 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002323 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002324 automatically as fast as possible, but it may be
2325 useful during development since you can try to debug
2326 the conditions that lead to the situation.
2327
2328 CONFIG_NET_RETRY_COUNT
2329
wdenk4a5c8a72003-03-06 00:02:04 +00002330 This variable defines the number of retries for
2331 network operations like ARP, RARP, TFTP, or BOOTP
2332 before giving up the operation. If not defined, a
2333 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002334
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002335 CONFIG_ARP_TIMEOUT
2336
2337 Timeout waiting for an ARP reply in milliseconds.
2338
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002339 CONFIG_NFS_TIMEOUT
2340
2341 Timeout in milliseconds used in NFS protocol.
2342 If you encounter "ERROR: Cannot umount" in nfs command,
2343 try longer timeout such as
2344 #define CONFIG_NFS_TIMEOUT 10000UL
2345
wdenkc6097192002-11-03 00:24:07 +00002346- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002347 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002348
2349 Enable auto completion of commands using TAB.
2350
Wolfgang Denk018147d2006-11-27 15:32:42 +01002351 Note that this feature has NOT been implemented yet
2352 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002353
2354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002355 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002356
2357 Define this variable to enable the "hush" shell (from
2358 Busybox) as command line interpreter, thus enabling
2359 powerful command line syntax like
2360 if...then...else...fi conditionals or `&&' and '||'
2361 constructs ("shell scripts").
2362
2363 If undefined, you get the old, much simpler behaviour
2364 with a somewhat smaller memory footprint.
2365
2366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002367 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002368
2369 This defines the secondary prompt string, which is
2370 printed when the command interpreter needs more input
2371 to complete a command. Usually "> ".
2372
2373 Note:
2374
wdenk57b2d802003-06-27 21:31:46 +00002375 In the current implementation, the local variables
2376 space and global environment variables space are
2377 separated. Local variables are those you define by
2378 simply typing `name=value'. To access a local
2379 variable later on, you have write `$name' or
2380 `${name}'; to execute the contents of a variable
2381 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk4a5c8a72003-03-06 00:02:04 +00002383 Global environment variables are those you use
2384 setenv/printenv to work with. To run a command stored
2385 in such a variable, you need to use the run command,
2386 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002387
2388 To store commands and special characters in a
2389 variable, please use double quotation marks
2390 surrounding the whole text of the variable, instead
2391 of the backslashes before semicolons and special
2392 symbols.
2393
Wolfgang Denk2039a072006-07-21 11:35:21 +02002394- Commandline Editing and History:
2395 CONFIG_CMDLINE_EDITING
2396
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002397 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002398 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002399
wdenkc0aa5c52003-12-06 19:49:23 +00002400- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002401 CONFIG_EXTRA_ENV_SETTINGS
2402
wdenk4a5c8a72003-03-06 00:02:04 +00002403 Define this to contain any number of null terminated
2404 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002405 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002406
wdenk4a5c8a72003-03-06 00:02:04 +00002407 For example, place something like this in your
2408 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002409
2410 #define CONFIG_EXTRA_ENV_SETTINGS \
2411 "myvar1=value1\0" \
2412 "myvar2=value2\0"
2413
wdenk4a5c8a72003-03-06 00:02:04 +00002414 Warning: This method is based on knowledge about the
2415 internal format how the environment is stored by the
2416 U-Boot code. This is NOT an official, exported
2417 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002418 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002419 You better know what you are doing here.
2420
wdenk4a5c8a72003-03-06 00:02:04 +00002421 Note: overly (ab)use of the default environment is
2422 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002423 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002424 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002425
Stephen Warren1465d5f2012-05-22 09:21:54 +00002426 CONFIG_ENV_VARS_UBOOT_CONFIG
2427
2428 Define this in order to add variables describing the
2429 U-Boot build configuration to the default environment.
2430 These will be named arch, cpu, board, vendor, and soc.
2431
2432 Enabling this option will cause the following to be defined:
2433
2434 - CONFIG_SYS_ARCH
2435 - CONFIG_SYS_CPU
2436 - CONFIG_SYS_BOARD
2437 - CONFIG_SYS_VENDOR
2438 - CONFIG_SYS_SOC
2439
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002440 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2441
2442 Define this in order to add variables describing certain
2443 run-time determined information about the hardware to the
2444 environment. These will be named board_name, board_rev.
2445
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002446 CONFIG_DELAY_ENVIRONMENT
2447
2448 Normally the environment is loaded when the board is
2449 intialised so that it is available to U-Boot. This inhibits
2450 that so that the environment is not available until
2451 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2452 this is instead controlled by the value of
2453 /config/load-environment.
2454
wdenkc0aa5c52003-12-06 19:49:23 +00002455- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002456 CONFIG_HAS_DATAFLASH
2457
wdenk57b2d802003-06-27 21:31:46 +00002458 Defining this option enables DataFlash features and
2459 allows to read/write in Dataflash via the standard
2460 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002461
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002462- Serial Flash support
2463 CONFIG_CMD_SF
2464
2465 Defining this option enables SPI flash commands
2466 'sf probe/read/write/erase/update'.
2467
2468 Usage requires an initial 'probe' to define the serial
2469 flash parameters, followed by read/write/erase/update
2470 commands.
2471
2472 The following defaults may be provided by the platform
2473 to handle the common case when only a single serial
2474 flash is present on the system.
2475
2476 CONFIG_SF_DEFAULT_BUS Bus identifier
2477 CONFIG_SF_DEFAULT_CS Chip-select
2478 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2479 CONFIG_SF_DEFAULT_SPEED in Hz
2480
Simon Glass4b5545e2012-10-08 13:16:02 +00002481 CONFIG_CMD_SF_TEST
2482
2483 Define this option to include a destructive SPI flash
2484 test ('sf test').
2485
wdenkef893942004-02-23 16:11:30 +00002486- SystemACE Support:
2487 CONFIG_SYSTEMACE
2488
2489 Adding this option adds support for Xilinx SystemACE
2490 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002491 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002492 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002493
2494 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002495 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002496
2497 When SystemACE support is added, the "ace" device type
2498 becomes available to the fat commands, i.e. fatls.
2499
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002500- TFTP Fixed UDP Port:
2501 CONFIG_TFTP_PORT
2502
Wolfgang Denk227b5192005-09-24 23:25:46 +02002503 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002504 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002505 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002506 number generator is used.
2507
Wolfgang Denk227b5192005-09-24 23:25:46 +02002508 Also, the environment variable tftpdstp is used to supply
2509 the TFTP UDP destination port value. If tftpdstp isn't
2510 defined, the normal port 69 is used.
2511
2512 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002513 blindly start the TFTP transfer using the pre-configured
2514 target IP address and UDP port. This has the effect of
2515 "punching through" the (Windows XP) firewall, allowing
2516 the remainder of the TFTP transfer to proceed normally.
2517 A better solution is to properly configure the firewall,
2518 but sometimes that is not allowed.
2519
Simon Glass058bb8d2012-12-05 14:46:38 +00002520- Hashing support:
2521 CONFIG_CMD_HASH
2522
2523 This enables a generic 'hash' command which can produce
2524 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2525
2526 CONFIG_HASH_VERIFY
2527
2528 Enable the hash verify command (hash -v). This adds to code
2529 size a little.
2530
2531 CONFIG_SHA1 - support SHA1 hashing
2532 CONFIG_SHA256 - support SHA256 hashing
2533
2534 Note: There is also a sha1sum command, which should perhaps
2535 be deprecated in favour of 'hash sha1'.
2536
wdenkc0aa5c52003-12-06 19:49:23 +00002537- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002538 CONFIG_SHOW_BOOT_PROGRESS
2539
wdenk4a5c8a72003-03-06 00:02:04 +00002540 Defining this option allows to add some board-
2541 specific code (calling a user-provided function
2542 "show_boot_progress(int)") that enables you to show
2543 the system's boot progress on some display (for
2544 example, some LED's) on your board. At the moment,
2545 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002546
Simon Glass31a870e2012-02-13 13:51:19 +00002547- Detailed boot stage timing
2548 CONFIG_BOOTSTAGE
2549 Define this option to get detailed timing of each stage
2550 of the boot process.
2551
2552 CONFIG_BOOTSTAGE_USER_COUNT
2553 This is the number of available user bootstage records.
2554 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2555 a new ID will be allocated from this stash. If you exceed
2556 the limit, recording will stop.
2557
2558 CONFIG_BOOTSTAGE_REPORT
2559 Define this to print a report before boot, similar to this:
2560
2561 Timer summary in microseconds:
2562 Mark Elapsed Stage
2563 0 0 reset
2564 3,575,678 3,575,678 board_init_f start
2565 3,575,695 17 arch_cpu_init A9
2566 3,575,777 82 arch_cpu_init done
2567 3,659,598 83,821 board_init_r start
2568 3,910,375 250,777 main_loop
2569 29,916,167 26,005,792 bootm_start
2570 30,361,327 445,160 start_kernel
2571
Simon Glass4afd88e2012-09-28 08:56:39 +00002572 CONFIG_CMD_BOOTSTAGE
2573 Add a 'bootstage' command which supports printing a report
2574 and un/stashing of bootstage data.
2575
Simon Glass0fa36a42012-09-28 08:56:37 +00002576 CONFIG_BOOTSTAGE_FDT
2577 Stash the bootstage information in the FDT. A root 'bootstage'
2578 node is created with each bootstage id as a child. Each child
2579 has a 'name' property and either 'mark' containing the
2580 mark time in microsecond, or 'accum' containing the
2581 accumulated time for that bootstage id in microseconds.
2582 For example:
2583
2584 bootstage {
2585 154 {
2586 name = "board_init_f";
2587 mark = <3575678>;
2588 };
2589 170 {
2590 name = "lcd";
2591 accum = <33482>;
2592 };
2593 };
2594
2595 Code in the Linux kernel can find this in /proc/devicetree.
2596
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002597Legacy uImage format:
2598
wdenkc6097192002-11-03 00:24:07 +00002599 Arg Where When
2600 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002601 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002602 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002603 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002604 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002605 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002606 4 common/cmd_bootm.c Image data has correct checksum
2607 -4 common/cmd_bootm.c Image is for unsupported architecture
2608 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002609 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002610 6 common/cmd_bootm.c Image Type check OK
2611 -6 common/cmd_bootm.c gunzip uncompression error
2612 -7 common/cmd_bootm.c Unimplemented compression type
2613 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002614 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002615 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002616
2617 9 common/image.c Start initial ramdisk verification
2618 -10 common/image.c Ramdisk header has bad magic number
2619 -11 common/image.c Ramdisk header has bad checksum
2620 10 common/image.c Ramdisk header is OK
2621 -12 common/image.c Ramdisk data has bad checksum
2622 11 common/image.c Ramdisk data has correct checksum
2623 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002624 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002625 13 common/image.c Start multifile image verification
2626 14 common/image.c No initial ramdisk, no multifile, continue.
2627
Wolfgang Denk092ae952011-10-26 10:21:21 +00002628 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002629
Stefan Roese88fbf932010-04-15 16:07:28 +02002630 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002631 -31 post/post.c POST test failed, detected by post_output_backlog()
2632 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002633
Heiko Schocher633e03a2007-06-22 19:11:54 +02002634 34 common/cmd_doc.c before loading a Image from a DOC device
2635 -35 common/cmd_doc.c Bad usage of "doc" command
2636 35 common/cmd_doc.c correct usage of "doc" command
2637 -36 common/cmd_doc.c No boot device
2638 36 common/cmd_doc.c correct boot device
2639 -37 common/cmd_doc.c Unknown Chip ID on boot device
2640 37 common/cmd_doc.c correct chip ID found, device available
2641 -38 common/cmd_doc.c Read Error on boot device
2642 38 common/cmd_doc.c reading Image header from DOC device OK
2643 -39 common/cmd_doc.c Image header has bad magic number
2644 39 common/cmd_doc.c Image header has correct magic number
2645 -40 common/cmd_doc.c Error reading Image from DOC device
2646 40 common/cmd_doc.c Image header has correct magic number
2647 41 common/cmd_ide.c before loading a Image from a IDE device
2648 -42 common/cmd_ide.c Bad usage of "ide" command
2649 42 common/cmd_ide.c correct usage of "ide" command
2650 -43 common/cmd_ide.c No boot device
2651 43 common/cmd_ide.c boot device found
2652 -44 common/cmd_ide.c Device not available
2653 44 common/cmd_ide.c Device available
2654 -45 common/cmd_ide.c wrong partition selected
2655 45 common/cmd_ide.c partition selected
2656 -46 common/cmd_ide.c Unknown partition table
2657 46 common/cmd_ide.c valid partition table found
2658 -47 common/cmd_ide.c Invalid partition type
2659 47 common/cmd_ide.c correct partition type
2660 -48 common/cmd_ide.c Error reading Image Header on boot device
2661 48 common/cmd_ide.c reading Image Header from IDE device OK
2662 -49 common/cmd_ide.c Image header has bad magic number
2663 49 common/cmd_ide.c Image header has correct magic number
2664 -50 common/cmd_ide.c Image header has bad checksum
2665 50 common/cmd_ide.c Image header has correct checksum
2666 -51 common/cmd_ide.c Error reading Image from IDE device
2667 51 common/cmd_ide.c reading Image from IDE device OK
2668 52 common/cmd_nand.c before loading a Image from a NAND device
2669 -53 common/cmd_nand.c Bad usage of "nand" command
2670 53 common/cmd_nand.c correct usage of "nand" command
2671 -54 common/cmd_nand.c No boot device
2672 54 common/cmd_nand.c boot device found
2673 -55 common/cmd_nand.c Unknown Chip ID on boot device
2674 55 common/cmd_nand.c correct chip ID found, device available
2675 -56 common/cmd_nand.c Error reading Image Header on boot device
2676 56 common/cmd_nand.c reading Image Header from NAND device OK
2677 -57 common/cmd_nand.c Image header has bad magic number
2678 57 common/cmd_nand.c Image header has correct magic number
2679 -58 common/cmd_nand.c Error reading Image from NAND device
2680 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002681
Heiko Schocher633e03a2007-06-22 19:11:54 +02002682 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002683
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002684 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002685 -64 net/eth.c no Ethernet found.
2686 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002687
Heiko Schocher633e03a2007-06-22 19:11:54 +02002688 -80 common/cmd_net.c usage wrong
2689 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002690 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002691 81 common/cmd_net.c NetLoop() back without error
2692 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2693 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002694 83 common/cmd_net.c running "source" command
2695 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002696 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002697
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002698FIT uImage format:
2699
2700 Arg Where When
2701 100 common/cmd_bootm.c Kernel FIT Image has correct format
2702 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2703 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2704 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2705 102 common/cmd_bootm.c Kernel unit name specified
2706 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002707 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002708 104 common/cmd_bootm.c Got kernel subimage node offset
2709 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2710 105 common/cmd_bootm.c Kernel subimage hash verification OK
2711 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2712 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002713 -106 common/cmd_bootm.c Kernel subimage has wrong type
2714 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002715 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2716 108 common/cmd_bootm.c Got kernel subimage data/size
2717 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2718 -109 common/cmd_bootm.c Can't get kernel subimage type
2719 -110 common/cmd_bootm.c Can't get kernel subimage comp
2720 -111 common/cmd_bootm.c Can't get kernel subimage os
2721 -112 common/cmd_bootm.c Can't get kernel subimage load address
2722 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2723
2724 120 common/image.c Start initial ramdisk verification
2725 -120 common/image.c Ramdisk FIT image has incorrect format
2726 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002727 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002728 -122 common/image.c Can't get configuration for ramdisk subimage
2729 123 common/image.c Ramdisk unit name specified
2730 -124 common/image.c Can't get ramdisk subimage node offset
2731 125 common/image.c Got ramdisk subimage node offset
2732 -125 common/image.c Ramdisk subimage hash verification failed
2733 126 common/image.c Ramdisk subimage hash verification OK
2734 -126 common/image.c Ramdisk subimage for unsupported architecture
2735 127 common/image.c Architecture check OK
2736 -127 common/image.c Can't get ramdisk subimage data/size
2737 128 common/image.c Got ramdisk subimage data/size
2738 129 common/image.c Can't get ramdisk load address
2739 -129 common/image.c Got ramdisk load address
2740
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002741 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002742 131 common/cmd_doc.c FIT image format OK
2743
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002744 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002745 141 common/cmd_ide.c FIT image format OK
2746
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002747 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002748 151 common/cmd_nand.c FIT image format OK
2749
Gabe Blackd572e162012-10-25 16:31:10 +00002750- FIT image support:
2751 CONFIG_FIT
2752 Enable support for the FIT uImage format.
2753
2754 CONFIG_FIT_BEST_MATCH
2755 When no configuration is explicitly selected, default to the
2756 one whose fdt's compatibility field best matches that of
2757 U-Boot itself. A match is considered "best" if it matches the
2758 most specific compatibility entry of U-Boot's fdt's root node.
2759 The order of entries in the configuration's fdt is ignored.
2760
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002761- Standalone program support:
2762 CONFIG_STANDALONE_LOAD_ADDR
2763
Wolfgang Denk23f78482011-10-09 21:06:34 +02002764 This option defines a board specific value for the
2765 address where standalone program gets loaded, thus
2766 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002767 settings.
2768
2769- Frame Buffer Address:
2770 CONFIG_FB_ADDR
2771
2772 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002773 address for frame buffer. This is typically the case
2774 when using a graphics controller has separate video
2775 memory. U-Boot will then place the frame buffer at
2776 the given address instead of dynamically reserving it
2777 in system RAM by calling lcd_setmem(), which grabs
2778 the memory for the frame buffer depending on the
2779 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002780
2781 Please see board_init_f function.
2782
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002783- Automatic software updates via TFTP server
2784 CONFIG_UPDATE_TFTP
2785 CONFIG_UPDATE_TFTP_CNT_MAX
2786 CONFIG_UPDATE_TFTP_MSEC_MAX
2787
2788 These options enable and control the auto-update feature;
2789 for a more detailed description refer to doc/README.update.
2790
2791- MTD Support (mtdparts command, UBI support)
2792 CONFIG_MTD_DEVICE
2793
2794 Adds the MTD device infrastructure from the Linux kernel.
2795 Needed for mtdparts command support.
2796
2797 CONFIG_MTD_PARTITIONS
2798
2799 Adds the MTD partitioning infrastructure from the Linux
2800 kernel. Needed for UBI support.
2801
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002802- UBI support
2803 CONFIG_CMD_UBI
2804
2805 Adds commands for interacting with MTD partitions formatted
2806 with the UBI flash translation layer
2807
2808 Requires also defining CONFIG_RBTREE
2809
Joe Hershberger47550fc2013-04-08 10:32:49 +00002810 CONFIG_UBI_SILENCE_MSG
2811
2812 Make the verbose messages from UBI stop printing. This leaves
2813 warnings and errors enabled.
2814
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002815- UBIFS support
2816 CONFIG_CMD_UBIFS
2817
2818 Adds commands for interacting with UBI volumes formatted as
2819 UBIFS. UBIFS is read-only in u-boot.
2820
2821 Requires UBI support as well as CONFIG_LZO
2822
Joe Hershberger47550fc2013-04-08 10:32:49 +00002823 CONFIG_UBIFS_SILENCE_MSG
2824
2825 Make the verbose messages from UBIFS stop printing. This leaves
2826 warnings and errors enabled.
2827
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002828- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002829 CONFIG_SPL
2830 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002831
Tom Rini36853852012-02-14 07:29:40 +00002832 CONFIG_SPL_LDSCRIPT
2833 LDSCRIPT for linking the SPL binary.
2834
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002835 CONFIG_SPL_MAX_FOOTPRINT
2836 Maximum size in memory allocated to the SPL, BSS included.
2837 When defined, the linker checks that the actual memory
2838 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002839 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002840 must not be both defined at the same time.
2841
Tom Rini36853852012-02-14 07:29:40 +00002842 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002843 Maximum size of the SPL image (text, data, rodata, and
2844 linker lists sections), BSS excluded.
2845 When defined, the linker checks that the actual size does
2846 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002847
Wolfgang Denk825223d2011-09-11 21:24:09 +02002848 CONFIG_SPL_TEXT_BASE
2849 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002850
Scott Woodc4f0d002012-09-20 19:05:12 -05002851 CONFIG_SPL_RELOC_TEXT_BASE
2852 Address to relocate to. If unspecified, this is equal to
2853 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2854
Tom Rini36853852012-02-14 07:29:40 +00002855 CONFIG_SPL_BSS_START_ADDR
2856 Link address for the BSS within the SPL binary.
2857
2858 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002859 Maximum size in memory allocated to the SPL BSS.
2860 When defined, the linker checks that the actual memory used
2861 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002862 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002863 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002864
2865 CONFIG_SPL_STACK
2866 Adress of the start of the stack SPL will use
2867
Scott Woodc4f0d002012-09-20 19:05:12 -05002868 CONFIG_SPL_RELOC_STACK
2869 Adress of the start of the stack SPL will use after
2870 relocation. If unspecified, this is equal to
2871 CONFIG_SPL_STACK.
2872
Tom Rini36853852012-02-14 07:29:40 +00002873 CONFIG_SYS_SPL_MALLOC_START
2874 Starting address of the malloc pool used in SPL.
2875
2876 CONFIG_SYS_SPL_MALLOC_SIZE
2877 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002878
Tom Rini28591df2012-08-13 12:03:19 -07002879 CONFIG_SPL_FRAMEWORK
2880 Enable the SPL framework under common/. This framework
2881 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2882 NAND loading of the Linux Kernel.
2883
Tom Rinife3b0c72012-08-13 11:37:56 -07002884 CONFIG_SPL_DISPLAY_PRINT
2885 For ARM, enable an optional function to print more information
2886 about the running system.
2887
Scott Wood7c810902012-09-20 16:35:21 -05002888 CONFIG_SPL_INIT_MINIMAL
2889 Arch init code should be built for a very small image
2890
Wolfgang Denk825223d2011-09-11 21:24:09 +02002891 CONFIG_SPL_LIBCOMMON_SUPPORT
2892 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002893
Wolfgang Denk825223d2011-09-11 21:24:09 +02002894 CONFIG_SPL_LIBDISK_SUPPORT
2895 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002896
Wolfgang Denk825223d2011-09-11 21:24:09 +02002897 CONFIG_SPL_I2C_SUPPORT
2898 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002899
Wolfgang Denk825223d2011-09-11 21:24:09 +02002900 CONFIG_SPL_GPIO_SUPPORT
2901 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002902
Wolfgang Denk825223d2011-09-11 21:24:09 +02002903 CONFIG_SPL_MMC_SUPPORT
2904 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002905
Tom Rini36853852012-02-14 07:29:40 +00002906 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2907 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2908 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2909 Address, size and partition on the MMC to load U-Boot from
2910 when the MMC is being used in raw mode.
2911
2912 CONFIG_SPL_FAT_SUPPORT
2913 Support for fs/fat/libfat.o in SPL binary
2914
2915 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2916 Filename to read to load U-Boot when reading from FAT
2917
Scott Wood2b36fbb2012-12-06 13:33:17 +00002918 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2919 Set this for NAND SPL on PPC mpc83xx targets, so that
2920 start.S waits for the rest of the SPL to load before
2921 continuing (the hardware starts execution after just
2922 loading the first page rather than the full 4K).
2923
Scott Woodc352a0c2012-09-20 19:09:07 -05002924 CONFIG_SPL_NAND_BASE
2925 Include nand_base.c in the SPL. Requires
2926 CONFIG_SPL_NAND_DRIVERS.
2927
2928 CONFIG_SPL_NAND_DRIVERS
2929 SPL uses normal NAND drivers, not minimal drivers.
2930
2931 CONFIG_SPL_NAND_ECC
2932 Include standard software ECC in the SPL
2933
Tom Rini36853852012-02-14 07:29:40 +00002934 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002935 Support for NAND boot using simple NAND drivers that
2936 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002937
2938 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2939 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2940 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2941 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2942 CONFIG_SYS_NAND_ECCBYTES
2943 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002944 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002945
2946 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002947 Location in NAND to read U-Boot from
2948
2949 CONFIG_SYS_NAND_U_BOOT_DST
2950 Location in memory to load U-Boot to
2951
2952 CONFIG_SYS_NAND_U_BOOT_SIZE
2953 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002954
2955 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002956 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002957
2958 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2959 Define this if you need to first read the OOB and then the
2960 data. This is used for example on davinci plattforms.
2961
2962 CONFIG_SPL_OMAP3_ID_NAND
2963 Support for an OMAP3-specific set of functions to return the
2964 ID and MFR of the first attached NAND chip, if present.
2965
Wolfgang Denk825223d2011-09-11 21:24:09 +02002966 CONFIG_SPL_SERIAL_SUPPORT
2967 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002968
Wolfgang Denk825223d2011-09-11 21:24:09 +02002969 CONFIG_SPL_SPI_FLASH_SUPPORT
2970 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002971
Wolfgang Denk825223d2011-09-11 21:24:09 +02002972 CONFIG_SPL_SPI_SUPPORT
2973 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002974
Pavel Machekde997252012-08-30 22:42:11 +02002975 CONFIG_SPL_RAM_DEVICE
2976 Support for running image already present in ram, in SPL binary
2977
Wolfgang Denk825223d2011-09-11 21:24:09 +02002978 CONFIG_SPL_LIBGENERIC_SUPPORT
2979 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002980
Scott Woodeb7bd972012-12-06 13:33:16 +00002981 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00002982 Image offset to which the SPL should be padded before appending
2983 the SPL payload. By default, this is defined as
2984 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2985 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2986 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00002987
Scott Woodf147eb72012-09-21 16:27:32 -05002988 CONFIG_SPL_TARGET
2989 Final target image containing SPL and payload. Some SPLs
2990 use an arch-specific makefile fragment instead, for
2991 example if more than one image needs to be produced.
2992
wdenkc6097192002-11-03 00:24:07 +00002993Modem Support:
2994--------------
2995
Wolfgang Denk8f399b32011-05-01 20:44:23 +02002996[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002997
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002998- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002999 CONFIG_MODEM_SUPPORT
3000
3001- RTS/CTS Flow control enable:
3002 CONFIG_HWFLOW
3003
3004- Modem debug support:
3005 CONFIG_MODEM_SUPPORT_DEBUG
3006
wdenk4a5c8a72003-03-06 00:02:04 +00003007 Enables debugging stuff (char screen[1024], dbg())
3008 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003009
wdenkc0aa5c52003-12-06 19:49:23 +00003010- Interrupt support (PPC):
3011
wdenk1ebf41e2004-01-02 14:00:00 +00003012 There are common interrupt_init() and timer_interrupt()
3013 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003014 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003015 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003016 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003017 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003018 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003019 specific handling. If board has watchdog / status_led
3020 / other_activity_monitor it works automatically from
3021 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003022
wdenkc6097192002-11-03 00:24:07 +00003023- General:
3024
wdenk4a5c8a72003-03-06 00:02:04 +00003025 In the target system modem support is enabled when a
3026 specific key (key combination) is pressed during
3027 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003028 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003029 board_init(). Currently key_pressed() is a dummy
3030 function, returning 1 and thus enabling modem
3031 initialization.
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk4a5c8a72003-03-06 00:02:04 +00003033 If there are no modem init strings in the
3034 environment, U-Boot proceed to autoboot; the
3035 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003036 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003037
3038 See also: doc/README.Modem
3039
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003040Board initialization settings:
3041------------------------------
3042
3043During Initialization u-boot calls a number of board specific functions
3044to allow the preparation of board specific prerequisites, e.g. pin setup
3045before drivers are initialized. To enable these callbacks the
3046following configuration macros have to be defined. Currently this is
3047architecture specific, so please check arch/your_architecture/lib/board.c
3048typically in board_init_f() and board_init_r().
3049
3050- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3051- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3052- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3053- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003054
wdenkc6097192002-11-03 00:24:07 +00003055Configuration Settings:
3056-----------------------
3057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003058- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003059 undefine this when you're short of memory.
3060
Peter Tyserdfb72b82009-01-27 18:03:12 -06003061- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3062 width of the commands listed in the 'help' command output.
3063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003064- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003065 prompt for user input.
3066
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003067- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003068
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003069- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003070
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003071- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003073- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003074 the application (usually a Linux kernel) when it is
3075 booted
3076
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003077- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003078 List of legal baudrate settings for this board.
3079
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003080- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003081 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003082
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003083- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003084 If the board specific function
3085 extern int overwrite_console (void);
3086 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003087 serial port, else the settings in the environment are used.
3088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003089- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003090 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003092- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003093 Enable overwrite of previous console environment settings.
3094
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003095- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003096 Begin and End addresses of the area used by the
3097 simple memory test.
3098
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003099- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003100 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003101
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003102- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003103 Scratch address used by the alternate memory test
3104 You only need to set this if address zero isn't writeable
3105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003106- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3107 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003108 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003109 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003110 fixing up gd->ram_size the Linux kernel should gets passed
3111 the now "corrected" memory size and won't touch it either.
3112 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003113 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003114 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003115 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003116
3117 This option can be used as a workaround for the 440EPx/GRx
3118 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3119 be touched.
3120
3121 WARNING: Please make sure that this value is a multiple of
3122 the Linux page size (normally 4k). If this is not the case,
3123 then the end address of the Linux memory will be located at a
3124 non page size aligned address and this could cause major
3125 problems.
3126
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003127- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003128 Enable temporary baudrate change while serial download
3129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003130- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003131 Physical start address of SDRAM. _Must_ be 0 here.
3132
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003133- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003134 Physical start address of Motherboard I/O (if using a
3135 Cogent motherboard)
3136
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003137- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003138 Physical start address of Flash memory.
3139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003140- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003141 Physical start address of boot monitor code (set by
3142 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003143 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003144 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003146- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003147 Size of memory reserved for monitor code, used to
3148 determine _at_compile_time_ (!) if the environment is
3149 embedded within the U-Boot image, or in a separate
3150 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003151
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003152- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003153 Size of DRAM reserved for malloc() use.
3154
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003155- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003156 Normally compressed uImages are limited to an
3157 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003158 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003159 to adjust this setting to your needs.
3160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003161- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003162 Maximum size of memory mapped by the startup code of
3163 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003164 the Linux kernel (bd_info, boot arguments, FDT blob if
3165 used) must be put below this limit, unless "bootm_low"
3166 enviroment variable is defined and non-zero. In such case
3167 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003168 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003169 variable "bootm_mapsize" will override the value of
3170 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3171 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003172
John Rigbyeea8e692010-10-13 13:57:35 -06003173- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3174 Enable initrd_high functionality. If defined then the
3175 initrd_high feature is enabled and the bootm ramdisk subcommand
3176 is enabled.
3177
3178- CONFIG_SYS_BOOT_GET_CMDLINE:
3179 Enables allocating and saving kernel cmdline in space between
3180 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3181
3182- CONFIG_SYS_BOOT_GET_KBD:
3183 Enables allocating and saving a kernel copy of the bd_info in
3184 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003186- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003187 Max number of Flash memory banks
3188
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003189- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003190 Max number of sectors on a Flash chip
3191
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003192- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003193 Timeout for Flash erase operations (in ms)
3194
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003195- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003196 Timeout for Flash write operations (in ms)
3197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003198- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003199 Timeout for Flash set sector lock bit operation (in ms)
3200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003201- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003202 Timeout for Flash clear lock bits operation (in ms)
3203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003204- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003205 If defined, hardware flash sectors protection is used
3206 instead of U-Boot software protection.
3207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003208- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003209
3210 Enable TFTP transfers directly to flash memory;
3211 without this option such a download has to be
3212 performed in two steps: (1) download to RAM, and (2)
3213 copy from RAM to flash.
3214
3215 The two-step approach is usually more reliable, since
3216 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003217 the flash, but in some situations (when system RAM is
3218 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003219 downloaded image) this option may be very useful.
3220
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003221- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003222 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003223 common flash structure for storing flash geometry.
3224
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003225- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003226 This option also enables the building of the cfi_flash driver
3227 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003228
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003229- CONFIG_FLASH_CFI_MTD
3230 This option enables the building of the cfi_mtd driver
3231 in the drivers directory. The driver exports CFI flash
3232 to the MTD layer.
3233
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003234- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003235 Use buffered writes to flash.
3236
3237- CONFIG_FLASH_SPANSION_S29WS_N
3238 s29ws-n MirrorBit flash has non-standard addresses for buffered
3239 write commands.
3240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003241- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003242 If this option is defined, the common CFI flash doesn't
3243 print it's warning upon not recognized FLASH banks. This
3244 is useful, if some of the configured banks are only
3245 optionally available.
3246
Jerry Van Barenaae73572008-03-08 13:48:01 -05003247- CONFIG_FLASH_SHOW_PROGRESS
3248 If defined (must be an integer), print out countdown
3249 digits and dots. Recommended value: 45 (9..1) for 80
3250 column displays, 15 (3..1) for 40 column displays.
3251
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003252- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003253 Defines the number of Ethernet receive buffers. On some
3254 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003255 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3256 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003257 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003258 Defaults to 4 if not defined.
3259
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003260- CONFIG_ENV_MAX_ENTRIES
3261
Wolfgang Denk1136f692010-10-27 22:48:30 +02003262 Maximum number of entries in the hash table that is used
3263 internally to store the environment settings. The default
3264 setting is supposed to be generous and should work in most
3265 cases. This setting can be used to tune behaviour; see
3266 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003267
Joe Hershberger71497d02012-12-11 22:16:31 -06003268- CONFIG_ENV_FLAGS_LIST_DEFAULT
3269- CONFIG_ENV_FLAGS_LIST_STATIC
3270 Enable validation of the values given to enviroment variables when
3271 calling env set. Variables can be restricted to only decimal,
3272 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3273 the variables can also be restricted to IP address or MAC address.
3274
3275 The format of the list is:
3276 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003277 access_atribute = [a|r|o|c]
3278 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003279 entry = variable_name[:attributes]
3280 list = entry[,list]
3281
3282 The type attributes are:
3283 s - String (default)
3284 d - Decimal
3285 x - Hexadecimal
3286 b - Boolean ([1yYtT|0nNfF])
3287 i - IP address
3288 m - MAC address
3289
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003290 The access attributes are:
3291 a - Any (default)
3292 r - Read-only
3293 o - Write-once
3294 c - Change-default
3295
Joe Hershberger71497d02012-12-11 22:16:31 -06003296 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3297 Define this to a list (string) to define the ".flags"
3298 envirnoment variable in the default or embedded environment.
3299
3300 - CONFIG_ENV_FLAGS_LIST_STATIC
3301 Define this to a list (string) to define validation that
3302 should be done if an entry is not found in the ".flags"
3303 environment variable. To override a setting in the static
3304 list, simply add an entry for the same variable name to the
3305 ".flags" variable.
3306
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003307- CONFIG_ENV_ACCESS_IGNORE_FORCE
3308 If defined, don't allow the -f switch to env set override variable
3309 access flags.
3310
Simon Glass66828322013-03-08 13:45:27 +00003311- CONFIG_SYS_GENERIC_BOARD
3312 This selects the architecture-generic board system instead of the
3313 architecture-specific board files. It is intended to move boards
3314 to this new framework over time. Defining this will disable the
3315 arch/foo/lib/board.c file and use common/board_f.c and
3316 common/board_r.c instead. To use this option your architecture
3317 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3318 its config.mk file). If you find problems enabling this option on
3319 your board please report the problem and send patches!
3320
Simon Glass9c9f44a2013-03-11 07:06:48 +00003321- CONFIG_SYS_SYM_OFFSETS
3322 This is set by architectures that use offsets for link symbols
3323 instead of absolute values. So bss_start is obtained using an
3324 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3325 directly. You should not need to touch this setting.
3326
3327
wdenkc6097192002-11-03 00:24:07 +00003328The following definitions that deal with the placement and management
3329of environment data (variable area); in general, we support the
3330following configurations:
3331
Mike Frysinger63b8f122011-07-08 10:44:25 +00003332- CONFIG_BUILD_ENVCRC:
3333
3334 Builds up envcrc with the target environment so that external utils
3335 may easily extract it and embed it in final U-Boot images.
3336
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003337- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003338
3339 Define this if the environment is in flash memory.
3340
3341 a) The environment occupies one whole flash sector, which is
3342 "embedded" in the text segment with the U-Boot code. This
3343 happens usually with "bottom boot sector" or "top boot
3344 sector" type flash chips, which have several smaller
3345 sectors at the start or the end. For instance, such a
3346 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3347 such a case you would place the environment in one of the
3348 4 kB sectors - with U-Boot code before and after it. With
3349 "top boot sector" type flash chips, you would put the
3350 environment in one of the last sectors, leaving a gap
3351 between U-Boot and the environment.
3352
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003353 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003354
3355 Offset of environment data (variable area) to the
3356 beginning of flash memory; for instance, with bottom boot
3357 type flash chips the second sector can be used: the offset
3358 for this sector is given here.
3359
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003360 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003361
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003362 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003363
3364 This is just another way to specify the start address of
3365 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003366 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003367
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003368 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003369
3370 Size of the sector containing the environment.
3371
3372
3373 b) Sometimes flash chips have few, equal sized, BIG sectors.
3374 In such a case you don't want to spend a whole sector for
3375 the environment.
3376
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003377 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003378
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003379 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003380 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003381 of this flash sector for the environment. This saves
3382 memory for the RAM copy of the environment.
3383
3384 It may also save flash memory if you decide to use this
3385 when your environment is "embedded" within U-Boot code,
3386 since then the remainder of the flash sector could be used
3387 for U-Boot code. It should be pointed out that this is
3388 STRONGLY DISCOURAGED from a robustness point of view:
3389 updating the environment in flash makes it always
3390 necessary to erase the WHOLE sector. If something goes
3391 wrong before the contents has been restored from a copy in
3392 RAM, your target system will be dead.
3393
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003394 - CONFIG_ENV_ADDR_REDUND
3395 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003396
wdenk4a5c8a72003-03-06 00:02:04 +00003397 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003398 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003399 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003400 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003401
3402BE CAREFUL! Any changes to the flash layout, and some changes to the
3403source code will make it necessary to adapt <board>/u-boot.lds*
3404accordingly!
3405
3406
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003407- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003408
3409 Define this if you have some non-volatile memory device
3410 (NVRAM, battery buffered SRAM) which you want to use for the
3411 environment.
3412
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003413 - CONFIG_ENV_ADDR:
3414 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003415
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003416 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003417 want to use for environment. It is assumed that this memory
3418 can just be read and written to, without any special
3419 provision.
3420
3421BE CAREFUL! The first access to the environment happens quite early
3422in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003423console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003424U-Boot will hang.
3425
3426Please note that even with NVRAM we still use a copy of the
3427environment in RAM: we could work on NVRAM directly, but we want to
3428keep settings there always unmodified except somebody uses "saveenv"
3429to save the current settings.
3430
3431
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003432- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003433
3434 Use this if you have an EEPROM or similar serial access
3435 device and a driver for it.
3436
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003437 - CONFIG_ENV_OFFSET:
3438 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003439
3440 These two #defines specify the offset and size of the
3441 environment area within the total memory of your EEPROM.
3442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003443 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003444 If defined, specified the chip address of the EEPROM device.
3445 The default address is zero.
3446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003447 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003448 If defined, the number of bits used to address bytes in a
3449 single page in the EEPROM device. A 64 byte page, for example
3450 would require six bits.
3451
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003452 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003453 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003454 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003456 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003457 The length in bytes of the EEPROM memory array address. Note
3458 that this is NOT the chip address length!
3459
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003460 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003461 EEPROM chips that implement "address overflow" are ones
3462 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3463 address and the extra bits end up in the "chip address" bit
3464 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3465 byte chips.
3466
3467 Note that we consider the length of the address field to
3468 still be one byte because the extra address bits are hidden
3469 in the chip address.
3470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003471 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003472 The size in bytes of the EEPROM device.
3473
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003474 - CONFIG_ENV_EEPROM_IS_ON_I2C
3475 define this, if you have I2C and SPI activated, and your
3476 EEPROM, which holds the environment, is on the I2C bus.
3477
3478 - CONFIG_I2C_ENV_EEPROM_BUS
3479 if you have an Environment on an EEPROM reached over
3480 I2C muxes, you can define here, how to reach this
3481 EEPROM. For example:
3482
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003483 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003484
3485 EEPROM which holds the environment, is reached over
3486 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003487
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003488- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003489
wdenk1ebf41e2004-01-02 14:00:00 +00003490 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003491 want to use for the environment.
3492
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003493 - CONFIG_ENV_OFFSET:
3494 - CONFIG_ENV_ADDR:
3495 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003496
3497 These three #defines specify the offset and size of the
3498 environment area within the total memory of your DataFlash placed
3499 at the specified address.
3500
Liu Gang85bcd732012-03-08 00:33:20 +00003501- CONFIG_ENV_IS_IN_REMOTE:
3502
3503 Define this if you have a remote memory space which you
3504 want to use for the local device's environment.
3505
3506 - CONFIG_ENV_ADDR:
3507 - CONFIG_ENV_SIZE:
3508
3509 These two #defines specify the address and size of the
3510 environment area within the remote memory space. The
3511 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003512 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003513
3514BE CAREFUL! For some special cases, the local device can not use
3515"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003516environment stored in a remote NOR flash by SRIO or PCIE link,
3517but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003518
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003519- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003520
3521 Define this if you have a NAND device which you want to use
3522 for the environment.
3523
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003524 - CONFIG_ENV_OFFSET:
3525 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003526
3527 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003528 area within the first NAND device. CONFIG_ENV_OFFSET must be
3529 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003530
Scott Wood08239322010-09-17 14:38:37 -05003531 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003532
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003533 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003534 size used to hold a redundant copy of the environment data, so
3535 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003536 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003537 aligned to an erase block boundary.
3538
3539 - CONFIG_ENV_RANGE (optional):
3540
3541 Specifies the length of the region in which the environment
3542 can be written. This should be a multiple of the NAND device's
3543 block size. Specifying a range with more erase blocks than
3544 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3545 the range to be avoided.
3546
3547 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003548
Scott Wood08239322010-09-17 14:38:37 -05003549 Enables support for dynamically retrieving the offset of the
3550 environment from block zero's out-of-band data. The
3551 "nand env.oob" command can be used to record this offset.
3552 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3553 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003554
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003555- CONFIG_NAND_ENV_DST
3556
3557 Defines address in RAM to which the nand_spl code should copy the
3558 environment. If redundant environment is used, it will be copied to
3559 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3560
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003561- CONFIG_ENV_IS_IN_UBI:
3562
3563 Define this if you have an UBI volume that you want to use for the
3564 environment. This has the benefit of wear-leveling the environment
3565 accesses, which is important on NAND.
3566
3567 - CONFIG_ENV_UBI_PART:
3568
3569 Define this to a string that is the mtd partition containing the UBI.
3570
3571 - CONFIG_ENV_UBI_VOLUME:
3572
3573 Define this to the name of the volume that you want to store the
3574 environment in.
3575
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003576 - CONFIG_ENV_UBI_VOLUME_REDUND:
3577
3578 Define this to the name of another volume to store a second copy of
3579 the environment in. This will enable redundant environments in UBI.
3580 It is assumed that both volumes are in the same MTD partition.
3581
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003582 - CONFIG_UBI_SILENCE_MSG
3583 - CONFIG_UBIFS_SILENCE_MSG
3584
3585 You will probably want to define these to avoid a really noisy system
3586 when storing the env in UBI.
3587
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003588- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003589
3590 Defines offset to the initial SPI buffer area in DPRAM. The
3591 area is used at an early stage (ROM part) if the environment
3592 is configured to reside in the SPI EEPROM: We need a 520 byte
3593 scratch DPRAM area. It is used between the two initialization
3594 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3595 to be a good choice since it makes it far enough from the
3596 start of the data area as well as from the stack pointer.
3597
Bruce Adleredecc942007-11-02 13:15:42 -07003598Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003599has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003600created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003601until then to read environment variables.
3602
wdenk8dba0502003-03-31 16:34:49 +00003603The environment is protected by a CRC32 checksum. Before the monitor
3604is relocated into RAM, as a result of a bad CRC you will be working
3605with the compiled-in default environment - *silently*!!! [This is
3606necessary, because the first environment variable we need is the
3607"baudrate" setting for the console - if we have a bad CRC, we don't
3608have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003609
3610Note: once the monitor has been relocated, then it will complain if
3611the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003612use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003614- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003615 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003617 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003618 also needs to be defined.
3619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003620- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003621 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003622
Ron Madriddfa028a2009-02-18 14:30:44 -08003623- CONFIG_NS16550_MIN_FUNCTIONS:
3624 Define this if you desire to only have use of the NS16550_init
3625 and NS16550_putc functions for the serial driver located at
3626 drivers/serial/ns16550.c. This option is useful for saving
3627 space for already greatly restricted images, including but not
3628 limited to NAND_SPL configurations.
3629
Simon Glass28a9e332012-11-30 13:01:18 +00003630- CONFIG_DISPLAY_BOARDINFO
3631 Display information about the board that U-Boot is running on
3632 when U-Boot starts up. The board function checkboard() is called
3633 to do this.
3634
Simon Glasse8822012012-11-30 13:01:19 +00003635- CONFIG_DISPLAY_BOARDINFO_LATE
3636 Similar to the previous option, but display this information
3637 later, once stdio is running and output goes to the LCD, if
3638 present.
3639
wdenkc6097192002-11-03 00:24:07 +00003640Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003641---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003643- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003644 Cache Line Size of the CPU.
3645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003647 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003648
wdenk9c53f402003-10-15 23:53:47 +00003649 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3650 and RPXsuper) to be able to adjust the position of
3651 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003652
Timur Tabid8f341c2011-08-04 18:03:41 -05003653- CONFIG_SYS_CCSRBAR_DEFAULT:
3654 Default (power-on reset) physical address of CCSR on Freescale
3655 PowerPC SOCs.
3656
3657- CONFIG_SYS_CCSRBAR:
3658 Virtual address of CCSR. On a 32-bit build, this is typically
3659 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3660
3661 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3662 for cross-platform code that uses that macro instead.
3663
3664- CONFIG_SYS_CCSRBAR_PHYS:
3665 Physical address of CCSR. CCSR can be relocated to a new
3666 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003667 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003668 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3669 is typically relocated on 36-bit builds. It is recommended
3670 that this macro be defined via the _HIGH and _LOW macros:
3671
3672 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3673 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3674
3675- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003676 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3677 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003678 used in assembly code, so it must not contain typecasts or
3679 integer size suffixes (e.g. "ULL").
3680
3681- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3682 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3683 used in assembly code, so it must not contain typecasts or
3684 integer size suffixes (e.g. "ULL").
3685
3686- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3687 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3688 forced to a value that ensures that CCSR is not relocated.
3689
wdenk1272e232002-11-10 22:06:23 +00003690- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003691 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003692
3693 the default drive number (default value 0)
3694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003695 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003696
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003697 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003698 (default value 1)
3699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003700 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003701
wdenk4a5c8a72003-03-06 00:02:04 +00003702 defines the offset of register from address. It
3703 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003704 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003705
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003706 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3707 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003708 default value.
wdenk1272e232002-11-10 22:06:23 +00003709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003710 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003711 fdc_hw_init() is called at the beginning of the FDC
3712 setup. fdc_hw_init() must be provided by the board
3713 source code. It is used to make hardware dependant
3714 initializations.
wdenk1272e232002-11-10 22:06:23 +00003715
Macpaul Lind1e49942011-04-11 20:45:32 +00003716- CONFIG_IDE_AHB:
3717 Most IDE controllers were designed to be connected with PCI
3718 interface. Only few of them were designed for AHB interface.
3719 When software is doing ATA command and data transfer to
3720 IDE devices through IDE-AHB controller, some additional
3721 registers accessing to these kind of IDE-AHB controller
3722 is requierd.
3723
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003724- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003725 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003726 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003728- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003729
wdenkeb20ad32003-09-05 23:19:14 +00003730 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003731 initial data and stack; please note that this must be
3732 writable memory that is working WITHOUT special
3733 initialization, i. e. you CANNOT use normal RAM which
3734 will become available only after programming the
3735 memory controller and running certain initialization
3736 sequences.
3737
3738 U-Boot uses the following memory types:
3739 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3740 - MPC824X: data cache
3741 - PPC4xx: data cache
3742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003743- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003744
3745 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003746 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3747 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003748 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003749 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003750 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3751 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3752 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003753
3754 Note:
3755 On the MPC824X (or other systems that use the data
3756 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003758 point to an otherwise UNUSED address space between
3759 the top of RAM and the start of the PCI space.
3760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003761- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003762
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003763- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003765- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003768
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003769- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003770
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003771- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003772
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003773- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003774 SDRAM timing
3775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003777 periodic timer for refresh
3778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003781- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3782 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3783 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3784 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003785 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3786
3787- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003788 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3789 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003790 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003792- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3793 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003794 Machine Mode Register and Memory Periodic Timer
3795 Prescaler definitions (SDRAM timing)
3796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003797- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003798 enable I2C microcode relocation patch (MPC8xx);
3799 define relocation offset in DPRAM [DSP2]
3800
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003801- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003802 enable SMC microcode relocation patch (MPC8xx);
3803 define relocation offset in DPRAM [SMC1]
3804
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003805- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003806 enable SPI microcode relocation patch (MPC8xx);
3807 define relocation offset in DPRAM [SCC4]
3808
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003809- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003810 Use OSCM clock mode on MBX8xx board. Be careful,
3811 wrong setting might damage your board. Read
3812 doc/README.MBX before setting this variable!
3813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003815 Offset of the bootmode word in DPRAM used by post
3816 (Power On Self Tests). This definition overrides
3817 #define'd default value in commproc.h resp.
3818 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003819
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003820- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3821 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3822 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3823 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3824 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3825 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3826 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3827 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003828 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003829
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003830- CONFIG_PCI_DISABLE_PCIE:
3831 Disable PCI-Express on systems where it is supported but not
3832 required.
3833
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003834- CONFIG_PCI_ENUM_ONLY
3835 Only scan through and get the devices on the busses.
3836 Don't do any setup work, presumably because someone or
3837 something has already done it, and we don't need to do it
3838 a second time. Useful for platforms that are pre-booted
3839 by coreboot or similar.
3840
Kumar Gala8975d7a2010-12-30 12:09:53 -06003841- CONFIG_SYS_SRIO:
3842 Chip has SRIO or not
3843
3844- CONFIG_SRIO1:
3845 Board has SRIO 1 port available
3846
3847- CONFIG_SRIO2:
3848 Board has SRIO 2 port available
3849
3850- CONFIG_SYS_SRIOn_MEM_VIRT:
3851 Virtual Address of SRIO port 'n' memory region
3852
3853- CONFIG_SYS_SRIOn_MEM_PHYS:
3854 Physical Address of SRIO port 'n' memory region
3855
3856- CONFIG_SYS_SRIOn_MEM_SIZE:
3857 Size of SRIO port 'n' memory region
3858
Fabio Estevamf17e8782013-04-11 09:35:34 +00003859- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3860 Defined to tell the NAND controller that the NAND chip is using
3861 a 16 bit bus.
3862 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003863 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003864 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003865 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003866
3867- CONFIG_SYS_NDFC_EBC0_CFG
3868 Sets the EBC0_CFG register for the NDFC. If not defined
3869 a default value will be used.
3870
Ben Warren45657152006-09-07 16:50:54 -04003871- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003872 Get DDR timing information from an I2C EEPROM. Common
3873 with pluggable memory modules such as SODIMMs
3874
Ben Warren45657152006-09-07 16:50:54 -04003875 SPD_EEPROM_ADDRESS
3876 I2C address of the SPD EEPROM
3877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003878- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003879 If SPD EEPROM is on an I2C bus other than the first
3880 one, specify here. Note that the value must resolve
3881 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003882
York Sune73cc042011-06-07 09:42:16 +08003883- CONFIG_SYS_DDR_RAW_TIMING
3884 Get DDR timing information from other than SPD. Common with
3885 soldered DDR chips onboard without SPD. DDR raw timing
3886 parameters are extracted from datasheet and hard-coded into
3887 header files or board specific files.
3888
York Sunbd495cf2011-09-16 13:21:35 -07003889- CONFIG_FSL_DDR_INTERACTIVE
3890 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003893 Only for 83xx systems. If specified, then DDR should
3894 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06003895
wdenk6203e402004-04-18 10:13:26 +00003896- CONFIG_ETHER_ON_FEC[12]
3897 Define to enable FEC[12] on a 8xx series processor.
3898
3899- CONFIG_FEC[12]_PHY
3900 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00003901 to the given FEC; i. e.
3902 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00003903 means that the PHY with address 4 is connected to FEC1
3904
3905 When set to -1, means to probe for first available.
3906
3907- CONFIG_FEC[12]_PHY_NORXERR
3908 The PHY does not have a RXERR line (RMII only).
3909 (so program the FEC to ignore it).
3910
3911- CONFIG_RMII
3912 Enable RMII mode for all FECs.
3913 Note that this is a global option, we can't
3914 have one FEC in standard MII mode and another in RMII mode.
3915
wdenk20c98a62004-04-23 20:32:05 +00003916- CONFIG_CRC32_VERIFY
3917 Add a verify option to the crc32 command.
3918 The syntax is:
3919
3920 => crc32 -v <address> <count> <crc32>
3921
3922 Where address/count indicate a memory area
3923 and crc32 is the correct crc32 which the
3924 area should have.
3925
wdenk64519362004-07-11 17:40:54 +00003926- CONFIG_LOOPW
3927 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003928 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00003929
stroesecc3af832004-12-16 18:46:55 +00003930- CONFIG_MX_CYCLIC
3931 Add the "mdc" and "mwc" memory commands. These are cyclic
3932 "md/mw" commands.
3933 Examples:
3934
wdenk07d7e6b2004-12-16 21:44:03 +00003935 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00003936 This command will print 4 bytes (10,11,12,13) each 500 ms.
3937
wdenk07d7e6b2004-12-16 21:44:03 +00003938 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00003939 This command will write 12345678 to address 100 all 10 ms.
3940
wdenk07d7e6b2004-12-16 21:44:03 +00003941 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05003942 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00003943
wdenk3d3d99f2005-04-04 12:44:11 +00003944- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00003945 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01003946 low level initializations (like setting up the memory
3947 controller) are omitted and/or U-Boot does not
3948 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00003949
Wolfgang Denk302141d2010-11-27 23:30:56 +01003950 Normally this variable MUST NOT be defined. The only
3951 exception is when U-Boot is loaded (to RAM) by some
3952 other boot loader or by a debugger which performs
3953 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00003954
Aneesh V552a3192011-07-13 05:11:07 +00003955- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02003956 Modifies the behaviour of start.S when compiling a loader
3957 that is executed before the actual U-Boot. E.g. when
3958 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00003959
Simon Glass17dabf02013-02-24 17:33:14 +00003960- CONFIG_ARCH_MAP_SYSMEM
3961 Generally U-Boot (and in particular the md command) uses
3962 effective address. It is therefore not necessary to regard
3963 U-Boot address as virtual addresses that need to be translated
3964 to physical addresses. However, sandbox requires this, since
3965 it maintains its own little RAM buffer which contains all
3966 addressable memory. This option causes some memory accesses
3967 to be mapped through map_sysmem() / unmap_sysmem().
3968
Matthias Weisser93416c12011-03-10 21:36:32 +00003969- CONFIG_USE_ARCH_MEMCPY
3970 CONFIG_USE_ARCH_MEMSET
3971 If these options are used a optimized version of memcpy/memset will
3972 be used if available. These functions may be faster under some
3973 conditions but may increase the binary size.
3974
Simon Glassbfb59802013-02-14 04:18:54 +00003975- CONFIG_X86_RESET_VECTOR
3976 If defined, the x86 reset vector code is included. This is not
3977 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00003978
Mark Jackson52b003c2013-03-04 01:27:20 +00003979- CONFIG_SYS_MPUCLK
3980 Defines the MPU clock speed (in MHz).
3981
3982 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00003983
Timur Tabi275f4bb2011-11-22 09:21:25 -06003984Freescale QE/FMAN Firmware Support:
3985-----------------------------------
3986
3987The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3988loading of "firmware", which is encoded in the QE firmware binary format.
3989This firmware often needs to be loaded during U-Boot booting, so macros
3990are used to identify the storage device (NOR flash, SPI, etc) and the address
3991within that device.
3992
3993- CONFIG_SYS_QE_FMAN_FW_ADDR
3994 The address in the storage device where the firmware is located. The
3995 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3996 is also specified.
3997
3998- CONFIG_SYS_QE_FMAN_FW_LENGTH
3999 The maximum possible size of the firmware. The firmware binary format
4000 has a field that specifies the actual size of the firmware, but it
4001 might not be possible to read any part of the firmware unless some
4002 local storage is allocated to hold the entire firmware first.
4003
4004- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4005 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4006 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4007 virtual address in NOR flash.
4008
4009- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4010 Specifies that QE/FMAN firmware is located in NAND flash.
4011 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4012
4013- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4014 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4015 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4016
4017- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4018 Specifies that QE/FMAN firmware is located on the primary SPI
4019 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4020
Liu Gang1e084582012-03-08 00:33:18 +00004021- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4022 Specifies that QE/FMAN firmware is located in the remote (master)
4023 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004024 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4025 window->master inbound window->master LAW->the ucode address in
4026 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004027
wdenkc6097192002-11-03 00:24:07 +00004028Building the Software:
4029======================
4030
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004031Building U-Boot has been tested in several native build environments
4032and in many different cross environments. Of course we cannot support
4033all possibly existing versions of cross development tools in all
4034(potentially obsolete) versions. In case of tool chain problems we
4035recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4036which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004037
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004038If you are not using a native environment, it is assumed that you
4039have GNU cross compiling tools available in your path. In this case,
4040you must set the environment variable CROSS_COMPILE in your shell.
4041Note that no changes to the Makefile or any other source files are
4042necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004043
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004044 $ CROSS_COMPILE=ppc_4xx-
4045 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004046
Peter Tyserb06976d2009-03-13 18:54:51 -05004047Note: If you wish to generate Windows versions of the utilities in
4048 the tools directory you can use the MinGW toolchain
4049 (http://www.mingw.org). Set your HOST tools to the MinGW
4050 toolchain and execute 'make tools'. For example:
4051
4052 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4053
4054 Binaries such as tools/mkimage.exe will be created which can
4055 be executed on computers running Windows.
4056
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004057U-Boot is intended to be simple to build. After installing the
4058sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004059is done by typing:
4060
4061 make NAME_config
4062
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004063where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004064rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066Note: for some board special configuration names may exist; check if
4067 additional information is available from the board vendor; for
4068 instance, the TQM823L systems are available without (standard)
4069 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004070 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072 make TQM823L_config
4073 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk6c59edc2004-05-03 20:45:30 +00004075 make TQM823L_LCD_config
4076 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004077
wdenk6c59edc2004-05-03 20:45:30 +00004078 etc.
wdenkc6097192002-11-03 00:24:07 +00004079
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk6c59edc2004-05-03 20:45:30 +00004081Finally, type "make all", and you should get some working U-Boot
4082images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004083
wdenk6c59edc2004-05-03 20:45:30 +00004084- "u-boot.bin" is a raw binary image
4085- "u-boot" is an image in ELF binary format
4086- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004087
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004088By default the build is performed locally and the objects are saved
4089in the source directory. One of the two methods can be used to change
4090this behavior and build U-Boot to some external directory:
4091
40921. Add O= to the make command line invocations:
4093
4094 make O=/tmp/build distclean
4095 make O=/tmp/build NAME_config
4096 make O=/tmp/build all
4097
40982. Set environment variable BUILD_DIR to point to the desired location:
4099
4100 export BUILD_DIR=/tmp/build
4101 make distclean
4102 make NAME_config
4103 make all
4104
4105Note that the command line "O=" setting overrides the BUILD_DIR environment
4106variable.
4107
wdenkc6097192002-11-03 00:24:07 +00004108
wdenk6c59edc2004-05-03 20:45:30 +00004109Please be aware that the Makefiles assume you are using GNU make, so
4110for instance on NetBSD you might need to use "gmake" instead of
4111native "make".
wdenkc6097192002-11-03 00:24:07 +00004112
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk6c59edc2004-05-03 20:45:30 +00004114If the system board that you have is not listed, then you will need
4115to port U-Boot to your hardware platform. To do this, follow these
4116steps:
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk6c59edc2004-05-03 20:45:30 +000041181. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004119 "boards.cfg" file, using the existing entries as examples.
4120 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000041212. Create a new directory to hold your board specific code. Add any
4122 files you need. In your board directory, you will need at least
4123 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
41243. Create a new configuration file "include/configs/<board>.h" for
4125 your board
41263. If you're porting U-Boot to a new CPU, then also create a new
4127 directory to hold your CPU specific code. Add any files you need.
41284. Run "make <board>_config" with your new name.
41295. Type "make", and you should get a working "u-boot.srec" file
4130 to be installed on your target system.
41316. Debug and solve any problems that might arise.
4132 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004133
wdenkc6097192002-11-03 00:24:07 +00004134
wdenk6c59edc2004-05-03 20:45:30 +00004135Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4136==============================================================
wdenkc6097192002-11-03 00:24:07 +00004137
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004138If you have modified U-Boot sources (for instance added a new board
4139or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004140provide feedback to the other developers. The feedback normally takes
4141the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004142official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004143
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004144But before you submit such a patch, please verify that your modifi-
4145cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004146the supported boards compile WITHOUT ANY compiler warnings. To do so,
4147just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004148for ALL supported system. Be warned, this will take a while. You can
4149select which (cross) compiler to use by passing a `CROSS_COMPILE'
4150environment variable to the script, i. e. to use the ELDK cross tools
4151you can type
wdenkc6097192002-11-03 00:24:07 +00004152
wdenk6c59edc2004-05-03 20:45:30 +00004153 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004154
wdenk6c59edc2004-05-03 20:45:30 +00004155or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk6c59edc2004-05-03 20:45:30 +00004157 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004158
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004159When using the MAKEALL script, the default behaviour is to build
4160U-Boot in the source directory. This location can be changed by
4161setting the BUILD_DIR environment variable. Also, for each target
4162built, the MAKEALL script saves two log files (<target>.ERR and
4163<target>.MAKEALL) in the <source dir>/LOG directory. This default
4164location can be changed by setting the MAKEALL_LOGDIR environment
4165variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004166
4167 export BUILD_DIR=/tmp/build
4168 export MAKEALL_LOGDIR=/tmp/log
4169 CROSS_COMPILE=ppc_8xx- MAKEALL
4170
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004171With the above settings build objects are saved in the /tmp/build,
4172log files are saved in the /tmp/log and the source tree remains clean
4173during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004174
4175
wdenk6c59edc2004-05-03 20:45:30 +00004176See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004177
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk6c59edc2004-05-03 20:45:30 +00004179Monitor Commands - Overview:
4180============================
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk6c59edc2004-05-03 20:45:30 +00004182go - start application at address 'addr'
4183run - run commands in an environment variable
4184bootm - boot application image from memory
4185bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004186bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004187tftpboot- boot image via network using TFTP protocol
4188 and env variables "ipaddr" and "serverip"
4189 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004190tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004191rarpboot- boot image via network using RARP/TFTP protocol
4192diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4193loads - load S-Record file over serial line
4194loadb - load binary file over serial line (kermit mode)
4195md - memory display
4196mm - memory modify (auto-incrementing)
4197nm - memory modify (constant address)
4198mw - memory write (fill)
4199cp - memory copy
4200cmp - memory compare
4201crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004202i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004203sspi - SPI utility commands
4204base - print or set address offset
4205printenv- print environment variables
4206setenv - set environment variables
4207saveenv - save environment variables to persistent storage
4208protect - enable or disable FLASH write protection
4209erase - erase FLASH memory
4210flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004211nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004212bdinfo - print Board Info structure
4213iminfo - print header information for application image
4214coninfo - print console devices and informations
4215ide - IDE sub-system
4216loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004217loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004218mtest - simple RAM test
4219icache - enable or disable instruction cache
4220dcache - enable or disable data cache
4221reset - Perform RESET of the CPU
4222echo - echo args to console
4223version - print monitor version
4224help - print online help
4225? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004226
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk6c59edc2004-05-03 20:45:30 +00004228Monitor Commands - Detailed Description:
4229========================================
wdenkc6097192002-11-03 00:24:07 +00004230
wdenk6c59edc2004-05-03 20:45:30 +00004231TODO.
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk6c59edc2004-05-03 20:45:30 +00004233For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004234
4235
wdenk6c59edc2004-05-03 20:45:30 +00004236Environment Variables:
4237======================
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk6c59edc2004-05-03 20:45:30 +00004239U-Boot supports user configuration using Environment Variables which
4240can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk6c59edc2004-05-03 20:45:30 +00004242Environment Variables are set using "setenv", printed using
4243"printenv", and saved to Flash using "saveenv". Using "setenv"
4244without a value can be used to delete a variable from the
4245environment. As long as you don't save the environment you are
4246working with an in-memory copy. In case the Flash area containing the
4247environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004248
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004249Some configuration options can be set using Environment Variables.
4250
4251List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk6c59edc2004-05-03 20:45:30 +00004253 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk6c59edc2004-05-03 20:45:30 +00004255 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk6c59edc2004-05-03 20:45:30 +00004257 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk6c59edc2004-05-03 20:45:30 +00004259 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk6c59edc2004-05-03 20:45:30 +00004261 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004262
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004263 bootm_low - Memory range available for image processing in the bootm
4264 command can be restricted. This variable is given as
4265 a hexadecimal number and defines lowest address allowed
4266 for use by the bootm command. See also "bootm_size"
4267 environment variable. Address defined by "bootm_low" is
4268 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004269 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4270 bootm_mapsize.
4271
Wolfgang Denk092ae952011-10-26 10:21:21 +00004272 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004273 This variable is given as a hexadecimal number and it
4274 defines the size of the memory region starting at base
4275 address bootm_low that is accessible by the Linux kernel
4276 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4277 as the default value if it is defined, and bootm_size is
4278 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004279
4280 bootm_size - Memory range available for image processing in the bootm
4281 command can be restricted. This variable is given as
4282 a hexadecimal number and defines the size of the region
4283 allowed for use by the bootm command. See also "bootm_low"
4284 environment variable.
4285
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004286 updatefile - Location of the software update file on a TFTP server, used
4287 by the automatic software update feature. Please refer to
4288 documentation in doc/README.update for more details.
4289
wdenk6c59edc2004-05-03 20:45:30 +00004290 autoload - if set to "no" (any string beginning with 'n'),
4291 "bootp" will just load perform a lookup of the
4292 configuration from the BOOTP server, but not try to
4293 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk6c59edc2004-05-03 20:45:30 +00004295 autostart - if set to "yes", an image loaded using the "bootp",
4296 "rarpboot", "tftpboot" or "diskboot" commands will
4297 be automatically started (by internally calling
4298 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk6c59edc2004-05-03 20:45:30 +00004300 If set to "no", a standalone image passed to the
4301 "bootm" command will be copied to the load address
4302 (and eventually uncompressed), but NOT be started.
4303 This can be used to load and uncompress arbitrary
4304 data.
wdenkc6097192002-11-03 00:24:07 +00004305
David A. Longd558a4e2011-07-09 16:40:19 -04004306 fdt_high - if set this restricts the maximum address that the
4307 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004308 For example, if you have a system with 1 GB memory
4309 at physical address 0x10000000, while Linux kernel
4310 only recognizes the first 704 MB as low memory, you
4311 may need to set fdt_high as 0x3C000000 to have the
4312 device tree blob be copied to the maximum address
4313 of the 704 MB low memory, so that Linux kernel can
4314 access it during the boot procedure.
4315
David A. Longd558a4e2011-07-09 16:40:19 -04004316 If this is set to the special value 0xFFFFFFFF then
4317 the fdt will not be copied at all on boot. For this
4318 to work it must reside in writable memory, have
4319 sufficient padding on the end of it for u-boot to
4320 add the information it needs into it, and the memory
4321 must be accessible by the kernel.
4322
Simon Glassdc6fa642011-10-24 19:15:34 +00004323 fdtcontroladdr- if set this is the address of the control flattened
4324 device tree used by U-Boot when CONFIG_OF_CONTROL is
4325 defined.
4326
wdenk0e2bd9c2004-06-06 21:51:03 +00004327 i2cfast - (PPC405GP|PPC405EP only)
4328 if set to 'y' configures Linux I2C driver for fast
4329 mode (400kHZ). This environment variable is used in
4330 initialization code. So, for changes to be effective
4331 it must be saved and board must be reset.
4332
wdenk6c59edc2004-05-03 20:45:30 +00004333 initrd_high - restrict positioning of initrd images:
4334 If this variable is not set, initrd images will be
4335 copied to the highest possible address in RAM; this
4336 is usually what you want since it allows for
4337 maximum initrd size. If for some reason you want to
4338 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004339 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004340 variable to a value of "no" or "off" or "0".
4341 Alternatively, you can set it to a maximum upper
4342 address to use (U-Boot will still check that it
4343 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk6c59edc2004-05-03 20:45:30 +00004345 For instance, when you have a system with 16 MB
4346 RAM, and want to reserve 4 MB from use by Linux,
4347 you can do this by adding "mem=12M" to the value of
4348 the "bootargs" variable. However, now you must make
4349 sure that the initrd image is placed in the first
4350 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk6c59edc2004-05-03 20:45:30 +00004352 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004353
wdenk6c59edc2004-05-03 20:45:30 +00004354 If you set initrd_high to 0xFFFFFFFF, this is an
4355 indication to U-Boot that all addresses are legal
4356 for the Linux kernel, including addresses in flash
4357 memory. In this case U-Boot will NOT COPY the
4358 ramdisk at all. This may be useful to reduce the
4359 boot time on your system, but requires that this
4360 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk6c59edc2004-05-03 20:45:30 +00004364 loadaddr - Default load address for commands like "bootp",
4365 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004370
wdenk6c59edc2004-05-03 20:45:30 +00004371 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk6c59edc2004-05-03 20:45:30 +00004373 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk6c59edc2004-05-03 20:45:30 +00004375 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004376
Mike Frysingera23230c2011-10-02 10:01:27 +00004377 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004378
Mike Frysingera23230c2011-10-02 10:01:27 +00004379 ethact - controls which interface is currently active.
4380 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004381
Heiko Schocherc5e84052010-07-20 17:45:02 +02004382 => setenv ethact FEC
4383 => ping 192.168.0.1 # traffic sent on FEC
4384 => setenv ethact SCC
4385 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004386
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004387 ethrotate - When set to "no" U-Boot does not go through all
4388 available network interfaces.
4389 It just stays at the currently selected interface.
4390
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004391 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004392 either succeed or fail without retrying.
4393 When set to "once" the network operation will
4394 fail when all the available network interfaces
4395 are tried once without success.
4396 Useful on scripts which control the retry operation
4397 themselves.
wdenkc6097192002-11-03 00:24:07 +00004398
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004399 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004400
Wolfgang Denk227b5192005-09-24 23:25:46 +02004401 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004402 UDP source port.
4403
Wolfgang Denk227b5192005-09-24 23:25:46 +02004404 tftpdstport - If this is set, the value is used for TFTP's UDP
4405 destination port instead of the Well Know Port 69.
4406
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004407 tftpblocksize - Block size to use for TFTP transfers; if not set,
4408 we use the TFTP server's default block size
4409
4410 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4411 seconds, minimum value is 1000 = 1 second). Defines
4412 when a packet is considered to be lost so it has to
4413 be retransmitted. The default is 5000 = 5 seconds.
4414 Lowering this value may make downloads succeed
4415 faster in networks with high packet loss rates or
4416 with unreliable TFTP servers.
4417
4418 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004419 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004420 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004421
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004422The following image location variables contain the location of images
4423used in booting. The "Image" column gives the role of the image and is
4424not an environment variable name. The other columns are environment
4425variable names. "File Name" gives the name of the file on a TFTP
4426server, "RAM Address" gives the location in RAM the image will be
4427loaded to, and "Flash Location" gives the image's address in NOR
4428flash or offset in NAND flash.
4429
4430*Note* - these variables don't have to be defined for all boards, some
4431boards currenlty use other variables for these purposes, and some
4432boards use these variables for other purposes.
4433
Wolfgang Denk092ae952011-10-26 10:21:21 +00004434Image File Name RAM Address Flash Location
4435----- --------- ----------- --------------
4436u-boot u-boot u-boot_addr_r u-boot_addr
4437Linux kernel bootfile kernel_addr_r kernel_addr
4438device tree blob fdtfile fdt_addr_r fdt_addr
4439ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004440
wdenk6c59edc2004-05-03 20:45:30 +00004441The following environment variables may be used and automatically
4442updated by the network boot commands ("bootp" and "rarpboot"),
4443depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004444
wdenk6c59edc2004-05-03 20:45:30 +00004445 bootfile - see above
4446 dnsip - IP address of your Domain Name Server
4447 dnsip2 - IP address of your secondary Domain Name Server
4448 gatewayip - IP address of the Gateway (Router) to use
4449 hostname - Target hostname
4450 ipaddr - see above
4451 netmask - Subnet Mask
4452 rootpath - Pathname of the root filesystem on the NFS server
4453 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004454
wdenk145d2c12004-04-15 21:48:45 +00004455
wdenk6c59edc2004-05-03 20:45:30 +00004456There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk6c59edc2004-05-03 20:45:30 +00004458 serial# - contains hardware identification information such
4459 as type string and/or serial number
4460 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk6c59edc2004-05-03 20:45:30 +00004462These variables can be set only once (usually during manufacturing of
4463the board). U-Boot refuses to delete or overwrite these variables
4464once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004465
4466
wdenk6c59edc2004-05-03 20:45:30 +00004467Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004468
wdenk6c59edc2004-05-03 20:45:30 +00004469 ver - Contains the U-Boot version string as printed
4470 with the "version" command. This variable is
4471 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004472
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk6c59edc2004-05-03 20:45:30 +00004474Please note that changes to some configuration parameters may take
4475only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004476
stroeseb9c17c52003-04-04 15:53:41 +00004477
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004478Callback functions for environment variables:
4479---------------------------------------------
4480
4481For some environment variables, the behavior of u-boot needs to change
4482when their values are changed. This functionailty allows functions to
4483be associated with arbitrary variables. On creation, overwrite, or
4484deletion, the callback will provide the opportunity for some side
4485effect to happen or for the change to be rejected.
4486
4487The callbacks are named and associated with a function using the
4488U_BOOT_ENV_CALLBACK macro in your board or driver code.
4489
4490These callbacks are associated with variables in one of two ways. The
4491static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4492in the board configuration to a string that defines a list of
4493associations. The list must be in the following format:
4494
4495 entry = variable_name[:callback_name]
4496 list = entry[,list]
4497
4498If the callback name is not specified, then the callback is deleted.
4499Spaces are also allowed anywhere in the list.
4500
4501Callbacks can also be associated by defining the ".callbacks" variable
4502with the same list format above. Any association in ".callbacks" will
4503override any association in the static list. You can define
4504CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4505".callbacks" envirnoment variable in the default or embedded environment.
4506
4507
wdenk6c59edc2004-05-03 20:45:30 +00004508Command Line Parsing:
4509=====================
stroeseb9c17c52003-04-04 15:53:41 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511There are two different command line parsers available with U-Boot:
4512the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004513
wdenk6c59edc2004-05-03 20:45:30 +00004514Old, simple command line parser:
4515--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517- supports environment variables (through setenv / saveenv commands)
4518- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004519- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004520- special characters ('$', ';') can be escaped by prefixing with '\',
4521 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004522 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004523- You can also escape text by enclosing in single apostrophes, for example:
4524 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004525
wdenk6c59edc2004-05-03 20:45:30 +00004526Hush shell:
4527-----------
wdenkf4688a22003-05-28 08:06:31 +00004528
wdenk6c59edc2004-05-03 20:45:30 +00004529- similar to Bourne shell, with control structures like
4530 if...then...else...fi, for...do...done; while...do...done,
4531 until...do...done, ...
4532- supports environment ("global") variables (through setenv / saveenv
4533 commands) and local shell variables (through standard shell syntax
4534 "name=value"); only environment variables can be used with "run"
4535 command
wdenkf4688a22003-05-28 08:06:31 +00004536
wdenk6c59edc2004-05-03 20:45:30 +00004537General rules:
4538--------------
wdenkf4688a22003-05-28 08:06:31 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540(1) If a command line (or an environment variable executed by a "run"
4541 command) contains several commands separated by semicolon, and
4542 one of these commands fails, then the remaining commands will be
4543 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004544
wdenk6c59edc2004-05-03 20:45:30 +00004545(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004546 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004547 command will cause "run" to terminate, i. e. the remaining
4548 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550Note for Redundant Ethernet Interfaces:
4551=======================================
wdenkf4688a22003-05-28 08:06:31 +00004552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004553Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004554such configurations and is capable of automatic selection of a
4555"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004556
wdenk6c59edc2004-05-03 20:45:30 +00004557Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4558MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4559"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004560
wdenk6c59edc2004-05-03 20:45:30 +00004561If the network interface stores some valid MAC address (for instance
4562in SROM), this is used as default address if there is NO correspon-
4563ding setting in the environment; if the corresponding environment
4564variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566o If the SROM has a valid MAC address, and there is no address in the
4567 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk6c59edc2004-05-03 20:45:30 +00004569o If there is no valid address in the SROM, and a definition in the
4570 environment exists, then the value from the environment variable is
4571 used.
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk6c59edc2004-05-03 20:45:30 +00004573o If both the SROM and the environment contain a MAC address, and
4574 both addresses are the same, this MAC address is 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 the
4577 addresses differ, the value from the environment is used and a
4578 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk6c59edc2004-05-03 20:45:30 +00004580o If neither SROM nor the environment contain a MAC address, an error
4581 is raised.
wdenkc6097192002-11-03 00:24:07 +00004582
Ben Warren6db991a2010-04-26 11:11:46 -07004583If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004584will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004585may be skipped by setting the appropriate 'ethmacskip' environment variable.
4586The naming convention is as follows:
4587"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004588
wdenk6c59edc2004-05-03 20:45:30 +00004589Image Formats:
4590==============
wdenkc6097192002-11-03 00:24:07 +00004591
Marian Balakowicz18710b82008-03-12 12:13:13 +01004592U-Boot is capable of booting (and performing other auxiliary operations on)
4593images in two formats:
4594
4595New uImage format (FIT)
4596-----------------------
4597
4598Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4599to Flattened Device Tree). It allows the use of images with multiple
4600components (several kernels, ramdisks, etc.), with contents protected by
4601SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4602
4603
4604Old uImage format
4605-----------------
4606
4607Old image format is based on binary files which can be basically anything,
4608preceded by a special header; see the definitions in include/image.h for
4609details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4612 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004613 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4614 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4615 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004616* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004617 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4618 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004619* Compression Type (uncompressed, gzip, bzip2)
4620* Load Address
4621* Entry Point
4622* Image Name
4623* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004624
wdenk6c59edc2004-05-03 20:45:30 +00004625The header is marked by a special Magic Number, and both the header
4626and the data portions of the image are secured against corruption by
4627CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004628
wdenkc6097192002-11-03 00:24:07 +00004629
wdenk6c59edc2004-05-03 20:45:30 +00004630Linux Support:
4631==============
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633Although U-Boot should support any OS or standalone application
4634easily, the main focus has always been on Linux during the design of
4635U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637U-Boot includes many features that so far have been part of some
4638special "boot loader" code within the Linux kernel. Also, any
4639"initrd" images to be used are no longer part of one big Linux image;
4640instead, kernel and "initrd" are separate images. This implementation
4641serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643- the same features can be used for other OS or standalone
4644 applications (for instance: using compressed images to reduce the
4645 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004646
wdenk6c59edc2004-05-03 20:45:30 +00004647- it becomes much easier to port new Linux kernel versions because
4648 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk6c59edc2004-05-03 20:45:30 +00004650- the same Linux kernel image can now be used with different "initrd"
4651 images; of course this also means that different kernel images can
4652 be run with the same "initrd". This makes testing easier (you don't
4653 have to build a new "zImage.initrd" Linux image when you just
4654 change a file in your "initrd"). Also, a field-upgrade of the
4655 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004656
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk6c59edc2004-05-03 20:45:30 +00004658Linux HOWTO:
4659============
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661Porting Linux to U-Boot based systems:
4662---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664U-Boot cannot save you from doing all the necessary modifications to
4665configure the Linux device drivers for use with your target hardware
4666(no, we don't intend to provide a full virtual machine interface to
4667Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004668
Stefan Roese88fbf932010-04-15 16:07:28 +02004669But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004670
wdenk6c59edc2004-05-03 20:45:30 +00004671Just make sure your machine specific header file (for instance
4672include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004673Information structure as we define in include/asm-<arch>/u-boot.h,
4674and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004675as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004676
wdenkc6097192002-11-03 00:24:07 +00004677
wdenk6c59edc2004-05-03 20:45:30 +00004678Configuring the Linux kernel:
4679-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk6c59edc2004-05-03 20:45:30 +00004681No specific requirements for U-Boot. Make sure you have some root
4682device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004683
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685Building a Linux Image:
4686-----------------------
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4689not used. If you use recent kernel source, a new build target
4690"uImage" will exist which automatically builds an image usable by
4691U-Boot. Most older kernels also have support for a "pImage" target,
4692which was introduced for our predecessor project PPCBoot and uses a
4693100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk6c59edc2004-05-03 20:45:30 +00004695Example:
wdenkc6097192002-11-03 00:24:07 +00004696
wdenk6c59edc2004-05-03 20:45:30 +00004697 make TQM850L_config
4698 make oldconfig
4699 make dep
4700 make uImage
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk6c59edc2004-05-03 20:45:30 +00004702The "uImage" build target uses a special tool (in 'tools/mkimage') to
4703encapsulate a compressed Linux kernel image with header information,
4704CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004705
wdenk6c59edc2004-05-03 20:45:30 +00004706* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk6c59edc2004-05-03 20:45:30 +00004708* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710 ${CROSS_COMPILE}-objcopy -O binary \
4711 -R .note -R .comment \
4712 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004713
wdenk6c59edc2004-05-03 20:45:30 +00004714* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004715
wdenk6c59edc2004-05-03 20:45:30 +00004716 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004717
wdenk6c59edc2004-05-03 20:45:30 +00004718* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720 mkimage -A ppc -O linux -T kernel -C gzip \
4721 -a 0 -e 0 -n "Linux Kernel Image" \
4722 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004723
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk6c59edc2004-05-03 20:45:30 +00004725The "mkimage" tool can also be used to create ramdisk images for use
4726with U-Boot, either separated from the Linux kernel image, or
4727combined into one file. "mkimage" encapsulates the images with a 64
4728byte header containing information about target architecture,
4729operating system, image type, compression method, entry points, time
4730stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk6c59edc2004-05-03 20:45:30 +00004732"mkimage" can be called in two ways: to verify existing images and
4733print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004734
wdenk6c59edc2004-05-03 20:45:30 +00004735In the first form (with "-l" option) mkimage lists the information
4736contained in the header of an existing U-Boot image; this includes
4737checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004738
wdenk6c59edc2004-05-03 20:45:30 +00004739 tools/mkimage -l image
4740 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742The second form (with "-d" option) is used to build a U-Boot image
4743from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4746 -n name -d data_file image
4747 -A ==> set architecture to 'arch'
4748 -O ==> set operating system to 'os'
4749 -T ==> set image type to 'type'
4750 -C ==> set compression type 'comp'
4751 -a ==> set load address to 'addr' (hex)
4752 -e ==> set entry point to 'ep' (hex)
4753 -n ==> set image name to 'name'
4754 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004755
wdenkcd914452004-05-29 16:53:29 +00004756Right now, all Linux kernels for PowerPC systems use the same load
4757address (0x00000000), but the entry point address depends on the
4758kernel version:
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760- 2.2.x kernels have the entry point at 0x0000000C,
4761- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004762
wdenk6c59edc2004-05-03 20:45:30 +00004763So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk6c59edc2004-05-03 20:45:30 +00004765 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4766 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004767 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004768 > examples/uImage.TQM850L
4769 Image Name: 2.4.4 kernel for TQM850L
4770 Created: Wed Jul 19 02:34:59 2000
4771 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4772 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4773 Load Address: 0x00000000
4774 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk6c59edc2004-05-03 20:45:30 +00004778 -> tools/mkimage -l examples/uImage.TQM850L
4779 Image Name: 2.4.4 kernel for TQM850L
4780 Created: Wed Jul 19 02:34:59 2000
4781 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4782 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4783 Load Address: 0x00000000
4784 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk6c59edc2004-05-03 20:45:30 +00004786NOTE: for embedded systems where boot time is critical you can trade
4787speed for memory and install an UNCOMPRESSED image instead: this
4788needs more space in Flash, but boots much faster since it does not
4789need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004790
Stefan Roese88fbf932010-04-15 16:07:28 +02004791 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004792 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4793 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004794 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004795 > examples/uImage.TQM850L-uncompressed
4796 Image Name: 2.4.4 kernel for TQM850L
4797 Created: Wed Jul 19 02:34:59 2000
4798 Image Type: PowerPC Linux Kernel Image (uncompressed)
4799 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4800 Load Address: 0x00000000
4801 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004802
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk6c59edc2004-05-03 20:45:30 +00004804Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4805when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk6c59edc2004-05-03 20:45:30 +00004807 -> tools/mkimage -n 'Simple Ramdisk Image' \
4808 > -A ppc -O linux -T ramdisk -C gzip \
4809 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4810 Image Name: Simple Ramdisk Image
4811 Created: Wed Jan 12 14:01:50 2000
4812 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4813 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4814 Load Address: 0x00000000
4815 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004816
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818Installing a Linux Image:
4819-------------------------
wdenkc6097192002-11-03 00:24:07 +00004820
wdenk6c59edc2004-05-03 20:45:30 +00004821To downloading a U-Boot image over the serial (console) interface,
4822you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk6c59edc2004-05-03 20:45:30 +00004824 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk6c59edc2004-05-03 20:45:30 +00004826The 'objcopy' does not understand the information in the U-Boot
4827image header, so the resulting S-Record file will be relative to
4828address 0x00000000. To load it to a given address, you need to
4829specify the target address as 'offset' parameter with the 'loads'
4830command.
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832Example: install the image to address 0x40100000 (which on the
4833TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004834
wdenk6c59edc2004-05-03 20:45:30 +00004835 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004836
wdenk6c59edc2004-05-03 20:45:30 +00004837 .......... done
4838 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk6c59edc2004-05-03 20:45:30 +00004840 => loads 40100000
4841 ## Ready for S-Record download ...
4842 ~>examples/image.srec
4843 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4844 ...
4845 15989 15990 15991 15992
4846 [file transfer complete]
4847 [connected]
4848 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004849
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk6c59edc2004-05-03 20:45:30 +00004851You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004852this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004853corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk6c59edc2004-05-03 20:45:30 +00004855 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857 ## Checking Image at 40100000 ...
4858 Image Name: 2.2.13 for initrd on TQM850L
4859 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4860 Data Size: 335725 Bytes = 327 kB = 0 MB
4861 Load Address: 00000000
4862 Entry Point: 0000000c
4863 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004864
4865
wdenk6c59edc2004-05-03 20:45:30 +00004866Boot Linux:
4867-----------
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk6c59edc2004-05-03 20:45:30 +00004869The "bootm" command is used to boot an application that is stored in
4870memory (RAM or Flash). In case of a Linux kernel image, the contents
4871of the "bootargs" environment variable is passed to the kernel as
4872parameters. You can check and modify this variable using the
4873"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004874
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk6c59edc2004-05-03 20:45:30 +00004876 => printenv bootargs
4877 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879 => 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 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881 => printenv bootargs
4882 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 => bootm 40020000
4885 ## Booting Linux kernel at 40020000 ...
4886 Image Name: 2.2.13 for NFS on TQM850L
4887 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4888 Data Size: 381681 Bytes = 372 kB = 0 MB
4889 Load Address: 00000000
4890 Entry Point: 0000000c
4891 Verifying Checksum ... OK
4892 Uncompressing Kernel Image ... OK
4893 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
4894 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4895 time_init: decrementer frequency = 187500000/60
4896 Calibrating delay loop... 49.77 BogoMIPS
4897 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4898 ...
wdenkc6097192002-11-03 00:24:07 +00004899
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004900If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00004901the memory addresses of both the kernel and the initrd image (PPBCOOT
4902format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906 ## Checking Image at 40100000 ...
4907 Image Name: 2.2.13 for initrd on TQM850L
4908 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4909 Data Size: 335725 Bytes = 327 kB = 0 MB
4910 Load Address: 00000000
4911 Entry Point: 0000000c
4912 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk6c59edc2004-05-03 20:45:30 +00004914 ## Checking Image at 40200000 ...
4915 Image Name: Simple Ramdisk Image
4916 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4917 Data Size: 566530 Bytes = 553 kB = 0 MB
4918 Load Address: 00000000
4919 Entry Point: 00000000
4920 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004921
wdenk6c59edc2004-05-03 20:45:30 +00004922 => bootm 40100000 40200000
4923 ## Booting Linux kernel at 40100000 ...
4924 Image Name: 2.2.13 for initrd on TQM850L
4925 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4926 Data Size: 335725 Bytes = 327 kB = 0 MB
4927 Load Address: 00000000
4928 Entry Point: 0000000c
4929 Verifying Checksum ... OK
4930 Uncompressing Kernel Image ... OK
4931 ## Loading RAMDisk Image at 40200000 ...
4932 Image Name: Simple Ramdisk Image
4933 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4934 Data Size: 566530 Bytes = 553 kB = 0 MB
4935 Load Address: 00000000
4936 Entry Point: 00000000
4937 Verifying Checksum ... OK
4938 Loading Ramdisk ... OK
4939 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
4940 Boot arguments: root=/dev/ram
4941 time_init: decrementer frequency = 187500000/60
4942 Calibrating delay loop... 49.77 BogoMIPS
4943 ...
4944 RAMDISK: Compressed image found at block 0
4945 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk6c59edc2004-05-03 20:45:30 +00004947 bash#
wdenkc6097192002-11-03 00:24:07 +00004948
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004949Boot Linux and pass a flat device tree:
4950-----------
4951
4952First, U-Boot must be compiled with the appropriate defines. See the section
4953titled "Linux Kernel Interface" above for a more in depth explanation. The
4954following is an example of how to start a kernel and pass an updated
4955flat device tree:
4956
4957=> print oftaddr
4958oftaddr=0x300000
4959=> print oft
4960oft=oftrees/mpc8540ads.dtb
4961=> tftp $oftaddr $oft
4962Speed: 1000, full duplex
4963Using TSEC0 device
4964TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4965Filename 'oftrees/mpc8540ads.dtb'.
4966Load address: 0x300000
4967Loading: #
4968done
4969Bytes transferred = 4106 (100a hex)
4970=> tftp $loadaddr $bootfile
4971Speed: 1000, full duplex
4972Using TSEC0 device
4973TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4974Filename 'uImage'.
4975Load address: 0x200000
4976Loading:############
4977done
4978Bytes transferred = 1029407 (fb51f hex)
4979=> print loadaddr
4980loadaddr=200000
4981=> print oftaddr
4982oftaddr=0x300000
4983=> bootm $loadaddr - $oftaddr
4984## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01004985 Image Name: Linux-2.6.17-dirty
4986 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4987 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004988 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01004989 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05004990 Verifying Checksum ... OK
4991 Uncompressing Kernel Image ... OK
4992Booting using flat device tree at 0x300000
4993Using MPC85xx ADS machine description
4994Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4995[snip]
4996
4997
wdenk6c59edc2004-05-03 20:45:30 +00004998More About U-Boot Image Types:
4999------------------------------
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003 "Standalone Programs" are directly runnable in the environment
5004 provided by U-Boot; it is expected that (if they behave
5005 well) you can continue to work in U-Boot after return from
5006 the Standalone Program.
5007 "OS Kernel Images" are usually images of some Embedded OS which
5008 will take over control completely. Usually these programs
5009 will install their own set of exception handlers, device
5010 drivers, set up the MMU, etc. - this means, that you cannot
5011 expect to re-enter U-Boot except by resetting the CPU.
5012 "RAMDisk Images" are more or less just data blocks, and their
5013 parameters (address, size) are passed to an OS kernel that is
5014 being started.
5015 "Multi-File Images" contain several images, typically an OS
5016 (Linux) kernel image and one or more data images like
5017 RAMDisks. This construct is useful for instance when you want
5018 to boot over the network using BOOTP etc., where the boot
5019 server provides just a single image file, but you want to get
5020 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk6c59edc2004-05-03 20:45:30 +00005022 "Multi-File Images" start with a list of image sizes, each
5023 image size (in bytes) specified by an "uint32_t" in network
5024 byte order. This list is terminated by an "(uint32_t)0".
5025 Immediately after the terminating 0 follow the images, one by
5026 one, all aligned on "uint32_t" boundaries (size rounded up to
5027 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005028
wdenk6c59edc2004-05-03 20:45:30 +00005029 "Firmware Images" are binary images containing firmware (like
5030 U-Boot or FPGA images) which usually will be programmed to
5031 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005032
wdenk6c59edc2004-05-03 20:45:30 +00005033 "Script files" are command sequences that will be executed by
5034 U-Boot's command interpreter; this feature is especially
5035 useful when you configure U-Boot to use a real shell (hush)
5036 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005037
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005038Booting the Linux zImage:
5039-------------------------
5040
5041On some platforms, it's possible to boot Linux zImage. This is done
5042using the "bootz" command. The syntax of "bootz" command is the same
5043as the syntax of "bootm" command.
5044
Marek Vasut28850d02012-03-18 11:47:58 +00005045Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
5046kernel with raw initrd images. The syntax is slightly different, the
5047address of the initrd must be augmented by it's size, in the following
5048format: "<initrd addres>:<initrd size>".
5049
stroeseb9c17c52003-04-04 15:53:41 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051Standalone HOWTO:
5052=================
stroeseb9c17c52003-04-04 15:53:41 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054One of the features of U-Boot is that you can dynamically load and
5055run "standalone" applications, which can use some resources of
5056U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005057
wdenk6c59edc2004-05-03 20:45:30 +00005058Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005059
wdenk6c59edc2004-05-03 20:45:30 +00005060"Hello World" Demo:
5061-------------------
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk6c59edc2004-05-03 20:45:30 +00005063'examples/hello_world.c' contains a small "Hello World" Demo
5064application; it is automatically compiled when you build U-Boot.
5065It's configured to run at address 0x00040004, so you can play with it
5066like that:
wdenkc6097192002-11-03 00:24:07 +00005067
wdenk6c59edc2004-05-03 20:45:30 +00005068 => loads
5069 ## Ready for S-Record download ...
5070 ~>examples/hello_world.srec
5071 1 2 3 4 5 6 7 8 9 10 11 ...
5072 [file transfer complete]
5073 [connected]
5074 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk6c59edc2004-05-03 20:45:30 +00005076 => go 40004 Hello World! This is a test.
5077 ## Starting application at 0x00040004 ...
5078 Hello World
5079 argc = 7
5080 argv[0] = "40004"
5081 argv[1] = "Hello"
5082 argv[2] = "World!"
5083 argv[3] = "This"
5084 argv[4] = "is"
5085 argv[5] = "a"
5086 argv[6] = "test."
5087 argv[7] = "<NULL>"
5088 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk6c59edc2004-05-03 20:45:30 +00005092Another example, which demonstrates how to register a CPM interrupt
5093handler with the U-Boot code, can be found in 'examples/timer.c'.
5094Here, a CPM timer is set up to generate an interrupt every second.
5095The interrupt service routine is trivial, just printing a '.'
5096character, but this is just a demo program. The application can be
5097controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005098
wdenk6c59edc2004-05-03 20:45:30 +00005099 ? - print current values og the CPM Timer registers
5100 b - enable interrupts and start timer
5101 e - stop timer and disable interrupts
5102 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk6c59edc2004-05-03 20:45:30 +00005104 => loads
5105 ## Ready for S-Record download ...
5106 ~>examples/timer.srec
5107 1 2 3 4 5 6 7 8 9 10 11 ...
5108 [file transfer complete]
5109 [connected]
5110 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk6c59edc2004-05-03 20:45:30 +00005112 => go 40004
5113 ## Starting application at 0x00040004 ...
5114 TIMERS=0xfff00980
5115 Using timer 1
5116 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118Hit 'b':
5119 [q, b, e, ?] Set interval 1000000 us
5120 Enabling timer
5121Hit '?':
5122 [q, b, e, ?] ........
5123 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5124Hit '?':
5125 [q, b, e, ?] .
5126 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5127Hit '?':
5128 [q, b, e, ?] .
5129 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5130Hit '?':
5131 [q, b, e, ?] .
5132 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5133Hit 'e':
5134 [q, b, e, ?] ...Stopping timer
5135Hit 'q':
5136 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005137
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139Minicom warning:
5140================
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142Over time, many people have reported problems when trying to use the
5143"minicom" terminal emulation program for serial download. I (wd)
5144consider minicom to be broken, and recommend not to use it. Under
5145Unix, I recommend to use C-Kermit for general purpose use (and
5146especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005147use "cu" for S-Record download ("loads" command). See
5148http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5149for help with kermit.
5150
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk6c59edc2004-05-03 20:45:30 +00005152Nevertheless, if you absolutely want to use it try adding this
5153configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155 Name Program Name U/D FullScr IO-Red. Multi
5156 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5157 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005158
wdenk8dba0502003-03-31 16:34:49 +00005159
wdenk6c59edc2004-05-03 20:45:30 +00005160NetBSD Notes:
5161=============
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163Starting at version 0.9.2, U-Boot supports NetBSD both as host
5164(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166Building requires a cross environment; it is known to work on
5167NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5168need gmake since the Makefiles are not compatible with BSD make).
5169Note that the cross-powerpc package does not install include files;
5170attempting to build U-Boot will fail because <machine/ansi.h> is
5171missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005172
wdenk6c59edc2004-05-03 20:45:30 +00005173 # cd /usr/pkg/cross/powerpc-netbsd/include
5174 # mkdir powerpc
5175 # ln -s powerpc machine
5176 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5177 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179Native builds *don't* work due to incompatibilities between native
5180and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182Booting assumes that (the first part of) the image booted is a
5183stage-2 loader which in turn loads and then invokes the kernel
5184proper. Loader sources will eventually appear in the NetBSD source
5185tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005186meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005187
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189Implementation Internals:
5190=========================
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk6c59edc2004-05-03 20:45:30 +00005192The following is not intended to be a complete description of every
5193implementation detail. However, it should help to understand the
5194inner workings of U-Boot and make it easier to port it to custom
5195hardware.
wdenkc6097192002-11-03 00:24:07 +00005196
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk6c59edc2004-05-03 20:45:30 +00005198Initial Stack, Global Data:
5199---------------------------
wdenkc6097192002-11-03 00:24:07 +00005200
wdenk6c59edc2004-05-03 20:45:30 +00005201The implementation of U-Boot is complicated by the fact that U-Boot
5202starts running out of ROM (flash memory), usually without access to
5203system RAM (because the memory controller is not initialized yet).
5204This means that we don't have writable Data or BSS segments, and BSS
5205is not initialized as zero. To be able to get a C environment working
5206at all, we have to allocate at least a minimal stack. Implementation
5207options for this are defined and restricted by the CPU used: Some CPU
5208models provide on-chip memory (like the IMMR area on MPC8xx and
5209MPC826x processors), on others (parts of) the data cache can be
5210locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005211
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005212 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005213 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5216 From: "Chris Hallinan" <clh@net1plus.com>
5217 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5218 ...
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220 Correct me if I'm wrong, folks, but the way I understand it
5221 is this: Using DCACHE as initial RAM for Stack, etc, does not
5222 require any physical RAM backing up the cache. The cleverness
5223 is that the cache is being used as a temporary supply of
5224 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005225 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005226 can see how this works by studying the cache architecture and
5227 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5230 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005231 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005232 option should work for you. Using CS 4 should be fine if your
5233 board designers haven't used it for something that would
5234 cause you grief during the initial boot! It is frequently not
5235 used.
wdenkc6097192002-11-03 00:24:07 +00005236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005237 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005238 with your processor/board/system design. The default value
5239 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005240 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005241 than your SDRAM module. If you have a 64MB SDRAM module, set
5242 it above 400_0000. Just make sure your board has no resources
5243 that are supposed to respond to that address! That code in
5244 start.S has been around a while and should work as is when
5245 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247 -Chris Hallinan
5248 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250It is essential to remember this, since it has some impact on the C
5251code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005252
wdenk6c59edc2004-05-03 20:45:30 +00005253* Initialized global data (data segment) is read-only. Do not attempt
5254 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005255
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005256* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005257 as zero data - BSS segment) at all - this is undefined, initiali-
5258 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005259
wdenk6c59edc2004-05-03 20:45:30 +00005260* Stack space is very limited. Avoid big data buffers or things like
5261 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263Having only the stack as writable memory limits means we cannot use
5264normal global data to share information beween the code. But it
5265turned out that the implementation of U-Boot can be greatly
5266simplified by making a global data structure (gd_t) available to all
5267functions. We could pass a pointer to this data as argument to _all_
5268functions, but this would bloat the code. Instead we use a feature of
5269the GCC compiler (Global Register Variables) to share the data: we
5270place a pointer (gd) to the global data into a register which we
5271reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273When choosing a register for such a purpose we are restricted by the
5274relevant (E)ABI specifications for the current architecture, and by
5275GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk6c59edc2004-05-03 20:45:30 +00005277For PowerPC, the following registers have specific use:
5278 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005279 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005280 R3-R4: parameter passing and return values
5281 R5-R10: parameter passing
5282 R13: small data area pointer
5283 R30: GOT pointer
5284 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005285
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005286 (U-Boot also uses R12 as internal GOT pointer. r12
5287 is a volatile register so r12 needs to be reset when
5288 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005289
Wolfgang Denk69c09642008-02-14 22:43:22 +01005290 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292 Note: on PPC, we could use a static initializer (since the
5293 address of the global data structure is known at compile time),
5294 but it turned out that reserving a register results in somewhat
5295 smaller code - although the code savings are not that big (on
5296 average for all boards 752 bytes for the whole U-Boot image,
5297 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005298
Robin Getz2773d5f2009-08-17 15:23:02 +00005299On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005300 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5301
Robin Getz2773d5f2009-08-17 15:23:02 +00005302 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005303
wdenk6c59edc2004-05-03 20:45:30 +00005304On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk6c59edc2004-05-03 20:45:30 +00005306 R0: function argument word/integer result
5307 R1-R3: function argument word
5308 R9: GOT pointer
5309 R10: stack limit (used only if stack checking if enabled)
5310 R11: argument (frame) pointer
5311 R12: temporary workspace
5312 R13: stack pointer
5313 R14: link register
5314 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005317
Thomas Chou8fa38582010-05-21 11:08:03 +08005318On Nios II, the ABI is documented here:
5319 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5320
5321 ==> U-Boot will use gp to hold a pointer to the global data
5322
5323 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5324 to access small data sections, so gp is free.
5325
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005326On NDS32, the following registers are used:
5327
5328 R0-R1: argument/return
5329 R2-R5: argument
5330 R15: temporary register for assembler
5331 R16: trampoline register
5332 R28: frame pointer (FP)
5333 R29: global pointer (GP)
5334 R30: link register (LP)
5335 R31: stack pointer (SP)
5336 PC: program counter (PC)
5337
5338 ==> U-Boot will use R10 to hold a pointer to the global data
5339
Wolfgang Denk6405a152006-03-31 18:32:53 +02005340NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5341or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343Memory Management:
5344------------------
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346U-Boot runs in system state and uses physical addresses, i.e. the
5347MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349The available memory is mapped to fixed addresses using the memory
5350controller. In this process, a contiguous block is formed for each
5351memory type (Flash, SDRAM, SRAM), even when it consists of several
5352physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk6c59edc2004-05-03 20:45:30 +00005354U-Boot is installed in the first 128 kB of the first Flash bank (on
5355TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5356booting and sizing and initializing DRAM, the code relocates itself
5357to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005358memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005359configuration setting]. Below that, a structure with global Board
5360Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362Additionally, some exception handler code is copied to the low 8 kB
5363of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365So a typical memory configuration with 16 MB of DRAM could look like
5366this:
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk6c59edc2004-05-03 20:45:30 +00005368 0x0000 0000 Exception Vector code
5369 :
5370 0x0000 1FFF
5371 0x0000 2000 Free for Application Use
5372 :
5373 :
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375 :
5376 :
5377 0x00FB FF20 Monitor Stack (Growing downward)
5378 0x00FB FFAC Board Info Data and permanent copy of global data
5379 0x00FC 0000 Malloc Arena
5380 :
5381 0x00FD FFFF
5382 0x00FE 0000 RAM Copy of Monitor Code
5383 ... eventually: LCD or video framebuffer
5384 ... eventually: pRAM (Protected RAM - unchanged by reset)
5385 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005386
wdenkc6097192002-11-03 00:24:07 +00005387
wdenk6c59edc2004-05-03 20:45:30 +00005388System Initialization:
5389----------------------
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005392(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005393configuration for CS0# this is a mirror of the onboard Flash memory.
5394To be able to re-map memory U-Boot then jumps to its link address.
5395To be able to implement the initialization code in C, a (small!)
5396initial stack is set up in the internal Dual Ported RAM (in case CPUs
5397which provide such a feature like MPC8xx or MPC8260), or in a locked
5398part of the data cache. After that, U-Boot initializes the CPU core,
5399the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Next, all (potentially) available memory banks are mapped using a
5402preliminary mapping. For example, we put them on 512 MB boundaries
5403(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5404on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5405programmed for SDRAM access. Using the temporary configuration, a
5406simple memory test is run that determines the size of the SDRAM
5407banks.
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409When there is more than one SDRAM bank, and the banks are of
5410different size, the largest is mapped first. For equal size, the first
5411bank (CS2#) is mapped first. The first mapping is always for address
54120x00000000, with any additional banks following immediately to create
5413contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415Then, the monitor installs itself at the upper end of the SDRAM area
5416and allocates memory for use by malloc() and for the global Board
5417Info data; also, the exception vector code is copied to the low RAM
5418pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420Only after this relocation will you have a "normal" C environment;
5421until that you are restricted in several ways, mostly because you are
5422running from ROM, and because the code will have to be relocated to a
5423new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005424
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk6c59edc2004-05-03 20:45:30 +00005426U-Boot Porting Guide:
5427----------------------
wdenkc6097192002-11-03 00:24:07 +00005428
wdenk6c59edc2004-05-03 20:45:30 +00005429[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5430list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005431
wdenkc6097192002-11-03 00:24:07 +00005432
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005433int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005434{
5435 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005436
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005437 signal(SIGALRM, no_more_time);
5438 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005439
wdenk6c59edc2004-05-03 20:45:30 +00005440 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005441 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005442 return 0;
5443 }
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk6c59edc2004-05-03 20:45:30 +00005445 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005446
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005447 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005448
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005449 if (clueless)
5450 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452 while (learning) {
5453 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005454 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5455 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005456 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005457 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005458 }
wdenkc6097192002-11-03 00:24:07 +00005459
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005460 if (available_money > toLocalCurrency ($2500))
5461 Buy a BDI3000;
5462 else
wdenk6c59edc2004-05-03 20:45:30 +00005463 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005464
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005465 if (a similar board exists) { /* hopefully... */
5466 cp -a board/<similar> board/<myboard>
5467 cp include/configs/<similar>.h include/configs/<myboard>.h
5468 } else {
5469 Create your own board support subdirectory;
5470 Create your own board include/configs/<myboard>.h file;
5471 }
5472 Edit new board/<myboard> files
5473 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005474
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005475 while (!accepted) {
5476 while (!running) {
5477 do {
5478 Add / modify source code;
5479 } until (compiles);
5480 Debug;
5481 if (clueless)
5482 email("Hi, I am having problems...");
5483 }
5484 Send patch file to the U-Boot email list;
5485 if (reasonable critiques)
5486 Incorporate improvements from email list code review;
5487 else
5488 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005489 }
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk6c59edc2004-05-03 20:45:30 +00005491 return 0;
5492}
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494void no_more_time (int sig)
5495{
5496 hire_a_guru();
5497}
wdenkc6097192002-11-03 00:24:07 +00005498
wdenkc6097192002-11-03 00:24:07 +00005499
wdenk6c59edc2004-05-03 20:45:30 +00005500Coding Standards:
5501-----------------
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk6c59edc2004-05-03 20:45:30 +00005503All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005504coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005505"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005506
5507Source files originating from a different project (for example the
5508MTD subsystem) are generally exempt from these guidelines and are not
5509reformated to ease subsequent migration to newer versions of those
5510sources.
wdenkc6097192002-11-03 00:24:07 +00005511
Detlev Zundelaa63d482006-09-01 15:39:02 +02005512Please note that U-Boot is implemented in C (and to some small parts in
5513Assembler); no C++ is used, so please do not use C++ style comments (//)
5514in your code.
wdenkad276f22004-01-04 16:28:35 +00005515
wdenk6c59edc2004-05-03 20:45:30 +00005516Please also stick to the following formatting rules:
5517- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005518- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005519- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005520- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005521- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523Submissions which do not conform to the standards may be returned
5524with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005525
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk6c59edc2004-05-03 20:45:30 +00005527Submitting Patches:
5528-------------------
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530Since the number of patches for U-Boot is growing, we need to
5531establish some rules. Submissions which do not conform to these rules
5532may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005533
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005534Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005535
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005536Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5537see http://lists.denx.de/mailman/listinfo/u-boot
5538
wdenk6c59edc2004-05-03 20:45:30 +00005539When you send a patch, please include the following information with
5540it:
wdenkc6097192002-11-03 00:24:07 +00005541
wdenk6c59edc2004-05-03 20:45:30 +00005542* For bug fixes: a description of the bug and how your patch fixes
5543 this bug. Please try to include a way of demonstrating that the
5544 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546* For new features: a description of the feature and your
5547 implementation.
wdenkc6097192002-11-03 00:24:07 +00005548
wdenk6c59edc2004-05-03 20:45:30 +00005549* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005554 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556* If your patch adds new configuration options, don't forget to
5557 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005558
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005559* The patch itself. If you are using git (which is *strongly*
5560 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005561 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005562 the U-Boot mailing list, you will avoid most of the common problems
5563 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005564
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005565 If you cannot use git, use "diff -purN OLD NEW". If your version of
5566 diff does not support these options, then get the latest version of
5567 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005568
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005569 The current directory when running this command shall be the parent
5570 directory of the U-Boot source tree (i. e. please make sure that
5571 your patch includes sufficient directory information for the
5572 affected files).
5573
5574 We prefer patches as plain text. MIME attachments are discouraged,
5575 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577* If one logical set of modifications affects or creates several
5578 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580* Changesets that contain different, unrelated modifications shall be
5581 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005582
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584Notes:
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586* Before sending the patch, run the MAKEALL script on your patched
5587 source tree and make sure that no errors or warnings are reported
5588 for any of the boards.
5589
5590* Keep your modifications to the necessary minimum: A patch
5591 containing several unrelated changes or arbitrary reformats will be
5592 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk6c59edc2004-05-03 20:45:30 +00005594* If you modify existing code, make sure that your new code does not
5595 add to the memory footprint of the code ;-) Small is beautiful!
5596 When adding new features, these should compile conditionally only
5597 (using #ifdef), and the resulting code with the new feature
5598 disabled must not need more memory than the old code without your
5599 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005600
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005601* Remember that there is a size limit of 100 kB per message on the
5602 u-boot mailing list. Bigger patches will be moderated. If they are
5603 reasonable and not too big, they will be acknowledged. But patches
5604 bigger than the size limit should be avoided.