blob: e9c3145156f3895370ae30acdfa2974194381e3c [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denk218ca722008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
126
127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000129
130
wdenk93f19cc2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Weber360d8832010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000140
Thomas Weber360d8832010-09-28 08:06:25 +0200141Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tyser8d321b82010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
204 /mpc8220 Files specific to Freescale MPC8220 CPUs
205 /mpc824x Files specific to Freescale MPC824x CPUs
206 /mpc8260 Files specific to Freescale MPC8260 CPUs
207 /mpc85xx Files specific to Freescale MPC85xx CPUs
208 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
209 /lib Architecture specific library files
210 /sh Files generic to SH architecture
211 /cpu CPU specific files
212 /sh2 Files specific to sh2 CPUs
213 /sh3 Files specific to sh3 CPUs
214 /sh4 Files specific to sh4 CPUs
215 /lib Architecture specific library files
216 /sparc Files generic to SPARC architecture
217 /cpu CPU specific files
218 /leon2 Files specific to Gaisler LEON2 SPARC CPU
219 /leon3 Files specific to Gaisler LEON3 SPARC CPU
220 /lib Architecture specific library files
221/api Machine/arch independent API for external apps
222/board Board dependent files
223/common Misc architecture independent functions
224/disk Code for disk drive partition handling
225/doc Documentation (don't expect too much)
226/drivers Commonly used device drivers
227/examples Example code for standalone applications, etc.
228/fs Filesystem code (cramfs, ext2, jffs2, etc.)
229/include Header Files
230/lib Files generic to all architectures
231 /libfdt Library files to support flattened device trees
232 /lzma Library files to support LZMA decompression
233 /lzo Library files to support LZO decompression
234/net Networking code
235/post Power On Self Test
236/rtc Real Time Clock drivers
237/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000238
wdenkc6097192002-11-03 00:24:07 +0000239Software Configuration:
240=======================
241
242Configuration is usually done using C preprocessor defines; the
243rationale behind that is to avoid dead code whenever possible.
244
245There are two classes of configuration variables:
246
247* Configuration _OPTIONS_:
248 These are selectable by the user and have names beginning with
249 "CONFIG_".
250
251* Configuration _SETTINGS_:
252 These depend on the hardware etc. and should not be meddled with if
253 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200254 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000255
256Later we will add a configuration tool - probably similar to or even
257identical to what's used for the Linux kernel. Right now, we have to
258do the configuration by hand, which means creating some symbolic
259links and editing some configuration files. We use the TQM8xxL boards
260as an example here.
261
262
263Selection of Processor Architecture and Board Type:
264---------------------------------------------------
265
266For all supported boards there are ready-to-use default
267configurations available; just type "make <board_name>_config".
268
269Example: For a TQM823L module type:
270
271 cd u-boot
272 make TQM823L_config
273
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200274For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000275e.g. "make cogent_mpc8xx_config". And also configure the cogent
276directory according to the instructions in cogent/README.
277
278
279Configuration Options:
280----------------------
281
282Configuration depends on the combination of board and CPU type; all
283such information is kept in a configuration file
284"include/configs/<board_name>.h".
285
286Example: For a TQM823L module, all configuration settings are in
287"include/configs/TQM823L.h".
288
289
wdenk7f6c2cb2002-11-10 22:06:23 +0000290Many of the options are named exactly as the corresponding Linux
291kernel configuration options. The intention is to make it easier to
292build a config tool - later.
293
294
wdenkc6097192002-11-03 00:24:07 +0000295The following options need to be configured:
296
Kim Phillips26281142007-08-10 13:28:25 -0500297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000298
Kim Phillips26281142007-08-10 13:28:25 -0500299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200300
301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100302 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000303
304- CPU Module Type: (if CONFIG_COGENT is defined)
305 Define exactly one of
306 CONFIG_CMA286_60_OLD
307--- FIXME --- not tested yet:
308 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
309 CONFIG_CMA287_23, CONFIG_CMA287_50
310
311- Motherboard Type: (if CONFIG_COGENT is defined)
312 Define exactly one of
313 CONFIG_CMA101, CONFIG_CMA102
314
315- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
316 Define one or more of
317 CONFIG_CMA302
318
319- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
320 Define one or more of
321 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200322 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000323 a "rotator" |\-/|\-/
324
wdenk2535d602003-07-17 23:16:40 +0000325- Board flavour: (if CONFIG_MPC8260ADS is defined)
326 CONFIG_ADSTYPE
327 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200328 CONFIG_SYS_8260ADS - original MPC8260ADS
329 CONFIG_SYS_8266ADS - MPC8266ADS
330 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
331 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000332
Lei Wencf946c62011-02-09 18:06:58 +0530333- Marvell Family Member
334 CONFIG_SYS_MVFS - define it if you want to enable
335 multiple fs option at one time
336 for marvell soc family
337
wdenkc6097192002-11-03 00:24:07 +0000338- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000339 Define exactly one of
340 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000341
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200342- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
344 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000345 e.g. if there is no 32KHz
346 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000347 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
348 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000349
wdenk66ca92a2004-09-28 17:59:53 +0000350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_8xx_CPUCLK_MIN
352 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000353 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000354 See doc/README.MPC866
355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200356 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000357
wdenkba56f622004-02-06 23:19:44 +0000358 Define this to measure the actual CPU clock instead
359 of relying on the correctness of the configured
360 values. Mostly useful for board bringup to make sure
361 the PLL is locked at the intended frequency. Note
362 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200363 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000364
Heiko Schocher506f3912009-03-12 07:37:15 +0100365 CONFIG_SYS_DELAYED_ICACHE
366
367 Define this option if you want to enable the
368 ICache only when Code runs from RAM.
369
Kumar Gala66412c62011-02-18 05:40:54 -0600370- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000371 CONFIG_SYS_PPC64
372
373 Specifies that the core is a 64-bit PowerPC implementation (implements
374 the "64" category of the Power ISA). This is necessary for ePAPR
375 compliance, among other possible reasons.
376
Kumar Gala66412c62011-02-18 05:40:54 -0600377 CONFIG_SYS_FSL_TBCLK_DIV
378
379 Defines the core time base clock divider ratio compared to the
380 system clock. On most PQ3 devices this is 8, on newer QorIQ
381 devices it can be 16 or 32. The ratio varies from SoC to Soc.
382
Kumar Gala8f290842011-05-20 00:39:21 -0500383 CONFIG_SYS_FSL_PCIE_COMPAT
384
385 Defines the string to utilize when trying to match PCIe device
386 tree nodes for the given platform.
387
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000388 CONFIG_SYS_PPC_E500_DEBUG_TLB
389
390 Enables a temporary TLB entry to be used during boot to work
391 around limitations in e500v1 and e500v2 external debugger
392 support. This reduces the portions of the boot code where
393 breakpoints and single stepping do not work. The value of this
394 symbol should be set to the TLB1 entry to be used for this
395 purpose.
396
Scott Wood33eee332012-08-14 10:14:53 +0000397 CONFIG_SYS_FSL_ERRATUM_A004510
398
399 Enables a workaround for erratum A004510. If set,
400 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
401 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
402
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
404 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
405
406 Defines one or two SoC revisions (low 8 bits of SVR)
407 for which the A004510 workaround should be applied.
408
409 The rest of SVR is either not relevant to the decision
410 of whether the erratum is present (e.g. p2040 versus
411 p2041) or is implied by the build target, which controls
412 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
413
414 See Freescale App Note 4493 for more information about
415 this erratum.
416
417 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
418
419 This is the value to write into CCSR offset 0x18600
420 according to the A004510 workaround.
421
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000422- Generic CPU options:
423 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
424
425 Defines the endianess of the CPU. Implementation of those
426 values is arch specific.
427
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100428- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100430
431 Defines the Monahans run mode to oscillator
432 ratio. Valid values are 8, 16, 24, 31. The core
433 frequency is this value multiplied by 13 MHz.
434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200436
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100437 Defines the Monahans turbo mode to oscillator
438 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200439 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100440 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200441
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200442- MIPS CPU options:
443 CONFIG_SYS_INIT_SP_OFFSET
444
445 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
446 pointer. This is needed for the temporary stack before
447 relocation.
448
449 CONFIG_SYS_MIPS_CACHE_MODE
450
451 Cache operation mode for the MIPS CPU.
452 See also arch/mips/include/asm/mipsregs.h.
453 Possible values are:
454 CONF_CM_CACHABLE_NO_WA
455 CONF_CM_CACHABLE_WA
456 CONF_CM_UNCACHED
457 CONF_CM_CACHABLE_NONCOHERENT
458 CONF_CM_CACHABLE_CE
459 CONF_CM_CACHABLE_COW
460 CONF_CM_CACHABLE_CUW
461 CONF_CM_CACHABLE_ACCELERATED
462
463 CONFIG_SYS_XWAY_EBU_BOOTCFG
464
465 Special option for Lantiq XWAY SoCs for booting from NOR flash.
466 See also arch/mips/cpu/mips32/start.S.
467
468 CONFIG_XWAY_SWAP_BYTES
469
470 Enable compilation of tools/xway-swap-bytes needed for Lantiq
471 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
472 be swapped if a flash programmer is used.
473
Christian Rieschb67d8812012-02-02 00:44:39 +0000474- ARM options:
475 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
476
477 Select high exception vectors of the ARM core, e.g., do not
478 clear the V bit of the c1 register of CP15.
479
Aneesh V5356f542012-03-08 07:20:19 +0000480 CONFIG_SYS_THUMB_BUILD
481
482 Use this flag to build U-Boot using the Thumb instruction
483 set for ARM architectures. Thumb instruction set provides
484 better code density. For ARM architectures that support
485 Thumb2 this flag will result in Thumb2 code generated by
486 GCC.
487
Stephen Warrenc5d47522013-03-04 13:29:40 +0000488 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000489 CONFIG_ARM_ERRATA_742230
490 CONFIG_ARM_ERRATA_743622
491 CONFIG_ARM_ERRATA_751472
492
493 If set, the workarounds for these ARM errata are applied early
494 during U-Boot startup. Note that these options force the
495 workarounds to be applied; no CPU-type/version detection
496 exists, unlike the similar options in the Linux kernel. Do not
497 set these options unless they apply!
498
wdenk5da627a2003-10-09 20:09:04 +0000499- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000500 CONFIG_CLOCKS_IN_MHZ
501
502 U-Boot stores all clock information in Hz
503 internally. For binary compatibility with older Linux
504 kernels (which expect the clocks passed in the
505 bd_info data to be in MHz) the environment variable
506 "clocks_in_mhz" can be defined so that U-Boot
507 converts clock data to MHZ before passing it to the
508 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000509 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100510 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000511 default environment.
512
wdenk5da627a2003-10-09 20:09:04 +0000513 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
514
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200515 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000516 expect it to be in bytes, others in MB.
517 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
518
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400519 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200520
521 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400522 passed using flattened device trees (based on open firmware
523 concepts).
524
525 CONFIG_OF_LIBFDT
526 * New libfdt-based support
527 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500528 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400529
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200530 OF_CPU - The proper name of the cpus node (only required for
531 MPC512X and MPC5xxx based boards).
532 OF_SOC - The proper name of the soc node (only required for
533 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200534 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600535 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200536
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200537 boards with QUICC Engines require OF_QE to set UCC MAC
538 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500539
Kumar Gala4e253132006-01-11 13:54:17 -0600540 CONFIG_OF_BOARD_SETUP
541
542 Board code has addition modification that it wants to make
543 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000544
Matthew McClintock02677682006-06-28 10:41:37 -0500545 CONFIG_OF_BOOT_CPU
546
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200547 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500548 param header, the default value is zero if undefined.
549
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200550 CONFIG_OF_IDE_FIXUP
551
552 U-Boot can detect if an IDE device is present or not.
553 If not, and this new config option is activated, U-Boot
554 removes the ATA node from the DTS before booting Linux,
555 so the Linux IDE driver does not probe the device and
556 crash. This is needed for buggy hardware (uc101) where
557 no pull down resistor is connected to the signal IDE5V_DD7.
558
Igor Grinberg7eb29392011-07-14 05:45:07 +0000559 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
560
561 This setting is mandatory for all boards that have only one
562 machine type and must be used to specify the machine type
563 number as it appears in the ARM machine registry
564 (see http://www.arm.linux.org.uk/developer/machines/).
565 Only boards that have multiple machine types supported
566 in a single configuration file and the machine type is
567 runtime discoverable, do not have to use this setting.
568
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100569- vxWorks boot parameters:
570
571 bootvx constructs a valid bootline using the following
572 environments variables: bootfile, ipaddr, serverip, hostname.
573 It loads the vxWorks image pointed bootfile.
574
575 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
576 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
577 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
578 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
579
580 CONFIG_SYS_VXWORKS_ADD_PARAMS
581
582 Add it at the end of the bootline. E.g "u=username pw=secret"
583
584 Note: If a "bootargs" environment is defined, it will overwride
585 the defaults discussed just above.
586
Aneesh V2c451f72011-06-16 23:30:47 +0000587- Cache Configuration:
588 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
589 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
590 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
591
Aneesh V93bc2192011-06-16 23:30:51 +0000592- Cache Configuration for ARM:
593 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
594 controller
595 CONFIG_SYS_PL310_BASE - Physical base address of PL310
596 controller register space
597
wdenk6705d812004-08-02 23:22:59 +0000598- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200599 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000600
601 Define this if you want support for Amba PrimeCell PL010 UARTs.
602
Andreas Engel48d01922008-09-08 14:30:53 +0200603 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000604
605 Define this if you want support for Amba PrimeCell PL011 UARTs.
606
607 CONFIG_PL011_CLOCK
608
609 If you have Amba PrimeCell PL011 UARTs, set this variable to
610 the clock speed of the UARTs.
611
612 CONFIG_PL01x_PORTS
613
614 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
615 define this to a list of base addresses for each (supported)
616 port. See e.g. include/configs/versatile.h
617
John Rigby910f1ae2011-04-19 10:42:39 +0000618 CONFIG_PL011_SERIAL_RLCR
619
620 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
621 have separate receive and transmit line control registers. Set
622 this variable to initialize the extra register.
623
624 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
625
626 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
627 boot loader that has already initialized the UART. Define this
628 variable to flush the UART at init time.
629
wdenk6705d812004-08-02 23:22:59 +0000630
wdenkc6097192002-11-03 00:24:07 +0000631- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000632 Depending on board, define exactly one serial port
633 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
634 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
635 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000636
637 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
638 port routines must be defined elsewhere
639 (i.e. serial_init(), serial_getc(), ...)
640
641 CONFIG_CFB_CONSOLE
642 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000643 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000644 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
645 (default big endian)
646 VIDEO_HW_RECTFILL graphic chip supports
647 rectangle fill
648 (cf. smiLynxEM)
649 VIDEO_HW_BITBLT graphic chip supports
650 bit-blit (cf. smiLynxEM)
651 VIDEO_VISIBLE_COLS visible pixel columns
652 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000653 VIDEO_VISIBLE_ROWS visible pixel rows
654 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000655 VIDEO_DATA_FORMAT graphic data format
656 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000657 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000658 VIDEO_KBD_INIT_FCT keyboard int fct
659 (i.e. i8042_kbd_init())
660 VIDEO_TSTC_FCT test char fct
661 (i.e. i8042_tstc)
662 VIDEO_GETC_FCT get char fct
663 (i.e. i8042_getc)
664 CONFIG_CONSOLE_CURSOR cursor drawing on/off
665 (requires blink timer
666 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200667 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000668 CONFIG_CONSOLE_TIME display time/date info in
669 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500670 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000671 CONFIG_VIDEO_LOGO display Linux logo in
672 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000673 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
674 linux_logo.h for logo.
675 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000676 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200677 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000678 the logo
679
Pali Rohár33a35bb2012-10-19 13:30:09 +0000680 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
681 a limited number of ANSI escape sequences (cursor control,
682 erase functions and limited graphics rendition control).
683
wdenk43d96162003-03-06 00:02:04 +0000684 When CONFIG_CFB_CONSOLE is defined, video console is
685 default i/o. Serial console can be forced with
686 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000687
wdenkd4ca31c2004-01-02 14:00:00 +0000688 When CONFIG_SILENT_CONSOLE is defined, all console
689 messages (by U-Boot and Linux!) can be silenced with
690 the "silent" environment variable. See
691 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000692
wdenkc6097192002-11-03 00:24:07 +0000693- Console Baudrate:
694 CONFIG_BAUDRATE - in bps
695 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200696 CONFIG_SYS_BAUDRATE_TABLE, see below.
697 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000698
Heiko Schocherc92fac92009-01-30 12:55:38 +0100699- Console Rx buffer length
700 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
701 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100702 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100703 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
704 must be defined, to setup the maximum idle timeout for
705 the SMC.
706
Graeme Russ9558b482011-09-01 00:48:27 +0000707- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200708 Prior to the console being initialised (i.e. serial UART
709 initialised etc) all console output is silently discarded.
710 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
711 buffer any console messages prior to the console being
712 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
713 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
714 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200715 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200716 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000717
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200718 'Sane' compilers will generate smaller code if
719 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000720
Sonny Rao046a37b2011-11-02 09:52:08 +0000721- Safe printf() functions
722 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
723 the printf() functions. These are defined in
724 include/vsprintf.h and include snprintf(), vsnprintf() and
725 so on. Code size increase is approximately 300-500 bytes.
726 If this option is not given then these functions will
727 silently discard their buffer size argument - this means
728 you are not getting any overflow checking in this case.
729
wdenkc6097192002-11-03 00:24:07 +0000730- Boot Delay: CONFIG_BOOTDELAY - in seconds
731 Delay before automatically booting the default image;
732 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000733 set to -2 to autoboot with no delay and not check for abort
734 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000735
736 See doc/README.autoboot for these options that
737 work with CONFIG_BOOTDELAY. None are required.
738 CONFIG_BOOT_RETRY_TIME
739 CONFIG_BOOT_RETRY_MIN
740 CONFIG_AUTOBOOT_KEYED
741 CONFIG_AUTOBOOT_PROMPT
742 CONFIG_AUTOBOOT_DELAY_STR
743 CONFIG_AUTOBOOT_STOP_STR
744 CONFIG_AUTOBOOT_DELAY_STR2
745 CONFIG_AUTOBOOT_STOP_STR2
746 CONFIG_ZERO_BOOTDELAY_CHECK
747 CONFIG_RESET_TO_RETRY
748
749- Autoboot Command:
750 CONFIG_BOOTCOMMAND
751 Only needed when CONFIG_BOOTDELAY is enabled;
752 define a command string that is automatically executed
753 when no character is read on the console interface
754 within "Boot Delay" after reset.
755
756 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000757 This can be used to pass arguments to the bootm
758 command. The value of CONFIG_BOOTARGS goes into the
759 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000760
761 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000762 The value of these goes into the environment as
763 "ramboot" and "nfsboot" respectively, and can be used
764 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200765 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000766
767- Pre-Boot Commands:
768 CONFIG_PREBOOT
769
770 When this option is #defined, the existence of the
771 environment variable "preboot" will be checked
772 immediately before starting the CONFIG_BOOTDELAY
773 countdown and/or running the auto-boot command resp.
774 entering interactive mode.
775
776 This feature is especially useful when "preboot" is
777 automatically generated or modified. For an example
778 see the LWMON board specific code: here "preboot" is
779 modified when the user holds down a certain
780 combination of keys on the (special) keyboard when
781 booting the systems
782
783- Serial Download Echo Mode:
784 CONFIG_LOADS_ECHO
785 If defined to 1, all characters received during a
786 serial download (using the "loads" command) are
787 echoed back. This might be needed by some terminal
788 emulations (like "cu"), but may as well just take
789 time on others. This setting #define's the initial
790 value of the "loads_echo" environment variable.
791
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500792- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000793 CONFIG_KGDB_BAUDRATE
794 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200795 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000796
797- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798 Monitor commands can be included or excluded
799 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000800 <config_cmd_all.h> and #undef'ing unwanted
801 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500802 and augmenting with additional #define's
803 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000804
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805 The default command configuration includes all commands
806 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000807
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 CONFIG_CMD_BDI bdinfo
810 CONFIG_CMD_BEDBUG * Include BedBug Debugger
811 CONFIG_CMD_BMP * BMP support
812 CONFIG_CMD_BSP * Board specific commands
813 CONFIG_CMD_BOOTD bootd
814 CONFIG_CMD_CACHE * icache, dcache
815 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500816 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500817 CONFIG_CMD_DATE * support for RTC, date/time...
818 CONFIG_CMD_DHCP * DHCP support
819 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600820 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
821 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
822 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
823 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_DTT * Digital Therm and Thermostat
825 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500826 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500827 CONFIG_CMD_EEPROM * EEPROM read/write support
828 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600829 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600830 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500831 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000832 CONFIG_CMD_EXT2 * ext2 command support
833 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500834 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500835 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000836 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_FDOS * Dos diskette Support
838 CONFIG_CMD_FLASH flinfo, erase, protect
839 CONFIG_CMD_FPGA FPGA device initialization support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000840 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500841 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000842 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000843 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
845 CONFIG_CMD_I2C * I2C serial bus support
846 CONFIG_CMD_IDE * IDE harddisk support
847 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000848 CONFIG_CMD_IMLS List all images found in NOR flash
849 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500850 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500851 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000852 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500853 CONFIG_CMD_IRQ * irqinfo
854 CONFIG_CMD_ITEST Integer/string test of 2 values
855 CONFIG_CMD_JFFS2 * JFFS2 Support
856 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500857 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000858 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
859 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500860 CONFIG_CMD_LOADB loadb
861 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400862 CONFIG_CMD_MD5SUM print md5 message digest
863 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000864 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500865 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000866 loop, loopw
867 CONFIG_CMD_MEMTEST mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500868 CONFIG_CMD_MISC Misc functions like sleep etc
869 CONFIG_CMD_MMC * MMC memory mapped support
870 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100871 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500872 CONFIG_CMD_NAND * NAND support
873 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600874 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000875 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500876 CONFIG_CMD_PCI * pciinfo
877 CONFIG_CMD_PCMCIA * PCMCIA support
878 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
879 host
880 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000881 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500882 CONFIG_CMD_REGINFO * Register dump
883 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000884 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500885 CONFIG_CMD_SAVES * save S record dump
886 CONFIG_CMD_SCSI * SCSI Support
887 CONFIG_CMD_SDRAM * print SDRAM configuration information
888 (requires CONFIG_CMD_I2C)
889 CONFIG_CMD_SETGETDCR Support for DCR Register access
890 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700891 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100892 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400893 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200894 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500895 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000896 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000897 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000898 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
899 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500900 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500901 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000902 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000903
wdenkc6097192002-11-03 00:24:07 +0000904
905 EXAMPLE: If you want all functions except of network
906 support you can write:
907
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500908 #include "config_cmd_all.h"
909 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000910
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400911 Other Commands:
912 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000913
914 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500915 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000916 what you (and your U-Boot users) are doing. Data
917 cache cannot be enabled on systems like the 8xx or
918 8260 (where accesses to the IMMR region must be
919 uncached), and it cannot be disabled on all other
920 systems where we (mis-) use the data cache to hold an
921 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000922
923
924 XXX - this list needs to get updated!
925
Simon Glass45ba8072011-10-15 05:48:20 +0000926- Device tree:
927 CONFIG_OF_CONTROL
928 If this variable is defined, U-Boot will use a device tree
929 to configure its devices, instead of relying on statically
930 compiled #defines in the board file. This option is
931 experimental and only available on a few boards. The device
932 tree is available in the global data as gd->fdt_blob.
933
Simon Glass2c0f79e2011-10-24 19:15:31 +0000934 U-Boot needs to get its device tree from somewhere. This can
935 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000936
937 CONFIG_OF_EMBED
938 If this variable is defined, U-Boot will embed a device tree
939 binary in its image. This device tree file should be in the
940 board directory and called <soc>-<board>.dts. The binary file
941 is then picked up in board_init_f() and made available through
942 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000943
Simon Glass2c0f79e2011-10-24 19:15:31 +0000944 CONFIG_OF_SEPARATE
945 If this variable is defined, U-Boot will build a device tree
946 binary. It will be called u-boot.dtb. Architecture-specific
947 code will locate it at run-time. Generally this works by:
948
949 cat u-boot.bin u-boot.dtb >image.bin
950
951 and in fact, U-Boot does this for you, creating a file called
952 u-boot-dtb.bin which is useful in the common case. You can
953 still use the individual files if you need something more
954 exotic.
955
wdenkc6097192002-11-03 00:24:07 +0000956- Watchdog:
957 CONFIG_WATCHDOG
958 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000959 support for the SoC. There must be support in the SoC
960 specific code for a watchdog. For the 8xx and 8260
961 CPUs, the SIU Watchdog feature is enabled in the SYPCR
962 register. When supported for a specific SoC is
963 available, then no further board specific code should
964 be needed to use it.
965
966 CONFIG_HW_WATCHDOG
967 When using a watchdog circuitry external to the used
968 SoC, then define this variable and provide board
969 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000970
stroesec1551ea2003-04-04 15:53:41 +0000971- U-Boot Version:
972 CONFIG_VERSION_VARIABLE
973 If this variable is defined, an environment variable
974 named "ver" is created by U-Boot showing the U-Boot
975 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200976 Any change to this variable will be reverted at the
977 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000978
wdenkc6097192002-11-03 00:24:07 +0000979- Real-Time Clock:
980
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500981 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000982 has to be selected, too. Define exactly one of the
983 following options:
984
985 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
986 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000987 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000988 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000989 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000990 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000991 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000992 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100993 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000994 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200995 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200996 CONFIG_SYS_RV3029_TCR - enable trickle charger on
997 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000998
wdenkb37c7e52003-06-30 16:24:52 +0000999 Note that if the RTC uses I2C, then the I2C interface
1000 must also be configured. See I2C Support, below.
1001
Peter Tysere92739d2008-12-17 16:36:21 -06001002- GPIO Support:
1003 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1004 CONFIG_PCA953X_INFO - enable pca953x info command
1005
Chris Packham5dec49c2010-12-19 10:12:13 +00001006 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1007 chip-ngpio pairs that tell the PCA953X driver the number of
1008 pins supported by a particular chip.
1009
Peter Tysere92739d2008-12-17 16:36:21 -06001010 Note that if the GPIO device uses I2C, then the I2C interface
1011 must also be configured. See I2C Support, below.
1012
wdenkc6097192002-11-03 00:24:07 +00001013- Timestamp Support:
1014
wdenk43d96162003-03-06 00:02:04 +00001015 When CONFIG_TIMESTAMP is selected, the timestamp
1016 (date and time) of an image is printed by image
1017 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001018 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001019
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001020- Partition Labels (disklabels) Supported:
1021 Zero or more of the following:
1022 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1023 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1024 Intel architecture, USB sticks, etc.
1025 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1026 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1027 bootloader. Note 2TB partition limit; see
1028 disk/part_efi.c
1029 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001030
Wolfgang Denk218ca722008-03-26 10:40:12 +01001031 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1032 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001033 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001034
1035- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001036 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1037 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001038
wdenk4d13cba2004-03-14 14:09:05 +00001039 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1040 be performed by calling the function
1041 ide_set_reset(int reset)
1042 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001043
1044- ATAPI Support:
1045 CONFIG_ATAPI
1046
1047 Set this to enable ATAPI support.
1048
wdenkc40b2952004-03-13 23:29:43 +00001049- LBA48 Support
1050 CONFIG_LBA48
1051
1052 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001053 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001054 Whithout these , LBA48 support uses 32bit variables and will 'only'
1055 support disks up to 2.1TB.
1056
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001057 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001058 When enabled, makes the IDE subsystem use 64bit sector addresses.
1059 Default is 32bit.
1060
wdenkc6097192002-11-03 00:24:07 +00001061- SCSI Support:
1062 At the moment only there is only support for the
1063 SYM53C8XX SCSI controller; define
1064 CONFIG_SCSI_SYM53C8XX to enable it.
1065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001066 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1067 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1068 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001069 maximum numbers of LUNs, SCSI ID's and target
1070 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001071 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001072
Stefan Reinauer447c0312012-10-29 05:23:48 +00001073 The environment variable 'scsidevs' is set to the number of
1074 SCSI devices found during the last scan.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001077 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001078 Support for Intel 8254x/8257x gigabit chips.
1079
1080 CONFIG_E1000_SPI
1081 Utility code for direct access to the SPI bus on Intel 8257x.
1082 This does not do anything useful unless you set at least one
1083 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1084
1085 CONFIG_E1000_SPI_GENERIC
1086 Allow generic access to the SPI bus on the Intel 8257x, for
1087 example with the "sspi" command.
1088
1089 CONFIG_CMD_E1000
1090 Management command for E1000 devices. When used on devices
1091 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001092
Andre Schwarzac3315c2008-03-06 16:45:44 +01001093 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001094 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001095
wdenkc6097192002-11-03 00:24:07 +00001096 CONFIG_EEPRO100
1097 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001098 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001099 write routine for first time initialisation.
1100
1101 CONFIG_TULIP
1102 Support for Digital 2114x chips.
1103 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1104 modem chip initialisation (KS8761/QS6611).
1105
1106 CONFIG_NATSEMI
1107 Support for National dp83815 chips.
1108
1109 CONFIG_NS8382X
1110 Support for National dp8382[01] gigabit chips.
1111
wdenk45219c42003-05-12 21:50:16 +00001112- NETWORK Support (other):
1113
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001114 CONFIG_DRIVER_AT91EMAC
1115 Support for AT91RM9200 EMAC.
1116
1117 CONFIG_RMII
1118 Define this to use reduced MII inteface
1119
1120 CONFIG_DRIVER_AT91EMAC_QUIET
1121 If this defined, the driver is quiet.
1122 The driver doen't show link status messages.
1123
Rob Herringefdd7312011-12-15 11:15:49 +00001124 CONFIG_CALXEDA_XGMAC
1125 Support for the Calxeda XGMAC device
1126
Ashok3bb46d22012-10-15 06:20:47 +00001127 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001128 Support for SMSC's LAN91C96 chips.
1129
1130 CONFIG_LAN91C96_BASE
1131 Define this to hold the physical address
1132 of the LAN91C96's I/O space
1133
1134 CONFIG_LAN91C96_USE_32_BIT
1135 Define this to enable 32 bit addressing
1136
Ashok3bb46d22012-10-15 06:20:47 +00001137 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001138 Support for SMSC's LAN91C111 chip
1139
1140 CONFIG_SMC91111_BASE
1141 Define this to hold the physical address
1142 of the device (I/O space)
1143
1144 CONFIG_SMC_USE_32_BIT
1145 Define this if data bus is 32 bits
1146
1147 CONFIG_SMC_USE_IOFUNCS
1148 Define this to use i/o functions instead of macros
1149 (some hardware wont work with macros)
1150
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001151 CONFIG_DRIVER_TI_EMAC
1152 Support for davinci emac
1153
1154 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1155 Define this if you have more then 3 PHYs.
1156
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001157 CONFIG_FTGMAC100
1158 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1159
1160 CONFIG_FTGMAC100_EGIGA
1161 Define this to use GE link update with gigabit PHY.
1162 Define this if FTGMAC100 is connected to gigabit PHY.
1163 If your system has 10/100 PHY only, it might not occur
1164 wrong behavior. Because PHY usually return timeout or
1165 useless data when polling gigabit status and gigabit
1166 control registers. This behavior won't affect the
1167 correctnessof 10/100 link speed update.
1168
Mike Rapoportc2fff332009-11-11 10:03:03 +02001169 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001170 Support for SMSC's LAN911x and LAN921x chips
1171
Mike Rapoportc2fff332009-11-11 10:03:03 +02001172 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001173 Define this to hold the physical address
1174 of the device (I/O space)
1175
Mike Rapoportc2fff332009-11-11 10:03:03 +02001176 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001177 Define this if data bus is 32 bits
1178
Mike Rapoportc2fff332009-11-11 10:03:03 +02001179 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001180 Define this if data bus is 16 bits. If your processor
1181 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001182 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001183
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001184 CONFIG_SH_ETHER
1185 Support for Renesas on-chip Ethernet controller
1186
1187 CONFIG_SH_ETHER_USE_PORT
1188 Define the number of ports to be used
1189
1190 CONFIG_SH_ETHER_PHY_ADDR
1191 Define the ETH PHY's address
1192
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001193 CONFIG_SH_ETHER_CACHE_WRITEBACK
1194 If this option is set, the driver enables cache flush.
1195
Vadim Bendebury5e124722011-10-17 08:36:14 +00001196- TPM Support:
1197 CONFIG_GENERIC_LPC_TPM
1198 Support for generic parallel port TPM devices. Only one device
1199 per system is supported at this time.
1200
1201 CONFIG_TPM_TIS_BASE_ADDRESS
1202 Base address where the generic TPM device is mapped
1203 to. Contemporary x86 systems usually map it at
1204 0xfed40000.
1205
wdenkc6097192002-11-03 00:24:07 +00001206- USB Support:
1207 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001208 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001209 CONFIG_USB_UHCI to enable it.
1210 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001211 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001212 storage devices.
1213 Note:
1214 Supported are USB Keyboards and USB Floppy drives
1215 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001216 MPC5200 USB requires additional defines:
1217 CONFIG_USB_CLOCK
1218 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001219 CONFIG_PSC3_USB
1220 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001221 CONFIG_USB_CONFIG
1222 for differential drivers: 0x00001000
1223 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001224 for differential drivers on PSC3: 0x00000100
1225 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001226 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001227 May be defined to allow interrupt polling
1228 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001229
Simon Glass9ab4ce22012-02-27 10:52:47 +00001230 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1231 txfilltuning field in the EHCI controller on reset.
1232
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001233- USB Device:
1234 Define the below if you wish to use the USB console.
1235 Once firmware is rebuilt from a serial console issue the
1236 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001237 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001238 it has found a new device. The environment variable usbtty
1239 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001240 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001241 Common Device Class Abstract Control Model serial device.
1242 If you select usbtty = gserial you should be able to enumerate
1243 a Linux host by
1244 # modprobe usbserial vendor=0xVendorID product=0xProductID
1245 else if using cdc_acm, simply setting the environment
1246 variable usbtty to be cdc_acm should suffice. The following
1247 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001248
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001249 CONFIG_USB_DEVICE
1250 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001251
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001252 CONFIG_USB_TTY
1253 Define this to have a tty type of device available to
1254 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001255
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301256 CONFIG_USBD_HS
1257 Define this to enable the high speed support for usb
1258 device and usbtty. If this feature is enabled, a routine
1259 int is_usbd_high_speed(void)
1260 also needs to be defined by the driver to dynamically poll
1261 whether the enumeration has succeded at high speed or full
1262 speed.
1263
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001264 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001265 Define this if you want stdin, stdout &/or stderr to
1266 be set to usbtty.
1267
1268 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001269 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001270 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001271 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001273 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001274 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001275 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001276
Wolfgang Denk386eda02006-06-14 18:14:56 +02001277 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001278 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001279 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001280 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1281 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1282 should pretend to be a Linux device to it's target host.
1283
1284 CONFIG_USBD_MANUFACTURER
1285 Define this string as the name of your company for
1286 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001287
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001288 CONFIG_USBD_PRODUCT_NAME
1289 Define this string as the name of your product
1290 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1291
1292 CONFIG_USBD_VENDORID
1293 Define this as your assigned Vendor ID from the USB
1294 Implementors Forum. This *must* be a genuine Vendor ID
1295 to avoid polluting the USB namespace.
1296 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001297
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001298 CONFIG_USBD_PRODUCTID
1299 Define this as the unique Product ID
1300 for your device
1301 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001302
Igor Grinbergd70a5602011-12-12 12:08:35 +02001303- ULPI Layer Support:
1304 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1305 the generic ULPI layer. The generic layer accesses the ULPI PHY
1306 via the platform viewport, so you need both the genric layer and
1307 the viewport enabled. Currently only Chipidea/ARC based
1308 viewport is supported.
1309 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1310 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001311 If your ULPI phy needs a different reference clock than the
1312 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1313 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001314
1315- MMC Support:
1316 The MMC controller on the Intel PXA is supported. To
1317 enable this define CONFIG_MMC. The MMC can be
1318 accessed from the boot prompt by mapping the device
1319 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001320 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1321 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001322
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001323 CONFIG_SH_MMCIF
1324 Support for Renesas on-chip MMCIF controller
1325
1326 CONFIG_SH_MMCIF_ADDR
1327 Define the base address of MMCIF registers
1328
1329 CONFIG_SH_MMCIF_CLK
1330 Define the clock frequency for MMCIF
1331
wdenk6705d812004-08-02 23:22:59 +00001332- Journaling Flash filesystem support:
1333 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1334 CONFIG_JFFS2_NAND_DEV
1335 Define these for a default partition on a NAND device
1336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001337 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1338 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001339 Define these for a default partition on a NOR device
1340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001341 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001342 Define this to create an own partition. You have to provide a
1343 function struct part_info* jffs2_part_info(int part_num)
1344
1345 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001346 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001347 to disable the command chpart. This is the default when you
1348 have not defined a custom partition
1349
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001350- FAT(File Allocation Table) filesystem write function support:
1351 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001352
1353 Define this to enable support for saving memory data as a
1354 file in FAT formatted partition.
1355
1356 This will also enable the command "fatwrite" enabling the
1357 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001358
Gabe Black84cd9322012-10-12 14:26:11 +00001359CBFS (Coreboot Filesystem) support
1360 CONFIG_CMD_CBFS
1361
1362 Define this to enable support for reading from a Coreboot
1363 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1364 and cbfsload.
1365
wdenkc6097192002-11-03 00:24:07 +00001366- Keyboard Support:
1367 CONFIG_ISA_KEYBOARD
1368
1369 Define this to enable standard (PC-Style) keyboard
1370 support
1371
1372 CONFIG_I8042_KBD
1373 Standard PC keyboard driver with US (is default) and
1374 GERMAN key layout (switch via environment 'keymap=de') support.
1375 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1376 for cfb_console. Supports cursor blinking.
1377
1378- Video support:
1379 CONFIG_VIDEO
1380
1381 Define this to enable video support (for output to
1382 video).
1383
1384 CONFIG_VIDEO_CT69000
1385
1386 Enable Chips & Technologies 69000 Video chip
1387
1388 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001389 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001390 video output is selected via environment 'videoout'
1391 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1392 assumed.
wdenkc6097192002-11-03 00:24:07 +00001393
wdenkb79a11c2004-03-25 15:14:43 +00001394 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001395 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001396 are possible:
1397 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001398 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001399
1400 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1401 -------------+---------------------------------------------
1402 8 bits | 0x301* 0x303 0x305 0x161 0x307
1403 15 bits | 0x310 0x313 0x316 0x162 0x319
1404 16 bits | 0x311 0x314 0x317 0x163 0x31A
1405 24 bits | 0x312 0x315 0x318 ? 0x31B
1406 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001407 (i.e. setenv videomode 317; saveenv; reset;)
1408
wdenkb79a11c2004-03-25 15:14:43 +00001409 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001410 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001411
1412
stroesec1551ea2003-04-04 15:53:41 +00001413 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001414 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001415 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1416 or CONFIG_VIDEO_SED13806_16BPP
1417
Timur Tabi7d3053f2011-02-15 17:09:19 -06001418 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001419 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001420 SOCs that have a DIU should define this macro to enable DIU
1421 support, and should also define these other macros:
1422
1423 CONFIG_SYS_DIU_ADDR
1424 CONFIG_VIDEO
1425 CONFIG_CMD_BMP
1426 CONFIG_CFB_CONSOLE
1427 CONFIG_VIDEO_SW_CURSOR
1428 CONFIG_VGA_AS_SINGLE_DEVICE
1429 CONFIG_VIDEO_LOGO
1430 CONFIG_VIDEO_BMP_LOGO
1431
Timur Tabiba8e76b2011-04-11 14:18:22 -05001432 The DIU driver will look for the 'video-mode' environment
1433 variable, and if defined, enable the DIU as a console during
1434 boot. See the documentation file README.video for a
1435 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001436
Simon Glass058d59b2012-12-03 13:59:47 +00001437 CONFIG_VIDEO_VGA
1438
1439 Enable the VGA video / BIOS for x86. The alternative if you
1440 are using coreboot is to use the coreboot frame buffer
1441 driver.
1442
1443
wdenk682011f2003-06-03 23:54:09 +00001444- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001445 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001446
wdenk8bde7f72003-06-27 21:31:46 +00001447 Define this to enable a custom keyboard support.
1448 This simply calls drv_keyboard_init() which must be
1449 defined in your board-specific files.
1450 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001451
wdenkc6097192002-11-03 00:24:07 +00001452- LCD Support: CONFIG_LCD
1453
1454 Define this to enable LCD support (for output to LCD
1455 display); also select one of the supported displays
1456 by defining one of these:
1457
Stelian Pop39cf4802008-05-09 21:57:18 +02001458 CONFIG_ATMEL_LCD:
1459
1460 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1461
wdenkfd3103b2003-11-25 16:55:19 +00001462 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001463
wdenkfd3103b2003-11-25 16:55:19 +00001464 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001465
wdenkfd3103b2003-11-25 16:55:19 +00001466 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001467
wdenkfd3103b2003-11-25 16:55:19 +00001468 NEC NL6448BC20-08. 6.5", 640x480.
1469 Active, color, single scan.
1470
1471 CONFIG_NEC_NL6448BC33_54
1472
1473 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001474 Active, color, single scan.
1475
1476 CONFIG_SHARP_16x9
1477
1478 Sharp 320x240. Active, color, single scan.
1479 It isn't 16x9, and I am not sure what it is.
1480
1481 CONFIG_SHARP_LQ64D341
1482
1483 Sharp LQ64D341 display, 640x480.
1484 Active, color, single scan.
1485
1486 CONFIG_HLD1045
1487
1488 HLD1045 display, 640x480.
1489 Active, color, single scan.
1490
1491 CONFIG_OPTREX_BW
1492
1493 Optrex CBL50840-2 NF-FW 99 22 M5
1494 or
1495 Hitachi LMG6912RPFC-00T
1496 or
1497 Hitachi SP14Q002
1498
1499 320x240. Black & white.
1500
1501 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001502 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001503
Simon Glass676d3192012-10-17 13:24:54 +00001504 CONFIG_LCD_ALIGNMENT
1505
1506 Normally the LCD is page-aligned (tyically 4KB). If this is
1507 defined then the LCD will be aligned to this value instead.
1508 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1509 here, since it is cheaper to change data cache settings on
1510 a per-section basis.
1511
Simon Glass0d89efe2012-10-17 13:24:59 +00001512 CONFIG_CONSOLE_SCROLL_LINES
1513
1514 When the console need to be scrolled, this is the number of
1515 lines to scroll by. It defaults to 1. Increasing this makes
1516 the console jump but can help speed up operation when scrolling
1517 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001518
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001519 CONFIG_LCD_BMP_RLE8
1520
1521 Support drawing of RLE8-compressed bitmaps on the LCD.
1522
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001523 CONFIG_I2C_EDID
1524
1525 Enables an 'i2c edid' command which can read EDID
1526 information over I2C from an attached LCD display.
1527
wdenk7152b1d2003-09-05 23:19:14 +00001528- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001529
wdenk8bde7f72003-06-27 21:31:46 +00001530 If this option is set, the environment is checked for
1531 a variable "splashimage". If found, the usual display
1532 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001533 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001534 specified in "splashimage" is loaded instead. The
1535 console is redirected to the "nulldev", too. This
1536 allows for a "silent" boot where a splash screen is
1537 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001538
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001539 CONFIG_SPLASHIMAGE_GUARD
1540
1541 If this option is set, then U-Boot will prevent the environment
1542 variable "splashimage" from being set to a problematic address
1543 (see README.displaying-bmps and README.arm-unaligned-accesses).
1544 This option is useful for targets where, due to alignment
1545 restrictions, an improperly aligned BMP image will cause a data
1546 abort. If you think you will not have problems with unaligned
1547 accesses (for example because your toolchain prevents them)
1548 there is no need to set this option.
1549
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001550 CONFIG_SPLASH_SCREEN_ALIGN
1551
1552 If this option is set the splash image can be freely positioned
1553 on the screen. Environment variable "splashpos" specifies the
1554 position as "x,y". If a positive number is given it is used as
1555 number of pixel from left/top. If a negative number is given it
1556 is used as number of pixel from right/bottom. You can also
1557 specify 'm' for centering the image.
1558
1559 Example:
1560 setenv splashpos m,m
1561 => image at center of screen
1562
1563 setenv splashpos 30,20
1564 => image at x = 30 and y = 20
1565
1566 setenv splashpos -10,m
1567 => vertically centered image
1568 at x = dspWidth - bmpWidth - 9
1569
Nikita Kiryanov581bb412013-01-30 21:39:57 +00001570 CONFIG_SPLASH_SCREEN_PREPARE
1571
1572 If this option is set then the board_splash_screen_prepare()
1573 function, which must be defined in your code, is called as part
1574 of the splash screen display sequence. It gives the board an
1575 opportunity to prepare the splash image data before it is
1576 processed and sent to the frame buffer by U-Boot.
1577
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001578- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1579
1580 If this option is set, additionally to standard BMP
1581 images, gzipped BMP images can be displayed via the
1582 splashscreen support or the bmp command.
1583
Anatolij Gustschind5011762010-03-15 14:50:25 +01001584- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1585
1586 If this option is set, 8-bit RLE compressed BMP images
1587 can be displayed via the splashscreen support or the
1588 bmp command.
1589
Lei Wenf2b96df2012-09-28 04:26:47 +00001590- Do compresssing for memory range:
1591 CONFIG_CMD_ZIP
1592
1593 If this option is set, it would use zlib deflate method
1594 to compress the specified memory at its best effort.
1595
wdenkc29fdfc2003-08-29 20:57:53 +00001596- Compression support:
1597 CONFIG_BZIP2
1598
1599 If this option is set, support for bzip2 compressed
1600 images is included. If not, only uncompressed and gzip
1601 compressed images are supported.
1602
wdenk42d1f032003-10-15 23:53:47 +00001603 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001605 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001606
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001607 CONFIG_LZMA
1608
1609 If this option is set, support for lzma compressed
1610 images is included.
1611
1612 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1613 requires an amount of dynamic memory that is given by the
1614 formula:
1615
1616 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1617
1618 Where lc and lp stand for, respectively, Literal context bits
1619 and Literal pos bits.
1620
1621 This value is upper-bounded by 14MB in the worst case. Anyway,
1622 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1623 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1624 a very small buffer.
1625
1626 Use the lzmainfo tool to determinate the lc and lp values and
1627 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001628 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001629
wdenk17ea1172004-06-06 21:51:03 +00001630- MII/PHY support:
1631 CONFIG_PHY_ADDR
1632
1633 The address of PHY on MII bus.
1634
1635 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1636
1637 The clock frequency of the MII bus
1638
1639 CONFIG_PHY_GIGE
1640
1641 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001642 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001643
1644 CONFIG_PHY_RESET_DELAY
1645
1646 Some PHY like Intel LXT971A need extra delay after
1647 reset before any MII register access is possible.
1648 For such PHY, set this option to the usec delay
1649 required. (minimum 300usec for LXT971A)
1650
1651 CONFIG_PHY_CMD_DELAY (ppc4xx)
1652
1653 Some PHY like Intel LXT971A need extra delay after
1654 command issued before MII status register can be read
1655
wdenkc6097192002-11-03 00:24:07 +00001656- Ethernet address:
1657 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001658 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001659 CONFIG_ETH2ADDR
1660 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001661 CONFIG_ETH4ADDR
1662 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001663
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001664 Define a default value for Ethernet address to use
1665 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001666 is not determined automatically.
1667
1668- IP address:
1669 CONFIG_IPADDR
1670
1671 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001672 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001673 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001674 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001675
1676- Server IP address:
1677 CONFIG_SERVERIP
1678
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001679 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001680 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001681 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001682
Robin Getz97cfe862009-07-21 12:15:28 -04001683 CONFIG_KEEP_SERVERADDR
1684
1685 Keeps the server's MAC address, in the env 'serveraddr'
1686 for passing to bootargs (like Linux's netconsole option)
1687
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001688- Gateway IP address:
1689 CONFIG_GATEWAYIP
1690
1691 Defines a default value for the IP address of the
1692 default router where packets to other networks are
1693 sent to.
1694 (Environment variable "gatewayip")
1695
1696- Subnet mask:
1697 CONFIG_NETMASK
1698
1699 Defines a default value for the subnet mask (or
1700 routing prefix) which is used to determine if an IP
1701 address belongs to the local subnet or needs to be
1702 forwarded through a router.
1703 (Environment variable "netmask")
1704
David Updegraff53a5c422007-06-11 10:41:07 -05001705- Multicast TFTP Mode:
1706 CONFIG_MCAST_TFTP
1707
1708 Defines whether you want to support multicast TFTP as per
1709 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001710 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001711 driver in use must provide a function: mcast() to join/leave a
1712 multicast group.
1713
wdenkc6097192002-11-03 00:24:07 +00001714- BOOTP Recovery Mode:
1715 CONFIG_BOOTP_RANDOM_DELAY
1716
1717 If you have many targets in a network that try to
1718 boot using BOOTP, you may want to avoid that all
1719 systems send out BOOTP requests at precisely the same
1720 moment (which would happen for instance at recovery
1721 from a power failure, when all systems will try to
1722 boot, thus flooding the BOOTP server. Defining
1723 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1724 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001725 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001726
1727 1st BOOTP request: delay 0 ... 1 sec
1728 2nd BOOTP request: delay 0 ... 2 sec
1729 3rd BOOTP request: delay 0 ... 4 sec
1730 4th and following
1731 BOOTP requests: delay 0 ... 8 sec
1732
stroesefe389a82003-08-28 14:17:32 +00001733- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001734 You can fine tune the DHCP functionality by defining
1735 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001736
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001737 CONFIG_BOOTP_SUBNETMASK
1738 CONFIG_BOOTP_GATEWAY
1739 CONFIG_BOOTP_HOSTNAME
1740 CONFIG_BOOTP_NISDOMAIN
1741 CONFIG_BOOTP_BOOTPATH
1742 CONFIG_BOOTP_BOOTFILESIZE
1743 CONFIG_BOOTP_DNS
1744 CONFIG_BOOTP_DNS2
1745 CONFIG_BOOTP_SEND_HOSTNAME
1746 CONFIG_BOOTP_NTPSERVER
1747 CONFIG_BOOTP_TIMEOFFSET
1748 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001749 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001750
Wilson Callan5d110f02007-07-28 10:56:13 -04001751 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1752 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001753
Joe Hershberger2c00e092012-05-23 07:59:19 +00001754 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1755 after the configured retry count, the call will fail
1756 instead of starting over. This can be used to fail over
1757 to Link-local IP address configuration if the DHCP server
1758 is not available.
1759
stroesefe389a82003-08-28 14:17:32 +00001760 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1761 serverip from a DHCP server, it is possible that more
1762 than one DNS serverip is offered to the client.
1763 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1764 serverip will be stored in the additional environment
1765 variable "dnsip2". The first DNS serverip is always
1766 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001767 is defined.
stroesefe389a82003-08-28 14:17:32 +00001768
1769 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1770 to do a dynamic update of a DNS server. To do this, they
1771 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001772 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001773 of the "hostname" environment variable is passed as
1774 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001775
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001776 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1777
1778 A 32bit value in microseconds for a delay between
1779 receiving a "DHCP Offer" and sending the "DHCP Request".
1780 This fixes a problem with certain DHCP servers that don't
1781 respond 100% of the time to a "DHCP request". E.g. On an
1782 AT91RM9200 processor running at 180MHz, this delay needed
1783 to be *at least* 15,000 usec before a Windows Server 2003
1784 DHCP server would reply 100% of the time. I recommend at
1785 least 50,000 usec to be safe. The alternative is to hope
1786 that one of the retries will be successful but note that
1787 the DHCP timeout and retry process takes a longer than
1788 this delay.
1789
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001790 - Link-local IP address negotiation:
1791 Negotiate with other link-local clients on the local network
1792 for an address that doesn't require explicit configuration.
1793 This is especially useful if a DHCP server cannot be guaranteed
1794 to exist in all environments that the device must operate.
1795
1796 See doc/README.link-local for more information.
1797
wdenka3d991b2004-04-15 21:48:45 +00001798 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001799 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001800
1801 The device id used in CDP trigger frames.
1802
1803 CONFIG_CDP_DEVICE_ID_PREFIX
1804
1805 A two character string which is prefixed to the MAC address
1806 of the device.
1807
1808 CONFIG_CDP_PORT_ID
1809
1810 A printf format string which contains the ascii name of
1811 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001812 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001813
1814 CONFIG_CDP_CAPABILITIES
1815
1816 A 32bit integer which indicates the device capabilities;
1817 0x00000010 for a normal host which does not forwards.
1818
1819 CONFIG_CDP_VERSION
1820
1821 An ascii string containing the version of the software.
1822
1823 CONFIG_CDP_PLATFORM
1824
1825 An ascii string containing the name of the platform.
1826
1827 CONFIG_CDP_TRIGGER
1828
1829 A 32bit integer sent on the trigger.
1830
1831 CONFIG_CDP_POWER_CONSUMPTION
1832
1833 A 16bit integer containing the power consumption of the
1834 device in .1 of milliwatts.
1835
1836 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1837
1838 A byte containing the id of the VLAN.
1839
wdenkc6097192002-11-03 00:24:07 +00001840- Status LED: CONFIG_STATUS_LED
1841
1842 Several configurations allow to display the current
1843 status using a LED. For instance, the LED will blink
1844 fast while running U-Boot code, stop blinking as
1845 soon as a reply to a BOOTP request was received, and
1846 start blinking slow once the Linux kernel is running
1847 (supported by a status LED driver in the Linux
1848 kernel). Defining CONFIG_STATUS_LED enables this
1849 feature in U-Boot.
1850
1851- CAN Support: CONFIG_CAN_DRIVER
1852
1853 Defining CONFIG_CAN_DRIVER enables CAN driver support
1854 on those systems that support this (optional)
1855 feature, like the TQM8xxL modules.
1856
1857- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1858
wdenkb37c7e52003-06-30 16:24:52 +00001859 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001860 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001861 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001862
wdenk945af8d2003-07-16 21:53:01 +00001863 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001864 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001865 CONFIG_COMMANDS) and communicate with i2c based realtime
1866 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001867 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001868
Ben Warrenbb99ad62006-09-07 16:50:54 -04001869 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001870
wdenk945af8d2003-07-16 21:53:01 +00001871 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001872 bit-banging) driver instead of CPM or similar hardware
1873 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001874
wdenk945af8d2003-07-16 21:53:01 +00001875 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001876 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001878 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001879 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001880 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001881 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001882
Peter Tyser8d321b82010-04-12 22:28:21 -05001883 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001884 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001885 and so its address should therefore be cleared to 0 (See,
1886 eg, MPC823e User's Manual p.16-473). So, set
1887 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001888
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001889 CONFIG_SYS_I2C_INIT_MPC5XXX
1890
1891 When a board is reset during an i2c bus transfer
1892 chips might think that the current transfer is still
1893 in progress. Reset the slave devices by sending start
1894 commands until the slave device responds.
1895
wdenk945af8d2003-07-16 21:53:01 +00001896 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001897
1898 If you use the software i2c interface (CONFIG_SOFT_I2C)
1899 then the following macros need to be defined (examples are
1900 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001901
1902 I2C_INIT
1903
wdenkb37c7e52003-06-30 16:24:52 +00001904 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001905 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001906
wdenkba56f622004-02-06 23:19:44 +00001907 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001908
wdenkc6097192002-11-03 00:24:07 +00001909 I2C_PORT
1910
wdenk43d96162003-03-06 00:02:04 +00001911 (Only for MPC8260 CPU). The I/O port to use (the code
1912 assumes both bits are on the same port). Valid values
1913 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001914
1915 I2C_ACTIVE
1916
1917 The code necessary to make the I2C data line active
1918 (driven). If the data line is open collector, this
1919 define can be null.
1920
wdenkb37c7e52003-06-30 16:24:52 +00001921 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1922
wdenkc6097192002-11-03 00:24:07 +00001923 I2C_TRISTATE
1924
1925 The code necessary to make the I2C data line tri-stated
1926 (inactive). If the data line is open collector, this
1927 define can be null.
1928
wdenkb37c7e52003-06-30 16:24:52 +00001929 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1930
wdenkc6097192002-11-03 00:24:07 +00001931 I2C_READ
1932
1933 Code that returns TRUE if the I2C data line is high,
1934 FALSE if it is low.
1935
wdenkb37c7e52003-06-30 16:24:52 +00001936 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1937
wdenkc6097192002-11-03 00:24:07 +00001938 I2C_SDA(bit)
1939
1940 If <bit> is TRUE, sets the I2C data line high. If it
1941 is FALSE, it clears it (low).
1942
wdenkb37c7e52003-06-30 16:24:52 +00001943 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001944 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001945 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001946
wdenkc6097192002-11-03 00:24:07 +00001947 I2C_SCL(bit)
1948
1949 If <bit> is TRUE, sets the I2C clock line high. If it
1950 is FALSE, it clears it (low).
1951
wdenkb37c7e52003-06-30 16:24:52 +00001952 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001953 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001954 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001955
wdenkc6097192002-11-03 00:24:07 +00001956 I2C_DELAY
1957
1958 This delay is invoked four times per clock cycle so this
1959 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001960 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001961 like:
1962
wdenkb37c7e52003-06-30 16:24:52 +00001963 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001964
Mike Frysinger793b5722010-07-21 13:38:02 -04001965 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1966
1967 If your arch supports the generic GPIO framework (asm/gpio.h),
1968 then you may alternatively define the two GPIOs that are to be
1969 used as SCL / SDA. Any of the previous I2C_xxx macros will
1970 have GPIO-based defaults assigned to them as appropriate.
1971
1972 You should define these to the GPIO value as given directly to
1973 the generic GPIO functions.
1974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001975 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001976
wdenk8bde7f72003-06-27 21:31:46 +00001977 When a board is reset during an i2c bus transfer
1978 chips might think that the current transfer is still
1979 in progress. On some boards it is possible to access
1980 the i2c SCLK line directly, either by using the
1981 processor pin as a GPIO or by having a second pin
1982 connected to the bus. If this option is defined a
1983 custom i2c_init_board() routine in boards/xxx/board.c
1984 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001985
Richard Retanubun26a33502010-04-12 15:08:17 -04001986 CONFIG_SYS_I2C_BOARD_LATE_INIT
1987
1988 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1989 defined a custom i2c_board_late_init() routine in
1990 boards/xxx/board.c is run AFTER the operations in i2c_init()
1991 is completed. This callpoint can be used to unreset i2c bus
1992 using CPU i2c controller register accesses for CPUs whose i2c
1993 controller provide such a method. It is called at the end of
1994 i2c_init() to allow i2c_init operations to setup the i2c bus
1995 controller on the CPU (e.g. setting bus speed & slave address).
1996
wdenk17ea1172004-06-06 21:51:03 +00001997 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1998
1999 This option enables configuration of bi_iic_fast[] flags
2000 in u-boot bd_info structure based on u-boot environment
2001 variable "i2cfast". (see also i2cfast)
2002
Ben Warrenbb99ad62006-09-07 16:50:54 -04002003 CONFIG_I2C_MULTI_BUS
2004
2005 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002006 must have a controller. At any point in time, only one bus is
2007 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002008 Note that bus numbering is zero-based.
2009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002010 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002011
2012 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002013 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002014 is set, specify a list of bus-device pairs. Otherwise, specify
2015 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002016
2017 e.g.
2018 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002019 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002020
2021 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2022
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002023 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002024 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002025
2026 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002028 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002029
2030 If defined, then this indicates the I2C bus number for DDR SPD.
2031 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002033 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002034
2035 If defined, then this indicates the I2C bus number for the RTC.
2036 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002038 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002039
2040 If defined, then this indicates the I2C bus number for the DTT.
2041 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2042
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002043 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002044
2045 If defined, specifies the I2C address of the DTT device.
2046 If not defined, then U-Boot uses predefined value for
2047 specified DTT device.
2048
Timur Tabibe5e6182006-11-03 19:15:00 -06002049 CONFIG_FSL_I2C
2050
2051 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002052 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002053
Heiko Schocher67b23a32008-10-15 09:39:47 +02002054 CONFIG_I2C_MUX
2055
2056 Define this option if you have I2C devices reached over 1 .. n
2057 I2C Muxes like the pca9544a. This option addes a new I2C
2058 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2059 new I2C Bus to the existing I2C Busses. If you select the
2060 new Bus with "i2c dev", u-bbot sends first the commandos for
2061 the muxes to activate this new "bus".
2062
2063 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2064 feature!
2065
2066 Example:
2067 Adding a new I2C Bus reached over 2 pca9544a muxes
2068 The First mux with address 70 and channel 6
2069 The Second mux with address 71 and channel 4
2070
2071 => i2c bus pca9544a:70:6:pca9544a:71:4
2072
2073 Use the "i2c bus" command without parameter, to get a list
2074 of I2C Busses with muxes:
2075
2076 => i2c bus
2077 Busses reached over muxes:
2078 Bus ID: 2
2079 reached over Mux(es):
2080 pca9544a@70 ch: 4
2081 Bus ID: 3
2082 reached over Mux(es):
2083 pca9544a@70 ch: 6
2084 pca9544a@71 ch: 4
2085 =>
2086
2087 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002088 u-boot first sends the command to the mux@70 to enable
2089 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002090 the channel 4.
2091
2092 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002093 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002094 the 2 muxes.
2095
2096 This option is actually implemented for the bitbanging
2097 algorithm in common/soft_i2c.c and for the Hardware I2C
2098 Bus on the MPC8260. But it should be not so difficult
2099 to add this option to other architectures.
2100
Andrew Dyer2ac69852008-12-29 17:36:01 -06002101 CONFIG_SOFT_I2C_READ_REPEATED_START
2102
2103 defining this will force the i2c_read() function in
2104 the soft_i2c driver to perform an I2C repeated start
2105 between writing the address pointer and reading the
2106 data. If this define is omitted the default behaviour
2107 of doing a stop-start sequence will be used. Most I2C
2108 devices can use either method, but some require one or
2109 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002110
wdenkc6097192002-11-03 00:24:07 +00002111- SPI Support: CONFIG_SPI
2112
2113 Enables SPI driver (so far only tested with
2114 SPI EEPROM, also an instance works with Crystal A/D and
2115 D/As on the SACSng board)
2116
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002117 CONFIG_SH_SPI
2118
2119 Enables the driver for SPI controller on SuperH. Currently
2120 only SH7757 is supported.
2121
wdenkc6097192002-11-03 00:24:07 +00002122 CONFIG_SPI_X
2123
2124 Enables extended (16-bit) SPI EEPROM addressing.
2125 (symmetrical to CONFIG_I2C_X)
2126
2127 CONFIG_SOFT_SPI
2128
wdenk43d96162003-03-06 00:02:04 +00002129 Enables a software (bit-bang) SPI driver rather than
2130 using hardware support. This is a general purpose
2131 driver that only requires three general I/O port pins
2132 (two outputs, one input) to function. If this is
2133 defined, the board configuration must define several
2134 SPI configuration items (port pins to use, etc). For
2135 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002136
Ben Warren04a9e112008-01-16 22:37:35 -05002137 CONFIG_HARD_SPI
2138
2139 Enables a hardware SPI driver for general-purpose reads
2140 and writes. As with CONFIG_SOFT_SPI, the board configuration
2141 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002142 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002143 example, see include/configs/mpc8349emds.h.
2144
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002145 CONFIG_MXC_SPI
2146
2147 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002148 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002149
Matthias Fuchs01335022007-12-27 17:12:34 +01002150- FPGA Support: CONFIG_FPGA
2151
2152 Enables FPGA subsystem.
2153
2154 CONFIG_FPGA_<vendor>
2155
2156 Enables support for specific chip vendors.
2157 (ALTERA, XILINX)
2158
2159 CONFIG_FPGA_<family>
2160
2161 Enables support for FPGA family.
2162 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2163
2164 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002165
wdenk43d96162003-03-06 00:02:04 +00002166 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002168 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002169
wdenk8bde7f72003-06-27 21:31:46 +00002170 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002171
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002172 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002173
wdenk43d96162003-03-06 00:02:04 +00002174 Enable checks on FPGA configuration interface busy
2175 status by the configuration function. This option
2176 will require a board or device specific function to
2177 be written.
wdenkc6097192002-11-03 00:24:07 +00002178
2179 CONFIG_FPGA_DELAY
2180
2181 If defined, a function that provides delays in the FPGA
2182 configuration driver.
2183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002184 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002185 Allow Control-C to interrupt FPGA configuration
2186
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002187 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002188
wdenk43d96162003-03-06 00:02:04 +00002189 Check for configuration errors during FPGA bitfile
2190 loading. For example, abort during Virtex II
2191 configuration if the INIT_B line goes low (which
2192 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002194 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002195
wdenk43d96162003-03-06 00:02:04 +00002196 Maximum time to wait for the INIT_B line to deassert
2197 after PROB_B has been deasserted during a Virtex II
2198 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002199 ms.
wdenkc6097192002-11-03 00:24:07 +00002200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002201 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002202
wdenk43d96162003-03-06 00:02:04 +00002203 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002204 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002206 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002207
wdenk43d96162003-03-06 00:02:04 +00002208 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002209 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002210
2211- Configuration Management:
2212 CONFIG_IDENT_STRING
2213
wdenk43d96162003-03-06 00:02:04 +00002214 If defined, this string will be added to the U-Boot
2215 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002216
2217- Vendor Parameter Protection:
2218
wdenk43d96162003-03-06 00:02:04 +00002219 U-Boot considers the values of the environment
2220 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002221 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002222 are set once by the board vendor / manufacturer, and
2223 protects these variables from casual modification by
2224 the user. Once set, these variables are read-only,
2225 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002226 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002227
2228 If CONFIG_ENV_OVERWRITE is #defined in your config
2229 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002230 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002231 these parameters.
2232
2233 Alternatively, if you #define _both_ CONFIG_ETHADDR
2234 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002235 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002236 which can be changed exactly ONCE by the user. [The
2237 serial# is unaffected by this, i. e. it remains
2238 read-only.]
2239
Joe Hershberger25980902012-12-11 22:16:31 -06002240 The same can be accomplished in a more flexible way
2241 for any variable by configuring the type of access
2242 to allow for those variables in the ".flags" variable
2243 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2244
wdenkc6097192002-11-03 00:24:07 +00002245- Protected RAM:
2246 CONFIG_PRAM
2247
2248 Define this variable to enable the reservation of
2249 "protected RAM", i. e. RAM which is not overwritten
2250 by U-Boot. Define CONFIG_PRAM to hold the number of
2251 kB you want to reserve for pRAM. You can overwrite
2252 this default value by defining an environment
2253 variable "pram" to the number of kB you want to
2254 reserve. Note that the board info structure will
2255 still show the full amount of RAM. If pRAM is
2256 reserved, a new environment variable "mem" will
2257 automatically be defined to hold the amount of
2258 remaining RAM in a form that can be passed as boot
2259 argument to Linux, for instance like that:
2260
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002261 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002262 saveenv
2263
2264 This way you can tell Linux not to use this memory,
2265 either, which results in a memory region that will
2266 not be affected by reboots.
2267
2268 *WARNING* If your board configuration uses automatic
2269 detection of the RAM size, you must make sure that
2270 this memory test is non-destructive. So far, the
2271 following board configurations are known to be
2272 "pRAM-clean":
2273
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002274 IVMS8, IVML24, SPD8xx, TQM8xxL,
2275 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002276 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002277
Gabe Black40fef042012-12-02 04:55:18 +00002278- Access to physical memory region (> 4GB)
2279 Some basic support is provided for operations on memory not
2280 normally accessible to U-Boot - e.g. some architectures
2281 support access to more than 4GB of memory on 32-bit
2282 machines using physical address extension or similar.
2283 Define CONFIG_PHYSMEM to access this basic support, which
2284 currently only supports clearing the memory.
2285
wdenkc6097192002-11-03 00:24:07 +00002286- Error Recovery:
2287 CONFIG_PANIC_HANG
2288
2289 Define this variable to stop the system in case of a
2290 fatal error, so that you have to reset it manually.
2291 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002292 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002293 automatically as fast as possible, but it may be
2294 useful during development since you can try to debug
2295 the conditions that lead to the situation.
2296
2297 CONFIG_NET_RETRY_COUNT
2298
wdenk43d96162003-03-06 00:02:04 +00002299 This variable defines the number of retries for
2300 network operations like ARP, RARP, TFTP, or BOOTP
2301 before giving up the operation. If not defined, a
2302 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002303
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002304 CONFIG_ARP_TIMEOUT
2305
2306 Timeout waiting for an ARP reply in milliseconds.
2307
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002308 CONFIG_NFS_TIMEOUT
2309
2310 Timeout in milliseconds used in NFS protocol.
2311 If you encounter "ERROR: Cannot umount" in nfs command,
2312 try longer timeout such as
2313 #define CONFIG_NFS_TIMEOUT 10000UL
2314
wdenkc6097192002-11-03 00:24:07 +00002315- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002316 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002317
2318 Enable auto completion of commands using TAB.
2319
Wolfgang Denka9398e02006-11-27 15:32:42 +01002320 Note that this feature has NOT been implemented yet
2321 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002322
2323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002324 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002325
2326 Define this variable to enable the "hush" shell (from
2327 Busybox) as command line interpreter, thus enabling
2328 powerful command line syntax like
2329 if...then...else...fi conditionals or `&&' and '||'
2330 constructs ("shell scripts").
2331
2332 If undefined, you get the old, much simpler behaviour
2333 with a somewhat smaller memory footprint.
2334
2335
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002336 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002337
2338 This defines the secondary prompt string, which is
2339 printed when the command interpreter needs more input
2340 to complete a command. Usually "> ".
2341
2342 Note:
2343
wdenk8bde7f72003-06-27 21:31:46 +00002344 In the current implementation, the local variables
2345 space and global environment variables space are
2346 separated. Local variables are those you define by
2347 simply typing `name=value'. To access a local
2348 variable later on, you have write `$name' or
2349 `${name}'; to execute the contents of a variable
2350 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002351
wdenk43d96162003-03-06 00:02:04 +00002352 Global environment variables are those you use
2353 setenv/printenv to work with. To run a command stored
2354 in such a variable, you need to use the run command,
2355 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002356
2357 To store commands and special characters in a
2358 variable, please use double quotation marks
2359 surrounding the whole text of the variable, instead
2360 of the backslashes before semicolons and special
2361 symbols.
2362
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002363- Commandline Editing and History:
2364 CONFIG_CMDLINE_EDITING
2365
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002367 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002368
wdenka8c7c702003-12-06 19:49:23 +00002369- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002370 CONFIG_EXTRA_ENV_SETTINGS
2371
wdenk43d96162003-03-06 00:02:04 +00002372 Define this to contain any number of null terminated
2373 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002374 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002375
wdenk43d96162003-03-06 00:02:04 +00002376 For example, place something like this in your
2377 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002378
2379 #define CONFIG_EXTRA_ENV_SETTINGS \
2380 "myvar1=value1\0" \
2381 "myvar2=value2\0"
2382
wdenk43d96162003-03-06 00:02:04 +00002383 Warning: This method is based on knowledge about the
2384 internal format how the environment is stored by the
2385 U-Boot code. This is NOT an official, exported
2386 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002387 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002388 You better know what you are doing here.
2389
wdenk43d96162003-03-06 00:02:04 +00002390 Note: overly (ab)use of the default environment is
2391 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002392 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002393 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002394
Stephen Warren5e724ca2012-05-22 09:21:54 +00002395 CONFIG_ENV_VARS_UBOOT_CONFIG
2396
2397 Define this in order to add variables describing the
2398 U-Boot build configuration to the default environment.
2399 These will be named arch, cpu, board, vendor, and soc.
2400
2401 Enabling this option will cause the following to be defined:
2402
2403 - CONFIG_SYS_ARCH
2404 - CONFIG_SYS_CPU
2405 - CONFIG_SYS_BOARD
2406 - CONFIG_SYS_VENDOR
2407 - CONFIG_SYS_SOC
2408
Tom Rini7e27f892012-10-24 07:28:16 +00002409 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2410
2411 Define this in order to add variables describing certain
2412 run-time determined information about the hardware to the
2413 environment. These will be named board_name, board_rev.
2414
Simon Glass06fd8532012-11-30 13:01:17 +00002415 CONFIG_DELAY_ENVIRONMENT
2416
2417 Normally the environment is loaded when the board is
2418 intialised so that it is available to U-Boot. This inhibits
2419 that so that the environment is not available until
2420 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2421 this is instead controlled by the value of
2422 /config/load-environment.
2423
wdenka8c7c702003-12-06 19:49:23 +00002424- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002425 CONFIG_HAS_DATAFLASH
2426
wdenk8bde7f72003-06-27 21:31:46 +00002427 Defining this option enables DataFlash features and
2428 allows to read/write in Dataflash via the standard
2429 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002430
Eric Nelsonf61ec452012-01-31 10:52:08 -07002431- Serial Flash support
2432 CONFIG_CMD_SF
2433
2434 Defining this option enables SPI flash commands
2435 'sf probe/read/write/erase/update'.
2436
2437 Usage requires an initial 'probe' to define the serial
2438 flash parameters, followed by read/write/erase/update
2439 commands.
2440
2441 The following defaults may be provided by the platform
2442 to handle the common case when only a single serial
2443 flash is present on the system.
2444
2445 CONFIG_SF_DEFAULT_BUS Bus identifier
2446 CONFIG_SF_DEFAULT_CS Chip-select
2447 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2448 CONFIG_SF_DEFAULT_SPEED in Hz
2449
Simon Glass24007272012-10-08 13:16:02 +00002450 CONFIG_CMD_SF_TEST
2451
2452 Define this option to include a destructive SPI flash
2453 test ('sf test').
2454
wdenk3f85ce22004-02-23 16:11:30 +00002455- SystemACE Support:
2456 CONFIG_SYSTEMACE
2457
2458 Adding this option adds support for Xilinx SystemACE
2459 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002460 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002462
2463 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002464 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002465
2466 When SystemACE support is added, the "ace" device type
2467 becomes available to the fat commands, i.e. fatls.
2468
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002469- TFTP Fixed UDP Port:
2470 CONFIG_TFTP_PORT
2471
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002472 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002473 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002474 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002475 number generator is used.
2476
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002477 Also, the environment variable tftpdstp is used to supply
2478 the TFTP UDP destination port value. If tftpdstp isn't
2479 defined, the normal port 69 is used.
2480
2481 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002482 blindly start the TFTP transfer using the pre-configured
2483 target IP address and UDP port. This has the effect of
2484 "punching through" the (Windows XP) firewall, allowing
2485 the remainder of the TFTP transfer to proceed normally.
2486 A better solution is to properly configure the firewall,
2487 but sometimes that is not allowed.
2488
Simon Glassbf36c5d2012-12-05 14:46:38 +00002489- Hashing support:
2490 CONFIG_CMD_HASH
2491
2492 This enables a generic 'hash' command which can produce
2493 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2494
2495 CONFIG_HASH_VERIFY
2496
2497 Enable the hash verify command (hash -v). This adds to code
2498 size a little.
2499
2500 CONFIG_SHA1 - support SHA1 hashing
2501 CONFIG_SHA256 - support SHA256 hashing
2502
2503 Note: There is also a sha1sum command, which should perhaps
2504 be deprecated in favour of 'hash sha1'.
2505
wdenka8c7c702003-12-06 19:49:23 +00002506- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002507 CONFIG_SHOW_BOOT_PROGRESS
2508
wdenk43d96162003-03-06 00:02:04 +00002509 Defining this option allows to add some board-
2510 specific code (calling a user-provided function
2511 "show_boot_progress(int)") that enables you to show
2512 the system's boot progress on some display (for
2513 example, some LED's) on your board. At the moment,
2514 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002515
Simon Glass3a608ca2012-02-13 13:51:19 +00002516- Detailed boot stage timing
2517 CONFIG_BOOTSTAGE
2518 Define this option to get detailed timing of each stage
2519 of the boot process.
2520
2521 CONFIG_BOOTSTAGE_USER_COUNT
2522 This is the number of available user bootstage records.
2523 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2524 a new ID will be allocated from this stash. If you exceed
2525 the limit, recording will stop.
2526
2527 CONFIG_BOOTSTAGE_REPORT
2528 Define this to print a report before boot, similar to this:
2529
2530 Timer summary in microseconds:
2531 Mark Elapsed Stage
2532 0 0 reset
2533 3,575,678 3,575,678 board_init_f start
2534 3,575,695 17 arch_cpu_init A9
2535 3,575,777 82 arch_cpu_init done
2536 3,659,598 83,821 board_init_r start
2537 3,910,375 250,777 main_loop
2538 29,916,167 26,005,792 bootm_start
2539 30,361,327 445,160 start_kernel
2540
Simon Glass2eba38c2012-09-28 08:56:39 +00002541 CONFIG_CMD_BOOTSTAGE
2542 Add a 'bootstage' command which supports printing a report
2543 and un/stashing of bootstage data.
2544
Simon Glass94fd1312012-09-28 08:56:37 +00002545 CONFIG_BOOTSTAGE_FDT
2546 Stash the bootstage information in the FDT. A root 'bootstage'
2547 node is created with each bootstage id as a child. Each child
2548 has a 'name' property and either 'mark' containing the
2549 mark time in microsecond, or 'accum' containing the
2550 accumulated time for that bootstage id in microseconds.
2551 For example:
2552
2553 bootstage {
2554 154 {
2555 name = "board_init_f";
2556 mark = <3575678>;
2557 };
2558 170 {
2559 name = "lcd";
2560 accum = <33482>;
2561 };
2562 };
2563
2564 Code in the Linux kernel can find this in /proc/devicetree.
2565
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002566Legacy uImage format:
2567
wdenkc6097192002-11-03 00:24:07 +00002568 Arg Where When
2569 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002570 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002571 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002572 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002573 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002574 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002575 4 common/cmd_bootm.c Image data has correct checksum
2576 -4 common/cmd_bootm.c Image is for unsupported architecture
2577 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002578 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002579 6 common/cmd_bootm.c Image Type check OK
2580 -6 common/cmd_bootm.c gunzip uncompression error
2581 -7 common/cmd_bootm.c Unimplemented compression type
2582 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002583 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002584 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002585
2586 9 common/image.c Start initial ramdisk verification
2587 -10 common/image.c Ramdisk header has bad magic number
2588 -11 common/image.c Ramdisk header has bad checksum
2589 10 common/image.c Ramdisk header is OK
2590 -12 common/image.c Ramdisk data has bad checksum
2591 11 common/image.c Ramdisk data has correct checksum
2592 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002593 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002594 13 common/image.c Start multifile image verification
2595 14 common/image.c No initial ramdisk, no multifile, continue.
2596
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002597 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002598
Stefan Roesea47a12b2010-04-15 16:07:28 +02002599 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002600 -31 post/post.c POST test failed, detected by post_output_backlog()
2601 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002602
Heiko Schocher566a4942007-06-22 19:11:54 +02002603 34 common/cmd_doc.c before loading a Image from a DOC device
2604 -35 common/cmd_doc.c Bad usage of "doc" command
2605 35 common/cmd_doc.c correct usage of "doc" command
2606 -36 common/cmd_doc.c No boot device
2607 36 common/cmd_doc.c correct boot device
2608 -37 common/cmd_doc.c Unknown Chip ID on boot device
2609 37 common/cmd_doc.c correct chip ID found, device available
2610 -38 common/cmd_doc.c Read Error on boot device
2611 38 common/cmd_doc.c reading Image header from DOC device OK
2612 -39 common/cmd_doc.c Image header has bad magic number
2613 39 common/cmd_doc.c Image header has correct magic number
2614 -40 common/cmd_doc.c Error reading Image from DOC device
2615 40 common/cmd_doc.c Image header has correct magic number
2616 41 common/cmd_ide.c before loading a Image from a IDE device
2617 -42 common/cmd_ide.c Bad usage of "ide" command
2618 42 common/cmd_ide.c correct usage of "ide" command
2619 -43 common/cmd_ide.c No boot device
2620 43 common/cmd_ide.c boot device found
2621 -44 common/cmd_ide.c Device not available
2622 44 common/cmd_ide.c Device available
2623 -45 common/cmd_ide.c wrong partition selected
2624 45 common/cmd_ide.c partition selected
2625 -46 common/cmd_ide.c Unknown partition table
2626 46 common/cmd_ide.c valid partition table found
2627 -47 common/cmd_ide.c Invalid partition type
2628 47 common/cmd_ide.c correct partition type
2629 -48 common/cmd_ide.c Error reading Image Header on boot device
2630 48 common/cmd_ide.c reading Image Header from IDE device OK
2631 -49 common/cmd_ide.c Image header has bad magic number
2632 49 common/cmd_ide.c Image header has correct magic number
2633 -50 common/cmd_ide.c Image header has bad checksum
2634 50 common/cmd_ide.c Image header has correct checksum
2635 -51 common/cmd_ide.c Error reading Image from IDE device
2636 51 common/cmd_ide.c reading Image from IDE device OK
2637 52 common/cmd_nand.c before loading a Image from a NAND device
2638 -53 common/cmd_nand.c Bad usage of "nand" command
2639 53 common/cmd_nand.c correct usage of "nand" command
2640 -54 common/cmd_nand.c No boot device
2641 54 common/cmd_nand.c boot device found
2642 -55 common/cmd_nand.c Unknown Chip ID on boot device
2643 55 common/cmd_nand.c correct chip ID found, device available
2644 -56 common/cmd_nand.c Error reading Image Header on boot device
2645 56 common/cmd_nand.c reading Image Header from NAND device OK
2646 -57 common/cmd_nand.c Image header has bad magic number
2647 57 common/cmd_nand.c Image header has correct magic number
2648 -58 common/cmd_nand.c Error reading Image from NAND device
2649 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002650
Heiko Schocher566a4942007-06-22 19:11:54 +02002651 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002652
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002653 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002654 -64 net/eth.c no Ethernet found.
2655 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002656
Heiko Schocher566a4942007-06-22 19:11:54 +02002657 -80 common/cmd_net.c usage wrong
2658 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002659 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002660 81 common/cmd_net.c NetLoop() back without error
2661 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2662 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002663 83 common/cmd_net.c running "source" command
2664 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002665 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002666
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002667FIT uImage format:
2668
2669 Arg Where When
2670 100 common/cmd_bootm.c Kernel FIT Image has correct format
2671 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2672 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2673 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2674 102 common/cmd_bootm.c Kernel unit name specified
2675 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002676 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002677 104 common/cmd_bootm.c Got kernel subimage node offset
2678 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2679 105 common/cmd_bootm.c Kernel subimage hash verification OK
2680 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2681 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002682 -106 common/cmd_bootm.c Kernel subimage has wrong type
2683 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002684 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2685 108 common/cmd_bootm.c Got kernel subimage data/size
2686 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2687 -109 common/cmd_bootm.c Can't get kernel subimage type
2688 -110 common/cmd_bootm.c Can't get kernel subimage comp
2689 -111 common/cmd_bootm.c Can't get kernel subimage os
2690 -112 common/cmd_bootm.c Can't get kernel subimage load address
2691 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2692
2693 120 common/image.c Start initial ramdisk verification
2694 -120 common/image.c Ramdisk FIT image has incorrect format
2695 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002696 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002697 -122 common/image.c Can't get configuration for ramdisk subimage
2698 123 common/image.c Ramdisk unit name specified
2699 -124 common/image.c Can't get ramdisk subimage node offset
2700 125 common/image.c Got ramdisk subimage node offset
2701 -125 common/image.c Ramdisk subimage hash verification failed
2702 126 common/image.c Ramdisk subimage hash verification OK
2703 -126 common/image.c Ramdisk subimage for unsupported architecture
2704 127 common/image.c Architecture check OK
2705 -127 common/image.c Can't get ramdisk subimage data/size
2706 128 common/image.c Got ramdisk subimage data/size
2707 129 common/image.c Can't get ramdisk load address
2708 -129 common/image.c Got ramdisk load address
2709
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002710 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002711 131 common/cmd_doc.c FIT image format OK
2712
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002713 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002714 141 common/cmd_ide.c FIT image format OK
2715
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002716 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002717 151 common/cmd_nand.c FIT image format OK
2718
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002719- FIT image support:
2720 CONFIG_FIT
2721 Enable support for the FIT uImage format.
2722
2723 CONFIG_FIT_BEST_MATCH
2724 When no configuration is explicitly selected, default to the
2725 one whose fdt's compatibility field best matches that of
2726 U-Boot itself. A match is considered "best" if it matches the
2727 most specific compatibility entry of U-Boot's fdt's root node.
2728 The order of entries in the configuration's fdt is ignored.
2729
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002730- Standalone program support:
2731 CONFIG_STANDALONE_LOAD_ADDR
2732
Wolfgang Denk6feff892011-10-09 21:06:34 +02002733 This option defines a board specific value for the
2734 address where standalone program gets loaded, thus
2735 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002736 settings.
2737
2738- Frame Buffer Address:
2739 CONFIG_FB_ADDR
2740
2741 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002742 address for frame buffer. This is typically the case
2743 when using a graphics controller has separate video
2744 memory. U-Boot will then place the frame buffer at
2745 the given address instead of dynamically reserving it
2746 in system RAM by calling lcd_setmem(), which grabs
2747 the memory for the frame buffer depending on the
2748 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002749
2750 Please see board_init_f function.
2751
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002752- Automatic software updates via TFTP server
2753 CONFIG_UPDATE_TFTP
2754 CONFIG_UPDATE_TFTP_CNT_MAX
2755 CONFIG_UPDATE_TFTP_MSEC_MAX
2756
2757 These options enable and control the auto-update feature;
2758 for a more detailed description refer to doc/README.update.
2759
2760- MTD Support (mtdparts command, UBI support)
2761 CONFIG_MTD_DEVICE
2762
2763 Adds the MTD device infrastructure from the Linux kernel.
2764 Needed for mtdparts command support.
2765
2766 CONFIG_MTD_PARTITIONS
2767
2768 Adds the MTD partitioning infrastructure from the Linux
2769 kernel. Needed for UBI support.
2770
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002771- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002772 CONFIG_SPL
2773 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002774
Tom Rini95579792012-02-14 07:29:40 +00002775 CONFIG_SPL_LDSCRIPT
2776 LDSCRIPT for linking the SPL binary.
2777
2778 CONFIG_SPL_MAX_SIZE
2779 Maximum binary size (text, data and rodata) of the SPL binary.
2780
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002781 CONFIG_SPL_TEXT_BASE
2782 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002783
Scott Wood94a45bb2012-09-20 19:05:12 -05002784 CONFIG_SPL_RELOC_TEXT_BASE
2785 Address to relocate to. If unspecified, this is equal to
2786 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2787
Tom Rini95579792012-02-14 07:29:40 +00002788 CONFIG_SPL_BSS_START_ADDR
2789 Link address for the BSS within the SPL binary.
2790
2791 CONFIG_SPL_BSS_MAX_SIZE
2792 Maximum binary size of the BSS section of the SPL binary.
2793
2794 CONFIG_SPL_STACK
2795 Adress of the start of the stack SPL will use
2796
Scott Wood94a45bb2012-09-20 19:05:12 -05002797 CONFIG_SPL_RELOC_STACK
2798 Adress of the start of the stack SPL will use after
2799 relocation. If unspecified, this is equal to
2800 CONFIG_SPL_STACK.
2801
Tom Rini95579792012-02-14 07:29:40 +00002802 CONFIG_SYS_SPL_MALLOC_START
2803 Starting address of the malloc pool used in SPL.
2804
2805 CONFIG_SYS_SPL_MALLOC_SIZE
2806 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002807
Tom Rini47f7bca2012-08-13 12:03:19 -07002808 CONFIG_SPL_FRAMEWORK
2809 Enable the SPL framework under common/. This framework
2810 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2811 NAND loading of the Linux Kernel.
2812
Tom Rini861a86f2012-08-13 11:37:56 -07002813 CONFIG_SPL_DISPLAY_PRINT
2814 For ARM, enable an optional function to print more information
2815 about the running system.
2816
Scott Wood4b919722012-09-20 16:35:21 -05002817 CONFIG_SPL_INIT_MINIMAL
2818 Arch init code should be built for a very small image
2819
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002820 CONFIG_SPL_LIBCOMMON_SUPPORT
2821 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002822
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002823 CONFIG_SPL_LIBDISK_SUPPORT
2824 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002825
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002826 CONFIG_SPL_I2C_SUPPORT
2827 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002828
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002829 CONFIG_SPL_GPIO_SUPPORT
2830 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002831
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002832 CONFIG_SPL_MMC_SUPPORT
2833 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002834
Tom Rini95579792012-02-14 07:29:40 +00002835 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2836 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2837 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2838 Address, size and partition on the MMC to load U-Boot from
2839 when the MMC is being used in raw mode.
2840
2841 CONFIG_SPL_FAT_SUPPORT
2842 Support for fs/fat/libfat.o in SPL binary
2843
2844 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2845 Filename to read to load U-Boot when reading from FAT
2846
Scott Wood06f60ae2012-12-06 13:33:17 +00002847 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2848 Set this for NAND SPL on PPC mpc83xx targets, so that
2849 start.S waits for the rest of the SPL to load before
2850 continuing (the hardware starts execution after just
2851 loading the first page rather than the full 4K).
2852
Scott Wood6f2f01b2012-09-20 19:09:07 -05002853 CONFIG_SPL_NAND_BASE
2854 Include nand_base.c in the SPL. Requires
2855 CONFIG_SPL_NAND_DRIVERS.
2856
2857 CONFIG_SPL_NAND_DRIVERS
2858 SPL uses normal NAND drivers, not minimal drivers.
2859
2860 CONFIG_SPL_NAND_ECC
2861 Include standard software ECC in the SPL
2862
Tom Rini95579792012-02-14 07:29:40 +00002863 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002864 Support for NAND boot using simple NAND drivers that
2865 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002866
2867 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2868 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2869 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2870 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2871 CONFIG_SYS_NAND_ECCBYTES
2872 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002873 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002874
2875 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002876 Location in NAND to read U-Boot from
2877
2878 CONFIG_SYS_NAND_U_BOOT_DST
2879 Location in memory to load U-Boot to
2880
2881 CONFIG_SYS_NAND_U_BOOT_SIZE
2882 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00002883
2884 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05002885 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00002886
2887 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2888 Define this if you need to first read the OOB and then the
2889 data. This is used for example on davinci plattforms.
2890
2891 CONFIG_SPL_OMAP3_ID_NAND
2892 Support for an OMAP3-specific set of functions to return the
2893 ID and MFR of the first attached NAND chip, if present.
2894
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002895 CONFIG_SPL_SERIAL_SUPPORT
2896 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002897
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002898 CONFIG_SPL_SPI_FLASH_SUPPORT
2899 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002900
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002901 CONFIG_SPL_SPI_SUPPORT
2902 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002903
Pavel Machekc57b9532012-08-30 22:42:11 +02002904 CONFIG_SPL_RAM_DEVICE
2905 Support for running image already present in ram, in SPL binary
2906
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002907 CONFIG_SPL_LIBGENERIC_SUPPORT
2908 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002909
Scott Wood74752ba2012-12-06 13:33:16 +00002910 CONFIG_SPL_PAD_TO
2911 Linker address to which the SPL should be padded before
2912 appending the SPL payload.
2913
Scott Woodca2fca22012-09-21 16:27:32 -05002914 CONFIG_SPL_TARGET
2915 Final target image containing SPL and payload. Some SPLs
2916 use an arch-specific makefile fragment instead, for
2917 example if more than one image needs to be produced.
2918
wdenkc6097192002-11-03 00:24:07 +00002919Modem Support:
2920--------------
2921
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002922[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002923
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002924- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002925 CONFIG_MODEM_SUPPORT
2926
2927- RTS/CTS Flow control enable:
2928 CONFIG_HWFLOW
2929
2930- Modem debug support:
2931 CONFIG_MODEM_SUPPORT_DEBUG
2932
wdenk43d96162003-03-06 00:02:04 +00002933 Enables debugging stuff (char screen[1024], dbg())
2934 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002935
wdenka8c7c702003-12-06 19:49:23 +00002936- Interrupt support (PPC):
2937
wdenkd4ca31c2004-01-02 14:00:00 +00002938 There are common interrupt_init() and timer_interrupt()
2939 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002940 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002941 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002942 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002943 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002944 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002945 specific handling. If board has watchdog / status_led
2946 / other_activity_monitor it works automatically from
2947 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002948
wdenkc6097192002-11-03 00:24:07 +00002949- General:
2950
wdenk43d96162003-03-06 00:02:04 +00002951 In the target system modem support is enabled when a
2952 specific key (key combination) is pressed during
2953 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002954 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002955 board_init(). Currently key_pressed() is a dummy
2956 function, returning 1 and thus enabling modem
2957 initialization.
wdenkc6097192002-11-03 00:24:07 +00002958
wdenk43d96162003-03-06 00:02:04 +00002959 If there are no modem init strings in the
2960 environment, U-Boot proceed to autoboot; the
2961 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002962 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002963
2964 See also: doc/README.Modem
2965
Helmut Raiger9660e442011-10-20 04:19:47 +00002966Board initialization settings:
2967------------------------------
2968
2969During Initialization u-boot calls a number of board specific functions
2970to allow the preparation of board specific prerequisites, e.g. pin setup
2971before drivers are initialized. To enable these callbacks the
2972following configuration macros have to be defined. Currently this is
2973architecture specific, so please check arch/your_architecture/lib/board.c
2974typically in board_init_f() and board_init_r().
2975
2976- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2977- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2978- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2979- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002980
wdenkc6097192002-11-03 00:24:07 +00002981Configuration Settings:
2982-----------------------
2983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002984- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002985 undefine this when you're short of memory.
2986
Peter Tyser2fb26042009-01-27 18:03:12 -06002987- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2988 width of the commands listed in the 'help' command output.
2989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002990- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002991 prompt for user input.
2992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002995- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002997- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002999- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003000 the application (usually a Linux kernel) when it is
3001 booted
3002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003003- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003004 List of legal baudrate settings for this board.
3005
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003006- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003007 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003009- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003010 If the board specific function
3011 extern int overwrite_console (void);
3012 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003013 serial port, else the settings in the environment are used.
3014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003015- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003016 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003017
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003019 Enable overwrite of previous console environment settings.
3020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003022 Begin and End addresses of the area used by the
3023 simple memory test.
3024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003025- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003026 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003028- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003029 Scratch address used by the alternate memory test
3030 You only need to set this if address zero isn't writeable
3031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003032- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3033 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003034 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003035 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003036 fixing up gd->ram_size the Linux kernel should gets passed
3037 the now "corrected" memory size and won't touch it either.
3038 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003039 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003040 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003041 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003042
3043 This option can be used as a workaround for the 440EPx/GRx
3044 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3045 be touched.
3046
3047 WARNING: Please make sure that this value is a multiple of
3048 the Linux page size (normally 4k). If this is not the case,
3049 then the end address of the Linux memory will be located at a
3050 non page size aligned address and this could cause major
3051 problems.
3052
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003053- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003054 Enable temporary baudrate change while serial download
3055
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003056- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003057 Physical start address of SDRAM. _Must_ be 0 here.
3058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003059- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003060 Physical start address of Motherboard I/O (if using a
3061 Cogent motherboard)
3062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003063- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003064 Physical start address of Flash memory.
3065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003066- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003067 Physical start address of boot monitor code (set by
3068 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003069 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003070 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003072- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003073 Size of memory reserved for monitor code, used to
3074 determine _at_compile_time_ (!) if the environment is
3075 embedded within the U-Boot image, or in a separate
3076 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003078- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003079 Size of DRAM reserved for malloc() use.
3080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003081- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003082 Normally compressed uImages are limited to an
3083 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003085 to adjust this setting to your needs.
3086
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003087- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003088 Maximum size of memory mapped by the startup code of
3089 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003090 the Linux kernel (bd_info, boot arguments, FDT blob if
3091 used) must be put below this limit, unless "bootm_low"
3092 enviroment variable is defined and non-zero. In such case
3093 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003094 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003095 variable "bootm_mapsize" will override the value of
3096 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3097 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003098
John Rigbyfca43cc2010-10-13 13:57:35 -06003099- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3100 Enable initrd_high functionality. If defined then the
3101 initrd_high feature is enabled and the bootm ramdisk subcommand
3102 is enabled.
3103
3104- CONFIG_SYS_BOOT_GET_CMDLINE:
3105 Enables allocating and saving kernel cmdline in space between
3106 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3107
3108- CONFIG_SYS_BOOT_GET_KBD:
3109 Enables allocating and saving a kernel copy of the bd_info in
3110 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003113 Max number of Flash memory banks
3114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003116 Max number of sectors on a Flash chip
3117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003118- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003119 Timeout for Flash erase operations (in ms)
3120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003121- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003122 Timeout for Flash write operations (in ms)
3123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003125 Timeout for Flash set sector lock bit operation (in ms)
3126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003127- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003128 Timeout for Flash clear lock bits operation (in ms)
3129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003130- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003131 If defined, hardware flash sectors protection is used
3132 instead of U-Boot software protection.
3133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003134- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003135
3136 Enable TFTP transfers directly to flash memory;
3137 without this option such a download has to be
3138 performed in two steps: (1) download to RAM, and (2)
3139 copy from RAM to flash.
3140
3141 The two-step approach is usually more reliable, since
3142 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003143 the flash, but in some situations (when system RAM is
3144 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003145 downloaded image) this option may be very useful.
3146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003147- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003148 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003149 common flash structure for storing flash geometry.
3150
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003151- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003152 This option also enables the building of the cfi_flash driver
3153 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003154
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003155- CONFIG_FLASH_CFI_MTD
3156 This option enables the building of the cfi_mtd driver
3157 in the drivers directory. The driver exports CFI flash
3158 to the MTD layer.
3159
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003160- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003161 Use buffered writes to flash.
3162
3163- CONFIG_FLASH_SPANSION_S29WS_N
3164 s29ws-n MirrorBit flash has non-standard addresses for buffered
3165 write commands.
3166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003167- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003168 If this option is defined, the common CFI flash doesn't
3169 print it's warning upon not recognized FLASH banks. This
3170 is useful, if some of the configured banks are only
3171 optionally available.
3172
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003173- CONFIG_FLASH_SHOW_PROGRESS
3174 If defined (must be an integer), print out countdown
3175 digits and dots. Recommended value: 45 (9..1) for 80
3176 column displays, 15 (3..1) for 40 column displays.
3177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003178- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003179 Defines the number of Ethernet receive buffers. On some
3180 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003181 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3182 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003183 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003184 Defaults to 4 if not defined.
3185
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003186- CONFIG_ENV_MAX_ENTRIES
3187
Wolfgang Denk071bc922010-10-27 22:48:30 +02003188 Maximum number of entries in the hash table that is used
3189 internally to store the environment settings. The default
3190 setting is supposed to be generous and should work in most
3191 cases. This setting can be used to tune behaviour; see
3192 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003193
Joe Hershberger25980902012-12-11 22:16:31 -06003194- CONFIG_ENV_FLAGS_LIST_DEFAULT
3195- CONFIG_ENV_FLAGS_LIST_STATIC
3196 Enable validation of the values given to enviroment variables when
3197 calling env set. Variables can be restricted to only decimal,
3198 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3199 the variables can also be restricted to IP address or MAC address.
3200
3201 The format of the list is:
3202 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003203 access_atribute = [a|r|o|c]
3204 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003205 entry = variable_name[:attributes]
3206 list = entry[,list]
3207
3208 The type attributes are:
3209 s - String (default)
3210 d - Decimal
3211 x - Hexadecimal
3212 b - Boolean ([1yYtT|0nNfF])
3213 i - IP address
3214 m - MAC address
3215
Joe Hershberger267541f2012-12-11 22:16:34 -06003216 The access attributes are:
3217 a - Any (default)
3218 r - Read-only
3219 o - Write-once
3220 c - Change-default
3221
Joe Hershberger25980902012-12-11 22:16:31 -06003222 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3223 Define this to a list (string) to define the ".flags"
3224 envirnoment variable in the default or embedded environment.
3225
3226 - CONFIG_ENV_FLAGS_LIST_STATIC
3227 Define this to a list (string) to define validation that
3228 should be done if an entry is not found in the ".flags"
3229 environment variable. To override a setting in the static
3230 list, simply add an entry for the same variable name to the
3231 ".flags" variable.
3232
Joe Hershberger267541f2012-12-11 22:16:34 -06003233- CONFIG_ENV_ACCESS_IGNORE_FORCE
3234 If defined, don't allow the -f switch to env set override variable
3235 access flags.
3236
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003237- CONFIG_SYS_GENERIC_BOARD
3238 This selects the architecture-generic board system instead of the
3239 architecture-specific board files. It is intended to move boards
3240 to this new framework over time. Defining this will disable the
3241 arch/foo/lib/board.c file and use common/board_f.c and
3242 common/board_r.c instead. To use this option your architecture
3243 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3244 its config.mk file). If you find problems enabling this option on
3245 your board please report the problem and send patches!
3246
Simon Glass632efa72013-03-11 07:06:48 +00003247- CONFIG_SYS_SYM_OFFSETS
3248 This is set by architectures that use offsets for link symbols
3249 instead of absolute values. So bss_start is obtained using an
3250 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3251 directly. You should not need to touch this setting.
3252
3253
wdenkc6097192002-11-03 00:24:07 +00003254The following definitions that deal with the placement and management
3255of environment data (variable area); in general, we support the
3256following configurations:
3257
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003258- CONFIG_BUILD_ENVCRC:
3259
3260 Builds up envcrc with the target environment so that external utils
3261 may easily extract it and embed it in final U-Boot images.
3262
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003263- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003264
3265 Define this if the environment is in flash memory.
3266
3267 a) The environment occupies one whole flash sector, which is
3268 "embedded" in the text segment with the U-Boot code. This
3269 happens usually with "bottom boot sector" or "top boot
3270 sector" type flash chips, which have several smaller
3271 sectors at the start or the end. For instance, such a
3272 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3273 such a case you would place the environment in one of the
3274 4 kB sectors - with U-Boot code before and after it. With
3275 "top boot sector" type flash chips, you would put the
3276 environment in one of the last sectors, leaving a gap
3277 between U-Boot and the environment.
3278
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003279 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003280
3281 Offset of environment data (variable area) to the
3282 beginning of flash memory; for instance, with bottom boot
3283 type flash chips the second sector can be used: the offset
3284 for this sector is given here.
3285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003286 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003287
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003288 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003289
3290 This is just another way to specify the start address of
3291 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003292 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003293
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003294 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003295
3296 Size of the sector containing the environment.
3297
3298
3299 b) Sometimes flash chips have few, equal sized, BIG sectors.
3300 In such a case you don't want to spend a whole sector for
3301 the environment.
3302
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003303 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003304
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003305 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003306 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003307 of this flash sector for the environment. This saves
3308 memory for the RAM copy of the environment.
3309
3310 It may also save flash memory if you decide to use this
3311 when your environment is "embedded" within U-Boot code,
3312 since then the remainder of the flash sector could be used
3313 for U-Boot code. It should be pointed out that this is
3314 STRONGLY DISCOURAGED from a robustness point of view:
3315 updating the environment in flash makes it always
3316 necessary to erase the WHOLE sector. If something goes
3317 wrong before the contents has been restored from a copy in
3318 RAM, your target system will be dead.
3319
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003320 - CONFIG_ENV_ADDR_REDUND
3321 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003322
wdenk43d96162003-03-06 00:02:04 +00003323 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003324 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003325 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003326 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003327
3328BE CAREFUL! Any changes to the flash layout, and some changes to the
3329source code will make it necessary to adapt <board>/u-boot.lds*
3330accordingly!
3331
3332
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003333- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003334
3335 Define this if you have some non-volatile memory device
3336 (NVRAM, battery buffered SRAM) which you want to use for the
3337 environment.
3338
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003339 - CONFIG_ENV_ADDR:
3340 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003341
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003342 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003343 want to use for environment. It is assumed that this memory
3344 can just be read and written to, without any special
3345 provision.
3346
3347BE CAREFUL! The first access to the environment happens quite early
3348in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003349console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003350U-Boot will hang.
3351
3352Please note that even with NVRAM we still use a copy of the
3353environment in RAM: we could work on NVRAM directly, but we want to
3354keep settings there always unmodified except somebody uses "saveenv"
3355to save the current settings.
3356
3357
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003358- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003359
3360 Use this if you have an EEPROM or similar serial access
3361 device and a driver for it.
3362
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003363 - CONFIG_ENV_OFFSET:
3364 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003365
3366 These two #defines specify the offset and size of the
3367 environment area within the total memory of your EEPROM.
3368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003369 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003370 If defined, specified the chip address of the EEPROM device.
3371 The default address is zero.
3372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003373 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003374 If defined, the number of bits used to address bytes in a
3375 single page in the EEPROM device. A 64 byte page, for example
3376 would require six bits.
3377
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003378 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003379 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003380 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003381
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003382 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003383 The length in bytes of the EEPROM memory array address. Note
3384 that this is NOT the chip address length!
3385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003386 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003387 EEPROM chips that implement "address overflow" are ones
3388 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3389 address and the extra bits end up in the "chip address" bit
3390 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3391 byte chips.
3392
3393 Note that we consider the length of the address field to
3394 still be one byte because the extra address bits are hidden
3395 in the chip address.
3396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003397 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003398 The size in bytes of the EEPROM device.
3399
Heiko Schocher548738b2010-01-07 08:55:40 +01003400 - CONFIG_ENV_EEPROM_IS_ON_I2C
3401 define this, if you have I2C and SPI activated, and your
3402 EEPROM, which holds the environment, is on the I2C bus.
3403
3404 - CONFIG_I2C_ENV_EEPROM_BUS
3405 if you have an Environment on an EEPROM reached over
3406 I2C muxes, you can define here, how to reach this
3407 EEPROM. For example:
3408
Wolfgang Denka9046b92010-06-13 17:48:15 +02003409 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003410
3411 EEPROM which holds the environment, is reached over
3412 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003413
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003414- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003415
wdenkd4ca31c2004-01-02 14:00:00 +00003416 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003417 want to use for the environment.
3418
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003419 - CONFIG_ENV_OFFSET:
3420 - CONFIG_ENV_ADDR:
3421 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003422
3423 These three #defines specify the offset and size of the
3424 environment area within the total memory of your DataFlash placed
3425 at the specified address.
3426
Liu Gang0a85a9e2012-03-08 00:33:20 +00003427- CONFIG_ENV_IS_IN_REMOTE:
3428
3429 Define this if you have a remote memory space which you
3430 want to use for the local device's environment.
3431
3432 - CONFIG_ENV_ADDR:
3433 - CONFIG_ENV_SIZE:
3434
3435 These two #defines specify the address and size of the
3436 environment area within the remote memory space. The
3437 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003438 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003439
3440BE CAREFUL! For some special cases, the local device can not use
3441"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003442environment stored in a remote NOR flash by SRIO or PCIE link,
3443but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003444
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003445- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003446
3447 Define this if you have a NAND device which you want to use
3448 for the environment.
3449
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003450 - CONFIG_ENV_OFFSET:
3451 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003452
3453 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003454 area within the first NAND device. CONFIG_ENV_OFFSET must be
3455 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003456
Scott Woodfdd813d2010-09-17 14:38:37 -05003457 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003458
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003459 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003460 size used to hold a redundant copy of the environment data, so
3461 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003462 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003463 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003464
Scott Woodfdd813d2010-09-17 14:38:37 -05003465 - CONFIG_ENV_RANGE (optional):
3466
3467 Specifies the length of the region in which the environment
3468 can be written. This should be a multiple of the NAND device's
3469 block size. Specifying a range with more erase blocks than
3470 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3471 the range to be avoided.
3472
3473 - CONFIG_ENV_OFFSET_OOB (optional):
3474
3475 Enables support for dynamically retrieving the offset of the
3476 environment from block zero's out-of-band data. The
3477 "nand env.oob" command can be used to record this offset.
3478 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3479 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003480
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003481- CONFIG_NAND_ENV_DST
3482
3483 Defines address in RAM to which the nand_spl code should copy the
3484 environment. If redundant environment is used, it will be copied to
3485 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003487- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003488
3489 Defines offset to the initial SPI buffer area in DPRAM. The
3490 area is used at an early stage (ROM part) if the environment
3491 is configured to reside in the SPI EEPROM: We need a 520 byte
3492 scratch DPRAM area. It is used between the two initialization
3493 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3494 to be a good choice since it makes it far enough from the
3495 start of the data area as well as from the stack pointer.
3496
Bruce Adlere881cb52007-11-02 13:15:42 -07003497Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003498has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003499created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003500until then to read environment variables.
3501
wdenk85ec0bc2003-03-31 16:34:49 +00003502The environment is protected by a CRC32 checksum. Before the monitor
3503is relocated into RAM, as a result of a bad CRC you will be working
3504with the compiled-in default environment - *silently*!!! [This is
3505necessary, because the first environment variable we need is the
3506"baudrate" setting for the console - if we have a bad CRC, we don't
3507have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003508
3509Note: once the monitor has been relocated, then it will complain if
3510the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003511use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003513- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003514 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003516 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003517 also needs to be defined.
3518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003519- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003520 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003521
Ron Madridf5675aa2009-02-18 14:30:44 -08003522- CONFIG_NS16550_MIN_FUNCTIONS:
3523 Define this if you desire to only have use of the NS16550_init
3524 and NS16550_putc functions for the serial driver located at
3525 drivers/serial/ns16550.c. This option is useful for saving
3526 space for already greatly restricted images, including but not
3527 limited to NAND_SPL configurations.
3528
Simon Glassb2b92f52012-11-30 13:01:18 +00003529- CONFIG_DISPLAY_BOARDINFO
3530 Display information about the board that U-Boot is running on
3531 when U-Boot starts up. The board function checkboard() is called
3532 to do this.
3533
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003534- CONFIG_DISPLAY_BOARDINFO_LATE
3535 Similar to the previous option, but display this information
3536 later, once stdio is running and output goes to the LCD, if
3537 present.
3538
wdenkc6097192002-11-03 00:24:07 +00003539Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003540---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003541
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003542- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003543 Cache Line Size of the CPU.
3544
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003545- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003546 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003547
wdenk42d1f032003-10-15 23:53:47 +00003548 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3549 and RPXsuper) to be able to adjust the position of
3550 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003551
Timur Tabie46fedf2011-08-04 18:03:41 -05003552- CONFIG_SYS_CCSRBAR_DEFAULT:
3553 Default (power-on reset) physical address of CCSR on Freescale
3554 PowerPC SOCs.
3555
3556- CONFIG_SYS_CCSRBAR:
3557 Virtual address of CCSR. On a 32-bit build, this is typically
3558 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3559
3560 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3561 for cross-platform code that uses that macro instead.
3562
3563- CONFIG_SYS_CCSRBAR_PHYS:
3564 Physical address of CCSR. CCSR can be relocated to a new
3565 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003566 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003567 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3568 is typically relocated on 36-bit builds. It is recommended
3569 that this macro be defined via the _HIGH and _LOW macros:
3570
3571 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3572 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3573
3574- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003575 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3576 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003577 used in assembly code, so it must not contain typecasts or
3578 integer size suffixes (e.g. "ULL").
3579
3580- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3581 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3582 used in assembly code, so it must not contain typecasts or
3583 integer size suffixes (e.g. "ULL").
3584
3585- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3586 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3587 forced to a value that ensures that CCSR is not relocated.
3588
wdenk7f6c2cb2002-11-10 22:06:23 +00003589- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003590 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003591
3592 the default drive number (default value 0)
3593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003594 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003595
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003596 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003597 (default value 1)
3598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003599 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003600
wdenk43d96162003-03-06 00:02:04 +00003601 defines the offset of register from address. It
3602 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003603 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003605 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3606 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003607 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003609 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003610 fdc_hw_init() is called at the beginning of the FDC
3611 setup. fdc_hw_init() must be provided by the board
3612 source code. It is used to make hardware dependant
3613 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003614
Macpaul Lin0abddf82011-04-11 20:45:32 +00003615- CONFIG_IDE_AHB:
3616 Most IDE controllers were designed to be connected with PCI
3617 interface. Only few of them were designed for AHB interface.
3618 When software is doing ATA command and data transfer to
3619 IDE devices through IDE-AHB controller, some additional
3620 registers accessing to these kind of IDE-AHB controller
3621 is requierd.
3622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003623- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003624 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003625 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003627- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk7152b1d2003-09-05 23:19:14 +00003629 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003630 initial data and stack; please note that this must be
3631 writable memory that is working WITHOUT special
3632 initialization, i. e. you CANNOT use normal RAM which
3633 will become available only after programming the
3634 memory controller and running certain initialization
3635 sequences.
3636
3637 U-Boot uses the following memory types:
3638 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3639 - MPC824X: data cache
3640 - PPC4xx: data cache
3641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003642- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003643
3644 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003645 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3646 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003647 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003648 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003649 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3650 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3651 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003652
3653 Note:
3654 On the MPC824X (or other systems that use the data
3655 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003656 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003657 point to an otherwise UNUSED address space between
3658 the top of RAM and the start of the PCI space.
3659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003660- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003662- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003663
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003664- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003665
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003666- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003668- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003670- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003672- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003673 SDRAM timing
3674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003675- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003676 periodic timer for refresh
3677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003678- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003680- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3681 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3682 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3683 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003684 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3685
3686- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003687 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3688 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003689 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003691- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3692 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003693 Machine Mode Register and Memory Periodic Timer
3694 Prescaler definitions (SDRAM timing)
3695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003696- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003697 enable I2C microcode relocation patch (MPC8xx);
3698 define relocation offset in DPRAM [DSP2]
3699
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003700- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003701 enable SMC microcode relocation patch (MPC8xx);
3702 define relocation offset in DPRAM [SMC1]
3703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003704- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003705 enable SPI microcode relocation patch (MPC8xx);
3706 define relocation offset in DPRAM [SCC4]
3707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003708- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003709 Use OSCM clock mode on MBX8xx board. Be careful,
3710 wrong setting might damage your board. Read
3711 doc/README.MBX before setting this variable!
3712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003713- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003714 Offset of the bootmode word in DPRAM used by post
3715 (Power On Self Tests). This definition overrides
3716 #define'd default value in commproc.h resp.
3717 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003719- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3720 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3721 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3722 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3723 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3724 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3725 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3726 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003727 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003728
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003729- CONFIG_PCI_DISABLE_PCIE:
3730 Disable PCI-Express on systems where it is supported but not
3731 required.
3732
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003733- CONFIG_PCI_ENUM_ONLY
3734 Only scan through and get the devices on the busses.
3735 Don't do any setup work, presumably because someone or
3736 something has already done it, and we don't need to do it
3737 a second time. Useful for platforms that are pre-booted
3738 by coreboot or similar.
3739
Kumar Galaa09b9b62010-12-30 12:09:53 -06003740- CONFIG_SYS_SRIO:
3741 Chip has SRIO or not
3742
3743- CONFIG_SRIO1:
3744 Board has SRIO 1 port available
3745
3746- CONFIG_SRIO2:
3747 Board has SRIO 2 port available
3748
3749- CONFIG_SYS_SRIOn_MEM_VIRT:
3750 Virtual Address of SRIO port 'n' memory region
3751
3752- CONFIG_SYS_SRIOn_MEM_PHYS:
3753 Physical Address of SRIO port 'n' memory region
3754
3755- CONFIG_SYS_SRIOn_MEM_SIZE:
3756 Size of SRIO port 'n' memory region
3757
Fabio Estevam66bd1842013-04-11 09:35:34 +00003758- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3759 Defined to tell the NAND controller that the NAND chip is using
3760 a 16 bit bus.
3761 Not all NAND drivers use this symbol.
3762 Example of driver that uses it:
3763 - drivers/mtd/nand/ndfc.c
Alex Watermaneced4622011-05-19 15:08:36 -04003764
3765- CONFIG_SYS_NDFC_EBC0_CFG
3766 Sets the EBC0_CFG register for the NDFC. If not defined
3767 a default value will be used.
3768
Ben Warrenbb99ad62006-09-07 16:50:54 -04003769- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003770 Get DDR timing information from an I2C EEPROM. Common
3771 with pluggable memory modules such as SODIMMs
3772
Ben Warrenbb99ad62006-09-07 16:50:54 -04003773 SPD_EEPROM_ADDRESS
3774 I2C address of the SPD EEPROM
3775
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003776- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003777 If SPD EEPROM is on an I2C bus other than the first
3778 one, specify here. Note that the value must resolve
3779 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003780
York Sun1b3e3c42011-06-07 09:42:16 +08003781- CONFIG_SYS_DDR_RAW_TIMING
3782 Get DDR timing information from other than SPD. Common with
3783 soldered DDR chips onboard without SPD. DDR raw timing
3784 parameters are extracted from datasheet and hard-coded into
3785 header files or board specific files.
3786
York Sun6f5e1dc2011-09-16 13:21:35 -07003787- CONFIG_FSL_DDR_INTERACTIVE
3788 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003790- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003791 Only for 83xx systems. If specified, then DDR should
3792 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003793
wdenkc26e4542004-04-18 10:13:26 +00003794- CONFIG_ETHER_ON_FEC[12]
3795 Define to enable FEC[12] on a 8xx series processor.
3796
3797- CONFIG_FEC[12]_PHY
3798 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003799 to the given FEC; i. e.
3800 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003801 means that the PHY with address 4 is connected to FEC1
3802
3803 When set to -1, means to probe for first available.
3804
3805- CONFIG_FEC[12]_PHY_NORXERR
3806 The PHY does not have a RXERR line (RMII only).
3807 (so program the FEC to ignore it).
3808
3809- CONFIG_RMII
3810 Enable RMII mode for all FECs.
3811 Note that this is a global option, we can't
3812 have one FEC in standard MII mode and another in RMII mode.
3813
wdenk5cf91d62004-04-23 20:32:05 +00003814- CONFIG_CRC32_VERIFY
3815 Add a verify option to the crc32 command.
3816 The syntax is:
3817
3818 => crc32 -v <address> <count> <crc32>
3819
3820 Where address/count indicate a memory area
3821 and crc32 is the correct crc32 which the
3822 area should have.
3823
wdenk56523f12004-07-11 17:40:54 +00003824- CONFIG_LOOPW
3825 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003826 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003827
stroese7b466642004-12-16 18:46:55 +00003828- CONFIG_MX_CYCLIC
3829 Add the "mdc" and "mwc" memory commands. These are cyclic
3830 "md/mw" commands.
3831 Examples:
3832
wdenkefe2a4d2004-12-16 21:44:03 +00003833 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003834 This command will print 4 bytes (10,11,12,13) each 500 ms.
3835
wdenkefe2a4d2004-12-16 21:44:03 +00003836 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003837 This command will write 12345678 to address 100 all 10 ms.
3838
wdenkefe2a4d2004-12-16 21:44:03 +00003839 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003840 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003841
wdenk8aa1a2d2005-04-04 12:44:11 +00003842- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003843 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003844 low level initializations (like setting up the memory
3845 controller) are omitted and/or U-Boot does not
3846 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003847
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003848 Normally this variable MUST NOT be defined. The only
3849 exception is when U-Boot is loaded (to RAM) by some
3850 other boot loader or by a debugger which performs
3851 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003852
Aneesh V401bb302011-07-13 05:11:07 +00003853- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003854 Modifies the behaviour of start.S when compiling a loader
3855 that is executed before the actual U-Boot. E.g. when
3856 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003857
Simon Glass4213fc22013-02-24 17:33:14 +00003858- CONFIG_ARCH_MAP_SYSMEM
3859 Generally U-Boot (and in particular the md command) uses
3860 effective address. It is therefore not necessary to regard
3861 U-Boot address as virtual addresses that need to be translated
3862 to physical addresses. However, sandbox requires this, since
3863 it maintains its own little RAM buffer which contains all
3864 addressable memory. This option causes some memory accesses
3865 to be mapped through map_sysmem() / unmap_sysmem().
3866
Matthias Weisserd8834a12011-03-10 21:36:32 +00003867- CONFIG_USE_ARCH_MEMCPY
3868 CONFIG_USE_ARCH_MEMSET
3869 If these options are used a optimized version of memcpy/memset will
3870 be used if available. These functions may be faster under some
3871 conditions but may increase the binary size.
3872
Simon Glass588a13f2013-02-14 04:18:54 +00003873- CONFIG_X86_RESET_VECTOR
3874 If defined, the x86 reset vector code is included. This is not
3875 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00003876
Mark Jacksonfc337052013-03-04 01:27:20 +00003877- CONFIG_SYS_MPUCLK
3878 Defines the MPU clock speed (in MHz).
3879
3880 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00003881
Timur Tabif2717b42011-11-22 09:21:25 -06003882Freescale QE/FMAN Firmware Support:
3883-----------------------------------
3884
3885The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3886loading of "firmware", which is encoded in the QE firmware binary format.
3887This firmware often needs to be loaded during U-Boot booting, so macros
3888are used to identify the storage device (NOR flash, SPI, etc) and the address
3889within that device.
3890
3891- CONFIG_SYS_QE_FMAN_FW_ADDR
3892 The address in the storage device where the firmware is located. The
3893 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3894 is also specified.
3895
3896- CONFIG_SYS_QE_FMAN_FW_LENGTH
3897 The maximum possible size of the firmware. The firmware binary format
3898 has a field that specifies the actual size of the firmware, but it
3899 might not be possible to read any part of the firmware unless some
3900 local storage is allocated to hold the entire firmware first.
3901
3902- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3903 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3904 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3905 virtual address in NOR flash.
3906
3907- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3908 Specifies that QE/FMAN firmware is located in NAND flash.
3909 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3910
3911- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3912 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3913 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3914
3915- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3916 Specifies that QE/FMAN firmware is located on the primary SPI
3917 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3918
Liu Gang292dc6c2012-03-08 00:33:18 +00003919- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3920 Specifies that QE/FMAN firmware is located in the remote (master)
3921 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003922 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3923 window->master inbound window->master LAW->the ucode address in
3924 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003925
wdenkc6097192002-11-03 00:24:07 +00003926Building the Software:
3927======================
3928
Wolfgang Denk218ca722008-03-26 10:40:12 +01003929Building U-Boot has been tested in several native build environments
3930and in many different cross environments. Of course we cannot support
3931all possibly existing versions of cross development tools in all
3932(potentially obsolete) versions. In case of tool chain problems we
3933recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3934which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003935
Wolfgang Denk218ca722008-03-26 10:40:12 +01003936If you are not using a native environment, it is assumed that you
3937have GNU cross compiling tools available in your path. In this case,
3938you must set the environment variable CROSS_COMPILE in your shell.
3939Note that no changes to the Makefile or any other source files are
3940necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003941
Wolfgang Denk218ca722008-03-26 10:40:12 +01003942 $ CROSS_COMPILE=ppc_4xx-
3943 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003944
Peter Tyser2f8d3962009-03-13 18:54:51 -05003945Note: If you wish to generate Windows versions of the utilities in
3946 the tools directory you can use the MinGW toolchain
3947 (http://www.mingw.org). Set your HOST tools to the MinGW
3948 toolchain and execute 'make tools'. For example:
3949
3950 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3951
3952 Binaries such as tools/mkimage.exe will be created which can
3953 be executed on computers running Windows.
3954
Wolfgang Denk218ca722008-03-26 10:40:12 +01003955U-Boot is intended to be simple to build. After installing the
3956sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003957is done by typing:
3958
3959 make NAME_config
3960
Wolfgang Denk218ca722008-03-26 10:40:12 +01003961where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003962rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003963
wdenk2729af92004-05-03 20:45:30 +00003964Note: for some board special configuration names may exist; check if
3965 additional information is available from the board vendor; for
3966 instance, the TQM823L systems are available without (standard)
3967 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003968 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970 make TQM823L_config
3971 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 make TQM823L_LCD_config
3974 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976 etc.
wdenkc6097192002-11-03 00:24:07 +00003977
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979Finally, type "make all", and you should get some working U-Boot
3980images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk2729af92004-05-03 20:45:30 +00003982- "u-boot.bin" is a raw binary image
3983- "u-boot" is an image in ELF binary format
3984- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003985
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003986By default the build is performed locally and the objects are saved
3987in the source directory. One of the two methods can be used to change
3988this behavior and build U-Boot to some external directory:
3989
39901. Add O= to the make command line invocations:
3991
3992 make O=/tmp/build distclean
3993 make O=/tmp/build NAME_config
3994 make O=/tmp/build all
3995
39962. Set environment variable BUILD_DIR to point to the desired location:
3997
3998 export BUILD_DIR=/tmp/build
3999 make distclean
4000 make NAME_config
4001 make all
4002
4003Note that the command line "O=" setting overrides the BUILD_DIR environment
4004variable.
4005
wdenkc6097192002-11-03 00:24:07 +00004006
wdenk2729af92004-05-03 20:45:30 +00004007Please be aware that the Makefiles assume you are using GNU make, so
4008for instance on NetBSD you might need to use "gmake" instead of
4009native "make".
wdenkc6097192002-11-03 00:24:07 +00004010
wdenkc6097192002-11-03 00:24:07 +00004011
wdenk2729af92004-05-03 20:45:30 +00004012If the system board that you have is not listed, then you will need
4013to port U-Boot to your hardware platform. To do this, follow these
4014steps:
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk2729af92004-05-03 20:45:30 +000040161. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004017 "boards.cfg" file, using the existing entries as examples.
4018 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000040192. Create a new directory to hold your board specific code. Add any
4020 files you need. In your board directory, you will need at least
4021 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
40223. Create a new configuration file "include/configs/<board>.h" for
4023 your board
40243. If you're porting U-Boot to a new CPU, then also create a new
4025 directory to hold your CPU specific code. Add any files you need.
40264. Run "make <board>_config" with your new name.
40275. Type "make", and you should get a working "u-boot.srec" file
4028 to be installed on your target system.
40296. Debug and solve any problems that might arise.
4030 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004031
wdenkc6097192002-11-03 00:24:07 +00004032
wdenk2729af92004-05-03 20:45:30 +00004033Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4034==============================================================
wdenkc6097192002-11-03 00:24:07 +00004035
Wolfgang Denk218ca722008-03-26 10:40:12 +01004036If you have modified U-Boot sources (for instance added a new board
4037or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004038provide feedback to the other developers. The feedback normally takes
4039the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004040official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004041
Wolfgang Denk218ca722008-03-26 10:40:12 +01004042But before you submit such a patch, please verify that your modifi-
4043cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004044the supported boards compile WITHOUT ANY compiler warnings. To do so,
4045just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004046for ALL supported system. Be warned, this will take a while. You can
4047select which (cross) compiler to use by passing a `CROSS_COMPILE'
4048environment variable to the script, i. e. to use the ELDK cross tools
4049you can type
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004052
wdenk2729af92004-05-03 20:45:30 +00004053or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004056
Wolfgang Denk218ca722008-03-26 10:40:12 +01004057When using the MAKEALL script, the default behaviour is to build
4058U-Boot in the source directory. This location can be changed by
4059setting the BUILD_DIR environment variable. Also, for each target
4060built, the MAKEALL script saves two log files (<target>.ERR and
4061<target>.MAKEALL) in the <source dir>/LOG directory. This default
4062location can be changed by setting the MAKEALL_LOGDIR environment
4063variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004064
4065 export BUILD_DIR=/tmp/build
4066 export MAKEALL_LOGDIR=/tmp/log
4067 CROSS_COMPILE=ppc_8xx- MAKEALL
4068
Wolfgang Denk218ca722008-03-26 10:40:12 +01004069With the above settings build objects are saved in the /tmp/build,
4070log files are saved in the /tmp/log and the source tree remains clean
4071during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004072
4073
wdenk2729af92004-05-03 20:45:30 +00004074See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004075
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077Monitor Commands - Overview:
4078============================
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080go - start application at address 'addr'
4081run - run commands in an environment variable
4082bootm - boot application image from memory
4083bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004084bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004085tftpboot- boot image via network using TFTP protocol
4086 and env variables "ipaddr" and "serverip"
4087 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004088tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004089rarpboot- boot image via network using RARP/TFTP protocol
4090diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4091loads - load S-Record file over serial line
4092loadb - load binary file over serial line (kermit mode)
4093md - memory display
4094mm - memory modify (auto-incrementing)
4095nm - memory modify (constant address)
4096mw - memory write (fill)
4097cp - memory copy
4098cmp - memory compare
4099crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004100i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004101sspi - SPI utility commands
4102base - print or set address offset
4103printenv- print environment variables
4104setenv - set environment variables
4105saveenv - save environment variables to persistent storage
4106protect - enable or disable FLASH write protection
4107erase - erase FLASH memory
4108flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004109nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004110bdinfo - print Board Info structure
4111iminfo - print header information for application image
4112coninfo - print console devices and informations
4113ide - IDE sub-system
4114loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004115loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004116mtest - simple RAM test
4117icache - enable or disable instruction cache
4118dcache - enable or disable data cache
4119reset - Perform RESET of the CPU
4120echo - echo args to console
4121version - print monitor version
4122help - print online help
4123? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004124
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126Monitor Commands - Detailed Description:
4127========================================
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk2729af92004-05-03 20:45:30 +00004129TODO.
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004132
4133
wdenk2729af92004-05-03 20:45:30 +00004134Environment Variables:
4135======================
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137U-Boot supports user configuration using Environment Variables which
4138can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140Environment Variables are set using "setenv", printed using
4141"printenv", and saved to Flash using "saveenv". Using "setenv"
4142without a value can be used to delete a variable from the
4143environment. As long as you don't save the environment you are
4144working with an in-memory copy. In case the Flash area containing the
4145environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004146
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004147Some configuration options can be set using Environment Variables.
4148
4149List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004150
wdenk2729af92004-05-03 20:45:30 +00004151 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004152
wdenk2729af92004-05-03 20:45:30 +00004153 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004160
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004161 bootm_low - Memory range available for image processing in the bootm
4162 command can be restricted. This variable is given as
4163 a hexadecimal number and defines lowest address allowed
4164 for use by the bootm command. See also "bootm_size"
4165 environment variable. Address defined by "bootm_low" is
4166 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004167 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4168 bootm_mapsize.
4169
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004170 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004171 This variable is given as a hexadecimal number and it
4172 defines the size of the memory region starting at base
4173 address bootm_low that is accessible by the Linux kernel
4174 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4175 as the default value if it is defined, and bootm_size is
4176 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004177
4178 bootm_size - Memory range available for image processing in the bootm
4179 command can be restricted. This variable is given as
4180 a hexadecimal number and defines the size of the region
4181 allowed for use by the bootm command. See also "bootm_low"
4182 environment variable.
4183
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004184 updatefile - Location of the software update file on a TFTP server, used
4185 by the automatic software update feature. Please refer to
4186 documentation in doc/README.update for more details.
4187
wdenk2729af92004-05-03 20:45:30 +00004188 autoload - if set to "no" (any string beginning with 'n'),
4189 "bootp" will just load perform a lookup of the
4190 configuration from the BOOTP server, but not try to
4191 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193 autostart - if set to "yes", an image loaded using the "bootp",
4194 "rarpboot", "tftpboot" or "diskboot" commands will
4195 be automatically started (by internally calling
4196 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198 If set to "no", a standalone image passed to the
4199 "bootm" command will be copied to the load address
4200 (and eventually uncompressed), but NOT be started.
4201 This can be used to load and uncompress arbitrary
4202 data.
wdenkc6097192002-11-03 00:24:07 +00004203
David A. Longa28afca2011-07-09 16:40:19 -04004204 fdt_high - if set this restricts the maximum address that the
4205 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004206 For example, if you have a system with 1 GB memory
4207 at physical address 0x10000000, while Linux kernel
4208 only recognizes the first 704 MB as low memory, you
4209 may need to set fdt_high as 0x3C000000 to have the
4210 device tree blob be copied to the maximum address
4211 of the 704 MB low memory, so that Linux kernel can
4212 access it during the boot procedure.
4213
David A. Longa28afca2011-07-09 16:40:19 -04004214 If this is set to the special value 0xFFFFFFFF then
4215 the fdt will not be copied at all on boot. For this
4216 to work it must reside in writable memory, have
4217 sufficient padding on the end of it for u-boot to
4218 add the information it needs into it, and the memory
4219 must be accessible by the kernel.
4220
Simon Glasseea63e02011-10-24 19:15:34 +00004221 fdtcontroladdr- if set this is the address of the control flattened
4222 device tree used by U-Boot when CONFIG_OF_CONTROL is
4223 defined.
4224
wdenk17ea1172004-06-06 21:51:03 +00004225 i2cfast - (PPC405GP|PPC405EP only)
4226 if set to 'y' configures Linux I2C driver for fast
4227 mode (400kHZ). This environment variable is used in
4228 initialization code. So, for changes to be effective
4229 it must be saved and board must be reset.
4230
wdenk2729af92004-05-03 20:45:30 +00004231 initrd_high - restrict positioning of initrd images:
4232 If this variable is not set, initrd images will be
4233 copied to the highest possible address in RAM; this
4234 is usually what you want since it allows for
4235 maximum initrd size. If for some reason you want to
4236 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004237 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004238 variable to a value of "no" or "off" or "0".
4239 Alternatively, you can set it to a maximum upper
4240 address to use (U-Boot will still check that it
4241 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243 For instance, when you have a system with 16 MB
4244 RAM, and want to reserve 4 MB from use by Linux,
4245 you can do this by adding "mem=12M" to the value of
4246 the "bootargs" variable. However, now you must make
4247 sure that the initrd image is placed in the first
4248 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk2729af92004-05-03 20:45:30 +00004252 If you set initrd_high to 0xFFFFFFFF, this is an
4253 indication to U-Boot that all addresses are legal
4254 for the Linux kernel, including addresses in flash
4255 memory. In this case U-Boot will NOT COPY the
4256 ramdisk at all. This may be useful to reduce the
4257 boot time on your system, but requires that this
4258 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004259
wdenk2729af92004-05-03 20:45:30 +00004260 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk2729af92004-05-03 20:45:30 +00004262 loadaddr - Default load address for commands like "bootp",
4263 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk2729af92004-05-03 20:45:30 +00004271 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004274
Mike Frysingere2a53452011-10-02 10:01:27 +00004275 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004276
Mike Frysingere2a53452011-10-02 10:01:27 +00004277 ethact - controls which interface is currently active.
4278 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004279
Heiko Schocher48690d82010-07-20 17:45:02 +02004280 => setenv ethact FEC
4281 => ping 192.168.0.1 # traffic sent on FEC
4282 => setenv ethact SCC
4283 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004284
Matthias Fuchse1692572008-01-17 07:45:05 +01004285 ethrotate - When set to "no" U-Boot does not go through all
4286 available network interfaces.
4287 It just stays at the currently selected interface.
4288
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004289 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004290 either succeed or fail without retrying.
4291 When set to "once" the network operation will
4292 fail when all the available network interfaces
4293 are tried once without success.
4294 Useful on scripts which control the retry operation
4295 themselves.
wdenkc6097192002-11-03 00:24:07 +00004296
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004297 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004298
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004299 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004300 UDP source port.
4301
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004302 tftpdstport - If this is set, the value is used for TFTP's UDP
4303 destination port instead of the Well Know Port 69.
4304
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004305 tftpblocksize - Block size to use for TFTP transfers; if not set,
4306 we use the TFTP server's default block size
4307
4308 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4309 seconds, minimum value is 1000 = 1 second). Defines
4310 when a packet is considered to be lost so it has to
4311 be retransmitted. The default is 5000 = 5 seconds.
4312 Lowering this value may make downloads succeed
4313 faster in networks with high packet loss rates or
4314 with unreliable TFTP servers.
4315
4316 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004317 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004318 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004319
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004320The following image location variables contain the location of images
4321used in booting. The "Image" column gives the role of the image and is
4322not an environment variable name. The other columns are environment
4323variable names. "File Name" gives the name of the file on a TFTP
4324server, "RAM Address" gives the location in RAM the image will be
4325loaded to, and "Flash Location" gives the image's address in NOR
4326flash or offset in NAND flash.
4327
4328*Note* - these variables don't have to be defined for all boards, some
4329boards currenlty use other variables for these purposes, and some
4330boards use these variables for other purposes.
4331
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004332Image File Name RAM Address Flash Location
4333----- --------- ----------- --------------
4334u-boot u-boot u-boot_addr_r u-boot_addr
4335Linux kernel bootfile kernel_addr_r kernel_addr
4336device tree blob fdtfile fdt_addr_r fdt_addr
4337ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339The following environment variables may be used and automatically
4340updated by the network boot commands ("bootp" and "rarpboot"),
4341depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343 bootfile - see above
4344 dnsip - IP address of your Domain Name Server
4345 dnsip2 - IP address of your secondary Domain Name Server
4346 gatewayip - IP address of the Gateway (Router) to use
4347 hostname - Target hostname
4348 ipaddr - see above
4349 netmask - Subnet Mask
4350 rootpath - Pathname of the root filesystem on the NFS server
4351 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004352
wdenka3d991b2004-04-15 21:48:45 +00004353
wdenk2729af92004-05-03 20:45:30 +00004354There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356 serial# - contains hardware identification information such
4357 as type string and/or serial number
4358 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360These variables can be set only once (usually during manufacturing of
4361the board). U-Boot refuses to delete or overwrite these variables
4362once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004363
4364
wdenk2729af92004-05-03 20:45:30 +00004365Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk2729af92004-05-03 20:45:30 +00004367 ver - Contains the U-Boot version string as printed
4368 with the "version" command. This variable is
4369 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004370
wdenkc6097192002-11-03 00:24:07 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372Please note that changes to some configuration parameters may take
4373only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004374
stroesec1551ea2003-04-04 15:53:41 +00004375
Joe Hershberger170ab112012-12-11 22:16:24 -06004376Callback functions for environment variables:
4377---------------------------------------------
4378
4379For some environment variables, the behavior of u-boot needs to change
4380when their values are changed. This functionailty allows functions to
4381be associated with arbitrary variables. On creation, overwrite, or
4382deletion, the callback will provide the opportunity for some side
4383effect to happen or for the change to be rejected.
4384
4385The callbacks are named and associated with a function using the
4386U_BOOT_ENV_CALLBACK macro in your board or driver code.
4387
4388These callbacks are associated with variables in one of two ways. The
4389static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4390in the board configuration to a string that defines a list of
4391associations. The list must be in the following format:
4392
4393 entry = variable_name[:callback_name]
4394 list = entry[,list]
4395
4396If the callback name is not specified, then the callback is deleted.
4397Spaces are also allowed anywhere in the list.
4398
4399Callbacks can also be associated by defining the ".callbacks" variable
4400with the same list format above. Any association in ".callbacks" will
4401override any association in the static list. You can define
4402CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4403".callbacks" envirnoment variable in the default or embedded environment.
4404
4405
wdenk2729af92004-05-03 20:45:30 +00004406Command Line Parsing:
4407=====================
stroesec1551ea2003-04-04 15:53:41 +00004408
wdenk2729af92004-05-03 20:45:30 +00004409There are two different command line parsers available with U-Boot:
4410the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004411
wdenk2729af92004-05-03 20:45:30 +00004412Old, simple command line parser:
4413--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004414
wdenk2729af92004-05-03 20:45:30 +00004415- supports environment variables (through setenv / saveenv commands)
4416- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004417- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004418- special characters ('$', ';') can be escaped by prefixing with '\',
4419 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004420 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004421- You can also escape text by enclosing in single apostrophes, for example:
4422 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424Hush shell:
4425-----------
wdenkf07771c2003-05-28 08:06:31 +00004426
wdenk2729af92004-05-03 20:45:30 +00004427- similar to Bourne shell, with control structures like
4428 if...then...else...fi, for...do...done; while...do...done,
4429 until...do...done, ...
4430- supports environment ("global") variables (through setenv / saveenv
4431 commands) and local shell variables (through standard shell syntax
4432 "name=value"); only environment variables can be used with "run"
4433 command
wdenkf07771c2003-05-28 08:06:31 +00004434
wdenk2729af92004-05-03 20:45:30 +00004435General rules:
4436--------------
wdenkf07771c2003-05-28 08:06:31 +00004437
wdenk2729af92004-05-03 20:45:30 +00004438(1) If a command line (or an environment variable executed by a "run"
4439 command) contains several commands separated by semicolon, and
4440 one of these commands fails, then the remaining commands will be
4441 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004442
wdenk2729af92004-05-03 20:45:30 +00004443(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004444 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004445 command will cause "run" to terminate, i. e. the remaining
4446 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448Note for Redundant Ethernet Interfaces:
4449=======================================
wdenkf07771c2003-05-28 08:06:31 +00004450
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004451Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004452such configurations and is capable of automatic selection of a
4453"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4456MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4457"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459If the network interface stores some valid MAC address (for instance
4460in SROM), this is used as default address if there is NO correspon-
4461ding setting in the environment; if the corresponding environment
4462variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464o If the SROM has a valid MAC address, and there is no address in the
4465 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467o If there is no valid address in the SROM, and a definition in the
4468 environment exists, then the value from the environment variable is
4469 used.
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk2729af92004-05-03 20:45:30 +00004471o If both the SROM and the environment contain a MAC address, and
4472 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk2729af92004-05-03 20:45:30 +00004474o If both the SROM and the environment contain a MAC address, and the
4475 addresses differ, the value from the environment is used and a
4476 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk2729af92004-05-03 20:45:30 +00004478o If neither SROM nor the environment contain a MAC address, an error
4479 is raised.
wdenkc6097192002-11-03 00:24:07 +00004480
Ben Warrenecee9322010-04-26 11:11:46 -07004481If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004482will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004483may be skipped by setting the appropriate 'ethmacskip' environment variable.
4484The naming convention is as follows:
4485"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk2729af92004-05-03 20:45:30 +00004487Image Formats:
4488==============
wdenkc6097192002-11-03 00:24:07 +00004489
Marian Balakowicz3310c542008-03-12 12:13:13 +01004490U-Boot is capable of booting (and performing other auxiliary operations on)
4491images in two formats:
4492
4493New uImage format (FIT)
4494-----------------------
4495
4496Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4497to Flattened Device Tree). It allows the use of images with multiple
4498components (several kernels, ramdisks, etc.), with contents protected by
4499SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4500
4501
4502Old uImage format
4503-----------------
4504
4505Old image format is based on binary files which can be basically anything,
4506preceded by a special header; see the definitions in include/image.h for
4507details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4510 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004511 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4512 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4513 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004514* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004515 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4516 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004517* Compression Type (uncompressed, gzip, bzip2)
4518* Load Address
4519* Entry Point
4520* Image Name
4521* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk2729af92004-05-03 20:45:30 +00004523The header is marked by a special Magic Number, and both the header
4524and the data portions of the image are secured against corruption by
4525CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004526
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk2729af92004-05-03 20:45:30 +00004528Linux Support:
4529==============
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk2729af92004-05-03 20:45:30 +00004531Although U-Boot should support any OS or standalone application
4532easily, the main focus has always been on Linux during the design of
4533U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk2729af92004-05-03 20:45:30 +00004535U-Boot includes many features that so far have been part of some
4536special "boot loader" code within the Linux kernel. Also, any
4537"initrd" images to be used are no longer part of one big Linux image;
4538instead, kernel and "initrd" are separate images. This implementation
4539serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541- the same features can be used for other OS or standalone
4542 applications (for instance: using compressed images to reduce the
4543 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk2729af92004-05-03 20:45:30 +00004545- it becomes much easier to port new Linux kernel versions because
4546 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004547
wdenk2729af92004-05-03 20:45:30 +00004548- the same Linux kernel image can now be used with different "initrd"
4549 images; of course this also means that different kernel images can
4550 be run with the same "initrd". This makes testing easier (you don't
4551 have to build a new "zImage.initrd" Linux image when you just
4552 change a file in your "initrd"). Also, a field-upgrade of the
4553 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004554
wdenkc6097192002-11-03 00:24:07 +00004555
wdenk2729af92004-05-03 20:45:30 +00004556Linux HOWTO:
4557============
wdenkc6097192002-11-03 00:24:07 +00004558
wdenk2729af92004-05-03 20:45:30 +00004559Porting Linux to U-Boot based systems:
4560---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004561
wdenk2729af92004-05-03 20:45:30 +00004562U-Boot cannot save you from doing all the necessary modifications to
4563configure the Linux device drivers for use with your target hardware
4564(no, we don't intend to provide a full virtual machine interface to
4565Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004566
Stefan Roesea47a12b2010-04-15 16:07:28 +02004567But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569Just make sure your machine specific header file (for instance
4570include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004571Information structure as we define in include/asm-<arch>/u-boot.h,
4572and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004573as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004574
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk2729af92004-05-03 20:45:30 +00004576Configuring the Linux kernel:
4577-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk2729af92004-05-03 20:45:30 +00004579No specific requirements for U-Boot. Make sure you have some root
4580device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004581
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583Building a Linux Image:
4584-----------------------
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk2729af92004-05-03 20:45:30 +00004586With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4587not used. If you use recent kernel source, a new build target
4588"uImage" will exist which automatically builds an image usable by
4589U-Boot. Most older kernels also have support for a "pImage" target,
4590which was introduced for our predecessor project PPCBoot and uses a
4591100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593Example:
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk2729af92004-05-03 20:45:30 +00004595 make TQM850L_config
4596 make oldconfig
4597 make dep
4598 make uImage
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600The "uImage" build target uses a special tool (in 'tools/mkimage') to
4601encapsulate a compressed Linux kernel image with header information,
4602CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004603
wdenk2729af92004-05-03 20:45:30 +00004604* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608 ${CROSS_COMPILE}-objcopy -O binary \
4609 -R .note -R .comment \
4610 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk2729af92004-05-03 20:45:30 +00004614 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk2729af92004-05-03 20:45:30 +00004616* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004617
wdenk2729af92004-05-03 20:45:30 +00004618 mkimage -A ppc -O linux -T kernel -C gzip \
4619 -a 0 -e 0 -n "Linux Kernel Image" \
4620 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004621
wdenk24ee89b2002-11-03 17:56:27 +00004622
wdenk2729af92004-05-03 20:45:30 +00004623The "mkimage" tool can also be used to create ramdisk images for use
4624with U-Boot, either separated from the Linux kernel image, or
4625combined into one file. "mkimage" encapsulates the images with a 64
4626byte header containing information about target architecture,
4627operating system, image type, compression method, entry points, time
4628stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630"mkimage" can be called in two ways: to verify existing images and
4631print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633In the first form (with "-l" option) mkimage lists the information
4634contained in the header of an existing U-Boot image; this includes
4635checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004636
wdenk2729af92004-05-03 20:45:30 +00004637 tools/mkimage -l image
4638 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004639
wdenk2729af92004-05-03 20:45:30 +00004640The second form (with "-d" option) is used to build a U-Boot image
4641from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4644 -n name -d data_file image
4645 -A ==> set architecture to 'arch'
4646 -O ==> set operating system to 'os'
4647 -T ==> set image type to 'type'
4648 -C ==> set compression type 'comp'
4649 -a ==> set load address to 'addr' (hex)
4650 -e ==> set entry point to 'ep' (hex)
4651 -n ==> set image name to 'name'
4652 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004653
wdenk69459792004-05-29 16:53:29 +00004654Right now, all Linux kernels for PowerPC systems use the same load
4655address (0x00000000), but the entry point address depends on the
4656kernel version:
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk2729af92004-05-03 20:45:30 +00004658- 2.2.x kernels have the entry point at 0x0000000C,
4659- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk2729af92004-05-03 20:45:30 +00004661So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4664 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004665 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004666 > examples/uImage.TQM850L
4667 Image Name: 2.4.4 kernel for TQM850L
4668 Created: Wed Jul 19 02:34:59 2000
4669 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4670 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4671 Load Address: 0x00000000
4672 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk2729af92004-05-03 20:45:30 +00004674To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk2729af92004-05-03 20:45:30 +00004676 -> tools/mkimage -l examples/uImage.TQM850L
4677 Image Name: 2.4.4 kernel for TQM850L
4678 Created: Wed Jul 19 02:34:59 2000
4679 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4680 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4681 Load Address: 0x00000000
4682 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004683
wdenk2729af92004-05-03 20:45:30 +00004684NOTE: for embedded systems where boot time is critical you can trade
4685speed for memory and install an UNCOMPRESSED image instead: this
4686needs more space in Flash, but boots much faster since it does not
4687need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004688
Stefan Roesea47a12b2010-04-15 16:07:28 +02004689 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004690 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4691 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004692 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004693 > examples/uImage.TQM850L-uncompressed
4694 Image Name: 2.4.4 kernel for TQM850L
4695 Created: Wed Jul 19 02:34:59 2000
4696 Image Type: PowerPC Linux Kernel Image (uncompressed)
4697 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4698 Load Address: 0x00000000
4699 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004700
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4703when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004704
wdenk2729af92004-05-03 20:45:30 +00004705 -> tools/mkimage -n 'Simple Ramdisk Image' \
4706 > -A ppc -O linux -T ramdisk -C gzip \
4707 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4708 Image Name: Simple Ramdisk Image
4709 Created: Wed Jan 12 14:01:50 2000
4710 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4711 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4712 Load Address: 0x00000000
4713 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004714
wdenkdb01a2e2004-04-15 23:14:49 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716Installing a Linux Image:
4717-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004718
wdenk2729af92004-05-03 20:45:30 +00004719To downloading a U-Boot image over the serial (console) interface,
4720you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004723
wdenk2729af92004-05-03 20:45:30 +00004724The 'objcopy' does not understand the information in the U-Boot
4725image header, so the resulting S-Record file will be relative to
4726address 0x00000000. To load it to a given address, you need to
4727specify the target address as 'offset' parameter with the 'loads'
4728command.
wdenkc6097192002-11-03 00:24:07 +00004729
wdenk2729af92004-05-03 20:45:30 +00004730Example: install the image to address 0x40100000 (which on the
4731TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004732
wdenk2729af92004-05-03 20:45:30 +00004733 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735 .......... done
4736 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738 => loads 40100000
4739 ## Ready for S-Record download ...
4740 ~>examples/image.srec
4741 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4742 ...
4743 15989 15990 15991 15992
4744 [file transfer complete]
4745 [connected]
4746 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004747
4748
wdenk2729af92004-05-03 20:45:30 +00004749You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004750this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004751corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk2729af92004-05-03 20:45:30 +00004753 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755 ## Checking Image at 40100000 ...
4756 Image Name: 2.2.13 for initrd on TQM850L
4757 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4758 Data Size: 335725 Bytes = 327 kB = 0 MB
4759 Load Address: 00000000
4760 Entry Point: 0000000c
4761 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004762
4763
wdenk2729af92004-05-03 20:45:30 +00004764Boot Linux:
4765-----------
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767The "bootm" command is used to boot an application that is stored in
4768memory (RAM or Flash). In case of a Linux kernel image, the contents
4769of the "bootargs" environment variable is passed to the kernel as
4770parameters. You can check and modify this variable using the
4771"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004772
4773
wdenk2729af92004-05-03 20:45:30 +00004774 => printenv bootargs
4775 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk2729af92004-05-03 20:45:30 +00004777 => 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 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779 => printenv bootargs
4780 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 +00004781
wdenk2729af92004-05-03 20:45:30 +00004782 => bootm 40020000
4783 ## Booting Linux kernel at 40020000 ...
4784 Image Name: 2.2.13 for NFS on TQM850L
4785 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4786 Data Size: 381681 Bytes = 372 kB = 0 MB
4787 Load Address: 00000000
4788 Entry Point: 0000000c
4789 Verifying Checksum ... OK
4790 Uncompressing Kernel Image ... OK
4791 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
4792 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4793 time_init: decrementer frequency = 187500000/60
4794 Calibrating delay loop... 49.77 BogoMIPS
4795 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4796 ...
wdenkc6097192002-11-03 00:24:07 +00004797
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004798If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004799the memory addresses of both the kernel and the initrd image (PPBCOOT
4800format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk2729af92004-05-03 20:45:30 +00004804 ## Checking Image at 40100000 ...
4805 Image Name: 2.2.13 for initrd on TQM850L
4806 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4807 Data Size: 335725 Bytes = 327 kB = 0 MB
4808 Load Address: 00000000
4809 Entry Point: 0000000c
4810 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004811
wdenk2729af92004-05-03 20:45:30 +00004812 ## Checking Image at 40200000 ...
4813 Image Name: Simple Ramdisk Image
4814 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4815 Data Size: 566530 Bytes = 553 kB = 0 MB
4816 Load Address: 00000000
4817 Entry Point: 00000000
4818 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820 => bootm 40100000 40200000
4821 ## Booting Linux kernel at 40100000 ...
4822 Image Name: 2.2.13 for initrd on TQM850L
4823 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4824 Data Size: 335725 Bytes = 327 kB = 0 MB
4825 Load Address: 00000000
4826 Entry Point: 0000000c
4827 Verifying Checksum ... OK
4828 Uncompressing Kernel Image ... OK
4829 ## Loading RAMDisk Image at 40200000 ...
4830 Image Name: Simple Ramdisk Image
4831 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4832 Data Size: 566530 Bytes = 553 kB = 0 MB
4833 Load Address: 00000000
4834 Entry Point: 00000000
4835 Verifying Checksum ... OK
4836 Loading Ramdisk ... OK
4837 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
4838 Boot arguments: root=/dev/ram
4839 time_init: decrementer frequency = 187500000/60
4840 Calibrating delay loop... 49.77 BogoMIPS
4841 ...
4842 RAMDISK: Compressed image found at block 0
4843 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004844
wdenk2729af92004-05-03 20:45:30 +00004845 bash#
wdenkc6097192002-11-03 00:24:07 +00004846
Matthew McClintock02677682006-06-28 10:41:37 -05004847Boot Linux and pass a flat device tree:
4848-----------
4849
4850First, U-Boot must be compiled with the appropriate defines. See the section
4851titled "Linux Kernel Interface" above for a more in depth explanation. The
4852following is an example of how to start a kernel and pass an updated
4853flat device tree:
4854
4855=> print oftaddr
4856oftaddr=0x300000
4857=> print oft
4858oft=oftrees/mpc8540ads.dtb
4859=> tftp $oftaddr $oft
4860Speed: 1000, full duplex
4861Using TSEC0 device
4862TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4863Filename 'oftrees/mpc8540ads.dtb'.
4864Load address: 0x300000
4865Loading: #
4866done
4867Bytes transferred = 4106 (100a hex)
4868=> tftp $loadaddr $bootfile
4869Speed: 1000, full duplex
4870Using TSEC0 device
4871TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4872Filename 'uImage'.
4873Load address: 0x200000
4874Loading:############
4875done
4876Bytes transferred = 1029407 (fb51f hex)
4877=> print loadaddr
4878loadaddr=200000
4879=> print oftaddr
4880oftaddr=0x300000
4881=> bootm $loadaddr - $oftaddr
4882## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004883 Image Name: Linux-2.6.17-dirty
4884 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4885 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004886 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004887 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004888 Verifying Checksum ... OK
4889 Uncompressing Kernel Image ... OK
4890Booting using flat device tree at 0x300000
4891Using MPC85xx ADS machine description
4892Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4893[snip]
4894
4895
wdenk2729af92004-05-03 20:45:30 +00004896More About U-Boot Image Types:
4897------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004898
wdenk2729af92004-05-03 20:45:30 +00004899U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004900
wdenk2729af92004-05-03 20:45:30 +00004901 "Standalone Programs" are directly runnable in the environment
4902 provided by U-Boot; it is expected that (if they behave
4903 well) you can continue to work in U-Boot after return from
4904 the Standalone Program.
4905 "OS Kernel Images" are usually images of some Embedded OS which
4906 will take over control completely. Usually these programs
4907 will install their own set of exception handlers, device
4908 drivers, set up the MMU, etc. - this means, that you cannot
4909 expect to re-enter U-Boot except by resetting the CPU.
4910 "RAMDisk Images" are more or less just data blocks, and their
4911 parameters (address, size) are passed to an OS kernel that is
4912 being started.
4913 "Multi-File Images" contain several images, typically an OS
4914 (Linux) kernel image and one or more data images like
4915 RAMDisks. This construct is useful for instance when you want
4916 to boot over the network using BOOTP etc., where the boot
4917 server provides just a single image file, but you want to get
4918 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004919
wdenk2729af92004-05-03 20:45:30 +00004920 "Multi-File Images" start with a list of image sizes, each
4921 image size (in bytes) specified by an "uint32_t" in network
4922 byte order. This list is terminated by an "(uint32_t)0".
4923 Immediately after the terminating 0 follow the images, one by
4924 one, all aligned on "uint32_t" boundaries (size rounded up to
4925 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004926
wdenk2729af92004-05-03 20:45:30 +00004927 "Firmware Images" are binary images containing firmware (like
4928 U-Boot or FPGA images) which usually will be programmed to
4929 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931 "Script files" are command sequences that will be executed by
4932 U-Boot's command interpreter; this feature is especially
4933 useful when you configure U-Boot to use a real shell (hush)
4934 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004935
Marek Vasut44f074c2012-03-14 21:52:45 +00004936Booting the Linux zImage:
4937-------------------------
4938
4939On some platforms, it's possible to boot Linux zImage. This is done
4940using the "bootz" command. The syntax of "bootz" command is the same
4941as the syntax of "bootm" command.
4942
Marek Vasut017e1f32012-03-18 11:47:58 +00004943Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4944kernel with raw initrd images. The syntax is slightly different, the
4945address of the initrd must be augmented by it's size, in the following
4946format: "<initrd addres>:<initrd size>".
4947
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk2729af92004-05-03 20:45:30 +00004949Standalone HOWTO:
4950=================
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk2729af92004-05-03 20:45:30 +00004952One of the features of U-Boot is that you can dynamically load and
4953run "standalone" applications, which can use some resources of
4954U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004955
wdenk2729af92004-05-03 20:45:30 +00004956Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004957
wdenk2729af92004-05-03 20:45:30 +00004958"Hello World" Demo:
4959-------------------
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk2729af92004-05-03 20:45:30 +00004961'examples/hello_world.c' contains a small "Hello World" Demo
4962application; it is automatically compiled when you build U-Boot.
4963It's configured to run at address 0x00040004, so you can play with it
4964like that:
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk2729af92004-05-03 20:45:30 +00004966 => loads
4967 ## Ready for S-Record download ...
4968 ~>examples/hello_world.srec
4969 1 2 3 4 5 6 7 8 9 10 11 ...
4970 [file transfer complete]
4971 [connected]
4972 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004973
wdenk2729af92004-05-03 20:45:30 +00004974 => go 40004 Hello World! This is a test.
4975 ## Starting application at 0x00040004 ...
4976 Hello World
4977 argc = 7
4978 argv[0] = "40004"
4979 argv[1] = "Hello"
4980 argv[2] = "World!"
4981 argv[3] = "This"
4982 argv[4] = "is"
4983 argv[5] = "a"
4984 argv[6] = "test."
4985 argv[7] = "<NULL>"
4986 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990Another example, which demonstrates how to register a CPM interrupt
4991handler with the U-Boot code, can be found in 'examples/timer.c'.
4992Here, a CPM timer is set up to generate an interrupt every second.
4993The interrupt service routine is trivial, just printing a '.'
4994character, but this is just a demo program. The application can be
4995controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997 ? - print current values og the CPM Timer registers
4998 b - enable interrupts and start timer
4999 e - stop timer and disable interrupts
5000 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk2729af92004-05-03 20:45:30 +00005002 => loads
5003 ## Ready for S-Record download ...
5004 ~>examples/timer.srec
5005 1 2 3 4 5 6 7 8 9 10 11 ...
5006 [file transfer complete]
5007 [connected]
5008 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005009
wdenk2729af92004-05-03 20:45:30 +00005010 => go 40004
5011 ## Starting application at 0x00040004 ...
5012 TIMERS=0xfff00980
5013 Using timer 1
5014 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk2729af92004-05-03 20:45:30 +00005016Hit 'b':
5017 [q, b, e, ?] Set interval 1000000 us
5018 Enabling timer
5019Hit '?':
5020 [q, b, e, ?] ........
5021 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5022Hit '?':
5023 [q, b, e, ?] .
5024 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5025Hit '?':
5026 [q, b, e, ?] .
5027 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5028Hit '?':
5029 [q, b, e, ?] .
5030 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5031Hit 'e':
5032 [q, b, e, ?] ...Stopping timer
5033Hit 'q':
5034 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005035
5036
wdenk2729af92004-05-03 20:45:30 +00005037Minicom warning:
5038================
wdenk85ec0bc2003-03-31 16:34:49 +00005039
wdenk2729af92004-05-03 20:45:30 +00005040Over time, many people have reported problems when trying to use the
5041"minicom" terminal emulation program for serial download. I (wd)
5042consider minicom to be broken, and recommend not to use it. Under
5043Unix, I recommend to use C-Kermit for general purpose use (and
5044especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005045use "cu" for S-Record download ("loads" command). See
5046http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5047for help with kermit.
5048
wdenk85ec0bc2003-03-31 16:34:49 +00005049
wdenk2729af92004-05-03 20:45:30 +00005050Nevertheless, if you absolutely want to use it try adding this
5051configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053 Name Program Name U/D FullScr IO-Red. Multi
5054 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5055 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005056
5057
wdenk2729af92004-05-03 20:45:30 +00005058NetBSD Notes:
5059=============
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk2729af92004-05-03 20:45:30 +00005061Starting at version 0.9.2, U-Boot supports NetBSD both as host
5062(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005063
wdenk2729af92004-05-03 20:45:30 +00005064Building requires a cross environment; it is known to work on
5065NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5066need gmake since the Makefiles are not compatible with BSD make).
5067Note that the cross-powerpc package does not install include files;
5068attempting to build U-Boot will fail because <machine/ansi.h> is
5069missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005070
wdenk2729af92004-05-03 20:45:30 +00005071 # cd /usr/pkg/cross/powerpc-netbsd/include
5072 # mkdir powerpc
5073 # ln -s powerpc machine
5074 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5075 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077Native builds *don't* work due to incompatibilities between native
5078and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080Booting assumes that (the first part of) the image booted is a
5081stage-2 loader which in turn loads and then invokes the kernel
5082proper. Loader sources will eventually appear in the NetBSD source
5083tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005084meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005085
5086
wdenk2729af92004-05-03 20:45:30 +00005087Implementation Internals:
5088=========================
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk2729af92004-05-03 20:45:30 +00005090The following is not intended to be a complete description of every
5091implementation detail. However, it should help to understand the
5092inner workings of U-Boot and make it easier to port it to custom
5093hardware.
wdenkc6097192002-11-03 00:24:07 +00005094
5095
wdenk2729af92004-05-03 20:45:30 +00005096Initial Stack, Global Data:
5097---------------------------
wdenkc6097192002-11-03 00:24:07 +00005098
wdenk2729af92004-05-03 20:45:30 +00005099The implementation of U-Boot is complicated by the fact that U-Boot
5100starts running out of ROM (flash memory), usually without access to
5101system RAM (because the memory controller is not initialized yet).
5102This means that we don't have writable Data or BSS segments, and BSS
5103is not initialized as zero. To be able to get a C environment working
5104at all, we have to allocate at least a minimal stack. Implementation
5105options for this are defined and restricted by the CPU used: Some CPU
5106models provide on-chip memory (like the IMMR area on MPC8xx and
5107MPC826x processors), on others (parts of) the data cache can be
5108locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005109
Wolfgang Denk218ca722008-03-26 10:40:12 +01005110 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005111 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5114 From: "Chris Hallinan" <clh@net1plus.com>
5115 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5116 ...
wdenk43d96162003-03-06 00:02:04 +00005117
wdenk2729af92004-05-03 20:45:30 +00005118 Correct me if I'm wrong, folks, but the way I understand it
5119 is this: Using DCACHE as initial RAM for Stack, etc, does not
5120 require any physical RAM backing up the cache. The cleverness
5121 is that the cache is being used as a temporary supply of
5122 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005123 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005124 can see how this works by studying the cache architecture and
5125 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005126
wdenk2729af92004-05-03 20:45:30 +00005127 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5128 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005129 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005130 option should work for you. Using CS 4 should be fine if your
5131 board designers haven't used it for something that would
5132 cause you grief during the initial boot! It is frequently not
5133 used.
wdenk43d96162003-03-06 00:02:04 +00005134
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005135 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005136 with your processor/board/system design. The default value
5137 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005138 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005139 than your SDRAM module. If you have a 64MB SDRAM module, set
5140 it above 400_0000. Just make sure your board has no resources
5141 that are supposed to respond to that address! That code in
5142 start.S has been around a while and should work as is when
5143 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145 -Chris Hallinan
5146 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148It is essential to remember this, since it has some impact on the C
5149code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151* Initialized global data (data segment) is read-only. Do not attempt
5152 to write it.
wdenkc6097192002-11-03 00:24:07 +00005153
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005154* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005155 as zero data - BSS segment) at all - this is undefined, initiali-
5156 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk2729af92004-05-03 20:45:30 +00005158* Stack space is very limited. Avoid big data buffers or things like
5159 that.
wdenkc6097192002-11-03 00:24:07 +00005160
wdenk2729af92004-05-03 20:45:30 +00005161Having only the stack as writable memory limits means we cannot use
5162normal global data to share information beween the code. But it
5163turned out that the implementation of U-Boot can be greatly
5164simplified by making a global data structure (gd_t) available to all
5165functions. We could pass a pointer to this data as argument to _all_
5166functions, but this would bloat the code. Instead we use a feature of
5167the GCC compiler (Global Register Variables) to share the data: we
5168place a pointer (gd) to the global data into a register which we
5169reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171When choosing a register for such a purpose we are restricted by the
5172relevant (E)ABI specifications for the current architecture, and by
5173GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175For PowerPC, the following registers have specific use:
5176 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005177 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005178 R3-R4: parameter passing and return values
5179 R5-R10: parameter passing
5180 R13: small data area pointer
5181 R30: GOT pointer
5182 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005183
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005184 (U-Boot also uses R12 as internal GOT pointer. r12
5185 is a volatile register so r12 needs to be reset when
5186 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005187
Wolfgang Denke7670f62008-02-14 22:43:22 +01005188 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk2729af92004-05-03 20:45:30 +00005190 Note: on PPC, we could use a static initializer (since the
5191 address of the global data structure is known at compile time),
5192 but it turned out that reserving a register results in somewhat
5193 smaller code - although the code savings are not that big (on
5194 average for all boards 752 bytes for the whole U-Boot image,
5195 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005196
Robin Getzc4db3352009-08-17 15:23:02 +00005197On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005198 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5199
Robin Getzc4db3352009-08-17 15:23:02 +00005200 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005201
wdenk2729af92004-05-03 20:45:30 +00005202On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204 R0: function argument word/integer result
5205 R1-R3: function argument word
5206 R9: GOT pointer
5207 R10: stack limit (used only if stack checking if enabled)
5208 R11: argument (frame) pointer
5209 R12: temporary workspace
5210 R13: stack pointer
5211 R14: link register
5212 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk2729af92004-05-03 20:45:30 +00005214 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005215
Thomas Chou0df01fd2010-05-21 11:08:03 +08005216On Nios II, the ABI is documented here:
5217 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5218
5219 ==> U-Boot will use gp to hold a pointer to the global data
5220
5221 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5222 to access small data sections, so gp is free.
5223
Macpaul Linafc1ce82011-10-19 20:41:11 +00005224On NDS32, the following registers are used:
5225
5226 R0-R1: argument/return
5227 R2-R5: argument
5228 R15: temporary register for assembler
5229 R16: trampoline register
5230 R28: frame pointer (FP)
5231 R29: global pointer (GP)
5232 R30: link register (LP)
5233 R31: stack pointer (SP)
5234 PC: program counter (PC)
5235
5236 ==> U-Boot will use R10 to hold a pointer to the global data
5237
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005238NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5239or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241Memory Management:
5242------------------
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244U-Boot runs in system state and uses physical addresses, i.e. the
5245MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk2729af92004-05-03 20:45:30 +00005247The available memory is mapped to fixed addresses using the memory
5248controller. In this process, a contiguous block is formed for each
5249memory type (Flash, SDRAM, SRAM), even when it consists of several
5250physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk2729af92004-05-03 20:45:30 +00005252U-Boot is installed in the first 128 kB of the first Flash bank (on
5253TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5254booting and sizing and initializing DRAM, the code relocates itself
5255to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005256memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005257configuration setting]. Below that, a structure with global Board
5258Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk2729af92004-05-03 20:45:30 +00005260Additionally, some exception handler code is copied to the low 8 kB
5261of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005262
wdenk2729af92004-05-03 20:45:30 +00005263So a typical memory configuration with 16 MB of DRAM could look like
5264this:
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266 0x0000 0000 Exception Vector code
5267 :
5268 0x0000 1FFF
5269 0x0000 2000 Free for Application Use
5270 :
5271 :
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk2729af92004-05-03 20:45:30 +00005273 :
5274 :
5275 0x00FB FF20 Monitor Stack (Growing downward)
5276 0x00FB FFAC Board Info Data and permanent copy of global data
5277 0x00FC 0000 Malloc Arena
5278 :
5279 0x00FD FFFF
5280 0x00FE 0000 RAM Copy of Monitor Code
5281 ... eventually: LCD or video framebuffer
5282 ... eventually: pRAM (Protected RAM - unchanged by reset)
5283 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005284
5285
wdenk2729af92004-05-03 20:45:30 +00005286System Initialization:
5287----------------------
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk2729af92004-05-03 20:45:30 +00005289In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005290(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005291configuration for CS0# this is a mirror of the onboard Flash memory.
5292To be able to re-map memory U-Boot then jumps to its link address.
5293To be able to implement the initialization code in C, a (small!)
5294initial stack is set up in the internal Dual Ported RAM (in case CPUs
5295which provide such a feature like MPC8xx or MPC8260), or in a locked
5296part of the data cache. After that, U-Boot initializes the CPU core,
5297the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk2729af92004-05-03 20:45:30 +00005299Next, all (potentially) available memory banks are mapped using a
5300preliminary mapping. For example, we put them on 512 MB boundaries
5301(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5302on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5303programmed for SDRAM access. Using the temporary configuration, a
5304simple memory test is run that determines the size of the SDRAM
5305banks.
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk2729af92004-05-03 20:45:30 +00005307When there is more than one SDRAM bank, and the banks are of
5308different size, the largest is mapped first. For equal size, the first
5309bank (CS2#) is mapped first. The first mapping is always for address
53100x00000000, with any additional banks following immediately to create
5311contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313Then, the monitor installs itself at the upper end of the SDRAM area
5314and allocates memory for use by malloc() and for the global Board
5315Info data; also, the exception vector code is copied to the low RAM
5316pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005317
wdenk2729af92004-05-03 20:45:30 +00005318Only after this relocation will you have a "normal" C environment;
5319until that you are restricted in several ways, mostly because you are
5320running from ROM, and because the code will have to be relocated to a
5321new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005322
5323
wdenk2729af92004-05-03 20:45:30 +00005324U-Boot Porting Guide:
5325----------------------
wdenkc6097192002-11-03 00:24:07 +00005326
wdenk2729af92004-05-03 20:45:30 +00005327[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5328list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005329
5330
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005331int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005332{
5333 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005334
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005335 signal(SIGALRM, no_more_time);
5336 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk2729af92004-05-03 20:45:30 +00005338 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005339 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005340 return 0;
5341 }
5342
wdenk2729af92004-05-03 20:45:30 +00005343 Download latest U-Boot source;
5344
Wolfgang Denk06682362008-12-30 22:56:11 +01005345 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005346
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005347 if (clueless)
5348 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk2729af92004-05-03 20:45:30 +00005350 while (learning) {
5351 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005352 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5353 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005354 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005355 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005356 }
wdenkc6097192002-11-03 00:24:07 +00005357
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005358 if (available_money > toLocalCurrency ($2500))
5359 Buy a BDI3000;
5360 else
wdenk2729af92004-05-03 20:45:30 +00005361 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005362
5363 if (a similar board exists) { /* hopefully... */
5364 cp -a board/<similar> board/<myboard>
5365 cp include/configs/<similar>.h include/configs/<myboard>.h
5366 } else {
5367 Create your own board support subdirectory;
5368 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005369 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005370 Edit new board/<myboard> files
5371 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005372
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005373 while (!accepted) {
5374 while (!running) {
5375 do {
5376 Add / modify source code;
5377 } until (compiles);
5378 Debug;
5379 if (clueless)
5380 email("Hi, I am having problems...");
5381 }
5382 Send patch file to the U-Boot email list;
5383 if (reasonable critiques)
5384 Incorporate improvements from email list code review;
5385 else
5386 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005387 }
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk2729af92004-05-03 20:45:30 +00005389 return 0;
5390}
5391
5392void no_more_time (int sig)
5393{
5394 hire_a_guru();
5395}
wdenkc6097192002-11-03 00:24:07 +00005396
5397
wdenk2729af92004-05-03 20:45:30 +00005398Coding Standards:
5399-----------------
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005402coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005403"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005404
Detlev Zundel2c051652006-09-01 15:39:02 +02005405Source files originating from a different project (for example the
5406MTD subsystem) are generally exempt from these guidelines and are not
5407reformated to ease subsequent migration to newer versions of those
5408sources.
5409
5410Please note that U-Boot is implemented in C (and to some small parts in
5411Assembler); no C++ is used, so please do not use C++ style comments (//)
5412in your code.
wdenk2729af92004-05-03 20:45:30 +00005413
5414Please also stick to the following formatting rules:
5415- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005416- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005417- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005418- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005419- do not add trailing empty lines to source files
5420
5421Submissions which do not conform to the standards may be returned
5422with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005423
5424
wdenk2729af92004-05-03 20:45:30 +00005425Submitting Patches:
5426-------------------
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk2729af92004-05-03 20:45:30 +00005428Since the number of patches for U-Boot is growing, we need to
5429establish some rules. Submissions which do not conform to these rules
5430may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005431
Magnus Lilja0d28f342008-08-06 19:32:33 +02005432Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005433
Wolfgang Denk06682362008-12-30 22:56:11 +01005434Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5435see http://lists.denx.de/mailman/listinfo/u-boot
5436
wdenk2729af92004-05-03 20:45:30 +00005437When you send a patch, please include the following information with
5438it:
wdenkc6097192002-11-03 00:24:07 +00005439
wdenk2729af92004-05-03 20:45:30 +00005440* For bug fixes: a description of the bug and how your patch fixes
5441 this bug. Please try to include a way of demonstrating that the
5442 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444* For new features: a description of the feature and your
5445 implementation.
wdenkc6097192002-11-03 00:24:07 +00005446
wdenk2729af92004-05-03 20:45:30 +00005447* A CHANGELOG entry as plaintext (separate from the patch)
5448
5449* For major contributions, your entry to the CREDITS file
5450
5451* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005452 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005453
5454* If your patch adds new configuration options, don't forget to
5455 document these in the README file.
5456
Wolfgang Denk218ca722008-03-26 10:40:12 +01005457* The patch itself. If you are using git (which is *strongly*
5458 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005459 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005460 the U-Boot mailing list, you will avoid most of the common problems
5461 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005462
Wolfgang Denk218ca722008-03-26 10:40:12 +01005463 If you cannot use git, use "diff -purN OLD NEW". If your version of
5464 diff does not support these options, then get the latest version of
5465 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005466
Wolfgang Denk218ca722008-03-26 10:40:12 +01005467 The current directory when running this command shall be the parent
5468 directory of the U-Boot source tree (i. e. please make sure that
5469 your patch includes sufficient directory information for the
5470 affected files).
5471
5472 We prefer patches as plain text. MIME attachments are discouraged,
5473 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005474
5475* If one logical set of modifications affects or creates several
5476 files, all these changes shall be submitted in a SINGLE patch file.
5477
5478* Changesets that contain different, unrelated modifications shall be
5479 submitted as SEPARATE patches, one patch per changeset.
5480
5481
5482Notes:
5483
5484* Before sending the patch, run the MAKEALL script on your patched
5485 source tree and make sure that no errors or warnings are reported
5486 for any of the boards.
5487
5488* Keep your modifications to the necessary minimum: A patch
5489 containing several unrelated changes or arbitrary reformats will be
5490 returned with a request to re-formatting / split it.
5491
5492* If you modify existing code, make sure that your new code does not
5493 add to the memory footprint of the code ;-) Small is beautiful!
5494 When adding new features, these should compile conditionally only
5495 (using #ifdef), and the resulting code with the new feature
5496 disabled must not need more memory than the old code without your
5497 modification.
wdenk90dc6702005-05-03 14:12:25 +00005498
Wolfgang Denk06682362008-12-30 22:56:11 +01005499* Remember that there is a size limit of 100 kB per message on the
5500 u-boot mailing list. Bigger patches will be moderated. If they are
5501 reasonable and not too big, they will be acknowledged. But patches
5502 bigger than the size limit should be avoided.