blob: bbd7399f53748d2b28ae5cc1e48ad6390a5a46bb [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
135 /arm Files generic to ARM architecture
136 /cpu CPU specific files
137 /arm720t Files specific to ARM 720 CPUs
138 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000139 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200140 /imx Files specific to Freescale MC9328 i.MX CPUs
141 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /arm926ejs Files specific to ARM 926 CPUs
143 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500144 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
146 /lib Architecture specific library files
147 /avr32 Files generic to AVR32 architecture
148 /cpu CPU specific files
149 /lib Architecture specific library files
150 /blackfin Files generic to Analog Devices Blackfin architecture
151 /cpu CPU specific files
152 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /m68k Files generic to m68k architecture
154 /cpu CPU specific files
155 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
156 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
157 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
158 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
159 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
160 /lib Architecture specific library files
161 /microblaze Files generic to microblaze architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /mips Files generic to MIPS architecture
165 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200166 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800167 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000169 /nds32 Files generic to NDS32 architecture
170 /cpu CPU specific files
171 /n1213 Files specific to Andes Technology N1213 CPUs
172 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500173 /nios2 Files generic to Altera NIOS2 architecture
174 /cpu CPU specific files
175 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400176 /openrisc Files generic to OpenRISC architecture
177 /cpu CPU specific files
178 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200179 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500180 /cpu CPU specific files
181 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
182 /mpc5xx Files specific to Freescale MPC5xx CPUs
183 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
184 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc824x Files specific to Freescale MPC824x CPUs
186 /mpc8260 Files specific to Freescale MPC8260 CPUs
187 /mpc85xx Files specific to Freescale MPC85xx CPUs
188 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
189 /lib Architecture specific library files
190 /sh Files generic to SH architecture
191 /cpu CPU specific files
192 /sh2 Files specific to sh2 CPUs
193 /sh3 Files specific to sh3 CPUs
194 /sh4 Files specific to sh4 CPUs
195 /lib Architecture specific library files
196 /sparc Files generic to SPARC architecture
197 /cpu CPU specific files
198 /leon2 Files specific to Gaisler LEON2 SPARC CPU
199 /leon3 Files specific to Gaisler LEON3 SPARC CPU
200 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400201 /x86 Files generic to x86 architecture
202 /cpu CPU specific files
203 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500204/api Machine/arch independent API for external apps
205/board Board dependent files
206/common Misc architecture independent functions
207/disk Code for disk drive partition handling
208/doc Documentation (don't expect too much)
209/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400210/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500211/examples Example code for standalone applications, etc.
212/fs Filesystem code (cramfs, ext2, jffs2, etc.)
213/include Header Files
214/lib Files generic to all architectures
215 /libfdt Library files to support flattened device trees
216 /lzma Library files to support LZMA decompression
217 /lzo Library files to support LZO decompression
218/net Networking code
219/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400220/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500221/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000222
wdenkc6097192002-11-03 00:24:07 +0000223Software Configuration:
224=======================
225
226Configuration is usually done using C preprocessor defines; the
227rationale behind that is to avoid dead code whenever possible.
228
229There are two classes of configuration variables:
230
231* Configuration _OPTIONS_:
232 These are selectable by the user and have names beginning with
233 "CONFIG_".
234
235* Configuration _SETTINGS_:
236 These depend on the hardware etc. and should not be meddled with if
237 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200238 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000239
240Later we will add a configuration tool - probably similar to or even
241identical to what's used for the Linux kernel. Right now, we have to
242do the configuration by hand, which means creating some symbolic
243links and editing some configuration files. We use the TQM8xxL boards
244as an example here.
245
246
247Selection of Processor Architecture and Board Type:
248---------------------------------------------------
249
250For all supported boards there are ready-to-use default
251configurations available; just type "make <board_name>_config".
252
253Example: For a TQM823L module type:
254
255 cd u-boot
256 make TQM823L_config
257
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200258For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000259e.g. "make cogent_mpc8xx_config". And also configure the cogent
260directory according to the instructions in cogent/README.
261
262
263Configuration Options:
264----------------------
265
266Configuration depends on the combination of board and CPU type; all
267such information is kept in a configuration file
268"include/configs/<board_name>.h".
269
270Example: For a TQM823L module, all configuration settings are in
271"include/configs/TQM823L.h".
272
273
wdenk7f6c2cb2002-11-10 22:06:23 +0000274Many of the options are named exactly as the corresponding Linux
275kernel configuration options. The intention is to make it easier to
276build a config tool - later.
277
278
wdenkc6097192002-11-03 00:24:07 +0000279The following options need to be configured:
280
Kim Phillips26281142007-08-10 13:28:25 -0500281- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000282
Kim Phillips26281142007-08-10 13:28:25 -0500283- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200284
285- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100286 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000287
288- CPU Module Type: (if CONFIG_COGENT is defined)
289 Define exactly one of
290 CONFIG_CMA286_60_OLD
291--- FIXME --- not tested yet:
292 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
293 CONFIG_CMA287_23, CONFIG_CMA287_50
294
295- Motherboard Type: (if CONFIG_COGENT is defined)
296 Define exactly one of
297 CONFIG_CMA101, CONFIG_CMA102
298
299- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
300 Define one or more of
301 CONFIG_CMA302
302
303- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
304 Define one or more of
305 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200306 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000307 a "rotator" |\-/|\-/
308
wdenk2535d602003-07-17 23:16:40 +0000309- Board flavour: (if CONFIG_MPC8260ADS is defined)
310 CONFIG_ADSTYPE
311 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200312 CONFIG_SYS_8260ADS - original MPC8260ADS
313 CONFIG_SYS_8266ADS - MPC8266ADS
314 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
315 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000316
Lei Wencf946c62011-02-09 18:06:58 +0530317- Marvell Family Member
318 CONFIG_SYS_MVFS - define it if you want to enable
319 multiple fs option at one time
320 for marvell soc family
321
wdenkc6097192002-11-03 00:24:07 +0000322- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000323 Define exactly one of
324 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000325
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200326- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000327 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
328 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000329 e.g. if there is no 32KHz
330 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000331 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
332 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000333
wdenk66ca92a2004-09-28 17:59:53 +0000334- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200335 CONFIG_SYS_8xx_CPUCLK_MIN
336 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000338 See doc/README.MPC866
339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000341
wdenkba56f622004-02-06 23:19:44 +0000342 Define this to measure the actual CPU clock instead
343 of relying on the correctness of the configured
344 values. Mostly useful for board bringup to make sure
345 the PLL is locked at the intended frequency. Note
346 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000348
Heiko Schocher506f3912009-03-12 07:37:15 +0100349 CONFIG_SYS_DELAYED_ICACHE
350
351 Define this option if you want to enable the
352 ICache only when Code runs from RAM.
353
Kumar Gala66412c62011-02-18 05:40:54 -0600354- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000355 CONFIG_SYS_PPC64
356
357 Specifies that the core is a 64-bit PowerPC implementation (implements
358 the "64" category of the Power ISA). This is necessary for ePAPR
359 compliance, among other possible reasons.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361 CONFIG_SYS_FSL_TBCLK_DIV
362
363 Defines the core time base clock divider ratio compared to the
364 system clock. On most PQ3 devices this is 8, on newer QorIQ
365 devices it can be 16 or 32. The ratio varies from SoC to Soc.
366
Kumar Gala8f290842011-05-20 00:39:21 -0500367 CONFIG_SYS_FSL_PCIE_COMPAT
368
369 Defines the string to utilize when trying to match PCIe device
370 tree nodes for the given platform.
371
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000372 CONFIG_SYS_PPC_E500_DEBUG_TLB
373
374 Enables a temporary TLB entry to be used during boot to work
375 around limitations in e500v1 and e500v2 external debugger
376 support. This reduces the portions of the boot code where
377 breakpoints and single stepping do not work. The value of this
378 symbol should be set to the TLB1 entry to be used for this
379 purpose.
380
Scott Wood33eee332012-08-14 10:14:53 +0000381 CONFIG_SYS_FSL_ERRATUM_A004510
382
383 Enables a workaround for erratum A004510. If set,
384 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
385 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
386
387 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
389
390 Defines one or two SoC revisions (low 8 bits of SVR)
391 for which the A004510 workaround should be applied.
392
393 The rest of SVR is either not relevant to the decision
394 of whether the erratum is present (e.g. p2040 versus
395 p2041) or is implied by the build target, which controls
396 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
397
398 See Freescale App Note 4493 for more information about
399 this erratum.
400
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530401 CONFIG_A003399_NOR_WORKAROUND
402 Enables a workaround for IFC erratum A003399. It is only
403 requred during NOR boot.
404
Scott Wood33eee332012-08-14 10:14:53 +0000405 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
406
407 This is the value to write into CCSR offset 0x18600
408 according to the A004510 workaround.
409
Priyanka Jain64501c62013-07-02 09:21:04 +0530410 CONFIG_SYS_FSL_DSP_DDR_ADDR
411 This value denotes start offset of DDR memory which is
412 connected exclusively to the DSP cores.
413
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530414 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415 This value denotes start offset of M2 memory
416 which is directly connected to the DSP core.
417
Priyanka Jain64501c62013-07-02 09:21:04 +0530418 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
419 This value denotes start offset of M3 memory which is directly
420 connected to the DSP core.
421
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jainb1359912013-12-17 14:25:52 +0530425 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426 Single Source Clock is clocking mode present in some of FSL SoC's.
427 In this mode, a single differential clock is used to supply
428 clocks to the sysclock, ddrclock and usbclock.
429
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530430 CONFIG_SYS_CPC_REINIT_F
431 This CONFIG is defined when the CPC is configured as SRAM at the
432 time of U-boot entry and is required to be re-initialized.
433
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000434- Generic CPU options:
435 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
436
437 Defines the endianess of the CPU. Implementation of those
438 values is arch specific.
439
York Sun5614e712013-09-30 09:22:09 -0700440 CONFIG_SYS_FSL_DDR
441 Freescale DDR driver in use. This type of DDR controller is
442 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
443 SoCs.
444
445 CONFIG_SYS_FSL_DDR_ADDR
446 Freescale DDR memory-mapped register base.
447
448 CONFIG_SYS_FSL_DDR_EMU
449 Specify emulator support for DDR. Some DDR features such as
450 deskew training are not available.
451
452 CONFIG_SYS_FSL_DDRC_GEN1
453 Freescale DDR1 controller.
454
455 CONFIG_SYS_FSL_DDRC_GEN2
456 Freescale DDR2 controller.
457
458 CONFIG_SYS_FSL_DDRC_GEN3
459 Freescale DDR3 controller.
460
York Sun34e026f2014-03-27 17:54:47 -0700461 CONFIG_SYS_FSL_DDRC_GEN4
462 Freescale DDR4 controller.
463
York Sun9ac4ffb2013-09-30 14:20:51 -0700464 CONFIG_SYS_FSL_DDRC_ARM_GEN3
465 Freescale DDR3 controller for ARM-based SoCs.
466
York Sun5614e712013-09-30 09:22:09 -0700467 CONFIG_SYS_FSL_DDR1
468 Board config to use DDR1. It can be enabled for SoCs with
469 Freescale DDR1 or DDR2 controllers, depending on the board
470 implemetation.
471
472 CONFIG_SYS_FSL_DDR2
473 Board config to use DDR2. It can be eanbeld for SoCs with
474 Freescale DDR2 or DDR3 controllers, depending on the board
475 implementation.
476
477 CONFIG_SYS_FSL_DDR3
478 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700479 Freescale DDR3 or DDR3L controllers.
480
481 CONFIG_SYS_FSL_DDR3L
482 Board config to use DDR3L. It can be enabled for SoCs with
483 DDR3L controllers.
484
485 CONFIG_SYS_FSL_DDR4
486 Board config to use DDR4. It can be enabled for SoCs with
487 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700488
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530489 CONFIG_SYS_FSL_IFC_BE
490 Defines the IFC controller register space as Big Endian
491
492 CONFIG_SYS_FSL_IFC_LE
493 Defines the IFC controller register space as Little Endian
494
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530495 CONFIG_SYS_FSL_PBL_PBI
496 It enables addition of RCW (Power on reset configuration) in built image.
497 Please refer doc/README.pblimage for more details
498
499 CONFIG_SYS_FSL_PBL_RCW
500 It adds PBI(pre-boot instructions) commands in u-boot build image.
501 PBI commands can be used to configure SoC before it starts the execution.
502 Please refer doc/README.pblimage for more details
503
York Sun4e5b1bd2014-02-10 13:59:42 -0800504 CONFIG_SYS_FSL_DDR_BE
505 Defines the DDR controller register space as Big Endian
506
507 CONFIG_SYS_FSL_DDR_LE
508 Defines the DDR controller register space as Little Endian
509
York Sun6b9e3092014-02-10 13:59:43 -0800510 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
511 Physical address from the view of DDR controllers. It is the
512 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
513 it could be different for ARM SoCs.
514
York Sun6b1e1252014-02-10 13:59:44 -0800515 CONFIG_SYS_FSL_DDR_INTLV_256B
516 DDR controller interleaving on 256-byte. This is a special
517 interleaving mode, handled by Dickens for Freescale layerscape
518 SoCs with ARM core.
519
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100520- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200521 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100522
523 Defines the Monahans run mode to oscillator
524 ratio. Valid values are 8, 16, 24, 31. The core
525 frequency is this value multiplied by 13 MHz.
526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200527 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200528
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100529 Defines the Monahans turbo mode to oscillator
530 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200531 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100532 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200533
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200534- MIPS CPU options:
535 CONFIG_SYS_INIT_SP_OFFSET
536
537 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
538 pointer. This is needed for the temporary stack before
539 relocation.
540
541 CONFIG_SYS_MIPS_CACHE_MODE
542
543 Cache operation mode for the MIPS CPU.
544 See also arch/mips/include/asm/mipsregs.h.
545 Possible values are:
546 CONF_CM_CACHABLE_NO_WA
547 CONF_CM_CACHABLE_WA
548 CONF_CM_UNCACHED
549 CONF_CM_CACHABLE_NONCOHERENT
550 CONF_CM_CACHABLE_CE
551 CONF_CM_CACHABLE_COW
552 CONF_CM_CACHABLE_CUW
553 CONF_CM_CACHABLE_ACCELERATED
554
555 CONFIG_SYS_XWAY_EBU_BOOTCFG
556
557 Special option for Lantiq XWAY SoCs for booting from NOR flash.
558 See also arch/mips/cpu/mips32/start.S.
559
560 CONFIG_XWAY_SWAP_BYTES
561
562 Enable compilation of tools/xway-swap-bytes needed for Lantiq
563 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
564 be swapped if a flash programmer is used.
565
Christian Rieschb67d8812012-02-02 00:44:39 +0000566- ARM options:
567 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
568
569 Select high exception vectors of the ARM core, e.g., do not
570 clear the V bit of the c1 register of CP15.
571
Aneesh V5356f542012-03-08 07:20:19 +0000572 CONFIG_SYS_THUMB_BUILD
573
574 Use this flag to build U-Boot using the Thumb instruction
575 set for ARM architectures. Thumb instruction set provides
576 better code density. For ARM architectures that support
577 Thumb2 this flag will result in Thumb2 code generated by
578 GCC.
579
Stephen Warrenc5d47522013-03-04 13:29:40 +0000580 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000581 CONFIG_ARM_ERRATA_742230
582 CONFIG_ARM_ERRATA_743622
583 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500584 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500585 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000586
587 If set, the workarounds for these ARM errata are applied early
588 during U-Boot startup. Note that these options force the
589 workarounds to be applied; no CPU-type/version detection
590 exists, unlike the similar options in the Linux kernel. Do not
591 set these options unless they apply!
592
Stephen Warren795659d2013-03-27 17:06:41 +0000593- CPU timer options:
594 CONFIG_SYS_HZ
595
596 The frequency of the timer returned by get_timer().
597 get_timer() must operate in milliseconds and this CONFIG
598 option must be set to 1000.
599
wdenk5da627a2003-10-09 20:09:04 +0000600- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000601 CONFIG_CLOCKS_IN_MHZ
602
603 U-Boot stores all clock information in Hz
604 internally. For binary compatibility with older Linux
605 kernels (which expect the clocks passed in the
606 bd_info data to be in MHz) the environment variable
607 "clocks_in_mhz" can be defined so that U-Boot
608 converts clock data to MHZ before passing it to the
609 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000610 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100611 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000612 default environment.
613
wdenk5da627a2003-10-09 20:09:04 +0000614 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
615
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200616 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000617 expect it to be in bytes, others in MB.
618 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
619
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400620 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200621
622 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400623 passed using flattened device trees (based on open firmware
624 concepts).
625
626 CONFIG_OF_LIBFDT
627 * New libfdt-based support
628 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500629 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400630
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200631 OF_CPU - The proper name of the cpus node (only required for
632 MPC512X and MPC5xxx based boards).
633 OF_SOC - The proper name of the soc node (only required for
634 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200635 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600636 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200637
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200638 boards with QUICC Engines require OF_QE to set UCC MAC
639 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500640
Kumar Gala4e253132006-01-11 13:54:17 -0600641 CONFIG_OF_BOARD_SETUP
642
643 Board code has addition modification that it wants to make
644 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000645
Matthew McClintock02677682006-06-28 10:41:37 -0500646 CONFIG_OF_BOOT_CPU
647
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200648 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500649 param header, the default value is zero if undefined.
650
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200651 CONFIG_OF_IDE_FIXUP
652
653 U-Boot can detect if an IDE device is present or not.
654 If not, and this new config option is activated, U-Boot
655 removes the ATA node from the DTS before booting Linux,
656 so the Linux IDE driver does not probe the device and
657 crash. This is needed for buggy hardware (uc101) where
658 no pull down resistor is connected to the signal IDE5V_DD7.
659
Igor Grinberg7eb29392011-07-14 05:45:07 +0000660 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
661
662 This setting is mandatory for all boards that have only one
663 machine type and must be used to specify the machine type
664 number as it appears in the ARM machine registry
665 (see http://www.arm.linux.org.uk/developer/machines/).
666 Only boards that have multiple machine types supported
667 in a single configuration file and the machine type is
668 runtime discoverable, do not have to use this setting.
669
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100670- vxWorks boot parameters:
671
672 bootvx constructs a valid bootline using the following
673 environments variables: bootfile, ipaddr, serverip, hostname.
674 It loads the vxWorks image pointed bootfile.
675
676 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
677 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
678 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
679 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
680
681 CONFIG_SYS_VXWORKS_ADD_PARAMS
682
683 Add it at the end of the bootline. E.g "u=username pw=secret"
684
685 Note: If a "bootargs" environment is defined, it will overwride
686 the defaults discussed just above.
687
Aneesh V2c451f72011-06-16 23:30:47 +0000688- Cache Configuration:
689 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
690 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
691 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
692
Aneesh V93bc2192011-06-16 23:30:51 +0000693- Cache Configuration for ARM:
694 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
695 controller
696 CONFIG_SYS_PL310_BASE - Physical base address of PL310
697 controller register space
698
wdenk6705d812004-08-02 23:22:59 +0000699- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200700 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000701
702 Define this if you want support for Amba PrimeCell PL010 UARTs.
703
Andreas Engel48d01922008-09-08 14:30:53 +0200704 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000705
706 Define this if you want support for Amba PrimeCell PL011 UARTs.
707
708 CONFIG_PL011_CLOCK
709
710 If you have Amba PrimeCell PL011 UARTs, set this variable to
711 the clock speed of the UARTs.
712
713 CONFIG_PL01x_PORTS
714
715 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
716 define this to a list of base addresses for each (supported)
717 port. See e.g. include/configs/versatile.h
718
John Rigby910f1ae2011-04-19 10:42:39 +0000719 CONFIG_PL011_SERIAL_RLCR
720
721 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
722 have separate receive and transmit line control registers. Set
723 this variable to initialize the extra register.
724
725 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
726
727 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
728 boot loader that has already initialized the UART. Define this
729 variable to flush the UART at init time.
730
wdenk6705d812004-08-02 23:22:59 +0000731
wdenkc6097192002-11-03 00:24:07 +0000732- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000733 Depending on board, define exactly one serial port
734 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
735 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
736 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000737
738 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
739 port routines must be defined elsewhere
740 (i.e. serial_init(), serial_getc(), ...)
741
742 CONFIG_CFB_CONSOLE
743 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000744 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000745 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
746 (default big endian)
747 VIDEO_HW_RECTFILL graphic chip supports
748 rectangle fill
749 (cf. smiLynxEM)
750 VIDEO_HW_BITBLT graphic chip supports
751 bit-blit (cf. smiLynxEM)
752 VIDEO_VISIBLE_COLS visible pixel columns
753 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000754 VIDEO_VISIBLE_ROWS visible pixel rows
755 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000756 VIDEO_DATA_FORMAT graphic data format
757 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000758 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000759 VIDEO_KBD_INIT_FCT keyboard int fct
760 (i.e. i8042_kbd_init())
761 VIDEO_TSTC_FCT test char fct
762 (i.e. i8042_tstc)
763 VIDEO_GETC_FCT get char fct
764 (i.e. i8042_getc)
765 CONFIG_CONSOLE_CURSOR cursor drawing on/off
766 (requires blink timer
767 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200768 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000769 CONFIG_CONSOLE_TIME display time/date info in
770 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500771 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000772 CONFIG_VIDEO_LOGO display Linux logo in
773 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000774 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
775 linux_logo.h for logo.
776 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000777 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200778 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000779 the logo
780
Pali Rohár33a35bb2012-10-19 13:30:09 +0000781 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
782 a limited number of ANSI escape sequences (cursor control,
783 erase functions and limited graphics rendition control).
784
wdenk43d96162003-03-06 00:02:04 +0000785 When CONFIG_CFB_CONSOLE is defined, video console is
786 default i/o. Serial console can be forced with
787 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000788
wdenkd4ca31c2004-01-02 14:00:00 +0000789 When CONFIG_SILENT_CONSOLE is defined, all console
790 messages (by U-Boot and Linux!) can be silenced with
791 the "silent" environment variable. See
792 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000793
Heiko Schocher45ae2542013-10-22 11:06:06 +0200794 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
795 is 0x00.
796 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
797 is 0xa0.
798
wdenkc6097192002-11-03 00:24:07 +0000799- Console Baudrate:
800 CONFIG_BAUDRATE - in bps
801 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200802 CONFIG_SYS_BAUDRATE_TABLE, see below.
803 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000804
Heiko Schocherc92fac92009-01-30 12:55:38 +0100805- Console Rx buffer length
806 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
807 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100808 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100809 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
810 must be defined, to setup the maximum idle timeout for
811 the SMC.
812
Graeme Russ9558b482011-09-01 00:48:27 +0000813- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200814 Prior to the console being initialised (i.e. serial UART
815 initialised etc) all console output is silently discarded.
816 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
817 buffer any console messages prior to the console being
818 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
819 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
820 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200821 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200822 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000823
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200824 'Sane' compilers will generate smaller code if
825 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000826
Sonny Rao046a37b2011-11-02 09:52:08 +0000827- Safe printf() functions
828 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
829 the printf() functions. These are defined in
830 include/vsprintf.h and include snprintf(), vsnprintf() and
831 so on. Code size increase is approximately 300-500 bytes.
832 If this option is not given then these functions will
833 silently discard their buffer size argument - this means
834 you are not getting any overflow checking in this case.
835
wdenkc6097192002-11-03 00:24:07 +0000836- Boot Delay: CONFIG_BOOTDELAY - in seconds
837 Delay before automatically booting the default image;
838 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000839 set to -2 to autoboot with no delay and not check for abort
840 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000841
842 See doc/README.autoboot for these options that
843 work with CONFIG_BOOTDELAY. None are required.
844 CONFIG_BOOT_RETRY_TIME
845 CONFIG_BOOT_RETRY_MIN
846 CONFIG_AUTOBOOT_KEYED
847 CONFIG_AUTOBOOT_PROMPT
848 CONFIG_AUTOBOOT_DELAY_STR
849 CONFIG_AUTOBOOT_STOP_STR
850 CONFIG_AUTOBOOT_DELAY_STR2
851 CONFIG_AUTOBOOT_STOP_STR2
852 CONFIG_ZERO_BOOTDELAY_CHECK
853 CONFIG_RESET_TO_RETRY
854
855- Autoboot Command:
856 CONFIG_BOOTCOMMAND
857 Only needed when CONFIG_BOOTDELAY is enabled;
858 define a command string that is automatically executed
859 when no character is read on the console interface
860 within "Boot Delay" after reset.
861
862 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000863 This can be used to pass arguments to the bootm
864 command. The value of CONFIG_BOOTARGS goes into the
865 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000866
867 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000868 The value of these goes into the environment as
869 "ramboot" and "nfsboot" respectively, and can be used
870 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200871 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000872
Heiko Schochereda0ba32013-11-04 14:04:59 +0100873- Bootcount:
874 CONFIG_BOOTCOUNT_LIMIT
875 Implements a mechanism for detecting a repeating reboot
876 cycle, see:
877 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
878
879 CONFIG_BOOTCOUNT_ENV
880 If no softreset save registers are found on the hardware
881 "bootcount" is stored in the environment. To prevent a
882 saveenv on all reboots, the environment variable
883 "upgrade_available" is used. If "upgrade_available" is
884 0, "bootcount" is always 0, if "upgrade_available" is
885 1 "bootcount" is incremented in the environment.
886 So the Userspace Applikation must set the "upgrade_available"
887 and "bootcount" variable to 0, if a boot was successfully.
888
wdenkc6097192002-11-03 00:24:07 +0000889- Pre-Boot Commands:
890 CONFIG_PREBOOT
891
892 When this option is #defined, the existence of the
893 environment variable "preboot" will be checked
894 immediately before starting the CONFIG_BOOTDELAY
895 countdown and/or running the auto-boot command resp.
896 entering interactive mode.
897
898 This feature is especially useful when "preboot" is
899 automatically generated or modified. For an example
900 see the LWMON board specific code: here "preboot" is
901 modified when the user holds down a certain
902 combination of keys on the (special) keyboard when
903 booting the systems
904
905- Serial Download Echo Mode:
906 CONFIG_LOADS_ECHO
907 If defined to 1, all characters received during a
908 serial download (using the "loads" command) are
909 echoed back. This might be needed by some terminal
910 emulations (like "cu"), but may as well just take
911 time on others. This setting #define's the initial
912 value of the "loads_echo" environment variable.
913
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500914- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000915 CONFIG_KGDB_BAUDRATE
916 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200917 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000918
919- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 Monitor commands can be included or excluded
921 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000922 <config_cmd_all.h> and #undef'ing unwanted
923 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500924 and augmenting with additional #define's
925 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000926
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500927 The default command configuration includes all commands
928 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000929
Marek Vasutb401b732014-03-05 19:58:39 +0100930 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500931 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500932 CONFIG_CMD_BDI bdinfo
933 CONFIG_CMD_BEDBUG * Include BedBug Debugger
934 CONFIG_CMD_BMP * BMP support
935 CONFIG_CMD_BSP * Board specific commands
936 CONFIG_CMD_BOOTD bootd
937 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800938 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500939 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500940 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500941 CONFIG_CMD_DATE * support for RTC, date/time...
942 CONFIG_CMD_DHCP * DHCP support
943 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600944 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
945 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
946 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
947 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500948 CONFIG_CMD_DTT * Digital Therm and Thermostat
949 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500950 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500951 CONFIG_CMD_EEPROM * EEPROM read/write support
952 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600953 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600954 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500955 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500956 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000957 CONFIG_CMD_EXT2 * ext2 command support
958 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700959 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
960 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500961 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500962 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000963 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500964 CONFIG_CMD_FLASH flinfo, erase, protect
965 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200966 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000967 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500968 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000969 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000970 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500971 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
972 CONFIG_CMD_I2C * I2C serial bus support
973 CONFIG_CMD_IDE * IDE harddisk support
974 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000975 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200976 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500977 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500978 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000979 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500980 CONFIG_CMD_IRQ * irqinfo
981 CONFIG_CMD_ITEST Integer/string test of 2 values
982 CONFIG_CMD_JFFS2 * JFFS2 Support
983 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200984 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000985 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
986 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500987 CONFIG_CMD_LOADB loadb
988 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200989 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400990 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000991 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500992 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000993 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200994 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500995 CONFIG_CMD_MISC Misc functions like sleep etc
996 CONFIG_CMD_MMC * MMC memory mapped support
997 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100998 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500999 CONFIG_CMD_NAND * NAND support
1000 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001001 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001002 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001003 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001004 CONFIG_CMD_PCI * pciinfo
1005 CONFIG_CMD_PCMCIA * PCMCIA support
1006 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1007 host
1008 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001009 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001010 CONFIG_CMD_REGINFO * Register dump
1011 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001012 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_SAVES * save S record dump
1014 CONFIG_CMD_SCSI * SCSI Support
1015 CONFIG_CMD_SDRAM * print SDRAM configuration information
1016 (requires CONFIG_CMD_I2C)
1017 CONFIG_CMD_SETGETDCR Support for DCR Register access
1018 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001019 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001020 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001021 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001022 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001023 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001024 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001025 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001026 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001027 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1028 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001029 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001030 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001031 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001032 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001033 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001034
1035 EXAMPLE: If you want all functions except of network
1036 support you can write:
1037
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001038 #include "config_cmd_all.h"
1039 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001040
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001041 Other Commands:
1042 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001043
1044 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001045 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001046 what you (and your U-Boot users) are doing. Data
1047 cache cannot be enabled on systems like the 8xx or
1048 8260 (where accesses to the IMMR region must be
1049 uncached), and it cannot be disabled on all other
1050 systems where we (mis-) use the data cache to hold an
1051 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001052
1053
1054 XXX - this list needs to get updated!
1055
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001056- Regular expression support:
1057 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001058 If this variable is defined, U-Boot is linked against
1059 the SLRE (Super Light Regular Expression) library,
1060 which adds regex support to some commands, as for
1061 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001062
Simon Glass45ba8072011-10-15 05:48:20 +00001063- Device tree:
1064 CONFIG_OF_CONTROL
1065 If this variable is defined, U-Boot will use a device tree
1066 to configure its devices, instead of relying on statically
1067 compiled #defines in the board file. This option is
1068 experimental and only available on a few boards. The device
1069 tree is available in the global data as gd->fdt_blob.
1070
Simon Glass2c0f79e2011-10-24 19:15:31 +00001071 U-Boot needs to get its device tree from somewhere. This can
1072 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001073
1074 CONFIG_OF_EMBED
1075 If this variable is defined, U-Boot will embed a device tree
1076 binary in its image. This device tree file should be in the
1077 board directory and called <soc>-<board>.dts. The binary file
1078 is then picked up in board_init_f() and made available through
1079 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001080
Simon Glass2c0f79e2011-10-24 19:15:31 +00001081 CONFIG_OF_SEPARATE
1082 If this variable is defined, U-Boot will build a device tree
1083 binary. It will be called u-boot.dtb. Architecture-specific
1084 code will locate it at run-time. Generally this works by:
1085
1086 cat u-boot.bin u-boot.dtb >image.bin
1087
1088 and in fact, U-Boot does this for you, creating a file called
1089 u-boot-dtb.bin which is useful in the common case. You can
1090 still use the individual files if you need something more
1091 exotic.
1092
wdenkc6097192002-11-03 00:24:07 +00001093- Watchdog:
1094 CONFIG_WATCHDOG
1095 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001096 support for the SoC. There must be support in the SoC
1097 specific code for a watchdog. For the 8xx and 8260
1098 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1099 register. When supported for a specific SoC is
1100 available, then no further board specific code should
1101 be needed to use it.
1102
1103 CONFIG_HW_WATCHDOG
1104 When using a watchdog circuitry external to the used
1105 SoC, then define this variable and provide board
1106 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001107
stroesec1551ea2003-04-04 15:53:41 +00001108- U-Boot Version:
1109 CONFIG_VERSION_VARIABLE
1110 If this variable is defined, an environment variable
1111 named "ver" is created by U-Boot showing the U-Boot
1112 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001113 Any change to this variable will be reverted at the
1114 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001115
wdenkc6097192002-11-03 00:24:07 +00001116- Real-Time Clock:
1117
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001118 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001119 has to be selected, too. Define exactly one of the
1120 following options:
1121
1122 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1123 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001124 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001125 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001126 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001127 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001128 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001129 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001130 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001131 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001132 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001133 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1134 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001135
wdenkb37c7e52003-06-30 16:24:52 +00001136 Note that if the RTC uses I2C, then the I2C interface
1137 must also be configured. See I2C Support, below.
1138
Peter Tysere92739d2008-12-17 16:36:21 -06001139- GPIO Support:
1140 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001141
Chris Packham5dec49c2010-12-19 10:12:13 +00001142 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1143 chip-ngpio pairs that tell the PCA953X driver the number of
1144 pins supported by a particular chip.
1145
Peter Tysere92739d2008-12-17 16:36:21 -06001146 Note that if the GPIO device uses I2C, then the I2C interface
1147 must also be configured. See I2C Support, below.
1148
wdenkc6097192002-11-03 00:24:07 +00001149- Timestamp Support:
1150
wdenk43d96162003-03-06 00:02:04 +00001151 When CONFIG_TIMESTAMP is selected, the timestamp
1152 (date and time) of an image is printed by image
1153 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001154 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001155
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001156- Partition Labels (disklabels) Supported:
1157 Zero or more of the following:
1158 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1159 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1160 Intel architecture, USB sticks, etc.
1161 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1162 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1163 bootloader. Note 2TB partition limit; see
1164 disk/part_efi.c
1165 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001166
Wolfgang Denk218ca722008-03-26 10:40:12 +01001167 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1168 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001169 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001170
1171- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001172 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1173 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001174
wdenk4d13cba2004-03-14 14:09:05 +00001175 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1176 be performed by calling the function
1177 ide_set_reset(int reset)
1178 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001179
1180- ATAPI Support:
1181 CONFIG_ATAPI
1182
1183 Set this to enable ATAPI support.
1184
wdenkc40b2952004-03-13 23:29:43 +00001185- LBA48 Support
1186 CONFIG_LBA48
1187
1188 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001189 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001190 Whithout these , LBA48 support uses 32bit variables and will 'only'
1191 support disks up to 2.1TB.
1192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001193 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001194 When enabled, makes the IDE subsystem use 64bit sector addresses.
1195 Default is 32bit.
1196
wdenkc6097192002-11-03 00:24:07 +00001197- SCSI Support:
1198 At the moment only there is only support for the
1199 SYM53C8XX SCSI controller; define
1200 CONFIG_SCSI_SYM53C8XX to enable it.
1201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001202 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1203 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1204 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001205 maximum numbers of LUNs, SCSI ID's and target
1206 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001207 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001208
Wolfgang Denk93e14592013-10-04 17:43:24 +02001209 The environment variable 'scsidevs' is set to the number of
1210 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001211
wdenkc6097192002-11-03 00:24:07 +00001212- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001213 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001214 Support for Intel 8254x/8257x gigabit chips.
1215
1216 CONFIG_E1000_SPI
1217 Utility code for direct access to the SPI bus on Intel 8257x.
1218 This does not do anything useful unless you set at least one
1219 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1220
1221 CONFIG_E1000_SPI_GENERIC
1222 Allow generic access to the SPI bus on the Intel 8257x, for
1223 example with the "sspi" command.
1224
1225 CONFIG_CMD_E1000
1226 Management command for E1000 devices. When used on devices
1227 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001228
Andre Schwarzac3315c2008-03-06 16:45:44 +01001229 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001230 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001231
wdenkc6097192002-11-03 00:24:07 +00001232 CONFIG_EEPRO100
1233 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001234 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001235 write routine for first time initialisation.
1236
1237 CONFIG_TULIP
1238 Support for Digital 2114x chips.
1239 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1240 modem chip initialisation (KS8761/QS6611).
1241
1242 CONFIG_NATSEMI
1243 Support for National dp83815 chips.
1244
1245 CONFIG_NS8382X
1246 Support for National dp8382[01] gigabit chips.
1247
wdenk45219c42003-05-12 21:50:16 +00001248- NETWORK Support (other):
1249
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001250 CONFIG_DRIVER_AT91EMAC
1251 Support for AT91RM9200 EMAC.
1252
1253 CONFIG_RMII
1254 Define this to use reduced MII inteface
1255
1256 CONFIG_DRIVER_AT91EMAC_QUIET
1257 If this defined, the driver is quiet.
1258 The driver doen't show link status messages.
1259
Rob Herringefdd7312011-12-15 11:15:49 +00001260 CONFIG_CALXEDA_XGMAC
1261 Support for the Calxeda XGMAC device
1262
Ashok3bb46d22012-10-15 06:20:47 +00001263 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001264 Support for SMSC's LAN91C96 chips.
1265
1266 CONFIG_LAN91C96_BASE
1267 Define this to hold the physical address
1268 of the LAN91C96's I/O space
1269
1270 CONFIG_LAN91C96_USE_32_BIT
1271 Define this to enable 32 bit addressing
1272
Ashok3bb46d22012-10-15 06:20:47 +00001273 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001274 Support for SMSC's LAN91C111 chip
1275
1276 CONFIG_SMC91111_BASE
1277 Define this to hold the physical address
1278 of the device (I/O space)
1279
1280 CONFIG_SMC_USE_32_BIT
1281 Define this if data bus is 32 bits
1282
1283 CONFIG_SMC_USE_IOFUNCS
1284 Define this to use i/o functions instead of macros
1285 (some hardware wont work with macros)
1286
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001287 CONFIG_DRIVER_TI_EMAC
1288 Support for davinci emac
1289
1290 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1291 Define this if you have more then 3 PHYs.
1292
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001293 CONFIG_FTGMAC100
1294 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1295
1296 CONFIG_FTGMAC100_EGIGA
1297 Define this to use GE link update with gigabit PHY.
1298 Define this if FTGMAC100 is connected to gigabit PHY.
1299 If your system has 10/100 PHY only, it might not occur
1300 wrong behavior. Because PHY usually return timeout or
1301 useless data when polling gigabit status and gigabit
1302 control registers. This behavior won't affect the
1303 correctnessof 10/100 link speed update.
1304
Mike Rapoportc2fff332009-11-11 10:03:03 +02001305 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001306 Support for SMSC's LAN911x and LAN921x chips
1307
Mike Rapoportc2fff332009-11-11 10:03:03 +02001308 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001309 Define this to hold the physical address
1310 of the device (I/O space)
1311
Mike Rapoportc2fff332009-11-11 10:03:03 +02001312 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001313 Define this if data bus is 32 bits
1314
Mike Rapoportc2fff332009-11-11 10:03:03 +02001315 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001316 Define this if data bus is 16 bits. If your processor
1317 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001318 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001319
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001320 CONFIG_SH_ETHER
1321 Support for Renesas on-chip Ethernet controller
1322
1323 CONFIG_SH_ETHER_USE_PORT
1324 Define the number of ports to be used
1325
1326 CONFIG_SH_ETHER_PHY_ADDR
1327 Define the ETH PHY's address
1328
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001329 CONFIG_SH_ETHER_CACHE_WRITEBACK
1330 If this option is set, the driver enables cache flush.
1331
Vadim Bendebury5e124722011-10-17 08:36:14 +00001332- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001333 CONFIG_TPM
1334 Support TPM devices.
1335
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001336 CONFIG_TPM_TIS_I2C
1337 Support for i2c bus TPM devices. Only one device
1338 per system is supported at this time.
1339
1340 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1341 Define the the i2c bus number for the TPM device
1342
1343 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1344 Define the TPM's address on the i2c bus
1345
1346 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1347 Define the burst count bytes upper limit
1348
Dirk Eibachc01939c2013-06-26 15:55:15 +02001349 CONFIG_TPM_ATMEL_TWI
1350 Support for Atmel TWI TPM device. Requires I2C support.
1351
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001352 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001353 Support for generic parallel port TPM devices. Only one device
1354 per system is supported at this time.
1355
1356 CONFIG_TPM_TIS_BASE_ADDRESS
1357 Base address where the generic TPM device is mapped
1358 to. Contemporary x86 systems usually map it at
1359 0xfed40000.
1360
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001361 CONFIG_CMD_TPM
1362 Add tpm monitor functions.
1363 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1364 provides monitor access to authorized functions.
1365
1366 CONFIG_TPM
1367 Define this to enable the TPM support library which provides
1368 functional interfaces to some TPM commands.
1369 Requires support for a TPM device.
1370
1371 CONFIG_TPM_AUTH_SESSIONS
1372 Define this to enable authorized functions in the TPM library.
1373 Requires CONFIG_TPM and CONFIG_SHA1.
1374
wdenkc6097192002-11-03 00:24:07 +00001375- USB Support:
1376 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001377 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001378 CONFIG_USB_UHCI to enable it.
1379 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001380 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001381 storage devices.
1382 Note:
1383 Supported are USB Keyboards and USB Floppy drives
1384 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001385 MPC5200 USB requires additional defines:
1386 CONFIG_USB_CLOCK
1387 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001388 CONFIG_PSC3_USB
1389 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001390 CONFIG_USB_CONFIG
1391 for differential drivers: 0x00001000
1392 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001393 for differential drivers on PSC3: 0x00000100
1394 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001395 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001396 May be defined to allow interrupt polling
1397 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001398
Simon Glass9ab4ce22012-02-27 10:52:47 +00001399 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1400 txfilltuning field in the EHCI controller on reset.
1401
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001402 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1403 interval for usb hub power-on delay.(minimum 100msec)
1404
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001405- USB Device:
1406 Define the below if you wish to use the USB console.
1407 Once firmware is rebuilt from a serial console issue the
1408 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001409 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001410 it has found a new device. The environment variable usbtty
1411 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001412 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001413 Common Device Class Abstract Control Model serial device.
1414 If you select usbtty = gserial you should be able to enumerate
1415 a Linux host by
1416 # modprobe usbserial vendor=0xVendorID product=0xProductID
1417 else if using cdc_acm, simply setting the environment
1418 variable usbtty to be cdc_acm should suffice. The following
1419 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001420
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001421 CONFIG_USB_DEVICE
1422 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001423
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001424 CONFIG_USB_TTY
1425 Define this to have a tty type of device available to
1426 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001427
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301428 CONFIG_USBD_HS
1429 Define this to enable the high speed support for usb
1430 device and usbtty. If this feature is enabled, a routine
1431 int is_usbd_high_speed(void)
1432 also needs to be defined by the driver to dynamically poll
1433 whether the enumeration has succeded at high speed or full
1434 speed.
1435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001436 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001437 Define this if you want stdin, stdout &/or stderr to
1438 be set to usbtty.
1439
1440 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001441 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001442 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001443 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001444
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001445 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001446 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001447 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001448
Wolfgang Denk386eda02006-06-14 18:14:56 +02001449 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001450 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001451 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001452 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1453 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1454 should pretend to be a Linux device to it's target host.
1455
1456 CONFIG_USBD_MANUFACTURER
1457 Define this string as the name of your company for
1458 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001459
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001460 CONFIG_USBD_PRODUCT_NAME
1461 Define this string as the name of your product
1462 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1463
1464 CONFIG_USBD_VENDORID
1465 Define this as your assigned Vendor ID from the USB
1466 Implementors Forum. This *must* be a genuine Vendor ID
1467 to avoid polluting the USB namespace.
1468 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001469
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001470 CONFIG_USBD_PRODUCTID
1471 Define this as the unique Product ID
1472 for your device
1473 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001474
Przemyslaw Marczak351e9b22013-10-23 14:30:46 +02001475 Some USB device drivers may need to check USB cable attachment.
1476 In this case you can enable following config in BoardName.h:
1477 CONFIG_USB_CABLE_CHECK
1478 This enables function definition:
1479 - usb_cable_connected() in include/usb.h
1480 Implementation of this function is board-specific.
1481
Igor Grinbergd70a5602011-12-12 12:08:35 +02001482- ULPI Layer Support:
1483 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1484 the generic ULPI layer. The generic layer accesses the ULPI PHY
1485 via the platform viewport, so you need both the genric layer and
1486 the viewport enabled. Currently only Chipidea/ARC based
1487 viewport is supported.
1488 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1489 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001490 If your ULPI phy needs a different reference clock than the
1491 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1492 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001493
1494- MMC Support:
1495 The MMC controller on the Intel PXA is supported. To
1496 enable this define CONFIG_MMC. The MMC can be
1497 accessed from the boot prompt by mapping the device
1498 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001499 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1500 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001501
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001502 CONFIG_SH_MMCIF
1503 Support for Renesas on-chip MMCIF controller
1504
1505 CONFIG_SH_MMCIF_ADDR
1506 Define the base address of MMCIF registers
1507
1508 CONFIG_SH_MMCIF_CLK
1509 Define the clock frequency for MMCIF
1510
Tom Rinib3ba6e92013-03-14 05:32:47 +00001511- USB Device Firmware Update (DFU) class support:
1512 CONFIG_DFU_FUNCTION
1513 This enables the USB portion of the DFU USB class
1514
1515 CONFIG_CMD_DFU
1516 This enables the command "dfu" which is used to have
1517 U-Boot create a DFU class device via USB. This command
1518 requires that the "dfu_alt_info" environment variable be
1519 set and define the alt settings to expose to the host.
1520
1521 CONFIG_DFU_MMC
1522 This enables support for exposing (e)MMC devices via DFU.
1523
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001524 CONFIG_DFU_NAND
1525 This enables support for exposing NAND devices via DFU.
1526
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301527 CONFIG_DFU_RAM
1528 This enables support for exposing RAM via DFU.
1529 Note: DFU spec refer to non-volatile memory usage, but
1530 allow usages beyond the scope of spec - here RAM usage,
1531 one that would help mostly the developer.
1532
Heiko Schochere7e75c72013-06-12 06:05:51 +02001533 CONFIG_SYS_DFU_DATA_BUF_SIZE
1534 Dfu transfer uses a buffer before writing data to the
1535 raw storage device. Make the size (in bytes) of this buffer
1536 configurable. The size of this buffer is also configurable
1537 through the "dfu_bufsiz" environment variable.
1538
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001539 CONFIG_SYS_DFU_MAX_FILE_SIZE
1540 When updating files rather than the raw storage device,
1541 we use a static buffer to copy the file into and then write
1542 the buffer once we've been given the whole file. Define
1543 this to the maximum filesize (in bytes) for the buffer.
1544 Default is 4 MiB if undefined.
1545
Heiko Schocher001a8312014-03-18 08:09:56 +01001546 DFU_DEFAULT_POLL_TIMEOUT
1547 Poll timeout [ms], is the timeout a device can send to the
1548 host. The host must wait for this timeout before sending
1549 a subsequent DFU_GET_STATUS request to the device.
1550
1551 DFU_MANIFEST_POLL_TIMEOUT
1552 Poll timeout [ms], which the device sends to the host when
1553 entering dfuMANIFEST state. Host waits this timeout, before
1554 sending again an USB request to the device.
1555
wdenk6705d812004-08-02 23:22:59 +00001556- Journaling Flash filesystem support:
1557 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1558 CONFIG_JFFS2_NAND_DEV
1559 Define these for a default partition on a NAND device
1560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001561 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1562 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001563 Define these for a default partition on a NOR device
1564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001565 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001566 Define this to create an own partition. You have to provide a
1567 function struct part_info* jffs2_part_info(int part_num)
1568
1569 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001570 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001571 to disable the command chpart. This is the default when you
1572 have not defined a custom partition
1573
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001574- FAT(File Allocation Table) filesystem write function support:
1575 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001576
1577 Define this to enable support for saving memory data as a
1578 file in FAT formatted partition.
1579
1580 This will also enable the command "fatwrite" enabling the
1581 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001582
Gabe Black84cd9322012-10-12 14:26:11 +00001583CBFS (Coreboot Filesystem) support
1584 CONFIG_CMD_CBFS
1585
1586 Define this to enable support for reading from a Coreboot
1587 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1588 and cbfsload.
1589
wdenkc6097192002-11-03 00:24:07 +00001590- Keyboard Support:
1591 CONFIG_ISA_KEYBOARD
1592
1593 Define this to enable standard (PC-Style) keyboard
1594 support
1595
1596 CONFIG_I8042_KBD
1597 Standard PC keyboard driver with US (is default) and
1598 GERMAN key layout (switch via environment 'keymap=de') support.
1599 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1600 for cfb_console. Supports cursor blinking.
1601
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001602 CONFIG_CROS_EC_KEYB
1603 Enables a Chrome OS keyboard using the CROS_EC interface.
1604 This uses CROS_EC to communicate with a second microcontroller
1605 which provides key scans on request.
1606
wdenkc6097192002-11-03 00:24:07 +00001607- Video support:
1608 CONFIG_VIDEO
1609
1610 Define this to enable video support (for output to
1611 video).
1612
1613 CONFIG_VIDEO_CT69000
1614
1615 Enable Chips & Technologies 69000 Video chip
1616
1617 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001618 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001619 video output is selected via environment 'videoout'
1620 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1621 assumed.
wdenkc6097192002-11-03 00:24:07 +00001622
wdenkb79a11c2004-03-25 15:14:43 +00001623 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001624 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001625 are possible:
1626 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001627 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001628
1629 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1630 -------------+---------------------------------------------
1631 8 bits | 0x301* 0x303 0x305 0x161 0x307
1632 15 bits | 0x310 0x313 0x316 0x162 0x319
1633 16 bits | 0x311 0x314 0x317 0x163 0x31A
1634 24 bits | 0x312 0x315 0x318 ? 0x31B
1635 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001636 (i.e. setenv videomode 317; saveenv; reset;)
1637
wdenkb79a11c2004-03-25 15:14:43 +00001638 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001639 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001640
1641
stroesec1551ea2003-04-04 15:53:41 +00001642 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001643 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001644 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1645 or CONFIG_VIDEO_SED13806_16BPP
1646
Timur Tabi7d3053f2011-02-15 17:09:19 -06001647 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001648 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001649 SOCs that have a DIU should define this macro to enable DIU
1650 support, and should also define these other macros:
1651
1652 CONFIG_SYS_DIU_ADDR
1653 CONFIG_VIDEO
1654 CONFIG_CMD_BMP
1655 CONFIG_CFB_CONSOLE
1656 CONFIG_VIDEO_SW_CURSOR
1657 CONFIG_VGA_AS_SINGLE_DEVICE
1658 CONFIG_VIDEO_LOGO
1659 CONFIG_VIDEO_BMP_LOGO
1660
Timur Tabiba8e76b2011-04-11 14:18:22 -05001661 The DIU driver will look for the 'video-mode' environment
1662 variable, and if defined, enable the DIU as a console during
1663 boot. See the documentation file README.video for a
1664 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001665
Simon Glass058d59b2012-12-03 13:59:47 +00001666 CONFIG_VIDEO_VGA
1667
1668 Enable the VGA video / BIOS for x86. The alternative if you
1669 are using coreboot is to use the coreboot frame buffer
1670 driver.
1671
1672
wdenk682011f2003-06-03 23:54:09 +00001673- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001674 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001675
wdenk8bde7f72003-06-27 21:31:46 +00001676 Define this to enable a custom keyboard support.
1677 This simply calls drv_keyboard_init() which must be
1678 defined in your board-specific files.
1679 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001680
wdenkc6097192002-11-03 00:24:07 +00001681- LCD Support: CONFIG_LCD
1682
1683 Define this to enable LCD support (for output to LCD
1684 display); also select one of the supported displays
1685 by defining one of these:
1686
Stelian Pop39cf4802008-05-09 21:57:18 +02001687 CONFIG_ATMEL_LCD:
1688
1689 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1690
wdenkfd3103b2003-11-25 16:55:19 +00001691 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001692
wdenkfd3103b2003-11-25 16:55:19 +00001693 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001694
wdenkfd3103b2003-11-25 16:55:19 +00001695 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001696
wdenkfd3103b2003-11-25 16:55:19 +00001697 NEC NL6448BC20-08. 6.5", 640x480.
1698 Active, color, single scan.
1699
1700 CONFIG_NEC_NL6448BC33_54
1701
1702 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001703 Active, color, single scan.
1704
1705 CONFIG_SHARP_16x9
1706
1707 Sharp 320x240. Active, color, single scan.
1708 It isn't 16x9, and I am not sure what it is.
1709
1710 CONFIG_SHARP_LQ64D341
1711
1712 Sharp LQ64D341 display, 640x480.
1713 Active, color, single scan.
1714
1715 CONFIG_HLD1045
1716
1717 HLD1045 display, 640x480.
1718 Active, color, single scan.
1719
1720 CONFIG_OPTREX_BW
1721
1722 Optrex CBL50840-2 NF-FW 99 22 M5
1723 or
1724 Hitachi LMG6912RPFC-00T
1725 or
1726 Hitachi SP14Q002
1727
1728 320x240. Black & white.
1729
1730 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001731 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001732
Simon Glass676d3192012-10-17 13:24:54 +00001733 CONFIG_LCD_ALIGNMENT
1734
1735 Normally the LCD is page-aligned (tyically 4KB). If this is
1736 defined then the LCD will be aligned to this value instead.
1737 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1738 here, since it is cheaper to change data cache settings on
1739 a per-section basis.
1740
Simon Glass0d89efe2012-10-17 13:24:59 +00001741 CONFIG_CONSOLE_SCROLL_LINES
1742
1743 When the console need to be scrolled, this is the number of
1744 lines to scroll by. It defaults to 1. Increasing this makes
1745 the console jump but can help speed up operation when scrolling
1746 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001747
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001748 CONFIG_LCD_BMP_RLE8
1749
1750 Support drawing of RLE8-compressed bitmaps on the LCD.
1751
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001752 CONFIG_I2C_EDID
1753
1754 Enables an 'i2c edid' command which can read EDID
1755 information over I2C from an attached LCD display.
1756
wdenk7152b1d2003-09-05 23:19:14 +00001757- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001758
wdenk8bde7f72003-06-27 21:31:46 +00001759 If this option is set, the environment is checked for
1760 a variable "splashimage". If found, the usual display
1761 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001762 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001763 specified in "splashimage" is loaded instead. The
1764 console is redirected to the "nulldev", too. This
1765 allows for a "silent" boot where a splash screen is
1766 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001767
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001768 CONFIG_SPLASHIMAGE_GUARD
1769
1770 If this option is set, then U-Boot will prevent the environment
1771 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001772 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001773 This option is useful for targets where, due to alignment
1774 restrictions, an improperly aligned BMP image will cause a data
1775 abort. If you think you will not have problems with unaligned
1776 accesses (for example because your toolchain prevents them)
1777 there is no need to set this option.
1778
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001779 CONFIG_SPLASH_SCREEN_ALIGN
1780
1781 If this option is set the splash image can be freely positioned
1782 on the screen. Environment variable "splashpos" specifies the
1783 position as "x,y". If a positive number is given it is used as
1784 number of pixel from left/top. If a negative number is given it
1785 is used as number of pixel from right/bottom. You can also
1786 specify 'm' for centering the image.
1787
1788 Example:
1789 setenv splashpos m,m
1790 => image at center of screen
1791
1792 setenv splashpos 30,20
1793 => image at x = 30 and y = 20
1794
1795 setenv splashpos -10,m
1796 => vertically centered image
1797 at x = dspWidth - bmpWidth - 9
1798
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001799- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1800
1801 If this option is set, additionally to standard BMP
1802 images, gzipped BMP images can be displayed via the
1803 splashscreen support or the bmp command.
1804
Anatolij Gustschind5011762010-03-15 14:50:25 +01001805- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1806
1807 If this option is set, 8-bit RLE compressed BMP images
1808 can be displayed via the splashscreen support or the
1809 bmp command.
1810
Lei Wenf2b96df2012-09-28 04:26:47 +00001811- Do compresssing for memory range:
1812 CONFIG_CMD_ZIP
1813
1814 If this option is set, it would use zlib deflate method
1815 to compress the specified memory at its best effort.
1816
wdenkc29fdfc2003-08-29 20:57:53 +00001817- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001818 CONFIG_GZIP
1819
1820 Enabled by default to support gzip compressed images.
1821
wdenkc29fdfc2003-08-29 20:57:53 +00001822 CONFIG_BZIP2
1823
1824 If this option is set, support for bzip2 compressed
1825 images is included. If not, only uncompressed and gzip
1826 compressed images are supported.
1827
wdenk42d1f032003-10-15 23:53:47 +00001828 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001829 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001830 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001831
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001832 CONFIG_LZMA
1833
1834 If this option is set, support for lzma compressed
1835 images is included.
1836
1837 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1838 requires an amount of dynamic memory that is given by the
1839 formula:
1840
1841 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1842
1843 Where lc and lp stand for, respectively, Literal context bits
1844 and Literal pos bits.
1845
1846 This value is upper-bounded by 14MB in the worst case. Anyway,
1847 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1848 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1849 a very small buffer.
1850
1851 Use the lzmainfo tool to determinate the lc and lp values and
1852 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001853 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001854
Kees Cook8ef70472013-08-16 07:59:12 -07001855 CONFIG_LZO
1856
1857 If this option is set, support for LZO compressed images
1858 is included.
1859
wdenk17ea1172004-06-06 21:51:03 +00001860- MII/PHY support:
1861 CONFIG_PHY_ADDR
1862
1863 The address of PHY on MII bus.
1864
1865 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1866
1867 The clock frequency of the MII bus
1868
1869 CONFIG_PHY_GIGE
1870
1871 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001872 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001873
1874 CONFIG_PHY_RESET_DELAY
1875
1876 Some PHY like Intel LXT971A need extra delay after
1877 reset before any MII register access is possible.
1878 For such PHY, set this option to the usec delay
1879 required. (minimum 300usec for LXT971A)
1880
1881 CONFIG_PHY_CMD_DELAY (ppc4xx)
1882
1883 Some PHY like Intel LXT971A need extra delay after
1884 command issued before MII status register can be read
1885
wdenkc6097192002-11-03 00:24:07 +00001886- Ethernet address:
1887 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001888 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001889 CONFIG_ETH2ADDR
1890 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001891 CONFIG_ETH4ADDR
1892 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001893
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001894 Define a default value for Ethernet address to use
1895 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001896 is not determined automatically.
1897
1898- IP address:
1899 CONFIG_IPADDR
1900
1901 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001902 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001903 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001904 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001905
1906- Server IP address:
1907 CONFIG_SERVERIP
1908
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001909 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001910 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001911 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001912
Robin Getz97cfe862009-07-21 12:15:28 -04001913 CONFIG_KEEP_SERVERADDR
1914
1915 Keeps the server's MAC address, in the env 'serveraddr'
1916 for passing to bootargs (like Linux's netconsole option)
1917
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001918- Gateway IP address:
1919 CONFIG_GATEWAYIP
1920
1921 Defines a default value for the IP address of the
1922 default router where packets to other networks are
1923 sent to.
1924 (Environment variable "gatewayip")
1925
1926- Subnet mask:
1927 CONFIG_NETMASK
1928
1929 Defines a default value for the subnet mask (or
1930 routing prefix) which is used to determine if an IP
1931 address belongs to the local subnet or needs to be
1932 forwarded through a router.
1933 (Environment variable "netmask")
1934
David Updegraff53a5c422007-06-11 10:41:07 -05001935- Multicast TFTP Mode:
1936 CONFIG_MCAST_TFTP
1937
1938 Defines whether you want to support multicast TFTP as per
1939 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001940 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001941 driver in use must provide a function: mcast() to join/leave a
1942 multicast group.
1943
wdenkc6097192002-11-03 00:24:07 +00001944- BOOTP Recovery Mode:
1945 CONFIG_BOOTP_RANDOM_DELAY
1946
1947 If you have many targets in a network that try to
1948 boot using BOOTP, you may want to avoid that all
1949 systems send out BOOTP requests at precisely the same
1950 moment (which would happen for instance at recovery
1951 from a power failure, when all systems will try to
1952 boot, thus flooding the BOOTP server. Defining
1953 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1954 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001955 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001956
1957 1st BOOTP request: delay 0 ... 1 sec
1958 2nd BOOTP request: delay 0 ... 2 sec
1959 3rd BOOTP request: delay 0 ... 4 sec
1960 4th and following
1961 BOOTP requests: delay 0 ... 8 sec
1962
stroesefe389a82003-08-28 14:17:32 +00001963- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001964 You can fine tune the DHCP functionality by defining
1965 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001966
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001967 CONFIG_BOOTP_SUBNETMASK
1968 CONFIG_BOOTP_GATEWAY
1969 CONFIG_BOOTP_HOSTNAME
1970 CONFIG_BOOTP_NISDOMAIN
1971 CONFIG_BOOTP_BOOTPATH
1972 CONFIG_BOOTP_BOOTFILESIZE
1973 CONFIG_BOOTP_DNS
1974 CONFIG_BOOTP_DNS2
1975 CONFIG_BOOTP_SEND_HOSTNAME
1976 CONFIG_BOOTP_NTPSERVER
1977 CONFIG_BOOTP_TIMEOFFSET
1978 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001979 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001980
Wilson Callan5d110f02007-07-28 10:56:13 -04001981 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1982 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001983
Joe Hershberger2c00e092012-05-23 07:59:19 +00001984 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1985 after the configured retry count, the call will fail
1986 instead of starting over. This can be used to fail over
1987 to Link-local IP address configuration if the DHCP server
1988 is not available.
1989
stroesefe389a82003-08-28 14:17:32 +00001990 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1991 serverip from a DHCP server, it is possible that more
1992 than one DNS serverip is offered to the client.
1993 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1994 serverip will be stored in the additional environment
1995 variable "dnsip2". The first DNS serverip is always
1996 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001997 is defined.
stroesefe389a82003-08-28 14:17:32 +00001998
1999 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2000 to do a dynamic update of a DNS server. To do this, they
2001 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002002 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002003 of the "hostname" environment variable is passed as
2004 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002005
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002006 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2007
2008 A 32bit value in microseconds for a delay between
2009 receiving a "DHCP Offer" and sending the "DHCP Request".
2010 This fixes a problem with certain DHCP servers that don't
2011 respond 100% of the time to a "DHCP request". E.g. On an
2012 AT91RM9200 processor running at 180MHz, this delay needed
2013 to be *at least* 15,000 usec before a Windows Server 2003
2014 DHCP server would reply 100% of the time. I recommend at
2015 least 50,000 usec to be safe. The alternative is to hope
2016 that one of the retries will be successful but note that
2017 the DHCP timeout and retry process takes a longer than
2018 this delay.
2019
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002020 - Link-local IP address negotiation:
2021 Negotiate with other link-local clients on the local network
2022 for an address that doesn't require explicit configuration.
2023 This is especially useful if a DHCP server cannot be guaranteed
2024 to exist in all environments that the device must operate.
2025
2026 See doc/README.link-local for more information.
2027
wdenka3d991b2004-04-15 21:48:45 +00002028 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002029 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002030
2031 The device id used in CDP trigger frames.
2032
2033 CONFIG_CDP_DEVICE_ID_PREFIX
2034
2035 A two character string which is prefixed to the MAC address
2036 of the device.
2037
2038 CONFIG_CDP_PORT_ID
2039
2040 A printf format string which contains the ascii name of
2041 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002042 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002043
2044 CONFIG_CDP_CAPABILITIES
2045
2046 A 32bit integer which indicates the device capabilities;
2047 0x00000010 for a normal host which does not forwards.
2048
2049 CONFIG_CDP_VERSION
2050
2051 An ascii string containing the version of the software.
2052
2053 CONFIG_CDP_PLATFORM
2054
2055 An ascii string containing the name of the platform.
2056
2057 CONFIG_CDP_TRIGGER
2058
2059 A 32bit integer sent on the trigger.
2060
2061 CONFIG_CDP_POWER_CONSUMPTION
2062
2063 A 16bit integer containing the power consumption of the
2064 device in .1 of milliwatts.
2065
2066 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2067
2068 A byte containing the id of the VLAN.
2069
wdenkc6097192002-11-03 00:24:07 +00002070- Status LED: CONFIG_STATUS_LED
2071
2072 Several configurations allow to display the current
2073 status using a LED. For instance, the LED will blink
2074 fast while running U-Boot code, stop blinking as
2075 soon as a reply to a BOOTP request was received, and
2076 start blinking slow once the Linux kernel is running
2077 (supported by a status LED driver in the Linux
2078 kernel). Defining CONFIG_STATUS_LED enables this
2079 feature in U-Boot.
2080
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002081 Additional options:
2082
2083 CONFIG_GPIO_LED
2084 The status LED can be connected to a GPIO pin.
2085 In such cases, the gpio_led driver can be used as a
2086 status LED backend implementation. Define CONFIG_GPIO_LED
2087 to include the gpio_led driver in the U-Boot binary.
2088
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002089 CONFIG_GPIO_LED_INVERTED_TABLE
2090 Some GPIO connected LEDs may have inverted polarity in which
2091 case the GPIO high value corresponds to LED off state and
2092 GPIO low value corresponds to LED on state.
2093 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2094 with a list of GPIO LEDs that have inverted polarity.
2095
wdenkc6097192002-11-03 00:24:07 +00002096- CAN Support: CONFIG_CAN_DRIVER
2097
2098 Defining CONFIG_CAN_DRIVER enables CAN driver support
2099 on those systems that support this (optional)
2100 feature, like the TQM8xxL modules.
2101
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002102- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002103
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002104 This enable the NEW i2c subsystem, and will allow you to use
2105 i2c commands at the u-boot command line (as long as you set
2106 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2107 based realtime clock chips or other i2c devices. See
2108 common/cmd_i2c.c for a description of the command line
2109 interface.
2110
2111 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002112 - drivers/i2c/soft_i2c.c:
2113 - activate first bus with CONFIG_SYS_I2C_SOFT define
2114 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2115 for defining speed and slave address
2116 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2117 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2118 for defining speed and slave address
2119 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2120 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2121 for defining speed and slave address
2122 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2123 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2124 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002125
Heiko Schocher00f792e2012-10-24 13:48:22 +02002126 - drivers/i2c/fsl_i2c.c:
2127 - activate i2c driver with CONFIG_SYS_I2C_FSL
2128 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2129 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2130 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2131 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002132 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002133 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2134 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2135 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2136 second bus.
2137
Simon Glass1f2ba722012-10-30 07:28:53 +00002138 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002139 - activate this driver with CONFIG_SYS_I2C_TEGRA
2140 - This driver adds 4 i2c buses with a fix speed from
2141 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002142
Dirk Eibach880540d2013-04-25 02:40:01 +00002143 - drivers/i2c/ppc4xx_i2c.c
2144 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2145 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2146 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2147
tremfac96402013-09-21 18:13:35 +02002148 - drivers/i2c/i2c_mxc.c
2149 - activate this driver with CONFIG_SYS_I2C_MXC
2150 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2151 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2152 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2153 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2154 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2155 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2156 If thoses defines are not set, default value is 100000
2157 for speed, and 0 for slave.
2158
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002159 - drivers/i2c/rcar_i2c.c:
2160 - activate this driver with CONFIG_SYS_I2C_RCAR
2161 - This driver adds 4 i2c buses
2162
2163 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2164 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2165 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2166 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2167 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2168 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2169 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2170 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2171 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2172
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002173 - drivers/i2c/sh_i2c.c:
2174 - activate this driver with CONFIG_SYS_I2C_SH
2175 - This driver adds from 2 to 5 i2c buses
2176
2177 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2178 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2179 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2180 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2181 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2182 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2183 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2184 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2185 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2186 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2187 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2188 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2189 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2190
Heiko Schocher6789e842013-10-22 11:03:18 +02002191 - drivers/i2c/omap24xx_i2c.c
2192 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2193 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2194 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2195 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2196 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2197 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2198 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2199 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2200 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2201 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2202 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2203
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002204 - drivers/i2c/zynq_i2c.c
2205 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2206 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2207 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2208
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302209 - drivers/i2c/s3c24x0_i2c.c:
2210 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2211 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2212 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2213 with a fix speed from 100000 and the slave addr 0!
2214
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002215 additional defines:
2216
2217 CONFIG_SYS_NUM_I2C_BUSES
2218 Hold the number of i2c busses you want to use. If you
2219 don't use/have i2c muxes on your i2c bus, this
2220 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2221 omit this define.
2222
2223 CONFIG_SYS_I2C_DIRECT_BUS
2224 define this, if you don't use i2c muxes on your hardware.
2225 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2226 omit this define.
2227
2228 CONFIG_SYS_I2C_MAX_HOPS
2229 define how many muxes are maximal consecutively connected
2230 on one i2c bus. If you not use i2c muxes, omit this
2231 define.
2232
2233 CONFIG_SYS_I2C_BUSES
2234 hold a list of busses you want to use, only used if
2235 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2236 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2237 CONFIG_SYS_NUM_I2C_BUSES = 9:
2238
2239 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2240 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2241 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2242 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2243 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2244 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2245 {1, {I2C_NULL_HOP}}, \
2246 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2247 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2248 }
2249
2250 which defines
2251 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002252 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2253 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2254 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2255 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2256 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002257 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002258 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2259 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002260
2261 If you do not have i2c muxes on your board, omit this define.
2262
Heiko Schocherea818db2013-01-29 08:53:15 +01002263- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002264
2265 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2266 provides the following compelling advantages:
2267
2268 - more than one i2c adapter is usable
2269 - approved multibus support
2270 - better i2c mux support
2271
2272 ** Please consider updating your I2C driver now. **
2273
Heiko Schocherea818db2013-01-29 08:53:15 +01002274 These enable legacy I2C serial bus commands. Defining
2275 CONFIG_HARD_I2C will include the appropriate I2C driver
2276 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002277
wdenk945af8d2003-07-16 21:53:01 +00002278 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002279 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002280 CONFIG_COMMANDS) and communicate with i2c based realtime
2281 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002282 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002283
Ben Warrenbb99ad62006-09-07 16:50:54 -04002284 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002285
wdenk945af8d2003-07-16 21:53:01 +00002286 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002287 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002289 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002290 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002292 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002293
Peter Tyser8d321b82010-04-12 22:28:21 -05002294 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002295 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002296 and so its address should therefore be cleared to 0 (See,
2297 eg, MPC823e User's Manual p.16-473). So, set
2298 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002299
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002300 CONFIG_SYS_I2C_INIT_MPC5XXX
2301
2302 When a board is reset during an i2c bus transfer
2303 chips might think that the current transfer is still
2304 in progress. Reset the slave devices by sending start
2305 commands until the slave device responds.
2306
wdenk945af8d2003-07-16 21:53:01 +00002307 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002308
Heiko Schocherea818db2013-01-29 08:53:15 +01002309 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002310 then the following macros need to be defined (examples are
2311 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002312
2313 I2C_INIT
2314
wdenkb37c7e52003-06-30 16:24:52 +00002315 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002316 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002317
wdenkba56f622004-02-06 23:19:44 +00002318 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002319
wdenkc6097192002-11-03 00:24:07 +00002320 I2C_PORT
2321
wdenk43d96162003-03-06 00:02:04 +00002322 (Only for MPC8260 CPU). The I/O port to use (the code
2323 assumes both bits are on the same port). Valid values
2324 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002325
2326 I2C_ACTIVE
2327
2328 The code necessary to make the I2C data line active
2329 (driven). If the data line is open collector, this
2330 define can be null.
2331
wdenkb37c7e52003-06-30 16:24:52 +00002332 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2333
wdenkc6097192002-11-03 00:24:07 +00002334 I2C_TRISTATE
2335
2336 The code necessary to make the I2C data line tri-stated
2337 (inactive). If the data line is open collector, this
2338 define can be null.
2339
wdenkb37c7e52003-06-30 16:24:52 +00002340 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2341
wdenkc6097192002-11-03 00:24:07 +00002342 I2C_READ
2343
York Sun472d5462013-04-01 11:29:11 -07002344 Code that returns true if the I2C data line is high,
2345 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002346
wdenkb37c7e52003-06-30 16:24:52 +00002347 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2348
wdenkc6097192002-11-03 00:24:07 +00002349 I2C_SDA(bit)
2350
York Sun472d5462013-04-01 11:29:11 -07002351 If <bit> is true, sets the I2C data line high. If it
2352 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002353
wdenkb37c7e52003-06-30 16:24:52 +00002354 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002355 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002356 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002357
wdenkc6097192002-11-03 00:24:07 +00002358 I2C_SCL(bit)
2359
York Sun472d5462013-04-01 11:29:11 -07002360 If <bit> is true, sets the I2C clock line high. If it
2361 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002362
wdenkb37c7e52003-06-30 16:24:52 +00002363 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002364 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002365 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002366
wdenkc6097192002-11-03 00:24:07 +00002367 I2C_DELAY
2368
2369 This delay is invoked four times per clock cycle so this
2370 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002371 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002372 like:
2373
wdenkb37c7e52003-06-30 16:24:52 +00002374 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002375
Mike Frysinger793b5722010-07-21 13:38:02 -04002376 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2377
2378 If your arch supports the generic GPIO framework (asm/gpio.h),
2379 then you may alternatively define the two GPIOs that are to be
2380 used as SCL / SDA. Any of the previous I2C_xxx macros will
2381 have GPIO-based defaults assigned to them as appropriate.
2382
2383 You should define these to the GPIO value as given directly to
2384 the generic GPIO functions.
2385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002386 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002387
wdenk8bde7f72003-06-27 21:31:46 +00002388 When a board is reset during an i2c bus transfer
2389 chips might think that the current transfer is still
2390 in progress. On some boards it is possible to access
2391 the i2c SCLK line directly, either by using the
2392 processor pin as a GPIO or by having a second pin
2393 connected to the bus. If this option is defined a
2394 custom i2c_init_board() routine in boards/xxx/board.c
2395 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002396
Richard Retanubun26a33502010-04-12 15:08:17 -04002397 CONFIG_SYS_I2C_BOARD_LATE_INIT
2398
2399 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2400 defined a custom i2c_board_late_init() routine in
2401 boards/xxx/board.c is run AFTER the operations in i2c_init()
2402 is completed. This callpoint can be used to unreset i2c bus
2403 using CPU i2c controller register accesses for CPUs whose i2c
2404 controller provide such a method. It is called at the end of
2405 i2c_init() to allow i2c_init operations to setup the i2c bus
2406 controller on the CPU (e.g. setting bus speed & slave address).
2407
wdenk17ea1172004-06-06 21:51:03 +00002408 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2409
2410 This option enables configuration of bi_iic_fast[] flags
2411 in u-boot bd_info structure based on u-boot environment
2412 variable "i2cfast". (see also i2cfast)
2413
Ben Warrenbb99ad62006-09-07 16:50:54 -04002414 CONFIG_I2C_MULTI_BUS
2415
2416 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002417 must have a controller. At any point in time, only one bus is
2418 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002419 Note that bus numbering is zero-based.
2420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002421 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002422
2423 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002424 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002425 is set, specify a list of bus-device pairs. Otherwise, specify
2426 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002427
2428 e.g.
2429 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002430 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002431
2432 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2433
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002434 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002435 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002436
2437 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2438
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002439 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06002440
2441 If defined, then this indicates the I2C bus number for DDR SPD.
2442 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002444 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002445
2446 If defined, then this indicates the I2C bus number for the RTC.
2447 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002449 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002450
2451 If defined, then this indicates the I2C bus number for the DTT.
2452 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002454 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002455
2456 If defined, specifies the I2C address of the DTT device.
2457 If not defined, then U-Boot uses predefined value for
2458 specified DTT device.
2459
Andrew Dyer2ac69852008-12-29 17:36:01 -06002460 CONFIG_SOFT_I2C_READ_REPEATED_START
2461
2462 defining this will force the i2c_read() function in
2463 the soft_i2c driver to perform an I2C repeated start
2464 between writing the address pointer and reading the
2465 data. If this define is omitted the default behaviour
2466 of doing a stop-start sequence will be used. Most I2C
2467 devices can use either method, but some require one or
2468 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06002469
wdenkc6097192002-11-03 00:24:07 +00002470- SPI Support: CONFIG_SPI
2471
2472 Enables SPI driver (so far only tested with
2473 SPI EEPROM, also an instance works with Crystal A/D and
2474 D/As on the SACSng board)
2475
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002476 CONFIG_SH_SPI
2477
2478 Enables the driver for SPI controller on SuperH. Currently
2479 only SH7757 is supported.
2480
wdenkc6097192002-11-03 00:24:07 +00002481 CONFIG_SPI_X
2482
2483 Enables extended (16-bit) SPI EEPROM addressing.
2484 (symmetrical to CONFIG_I2C_X)
2485
2486 CONFIG_SOFT_SPI
2487
wdenk43d96162003-03-06 00:02:04 +00002488 Enables a software (bit-bang) SPI driver rather than
2489 using hardware support. This is a general purpose
2490 driver that only requires three general I/O port pins
2491 (two outputs, one input) to function. If this is
2492 defined, the board configuration must define several
2493 SPI configuration items (port pins to use, etc). For
2494 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002495
Ben Warren04a9e112008-01-16 22:37:35 -05002496 CONFIG_HARD_SPI
2497
2498 Enables a hardware SPI driver for general-purpose reads
2499 and writes. As with CONFIG_SOFT_SPI, the board configuration
2500 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002501 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002502 example, see include/configs/mpc8349emds.h.
2503
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002504 CONFIG_MXC_SPI
2505
2506 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002507 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002508
Matthias Fuchs01335022007-12-27 17:12:34 +01002509- FPGA Support: CONFIG_FPGA
2510
2511 Enables FPGA subsystem.
2512
2513 CONFIG_FPGA_<vendor>
2514
2515 Enables support for specific chip vendors.
2516 (ALTERA, XILINX)
2517
2518 CONFIG_FPGA_<family>
2519
2520 Enables support for FPGA family.
2521 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2522
2523 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002524
wdenk43d96162003-03-06 00:02:04 +00002525 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk8bde7f72003-06-27 21:31:46 +00002529 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk43d96162003-03-06 00:02:04 +00002533 Enable checks on FPGA configuration interface busy
2534 status by the configuration function. This option
2535 will require a board or device specific function to
2536 be written.
wdenkc6097192002-11-03 00:24:07 +00002537
2538 CONFIG_FPGA_DELAY
2539
2540 If defined, a function that provides delays in the FPGA
2541 configuration driver.
2542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002544 Allow Control-C to interrupt FPGA configuration
2545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002546 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk43d96162003-03-06 00:02:04 +00002548 Check for configuration errors during FPGA bitfile
2549 loading. For example, abort during Virtex II
2550 configuration if the INIT_B line goes low (which
2551 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002554
wdenk43d96162003-03-06 00:02:04 +00002555 Maximum time to wait for the INIT_B line to deassert
2556 after PROB_B has been deasserted during a Virtex II
2557 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002558 ms.
wdenkc6097192002-11-03 00:24:07 +00002559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002561
wdenk43d96162003-03-06 00:02:04 +00002562 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002563 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002565 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002566
wdenk43d96162003-03-06 00:02:04 +00002567 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002568 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002569
2570- Configuration Management:
2571 CONFIG_IDENT_STRING
2572
wdenk43d96162003-03-06 00:02:04 +00002573 If defined, this string will be added to the U-Boot
2574 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002575
2576- Vendor Parameter Protection:
2577
wdenk43d96162003-03-06 00:02:04 +00002578 U-Boot considers the values of the environment
2579 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002580 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002581 are set once by the board vendor / manufacturer, and
2582 protects these variables from casual modification by
2583 the user. Once set, these variables are read-only,
2584 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002585 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002586
2587 If CONFIG_ENV_OVERWRITE is #defined in your config
2588 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002589 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002590 these parameters.
2591
2592 Alternatively, if you #define _both_ CONFIG_ETHADDR
2593 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002594 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002595 which can be changed exactly ONCE by the user. [The
2596 serial# is unaffected by this, i. e. it remains
2597 read-only.]
2598
Joe Hershberger25980902012-12-11 22:16:31 -06002599 The same can be accomplished in a more flexible way
2600 for any variable by configuring the type of access
2601 to allow for those variables in the ".flags" variable
2602 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2603
wdenkc6097192002-11-03 00:24:07 +00002604- Protected RAM:
2605 CONFIG_PRAM
2606
2607 Define this variable to enable the reservation of
2608 "protected RAM", i. e. RAM which is not overwritten
2609 by U-Boot. Define CONFIG_PRAM to hold the number of
2610 kB you want to reserve for pRAM. You can overwrite
2611 this default value by defining an environment
2612 variable "pram" to the number of kB you want to
2613 reserve. Note that the board info structure will
2614 still show the full amount of RAM. If pRAM is
2615 reserved, a new environment variable "mem" will
2616 automatically be defined to hold the amount of
2617 remaining RAM in a form that can be passed as boot
2618 argument to Linux, for instance like that:
2619
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002620 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002621 saveenv
2622
2623 This way you can tell Linux not to use this memory,
2624 either, which results in a memory region that will
2625 not be affected by reboots.
2626
2627 *WARNING* If your board configuration uses automatic
2628 detection of the RAM size, you must make sure that
2629 this memory test is non-destructive. So far, the
2630 following board configurations are known to be
2631 "pRAM-clean":
2632
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002633 IVMS8, IVML24, SPD8xx, TQM8xxL,
2634 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002635 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002636
Gabe Black40fef042012-12-02 04:55:18 +00002637- Access to physical memory region (> 4GB)
2638 Some basic support is provided for operations on memory not
2639 normally accessible to U-Boot - e.g. some architectures
2640 support access to more than 4GB of memory on 32-bit
2641 machines using physical address extension or similar.
2642 Define CONFIG_PHYSMEM to access this basic support, which
2643 currently only supports clearing the memory.
2644
wdenkc6097192002-11-03 00:24:07 +00002645- Error Recovery:
2646 CONFIG_PANIC_HANG
2647
2648 Define this variable to stop the system in case of a
2649 fatal error, so that you have to reset it manually.
2650 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002651 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002652 automatically as fast as possible, but it may be
2653 useful during development since you can try to debug
2654 the conditions that lead to the situation.
2655
2656 CONFIG_NET_RETRY_COUNT
2657
wdenk43d96162003-03-06 00:02:04 +00002658 This variable defines the number of retries for
2659 network operations like ARP, RARP, TFTP, or BOOTP
2660 before giving up the operation. If not defined, a
2661 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002662
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002663 CONFIG_ARP_TIMEOUT
2664
2665 Timeout waiting for an ARP reply in milliseconds.
2666
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002667 CONFIG_NFS_TIMEOUT
2668
2669 Timeout in milliseconds used in NFS protocol.
2670 If you encounter "ERROR: Cannot umount" in nfs command,
2671 try longer timeout such as
2672 #define CONFIG_NFS_TIMEOUT 10000UL
2673
wdenkc6097192002-11-03 00:24:07 +00002674- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002675 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002676
2677 Enable auto completion of commands using TAB.
2678
Wolfgang Denka9398e02006-11-27 15:32:42 +01002679 Note that this feature has NOT been implemented yet
2680 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002681
2682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002684
2685 Define this variable to enable the "hush" shell (from
2686 Busybox) as command line interpreter, thus enabling
2687 powerful command line syntax like
2688 if...then...else...fi conditionals or `&&' and '||'
2689 constructs ("shell scripts").
2690
2691 If undefined, you get the old, much simpler behaviour
2692 with a somewhat smaller memory footprint.
2693
2694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002695 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002696
2697 This defines the secondary prompt string, which is
2698 printed when the command interpreter needs more input
2699 to complete a command. Usually "> ".
2700
2701 Note:
2702
wdenk8bde7f72003-06-27 21:31:46 +00002703 In the current implementation, the local variables
2704 space and global environment variables space are
2705 separated. Local variables are those you define by
2706 simply typing `name=value'. To access a local
2707 variable later on, you have write `$name' or
2708 `${name}'; to execute the contents of a variable
2709 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002710
wdenk43d96162003-03-06 00:02:04 +00002711 Global environment variables are those you use
2712 setenv/printenv to work with. To run a command stored
2713 in such a variable, you need to use the run command,
2714 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002715
2716 To store commands and special characters in a
2717 variable, please use double quotation marks
2718 surrounding the whole text of the variable, instead
2719 of the backslashes before semicolons and special
2720 symbols.
2721
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002722- Commandline Editing and History:
2723 CONFIG_CMDLINE_EDITING
2724
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002725 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002726 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002727
wdenka8c7c702003-12-06 19:49:23 +00002728- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002729 CONFIG_EXTRA_ENV_SETTINGS
2730
wdenk43d96162003-03-06 00:02:04 +00002731 Define this to contain any number of null terminated
2732 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002733 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002734
wdenk43d96162003-03-06 00:02:04 +00002735 For example, place something like this in your
2736 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002737
2738 #define CONFIG_EXTRA_ENV_SETTINGS \
2739 "myvar1=value1\0" \
2740 "myvar2=value2\0"
2741
wdenk43d96162003-03-06 00:02:04 +00002742 Warning: This method is based on knowledge about the
2743 internal format how the environment is stored by the
2744 U-Boot code. This is NOT an official, exported
2745 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002746 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002747 You better know what you are doing here.
2748
wdenk43d96162003-03-06 00:02:04 +00002749 Note: overly (ab)use of the default environment is
2750 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002751 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002752 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002753
Stephen Warren5e724ca2012-05-22 09:21:54 +00002754 CONFIG_ENV_VARS_UBOOT_CONFIG
2755
2756 Define this in order to add variables describing the
2757 U-Boot build configuration to the default environment.
2758 These will be named arch, cpu, board, vendor, and soc.
2759
2760 Enabling this option will cause the following to be defined:
2761
2762 - CONFIG_SYS_ARCH
2763 - CONFIG_SYS_CPU
2764 - CONFIG_SYS_BOARD
2765 - CONFIG_SYS_VENDOR
2766 - CONFIG_SYS_SOC
2767
Tom Rini7e27f892012-10-24 07:28:16 +00002768 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2769
2770 Define this in order to add variables describing certain
2771 run-time determined information about the hardware to the
2772 environment. These will be named board_name, board_rev.
2773
Simon Glass06fd8532012-11-30 13:01:17 +00002774 CONFIG_DELAY_ENVIRONMENT
2775
2776 Normally the environment is loaded when the board is
2777 intialised so that it is available to U-Boot. This inhibits
2778 that so that the environment is not available until
2779 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2780 this is instead controlled by the value of
2781 /config/load-environment.
2782
wdenka8c7c702003-12-06 19:49:23 +00002783- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002784 CONFIG_HAS_DATAFLASH
2785
wdenk8bde7f72003-06-27 21:31:46 +00002786 Defining this option enables DataFlash features and
2787 allows to read/write in Dataflash via the standard
2788 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002789
Eric Nelsonf61ec452012-01-31 10:52:08 -07002790- Serial Flash support
2791 CONFIG_CMD_SF
2792
2793 Defining this option enables SPI flash commands
2794 'sf probe/read/write/erase/update'.
2795
2796 Usage requires an initial 'probe' to define the serial
2797 flash parameters, followed by read/write/erase/update
2798 commands.
2799
2800 The following defaults may be provided by the platform
2801 to handle the common case when only a single serial
2802 flash is present on the system.
2803
2804 CONFIG_SF_DEFAULT_BUS Bus identifier
2805 CONFIG_SF_DEFAULT_CS Chip-select
2806 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2807 CONFIG_SF_DEFAULT_SPEED in Hz
2808
Simon Glass24007272012-10-08 13:16:02 +00002809 CONFIG_CMD_SF_TEST
2810
2811 Define this option to include a destructive SPI flash
2812 test ('sf test').
2813
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302814 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2815
2816 Define this option to use the Bank addr/Extended addr
2817 support on SPI flashes which has size > 16Mbytes.
2818
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302819 CONFIG_SF_DUAL_FLASH Dual flash memories
2820
2821 Define this option to use dual flash support where two flash
2822 memories can be connected with a given cs line.
2823 currently Xilinx Zynq qspi support these type of connections.
2824
wdenk3f85ce22004-02-23 16:11:30 +00002825- SystemACE Support:
2826 CONFIG_SYSTEMACE
2827
2828 Adding this option adds support for Xilinx SystemACE
2829 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002830 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002832
2833 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002834 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002835
2836 When SystemACE support is added, the "ace" device type
2837 becomes available to the fat commands, i.e. fatls.
2838
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002839- TFTP Fixed UDP Port:
2840 CONFIG_TFTP_PORT
2841
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002842 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002843 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002844 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002845 number generator is used.
2846
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002847 Also, the environment variable tftpdstp is used to supply
2848 the TFTP UDP destination port value. If tftpdstp isn't
2849 defined, the normal port 69 is used.
2850
2851 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002852 blindly start the TFTP transfer using the pre-configured
2853 target IP address and UDP port. This has the effect of
2854 "punching through" the (Windows XP) firewall, allowing
2855 the remainder of the TFTP transfer to proceed normally.
2856 A better solution is to properly configure the firewall,
2857 but sometimes that is not allowed.
2858
Simon Glassbf36c5d2012-12-05 14:46:38 +00002859- Hashing support:
2860 CONFIG_CMD_HASH
2861
2862 This enables a generic 'hash' command which can produce
2863 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2864
2865 CONFIG_HASH_VERIFY
2866
2867 Enable the hash verify command (hash -v). This adds to code
2868 size a little.
2869
2870 CONFIG_SHA1 - support SHA1 hashing
2871 CONFIG_SHA256 - support SHA256 hashing
2872
2873 Note: There is also a sha1sum command, which should perhaps
2874 be deprecated in favour of 'hash sha1'.
2875
Robert Winklera11f1872013-07-24 17:57:06 -07002876- Freescale i.MX specific commands:
2877 CONFIG_CMD_HDMIDETECT
2878 This enables 'hdmidet' command which returns true if an
2879 HDMI monitor is detected. This command is i.MX 6 specific.
2880
2881 CONFIG_CMD_BMODE
2882 This enables the 'bmode' (bootmode) command for forcing
2883 a boot from specific media.
2884
2885 This is useful for forcing the ROM's usb downloader to
2886 activate upon a watchdog reset which is nice when iterating
2887 on U-Boot. Using the reset button or running bmode normal
2888 will set it back to normal. This command currently
2889 supports i.MX53 and i.MX6.
2890
Simon Glass19c402a2013-06-13 15:10:02 -07002891- Signing support:
2892 CONFIG_RSA
2893
2894 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01002895 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07002896
2897 The signing part is build into mkimage regardless of this
2898 option.
2899
Heiko Schocher9e50c402014-01-25 07:27:13 +01002900- bootcount support:
2901 CONFIG_BOOTCOUNT_LIMIT
2902
2903 This enables the bootcounter support, see:
2904 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2905
2906 CONFIG_AT91SAM9XE
2907 enable special bootcounter support on at91sam9xe based boards.
2908 CONFIG_BLACKFIN
2909 enable special bootcounter support on blackfin based boards.
2910 CONFIG_SOC_DA8XX
2911 enable special bootcounter support on da850 based boards.
2912 CONFIG_BOOTCOUNT_RAM
2913 enable support for the bootcounter in RAM
2914 CONFIG_BOOTCOUNT_I2C
2915 enable support for the bootcounter on an i2c (like RTC) device.
2916 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2917 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2918 the bootcounter.
2919 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002920
wdenka8c7c702003-12-06 19:49:23 +00002921- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002922 CONFIG_SHOW_BOOT_PROGRESS
2923
wdenk43d96162003-03-06 00:02:04 +00002924 Defining this option allows to add some board-
2925 specific code (calling a user-provided function
2926 "show_boot_progress(int)") that enables you to show
2927 the system's boot progress on some display (for
2928 example, some LED's) on your board. At the moment,
2929 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002930
Simon Glass3a608ca2012-02-13 13:51:19 +00002931- Detailed boot stage timing
2932 CONFIG_BOOTSTAGE
2933 Define this option to get detailed timing of each stage
2934 of the boot process.
2935
2936 CONFIG_BOOTSTAGE_USER_COUNT
2937 This is the number of available user bootstage records.
2938 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2939 a new ID will be allocated from this stash. If you exceed
2940 the limit, recording will stop.
2941
2942 CONFIG_BOOTSTAGE_REPORT
2943 Define this to print a report before boot, similar to this:
2944
2945 Timer summary in microseconds:
2946 Mark Elapsed Stage
2947 0 0 reset
2948 3,575,678 3,575,678 board_init_f start
2949 3,575,695 17 arch_cpu_init A9
2950 3,575,777 82 arch_cpu_init done
2951 3,659,598 83,821 board_init_r start
2952 3,910,375 250,777 main_loop
2953 29,916,167 26,005,792 bootm_start
2954 30,361,327 445,160 start_kernel
2955
Simon Glass2eba38c2012-09-28 08:56:39 +00002956 CONFIG_CMD_BOOTSTAGE
2957 Add a 'bootstage' command which supports printing a report
2958 and un/stashing of bootstage data.
2959
Simon Glass94fd1312012-09-28 08:56:37 +00002960 CONFIG_BOOTSTAGE_FDT
2961 Stash the bootstage information in the FDT. A root 'bootstage'
2962 node is created with each bootstage id as a child. Each child
2963 has a 'name' property and either 'mark' containing the
2964 mark time in microsecond, or 'accum' containing the
2965 accumulated time for that bootstage id in microseconds.
2966 For example:
2967
2968 bootstage {
2969 154 {
2970 name = "board_init_f";
2971 mark = <3575678>;
2972 };
2973 170 {
2974 name = "lcd";
2975 accum = <33482>;
2976 };
2977 };
2978
2979 Code in the Linux kernel can find this in /proc/devicetree.
2980
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002981Legacy uImage format:
2982
wdenkc6097192002-11-03 00:24:07 +00002983 Arg Where When
2984 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002985 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002986 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002987 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002988 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002989 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002990 4 common/cmd_bootm.c Image data has correct checksum
2991 -4 common/cmd_bootm.c Image is for unsupported architecture
2992 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002993 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002994 6 common/cmd_bootm.c Image Type check OK
2995 -6 common/cmd_bootm.c gunzip uncompression error
2996 -7 common/cmd_bootm.c Unimplemented compression type
2997 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002998 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002999 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003000
3001 9 common/image.c Start initial ramdisk verification
3002 -10 common/image.c Ramdisk header has bad magic number
3003 -11 common/image.c Ramdisk header has bad checksum
3004 10 common/image.c Ramdisk header is OK
3005 -12 common/image.c Ramdisk data has bad checksum
3006 11 common/image.c Ramdisk data has correct checksum
3007 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003008 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003009 13 common/image.c Start multifile image verification
3010 14 common/image.c No initial ramdisk, no multifile, continue.
3011
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003012 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003013
Stefan Roesea47a12b2010-04-15 16:07:28 +02003014 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003015 -31 post/post.c POST test failed, detected by post_output_backlog()
3016 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003017
Heiko Schocher566a4942007-06-22 19:11:54 +02003018 34 common/cmd_doc.c before loading a Image from a DOC device
3019 -35 common/cmd_doc.c Bad usage of "doc" command
3020 35 common/cmd_doc.c correct usage of "doc" command
3021 -36 common/cmd_doc.c No boot device
3022 36 common/cmd_doc.c correct boot device
3023 -37 common/cmd_doc.c Unknown Chip ID on boot device
3024 37 common/cmd_doc.c correct chip ID found, device available
3025 -38 common/cmd_doc.c Read Error on boot device
3026 38 common/cmd_doc.c reading Image header from DOC device OK
3027 -39 common/cmd_doc.c Image header has bad magic number
3028 39 common/cmd_doc.c Image header has correct magic number
3029 -40 common/cmd_doc.c Error reading Image from DOC device
3030 40 common/cmd_doc.c Image header has correct magic number
3031 41 common/cmd_ide.c before loading a Image from a IDE device
3032 -42 common/cmd_ide.c Bad usage of "ide" command
3033 42 common/cmd_ide.c correct usage of "ide" command
3034 -43 common/cmd_ide.c No boot device
3035 43 common/cmd_ide.c boot device found
3036 -44 common/cmd_ide.c Device not available
3037 44 common/cmd_ide.c Device available
3038 -45 common/cmd_ide.c wrong partition selected
3039 45 common/cmd_ide.c partition selected
3040 -46 common/cmd_ide.c Unknown partition table
3041 46 common/cmd_ide.c valid partition table found
3042 -47 common/cmd_ide.c Invalid partition type
3043 47 common/cmd_ide.c correct partition type
3044 -48 common/cmd_ide.c Error reading Image Header on boot device
3045 48 common/cmd_ide.c reading Image Header from IDE device OK
3046 -49 common/cmd_ide.c Image header has bad magic number
3047 49 common/cmd_ide.c Image header has correct magic number
3048 -50 common/cmd_ide.c Image header has bad checksum
3049 50 common/cmd_ide.c Image header has correct checksum
3050 -51 common/cmd_ide.c Error reading Image from IDE device
3051 51 common/cmd_ide.c reading Image from IDE device OK
3052 52 common/cmd_nand.c before loading a Image from a NAND device
3053 -53 common/cmd_nand.c Bad usage of "nand" command
3054 53 common/cmd_nand.c correct usage of "nand" command
3055 -54 common/cmd_nand.c No boot device
3056 54 common/cmd_nand.c boot device found
3057 -55 common/cmd_nand.c Unknown Chip ID on boot device
3058 55 common/cmd_nand.c correct chip ID found, device available
3059 -56 common/cmd_nand.c Error reading Image Header on boot device
3060 56 common/cmd_nand.c reading Image Header from NAND device OK
3061 -57 common/cmd_nand.c Image header has bad magic number
3062 57 common/cmd_nand.c Image header has correct magic number
3063 -58 common/cmd_nand.c Error reading Image from NAND device
3064 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003065
Heiko Schocher566a4942007-06-22 19:11:54 +02003066 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003067
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003068 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003069 -64 net/eth.c no Ethernet found.
3070 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003071
Heiko Schocher566a4942007-06-22 19:11:54 +02003072 -80 common/cmd_net.c usage wrong
3073 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003074 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003075 81 common/cmd_net.c NetLoop() back without error
3076 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3077 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003078 83 common/cmd_net.c running "source" command
3079 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003080 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003081
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003082FIT uImage format:
3083
3084 Arg Where When
3085 100 common/cmd_bootm.c Kernel FIT Image has correct format
3086 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3087 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3088 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3089 102 common/cmd_bootm.c Kernel unit name specified
3090 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003091 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003092 104 common/cmd_bootm.c Got kernel subimage node offset
3093 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3094 105 common/cmd_bootm.c Kernel subimage hash verification OK
3095 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3096 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003097 -106 common/cmd_bootm.c Kernel subimage has wrong type
3098 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003099 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3100 108 common/cmd_bootm.c Got kernel subimage data/size
3101 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3102 -109 common/cmd_bootm.c Can't get kernel subimage type
3103 -110 common/cmd_bootm.c Can't get kernel subimage comp
3104 -111 common/cmd_bootm.c Can't get kernel subimage os
3105 -112 common/cmd_bootm.c Can't get kernel subimage load address
3106 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3107
3108 120 common/image.c Start initial ramdisk verification
3109 -120 common/image.c Ramdisk FIT image has incorrect format
3110 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003111 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003112 -122 common/image.c Can't get configuration for ramdisk subimage
3113 123 common/image.c Ramdisk unit name specified
3114 -124 common/image.c Can't get ramdisk subimage node offset
3115 125 common/image.c Got ramdisk subimage node offset
3116 -125 common/image.c Ramdisk subimage hash verification failed
3117 126 common/image.c Ramdisk subimage hash verification OK
3118 -126 common/image.c Ramdisk subimage for unsupported architecture
3119 127 common/image.c Architecture check OK
3120 -127 common/image.c Can't get ramdisk subimage data/size
3121 128 common/image.c Got ramdisk subimage data/size
3122 129 common/image.c Can't get ramdisk load address
3123 -129 common/image.c Got ramdisk load address
3124
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003125 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003126 131 common/cmd_doc.c FIT image format OK
3127
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003128 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003129 141 common/cmd_ide.c FIT image format OK
3130
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003131 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003132 151 common/cmd_nand.c FIT image format OK
3133
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003134- FIT image support:
3135 CONFIG_FIT
3136 Enable support for the FIT uImage format.
3137
3138 CONFIG_FIT_BEST_MATCH
3139 When no configuration is explicitly selected, default to the
3140 one whose fdt's compatibility field best matches that of
3141 U-Boot itself. A match is considered "best" if it matches the
3142 most specific compatibility entry of U-Boot's fdt's root node.
3143 The order of entries in the configuration's fdt is ignored.
3144
Simon Glass3e569a62013-06-13 15:10:00 -07003145 CONFIG_FIT_SIGNATURE
3146 This option enables signature verification of FIT uImages,
3147 using a hash signed and verified using RSA. See
3148 doc/uImage.FIT/signature.txt for more details.
3149
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003150- Standalone program support:
3151 CONFIG_STANDALONE_LOAD_ADDR
3152
Wolfgang Denk6feff892011-10-09 21:06:34 +02003153 This option defines a board specific value for the
3154 address where standalone program gets loaded, thus
3155 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003156 settings.
3157
3158- Frame Buffer Address:
3159 CONFIG_FB_ADDR
3160
3161 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003162 address for frame buffer. This is typically the case
3163 when using a graphics controller has separate video
3164 memory. U-Boot will then place the frame buffer at
3165 the given address instead of dynamically reserving it
3166 in system RAM by calling lcd_setmem(), which grabs
3167 the memory for the frame buffer depending on the
3168 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003169
3170 Please see board_init_f function.
3171
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003172- Automatic software updates via TFTP server
3173 CONFIG_UPDATE_TFTP
3174 CONFIG_UPDATE_TFTP_CNT_MAX
3175 CONFIG_UPDATE_TFTP_MSEC_MAX
3176
3177 These options enable and control the auto-update feature;
3178 for a more detailed description refer to doc/README.update.
3179
3180- MTD Support (mtdparts command, UBI support)
3181 CONFIG_MTD_DEVICE
3182
3183 Adds the MTD device infrastructure from the Linux kernel.
3184 Needed for mtdparts command support.
3185
3186 CONFIG_MTD_PARTITIONS
3187
3188 Adds the MTD partitioning infrastructure from the Linux
3189 kernel. Needed for UBI support.
3190
Joe Hershberger70c219c2013-04-08 10:32:48 +00003191- UBI support
3192 CONFIG_CMD_UBI
3193
3194 Adds commands for interacting with MTD partitions formatted
3195 with the UBI flash translation layer
3196
3197 Requires also defining CONFIG_RBTREE
3198
Joe Hershberger147162d2013-04-08 10:32:49 +00003199 CONFIG_UBI_SILENCE_MSG
3200
3201 Make the verbose messages from UBI stop printing. This leaves
3202 warnings and errors enabled.
3203
Joe Hershberger70c219c2013-04-08 10:32:48 +00003204- UBIFS support
3205 CONFIG_CMD_UBIFS
3206
3207 Adds commands for interacting with UBI volumes formatted as
3208 UBIFS. UBIFS is read-only in u-boot.
3209
3210 Requires UBI support as well as CONFIG_LZO
3211
Joe Hershberger147162d2013-04-08 10:32:49 +00003212 CONFIG_UBIFS_SILENCE_MSG
3213
3214 Make the verbose messages from UBIFS stop printing. This leaves
3215 warnings and errors enabled.
3216
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003217- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003218 CONFIG_SPL
3219 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003220
Tom Rini95579792012-02-14 07:29:40 +00003221 CONFIG_SPL_LDSCRIPT
3222 LDSCRIPT for linking the SPL binary.
3223
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003224 CONFIG_SPL_MAX_FOOTPRINT
3225 Maximum size in memory allocated to the SPL, BSS included.
3226 When defined, the linker checks that the actual memory
3227 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003228 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003229 must not be both defined at the same time.
3230
Tom Rini95579792012-02-14 07:29:40 +00003231 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003232 Maximum size of the SPL image (text, data, rodata, and
3233 linker lists sections), BSS excluded.
3234 When defined, the linker checks that the actual size does
3235 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003236
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003237 CONFIG_SPL_TEXT_BASE
3238 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003239
Scott Wood94a45bb2012-09-20 19:05:12 -05003240 CONFIG_SPL_RELOC_TEXT_BASE
3241 Address to relocate to. If unspecified, this is equal to
3242 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3243
Tom Rini95579792012-02-14 07:29:40 +00003244 CONFIG_SPL_BSS_START_ADDR
3245 Link address for the BSS within the SPL binary.
3246
3247 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003248 Maximum size in memory allocated to the SPL BSS.
3249 When defined, the linker checks that the actual memory used
3250 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003251 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003252 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003253
3254 CONFIG_SPL_STACK
3255 Adress of the start of the stack SPL will use
3256
Scott Wood94a45bb2012-09-20 19:05:12 -05003257 CONFIG_SPL_RELOC_STACK
3258 Adress of the start of the stack SPL will use after
3259 relocation. If unspecified, this is equal to
3260 CONFIG_SPL_STACK.
3261
Tom Rini95579792012-02-14 07:29:40 +00003262 CONFIG_SYS_SPL_MALLOC_START
3263 Starting address of the malloc pool used in SPL.
3264
3265 CONFIG_SYS_SPL_MALLOC_SIZE
3266 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003267
Tom Rini47f7bca2012-08-13 12:03:19 -07003268 CONFIG_SPL_FRAMEWORK
3269 Enable the SPL framework under common/. This framework
3270 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3271 NAND loading of the Linux Kernel.
3272
Tom Rini861a86f2012-08-13 11:37:56 -07003273 CONFIG_SPL_DISPLAY_PRINT
3274 For ARM, enable an optional function to print more information
3275 about the running system.
3276
Scott Wood4b919722012-09-20 16:35:21 -05003277 CONFIG_SPL_INIT_MINIMAL
3278 Arch init code should be built for a very small image
3279
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003280 CONFIG_SPL_LIBCOMMON_SUPPORT
3281 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003282
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003283 CONFIG_SPL_LIBDISK_SUPPORT
3284 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003285
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003286 CONFIG_SPL_I2C_SUPPORT
3287 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003288
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003289 CONFIG_SPL_GPIO_SUPPORT
3290 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003291
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003292 CONFIG_SPL_MMC_SUPPORT
3293 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003294
Tom Rini95579792012-02-14 07:29:40 +00003295 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3296 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3297 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3298 Address, size and partition on the MMC to load U-Boot from
3299 when the MMC is being used in raw mode.
3300
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003301 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3302 Sector to load kernel uImage from when MMC is being
3303 used in raw mode (for Falcon mode)
3304
3305 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3306 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3307 Sector and number of sectors to load kernel argument
3308 parameters from when MMC is being used in raw mode
3309 (for falcon mode)
3310
Tom Rini95579792012-02-14 07:29:40 +00003311 CONFIG_SPL_FAT_SUPPORT
3312 Support for fs/fat/libfat.o in SPL binary
3313
3314 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3315 Filename to read to load U-Boot when reading from FAT
3316
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003317 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3318 Filename to read to load kernel uImage when reading
3319 from FAT (for Falcon mode)
3320
3321 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3322 Filename to read to load kernel argument parameters
3323 when reading from FAT (for Falcon mode)
3324
Scott Wood06f60ae2012-12-06 13:33:17 +00003325 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3326 Set this for NAND SPL on PPC mpc83xx targets, so that
3327 start.S waits for the rest of the SPL to load before
3328 continuing (the hardware starts execution after just
3329 loading the first page rather than the full 4K).
3330
Scott Wood6f2f01b2012-09-20 19:09:07 -05003331 CONFIG_SPL_NAND_BASE
3332 Include nand_base.c in the SPL. Requires
3333 CONFIG_SPL_NAND_DRIVERS.
3334
3335 CONFIG_SPL_NAND_DRIVERS
3336 SPL uses normal NAND drivers, not minimal drivers.
3337
3338 CONFIG_SPL_NAND_ECC
3339 Include standard software ECC in the SPL
3340
Tom Rini95579792012-02-14 07:29:40 +00003341 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003342 Support for NAND boot using simple NAND drivers that
3343 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003344
Ying Zhangbb0dc102013-08-16 15:16:11 +08003345 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3346 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003347 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003348
Ying Zhang7c8eea52013-08-16 15:16:12 +08003349 CONFIG_SPL_COMMON_INIT_DDR
3350 Set for common ddr init with serial presence detect in
3351 SPL binary.
3352
Tom Rini95579792012-02-14 07:29:40 +00003353 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3354 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3355 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3356 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3357 CONFIG_SYS_NAND_ECCBYTES
3358 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003359 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003360
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303361 CONFIG_SPL_NAND_BOOT
3362 Add support NAND boot
3363
Tom Rini95579792012-02-14 07:29:40 +00003364 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003365 Location in NAND to read U-Boot from
3366
3367 CONFIG_SYS_NAND_U_BOOT_DST
3368 Location in memory to load U-Boot to
3369
3370 CONFIG_SYS_NAND_U_BOOT_SIZE
3371 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003372
3373 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003374 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003375
3376 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3377 Define this if you need to first read the OOB and then the
3378 data. This is used for example on davinci plattforms.
3379
3380 CONFIG_SPL_OMAP3_ID_NAND
3381 Support for an OMAP3-specific set of functions to return the
3382 ID and MFR of the first attached NAND chip, if present.
3383
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003384 CONFIG_SPL_SERIAL_SUPPORT
3385 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003386
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003387 CONFIG_SPL_SPI_FLASH_SUPPORT
3388 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003389
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003390 CONFIG_SPL_SPI_SUPPORT
3391 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003392
Pavel Machekc57b9532012-08-30 22:42:11 +02003393 CONFIG_SPL_RAM_DEVICE
3394 Support for running image already present in ram, in SPL binary
3395
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003396 CONFIG_SPL_LIBGENERIC_SUPPORT
3397 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003398
Ying Zhangba1bee42013-05-20 14:07:25 +08003399 CONFIG_SPL_ENV_SUPPORT
3400 Support for the environment operating in SPL binary
3401
3402 CONFIG_SPL_NET_SUPPORT
3403 Support for the net/libnet.o in SPL binary.
3404 It conflicts with SPL env from storage medium specified by
3405 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3406
Scott Wood74752ba2012-12-06 13:33:16 +00003407 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003408 Image offset to which the SPL should be padded before appending
3409 the SPL payload. By default, this is defined as
3410 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3411 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3412 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003413
Scott Woodca2fca22012-09-21 16:27:32 -05003414 CONFIG_SPL_TARGET
3415 Final target image containing SPL and payload. Some SPLs
3416 use an arch-specific makefile fragment instead, for
3417 example if more than one image needs to be produced.
3418
Simon Glass87ebee32013-05-08 08:05:59 +00003419 CONFIG_FIT_SPL_PRINT
3420 Printing information about a FIT image adds quite a bit of
3421 code to SPL. So this is normally disabled in SPL. Use this
3422 option to re-enable it. This will affect the output of the
3423 bootm command when booting a FIT image.
3424
Ying Zhang3aa29de2013-08-16 15:16:15 +08003425- TPL framework
3426 CONFIG_TPL
3427 Enable building of TPL globally.
3428
3429 CONFIG_TPL_PAD_TO
3430 Image offset to which the TPL should be padded before appending
3431 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003432 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3433 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3434 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003435
wdenkc6097192002-11-03 00:24:07 +00003436Modem Support:
3437--------------
3438
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003439[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003440
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003441- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003442 CONFIG_MODEM_SUPPORT
3443
3444- RTS/CTS Flow control enable:
3445 CONFIG_HWFLOW
3446
3447- Modem debug support:
3448 CONFIG_MODEM_SUPPORT_DEBUG
3449
wdenk43d96162003-03-06 00:02:04 +00003450 Enables debugging stuff (char screen[1024], dbg())
3451 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003452
wdenka8c7c702003-12-06 19:49:23 +00003453- Interrupt support (PPC):
3454
wdenkd4ca31c2004-01-02 14:00:00 +00003455 There are common interrupt_init() and timer_interrupt()
3456 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003457 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003458 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003459 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003460 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003461 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003462 specific handling. If board has watchdog / status_led
3463 / other_activity_monitor it works automatically from
3464 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003465
wdenkc6097192002-11-03 00:24:07 +00003466- General:
3467
wdenk43d96162003-03-06 00:02:04 +00003468 In the target system modem support is enabled when a
3469 specific key (key combination) is pressed during
3470 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003471 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003472 board_init(). Currently key_pressed() is a dummy
3473 function, returning 1 and thus enabling modem
3474 initialization.
wdenkc6097192002-11-03 00:24:07 +00003475
wdenk43d96162003-03-06 00:02:04 +00003476 If there are no modem init strings in the
3477 environment, U-Boot proceed to autoboot; the
3478 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003479 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003480
3481 See also: doc/README.Modem
3482
Helmut Raiger9660e442011-10-20 04:19:47 +00003483Board initialization settings:
3484------------------------------
3485
3486During Initialization u-boot calls a number of board specific functions
3487to allow the preparation of board specific prerequisites, e.g. pin setup
3488before drivers are initialized. To enable these callbacks the
3489following configuration macros have to be defined. Currently this is
3490architecture specific, so please check arch/your_architecture/lib/board.c
3491typically in board_init_f() and board_init_r().
3492
3493- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3494- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3495- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3496- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003497
wdenkc6097192002-11-03 00:24:07 +00003498Configuration Settings:
3499-----------------------
3500
York Sun4d1fd7f2014-02-26 17:03:19 -08003501- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3502 Optionally it can be defined to support 64-bit memory commands.
3503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003504- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003505 undefine this when you're short of memory.
3506
Peter Tyser2fb26042009-01-27 18:03:12 -06003507- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3508 width of the commands listed in the 'help' command output.
3509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003510- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003511 prompt for user input.
3512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003513- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003515- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003516
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003517- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003519- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003520 the application (usually a Linux kernel) when it is
3521 booted
3522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003523- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003524 List of legal baudrate settings for this board.
3525
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003526- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003527 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003528
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003529- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003530 If the board specific function
3531 extern int overwrite_console (void);
3532 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003533 serial port, else the settings in the environment are used.
3534
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003535- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003536 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003538- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003539 Enable overwrite of previous console environment settings.
3540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003541- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003542 Begin and End addresses of the area used by the
3543 simple memory test.
3544
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003545- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003546 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003548- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003549 Scratch address used by the alternate memory test
3550 You only need to set this if address zero isn't writeable
3551
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003552- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3553 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003554 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003555 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003556 fixing up gd->ram_size the Linux kernel should gets passed
3557 the now "corrected" memory size and won't touch it either.
3558 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003559 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003560 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003561 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003562
3563 This option can be used as a workaround for the 440EPx/GRx
3564 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3565 be touched.
3566
3567 WARNING: Please make sure that this value is a multiple of
3568 the Linux page size (normally 4k). If this is not the case,
3569 then the end address of the Linux memory will be located at a
3570 non page size aligned address and this could cause major
3571 problems.
3572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003573- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003574 Enable temporary baudrate change while serial download
3575
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003576- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003577 Physical start address of SDRAM. _Must_ be 0 here.
3578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003579- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003580 Physical start address of Motherboard I/O (if using a
3581 Cogent motherboard)
3582
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003583- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003584 Physical start address of Flash memory.
3585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003586- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003587 Physical start address of boot monitor code (set by
3588 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003589 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003590 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003592- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003593 Size of memory reserved for monitor code, used to
3594 determine _at_compile_time_ (!) if the environment is
3595 embedded within the U-Boot image, or in a separate
3596 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003598- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003599 Size of DRAM reserved for malloc() use.
3600
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003601- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003602 Normally compressed uImages are limited to an
3603 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003604 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003605 to adjust this setting to your needs.
3606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003607- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003608 Maximum size of memory mapped by the startup code of
3609 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003610 the Linux kernel (bd_info, boot arguments, FDT blob if
3611 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003612 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003613 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003614 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003615 variable "bootm_mapsize" will override the value of
3616 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3617 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003618
John Rigbyfca43cc2010-10-13 13:57:35 -06003619- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3620 Enable initrd_high functionality. If defined then the
3621 initrd_high feature is enabled and the bootm ramdisk subcommand
3622 is enabled.
3623
3624- CONFIG_SYS_BOOT_GET_CMDLINE:
3625 Enables allocating and saving kernel cmdline in space between
3626 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3627
3628- CONFIG_SYS_BOOT_GET_KBD:
3629 Enables allocating and saving a kernel copy of the bd_info in
3630 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3631
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003632- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003633 Max number of Flash memory banks
3634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003635- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003636 Max number of sectors on a Flash chip
3637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003638- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003639 Timeout for Flash erase operations (in ms)
3640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003641- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003642 Timeout for Flash write operations (in ms)
3643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003644- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003645 Timeout for Flash set sector lock bit operation (in ms)
3646
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003647- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003648 Timeout for Flash clear lock bits operation (in ms)
3649
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003650- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003651 If defined, hardware flash sectors protection is used
3652 instead of U-Boot software protection.
3653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003654- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003655
3656 Enable TFTP transfers directly to flash memory;
3657 without this option such a download has to be
3658 performed in two steps: (1) download to RAM, and (2)
3659 copy from RAM to flash.
3660
3661 The two-step approach is usually more reliable, since
3662 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003663 the flash, but in some situations (when system RAM is
3664 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003665 downloaded image) this option may be very useful.
3666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003667- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003668 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003669 common flash structure for storing flash geometry.
3670
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003671- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003672 This option also enables the building of the cfi_flash driver
3673 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003674
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003675- CONFIG_FLASH_CFI_MTD
3676 This option enables the building of the cfi_mtd driver
3677 in the drivers directory. The driver exports CFI flash
3678 to the MTD layer.
3679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003680- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003681 Use buffered writes to flash.
3682
3683- CONFIG_FLASH_SPANSION_S29WS_N
3684 s29ws-n MirrorBit flash has non-standard addresses for buffered
3685 write commands.
3686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003687- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003688 If this option is defined, the common CFI flash doesn't
3689 print it's warning upon not recognized FLASH banks. This
3690 is useful, if some of the configured banks are only
3691 optionally available.
3692
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003693- CONFIG_FLASH_SHOW_PROGRESS
3694 If defined (must be an integer), print out countdown
3695 digits and dots. Recommended value: 45 (9..1) for 80
3696 column displays, 15 (3..1) for 40 column displays.
3697
Stefan Roese352ef3f2013-04-04 15:53:14 +02003698- CONFIG_FLASH_VERIFY
3699 If defined, the content of the flash (destination) is compared
3700 against the source after the write operation. An error message
3701 will be printed when the contents are not identical.
3702 Please note that this option is useless in nearly all cases,
3703 since such flash programming errors usually are detected earlier
3704 while unprotecting/erasing/programming. Please only enable
3705 this option if you really know what you are doing.
3706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003707- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003708 Defines the number of Ethernet receive buffers. On some
3709 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003710 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3711 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003712 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003713 Defaults to 4 if not defined.
3714
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003715- CONFIG_ENV_MAX_ENTRIES
3716
Wolfgang Denk071bc922010-10-27 22:48:30 +02003717 Maximum number of entries in the hash table that is used
3718 internally to store the environment settings. The default
3719 setting is supposed to be generous and should work in most
3720 cases. This setting can be used to tune behaviour; see
3721 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003722
Joe Hershberger25980902012-12-11 22:16:31 -06003723- CONFIG_ENV_FLAGS_LIST_DEFAULT
3724- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003725 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003726 calling env set. Variables can be restricted to only decimal,
3727 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3728 the variables can also be restricted to IP address or MAC address.
3729
3730 The format of the list is:
3731 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003732 access_atribute = [a|r|o|c]
3733 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003734 entry = variable_name[:attributes]
3735 list = entry[,list]
3736
3737 The type attributes are:
3738 s - String (default)
3739 d - Decimal
3740 x - Hexadecimal
3741 b - Boolean ([1yYtT|0nNfF])
3742 i - IP address
3743 m - MAC address
3744
Joe Hershberger267541f2012-12-11 22:16:34 -06003745 The access attributes are:
3746 a - Any (default)
3747 r - Read-only
3748 o - Write-once
3749 c - Change-default
3750
Joe Hershberger25980902012-12-11 22:16:31 -06003751 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3752 Define this to a list (string) to define the ".flags"
3753 envirnoment variable in the default or embedded environment.
3754
3755 - CONFIG_ENV_FLAGS_LIST_STATIC
3756 Define this to a list (string) to define validation that
3757 should be done if an entry is not found in the ".flags"
3758 environment variable. To override a setting in the static
3759 list, simply add an entry for the same variable name to the
3760 ".flags" variable.
3761
Joe Hershberger267541f2012-12-11 22:16:34 -06003762- CONFIG_ENV_ACCESS_IGNORE_FORCE
3763 If defined, don't allow the -f switch to env set override variable
3764 access flags.
3765
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003766- CONFIG_SYS_GENERIC_BOARD
3767 This selects the architecture-generic board system instead of the
3768 architecture-specific board files. It is intended to move boards
3769 to this new framework over time. Defining this will disable the
3770 arch/foo/lib/board.c file and use common/board_f.c and
3771 common/board_r.c instead. To use this option your architecture
3772 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3773 its config.mk file). If you find problems enabling this option on
3774 your board please report the problem and send patches!
3775
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003776- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3777 This is set by OMAP boards for the max time that reset should
3778 be asserted. See doc/README.omap-reset-time for details on how
3779 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003780
wdenkc6097192002-11-03 00:24:07 +00003781The following definitions that deal with the placement and management
3782of environment data (variable area); in general, we support the
3783following configurations:
3784
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003785- CONFIG_BUILD_ENVCRC:
3786
3787 Builds up envcrc with the target environment so that external utils
3788 may easily extract it and embed it in final U-Boot images.
3789
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003790- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003791
3792 Define this if the environment is in flash memory.
3793
3794 a) The environment occupies one whole flash sector, which is
3795 "embedded" in the text segment with the U-Boot code. This
3796 happens usually with "bottom boot sector" or "top boot
3797 sector" type flash chips, which have several smaller
3798 sectors at the start or the end. For instance, such a
3799 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3800 such a case you would place the environment in one of the
3801 4 kB sectors - with U-Boot code before and after it. With
3802 "top boot sector" type flash chips, you would put the
3803 environment in one of the last sectors, leaving a gap
3804 between U-Boot and the environment.
3805
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003806 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003807
3808 Offset of environment data (variable area) to the
3809 beginning of flash memory; for instance, with bottom boot
3810 type flash chips the second sector can be used: the offset
3811 for this sector is given here.
3812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003813 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003814
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003815 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003816
3817 This is just another way to specify the start address of
3818 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003819 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003820
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003821 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003822
3823 Size of the sector containing the environment.
3824
3825
3826 b) Sometimes flash chips have few, equal sized, BIG sectors.
3827 In such a case you don't want to spend a whole sector for
3828 the environment.
3829
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003830 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003831
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003832 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003833 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003834 of this flash sector for the environment. This saves
3835 memory for the RAM copy of the environment.
3836
3837 It may also save flash memory if you decide to use this
3838 when your environment is "embedded" within U-Boot code,
3839 since then the remainder of the flash sector could be used
3840 for U-Boot code. It should be pointed out that this is
3841 STRONGLY DISCOURAGED from a robustness point of view:
3842 updating the environment in flash makes it always
3843 necessary to erase the WHOLE sector. If something goes
3844 wrong before the contents has been restored from a copy in
3845 RAM, your target system will be dead.
3846
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003847 - CONFIG_ENV_ADDR_REDUND
3848 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk43d96162003-03-06 00:02:04 +00003850 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003851 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003852 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003853 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003854
3855BE CAREFUL! Any changes to the flash layout, and some changes to the
3856source code will make it necessary to adapt <board>/u-boot.lds*
3857accordingly!
3858
3859
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003860- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003861
3862 Define this if you have some non-volatile memory device
3863 (NVRAM, battery buffered SRAM) which you want to use for the
3864 environment.
3865
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003866 - CONFIG_ENV_ADDR:
3867 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003868
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003869 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003870 want to use for environment. It is assumed that this memory
3871 can just be read and written to, without any special
3872 provision.
3873
3874BE CAREFUL! The first access to the environment happens quite early
3875in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003876console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003877U-Boot will hang.
3878
3879Please note that even with NVRAM we still use a copy of the
3880environment in RAM: we could work on NVRAM directly, but we want to
3881keep settings there always unmodified except somebody uses "saveenv"
3882to save the current settings.
3883
3884
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003885- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003886
3887 Use this if you have an EEPROM or similar serial access
3888 device and a driver for it.
3889
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003890 - CONFIG_ENV_OFFSET:
3891 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003892
3893 These two #defines specify the offset and size of the
3894 environment area within the total memory of your EEPROM.
3895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003896 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003897 If defined, specified the chip address of the EEPROM device.
3898 The default address is zero.
3899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003900 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003901 If defined, the number of bits used to address bytes in a
3902 single page in the EEPROM device. A 64 byte page, for example
3903 would require six bits.
3904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003905 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003906 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003907 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003909 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003910 The length in bytes of the EEPROM memory array address. Note
3911 that this is NOT the chip address length!
3912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003913 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003914 EEPROM chips that implement "address overflow" are ones
3915 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3916 address and the extra bits end up in the "chip address" bit
3917 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3918 byte chips.
3919
3920 Note that we consider the length of the address field to
3921 still be one byte because the extra address bits are hidden
3922 in the chip address.
3923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003924 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003925 The size in bytes of the EEPROM device.
3926
Heiko Schocher548738b2010-01-07 08:55:40 +01003927 - CONFIG_ENV_EEPROM_IS_ON_I2C
3928 define this, if you have I2C and SPI activated, and your
3929 EEPROM, which holds the environment, is on the I2C bus.
3930
3931 - CONFIG_I2C_ENV_EEPROM_BUS
3932 if you have an Environment on an EEPROM reached over
3933 I2C muxes, you can define here, how to reach this
3934 EEPROM. For example:
3935
Heiko Schocherea818db2013-01-29 08:53:15 +01003936 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003937
3938 EEPROM which holds the environment, is reached over
3939 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003940
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003941- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003942
wdenkd4ca31c2004-01-02 14:00:00 +00003943 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003944 want to use for the environment.
3945
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003946 - CONFIG_ENV_OFFSET:
3947 - CONFIG_ENV_ADDR:
3948 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003949
3950 These three #defines specify the offset and size of the
3951 environment area within the total memory of your DataFlash placed
3952 at the specified address.
3953
Liu Gang0a85a9e2012-03-08 00:33:20 +00003954- CONFIG_ENV_IS_IN_REMOTE:
3955
3956 Define this if you have a remote memory space which you
3957 want to use for the local device's environment.
3958
3959 - CONFIG_ENV_ADDR:
3960 - CONFIG_ENV_SIZE:
3961
3962 These two #defines specify the address and size of the
3963 environment area within the remote memory space. The
3964 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003965 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003966
3967BE CAREFUL! For some special cases, the local device can not use
3968"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003969environment stored in a remote NOR flash by SRIO or PCIE link,
3970but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003971
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003972- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003973
3974 Define this if you have a NAND device which you want to use
3975 for the environment.
3976
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003977 - CONFIG_ENV_OFFSET:
3978 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003979
3980 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003981 area within the first NAND device. CONFIG_ENV_OFFSET must be
3982 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003983
Scott Woodfdd813d2010-09-17 14:38:37 -05003984 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003985
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003986 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003987 size used to hold a redundant copy of the environment data, so
3988 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003989 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003990 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003991
Scott Woodfdd813d2010-09-17 14:38:37 -05003992 - CONFIG_ENV_RANGE (optional):
3993
3994 Specifies the length of the region in which the environment
3995 can be written. This should be a multiple of the NAND device's
3996 block size. Specifying a range with more erase blocks than
3997 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3998 the range to be avoided.
3999
4000 - CONFIG_ENV_OFFSET_OOB (optional):
4001
4002 Enables support for dynamically retrieving the offset of the
4003 environment from block zero's out-of-band data. The
4004 "nand env.oob" command can be used to record this offset.
4005 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4006 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004007
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004008- CONFIG_NAND_ENV_DST
4009
4010 Defines address in RAM to which the nand_spl code should copy the
4011 environment. If redundant environment is used, it will be copied to
4012 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4013
Joe Hershberger2b744332013-04-08 10:32:51 +00004014- CONFIG_ENV_IS_IN_UBI:
4015
4016 Define this if you have an UBI volume that you want to use for the
4017 environment. This has the benefit of wear-leveling the environment
4018 accesses, which is important on NAND.
4019
4020 - CONFIG_ENV_UBI_PART:
4021
4022 Define this to a string that is the mtd partition containing the UBI.
4023
4024 - CONFIG_ENV_UBI_VOLUME:
4025
4026 Define this to the name of the volume that you want to store the
4027 environment in.
4028
Joe Hershberger785881f2013-04-08 10:32:52 +00004029 - CONFIG_ENV_UBI_VOLUME_REDUND:
4030
4031 Define this to the name of another volume to store a second copy of
4032 the environment in. This will enable redundant environments in UBI.
4033 It is assumed that both volumes are in the same MTD partition.
4034
Joe Hershberger2b744332013-04-08 10:32:51 +00004035 - CONFIG_UBI_SILENCE_MSG
4036 - CONFIG_UBIFS_SILENCE_MSG
4037
4038 You will probably want to define these to avoid a really noisy system
4039 when storing the env in UBI.
4040
Stephen Warren06e4ae52013-06-11 15:14:00 -06004041- CONFIG_ENV_IS_IN_MMC:
4042
4043 Define this if you have an MMC device which you want to use for the
4044 environment.
4045
4046 - CONFIG_SYS_MMC_ENV_DEV:
4047
4048 Specifies which MMC device the environment is stored in.
4049
4050 - CONFIG_SYS_MMC_ENV_PART (optional):
4051
4052 Specifies which MMC partition the environment is stored in. If not
4053 set, defaults to partition 0, the user area. Common values might be
4054 1 (first MMC boot partition), 2 (second MMC boot partition).
4055
4056 - CONFIG_ENV_OFFSET:
4057 - CONFIG_ENV_SIZE:
4058
4059 These two #defines specify the offset and size of the environment
4060 area within the specified MMC device.
4061
Stephen Warren5c088ee2013-06-11 15:14:02 -06004062 If offset is positive (the usual case), it is treated as relative to
4063 the start of the MMC partition. If offset is negative, it is treated
4064 as relative to the end of the MMC partition. This can be useful if
4065 your board may be fitted with different MMC devices, which have
4066 different sizes for the MMC partitions, and you always want the
4067 environment placed at the very end of the partition, to leave the
4068 maximum possible space before it, to store other data.
4069
Stephen Warren06e4ae52013-06-11 15:14:00 -06004070 These two values are in units of bytes, but must be aligned to an
4071 MMC sector boundary.
4072
4073 - CONFIG_ENV_OFFSET_REDUND (optional):
4074
4075 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4076 hold a redundant copy of the environment data. This provides a
4077 valid backup copy in case the other copy is corrupted, e.g. due
4078 to a power failure during a "saveenv" operation.
4079
Stephen Warren5c088ee2013-06-11 15:14:02 -06004080 This value may also be positive or negative; this is handled in the
4081 same way as CONFIG_ENV_OFFSET.
4082
Stephen Warren06e4ae52013-06-11 15:14:00 -06004083 This value is also in units of bytes, but must also be aligned to
4084 an MMC sector boundary.
4085
4086 - CONFIG_ENV_SIZE_REDUND (optional):
4087
4088 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4089 set. If this value is set, it must be set to the same value as
4090 CONFIG_ENV_SIZE.
4091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004092- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004093
4094 Defines offset to the initial SPI buffer area in DPRAM. The
4095 area is used at an early stage (ROM part) if the environment
4096 is configured to reside in the SPI EEPROM: We need a 520 byte
4097 scratch DPRAM area. It is used between the two initialization
4098 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4099 to be a good choice since it makes it far enough from the
4100 start of the data area as well as from the stack pointer.
4101
Bruce Adlere881cb52007-11-02 13:15:42 -07004102Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004103has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004104created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004105until then to read environment variables.
4106
wdenk85ec0bc2003-03-31 16:34:49 +00004107The environment is protected by a CRC32 checksum. Before the monitor
4108is relocated into RAM, as a result of a bad CRC you will be working
4109with the compiled-in default environment - *silently*!!! [This is
4110necessary, because the first environment variable we need is the
4111"baudrate" setting for the console - if we have a bad CRC, we don't
4112have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004113
4114Note: once the monitor has been relocated, then it will complain if
4115the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004116use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004118- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004119 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004121 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004122 also needs to be defined.
4123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004124- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004125 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004126
Ron Madridf5675aa2009-02-18 14:30:44 -08004127- CONFIG_NS16550_MIN_FUNCTIONS:
4128 Define this if you desire to only have use of the NS16550_init
4129 and NS16550_putc functions for the serial driver located at
4130 drivers/serial/ns16550.c. This option is useful for saving
4131 space for already greatly restricted images, including but not
4132 limited to NAND_SPL configurations.
4133
Simon Glassb2b92f52012-11-30 13:01:18 +00004134- CONFIG_DISPLAY_BOARDINFO
4135 Display information about the board that U-Boot is running on
4136 when U-Boot starts up. The board function checkboard() is called
4137 to do this.
4138
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004139- CONFIG_DISPLAY_BOARDINFO_LATE
4140 Similar to the previous option, but display this information
4141 later, once stdio is running and output goes to the LCD, if
4142 present.
4143
wdenkc6097192002-11-03 00:24:07 +00004144Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004145---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004147- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004148 Cache Line Size of the CPU.
4149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004150- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004151 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004152
wdenk42d1f032003-10-15 23:53:47 +00004153 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4154 and RPXsuper) to be able to adjust the position of
4155 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004156
Timur Tabie46fedf2011-08-04 18:03:41 -05004157- CONFIG_SYS_CCSRBAR_DEFAULT:
4158 Default (power-on reset) physical address of CCSR on Freescale
4159 PowerPC SOCs.
4160
4161- CONFIG_SYS_CCSRBAR:
4162 Virtual address of CCSR. On a 32-bit build, this is typically
4163 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4164
4165 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4166 for cross-platform code that uses that macro instead.
4167
4168- CONFIG_SYS_CCSRBAR_PHYS:
4169 Physical address of CCSR. CCSR can be relocated to a new
4170 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004171 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004172 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4173 is typically relocated on 36-bit builds. It is recommended
4174 that this macro be defined via the _HIGH and _LOW macros:
4175
4176 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4177 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4178
4179- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004180 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4181 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004182 used in assembly code, so it must not contain typecasts or
4183 integer size suffixes (e.g. "ULL").
4184
4185- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4186 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4187 used in assembly code, so it must not contain typecasts or
4188 integer size suffixes (e.g. "ULL").
4189
4190- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4191 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4192 forced to a value that ensures that CCSR is not relocated.
4193
wdenk7f6c2cb2002-11-10 22:06:23 +00004194- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004195 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004196
4197 the default drive number (default value 0)
4198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004199 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004200
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004201 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004202 (default value 1)
4203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004204 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004205
wdenk43d96162003-03-06 00:02:04 +00004206 defines the offset of register from address. It
4207 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004208 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004210 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4211 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004212 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004213
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004214 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004215 fdc_hw_init() is called at the beginning of the FDC
4216 setup. fdc_hw_init() must be provided by the board
4217 source code. It is used to make hardware dependant
4218 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004219
Macpaul Lin0abddf82011-04-11 20:45:32 +00004220- CONFIG_IDE_AHB:
4221 Most IDE controllers were designed to be connected with PCI
4222 interface. Only few of them were designed for AHB interface.
4223 When software is doing ATA command and data transfer to
4224 IDE devices through IDE-AHB controller, some additional
4225 registers accessing to these kind of IDE-AHB controller
4226 is requierd.
4227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004228- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004229 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004230 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004232- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk7152b1d2003-09-05 23:19:14 +00004234 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004235 initial data and stack; please note that this must be
4236 writable memory that is working WITHOUT special
4237 initialization, i. e. you CANNOT use normal RAM which
4238 will become available only after programming the
4239 memory controller and running certain initialization
4240 sequences.
4241
4242 U-Boot uses the following memory types:
4243 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4244 - MPC824X: data cache
4245 - PPC4xx: data cache
4246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004247- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004248
4249 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004250 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4251 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004252 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004253 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004254 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4255 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4256 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004257
4258 Note:
4259 On the MPC824X (or other systems that use the data
4260 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004261 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004262 point to an otherwise UNUSED address space between
4263 the top of RAM and the start of the PCI space.
4264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004265- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004267- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004269- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004271- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004273- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004275- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004277- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004278 SDRAM timing
4279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004280- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004281 periodic timer for refresh
4282
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004283- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004285- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4286 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4287 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4288 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004289 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4290
4291- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004292 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4293 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004294 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004296- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4297 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004298 Machine Mode Register and Memory Periodic Timer
4299 Prescaler definitions (SDRAM timing)
4300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004301- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004302 enable I2C microcode relocation patch (MPC8xx);
4303 define relocation offset in DPRAM [DSP2]
4304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004305- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004306 enable SMC microcode relocation patch (MPC8xx);
4307 define relocation offset in DPRAM [SMC1]
4308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004309- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004310 enable SPI microcode relocation patch (MPC8xx);
4311 define relocation offset in DPRAM [SCC4]
4312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004313- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004314 Use OSCM clock mode on MBX8xx board. Be careful,
4315 wrong setting might damage your board. Read
4316 doc/README.MBX before setting this variable!
4317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004318- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004319 Offset of the bootmode word in DPRAM used by post
4320 (Power On Self Tests). This definition overrides
4321 #define'd default value in commproc.h resp.
4322 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004324- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4325 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4326 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4327 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4328 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4329 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4330 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4331 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004332 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004333
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004334- CONFIG_PCI_DISABLE_PCIE:
4335 Disable PCI-Express on systems where it is supported but not
4336 required.
4337
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004338- CONFIG_PCI_ENUM_ONLY
4339 Only scan through and get the devices on the busses.
4340 Don't do any setup work, presumably because someone or
4341 something has already done it, and we don't need to do it
4342 a second time. Useful for platforms that are pre-booted
4343 by coreboot or similar.
4344
Gabor Juhos842033e2013-05-30 07:06:12 +00004345- CONFIG_PCI_INDIRECT_BRIDGE:
4346 Enable support for indirect PCI bridges.
4347
Kumar Galaa09b9b62010-12-30 12:09:53 -06004348- CONFIG_SYS_SRIO:
4349 Chip has SRIO or not
4350
4351- CONFIG_SRIO1:
4352 Board has SRIO 1 port available
4353
4354- CONFIG_SRIO2:
4355 Board has SRIO 2 port available
4356
Liu Gangc8b28152013-05-07 16:30:46 +08004357- CONFIG_SRIO_PCIE_BOOT_MASTER
4358 Board can support master function for Boot from SRIO and PCIE
4359
Kumar Galaa09b9b62010-12-30 12:09:53 -06004360- CONFIG_SYS_SRIOn_MEM_VIRT:
4361 Virtual Address of SRIO port 'n' memory region
4362
4363- CONFIG_SYS_SRIOn_MEM_PHYS:
4364 Physical Address of SRIO port 'n' memory region
4365
4366- CONFIG_SYS_SRIOn_MEM_SIZE:
4367 Size of SRIO port 'n' memory region
4368
Fabio Estevam66bd1842013-04-11 09:35:34 +00004369- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4370 Defined to tell the NAND controller that the NAND chip is using
4371 a 16 bit bus.
4372 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004373 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004374 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004375 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004376
4377- CONFIG_SYS_NDFC_EBC0_CFG
4378 Sets the EBC0_CFG register for the NDFC. If not defined
4379 a default value will be used.
4380
Ben Warrenbb99ad62006-09-07 16:50:54 -04004381- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004382 Get DDR timing information from an I2C EEPROM. Common
4383 with pluggable memory modules such as SODIMMs
4384
Ben Warrenbb99ad62006-09-07 16:50:54 -04004385 SPD_EEPROM_ADDRESS
4386 I2C address of the SPD EEPROM
4387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004388- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004389 If SPD EEPROM is on an I2C bus other than the first
4390 one, specify here. Note that the value must resolve
4391 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004392
York Sun1b3e3c42011-06-07 09:42:16 +08004393- CONFIG_SYS_DDR_RAW_TIMING
4394 Get DDR timing information from other than SPD. Common with
4395 soldered DDR chips onboard without SPD. DDR raw timing
4396 parameters are extracted from datasheet and hard-coded into
4397 header files or board specific files.
4398
York Sun6f5e1dc2011-09-16 13:21:35 -07004399- CONFIG_FSL_DDR_INTERACTIVE
4400 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4401
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004402- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004403 Only for 83xx systems. If specified, then DDR should
4404 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004405
wdenkc26e4542004-04-18 10:13:26 +00004406- CONFIG_ETHER_ON_FEC[12]
4407 Define to enable FEC[12] on a 8xx series processor.
4408
4409- CONFIG_FEC[12]_PHY
4410 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004411 to the given FEC; i. e.
4412 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004413 means that the PHY with address 4 is connected to FEC1
4414
4415 When set to -1, means to probe for first available.
4416
4417- CONFIG_FEC[12]_PHY_NORXERR
4418 The PHY does not have a RXERR line (RMII only).
4419 (so program the FEC to ignore it).
4420
4421- CONFIG_RMII
4422 Enable RMII mode for all FECs.
4423 Note that this is a global option, we can't
4424 have one FEC in standard MII mode and another in RMII mode.
4425
wdenk5cf91d62004-04-23 20:32:05 +00004426- CONFIG_CRC32_VERIFY
4427 Add a verify option to the crc32 command.
4428 The syntax is:
4429
4430 => crc32 -v <address> <count> <crc32>
4431
4432 Where address/count indicate a memory area
4433 and crc32 is the correct crc32 which the
4434 area should have.
4435
wdenk56523f12004-07-11 17:40:54 +00004436- CONFIG_LOOPW
4437 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004438 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004439
stroese7b466642004-12-16 18:46:55 +00004440- CONFIG_MX_CYCLIC
4441 Add the "mdc" and "mwc" memory commands. These are cyclic
4442 "md/mw" commands.
4443 Examples:
4444
wdenkefe2a4d2004-12-16 21:44:03 +00004445 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004446 This command will print 4 bytes (10,11,12,13) each 500 ms.
4447
wdenkefe2a4d2004-12-16 21:44:03 +00004448 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004449 This command will write 12345678 to address 100 all 10 ms.
4450
wdenkefe2a4d2004-12-16 21:44:03 +00004451 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004452 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004453
wdenk8aa1a2d2005-04-04 12:44:11 +00004454- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004455 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004456 low level initializations (like setting up the memory
4457 controller) are omitted and/or U-Boot does not
4458 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004459
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004460 Normally this variable MUST NOT be defined. The only
4461 exception is when U-Boot is loaded (to RAM) by some
4462 other boot loader or by a debugger which performs
4463 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004464
Aneesh V401bb302011-07-13 05:11:07 +00004465- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004466 Modifies the behaviour of start.S when compiling a loader
4467 that is executed before the actual U-Boot. E.g. when
4468 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004469
Ying Zhang3aa29de2013-08-16 15:16:15 +08004470- CONFIG_TPL_BUILD
4471 Modifies the behaviour of start.S when compiling a loader
4472 that is executed after the SPL and before the actual U-Boot.
4473 It is loaded by the SPL.
4474
Ying Zhang5df572f2013-05-20 14:07:23 +08004475- CONFIG_SYS_MPC85XX_NO_RESETVEC
4476 Only for 85xx systems. If this variable is specified, the section
4477 .resetvec is not kept and the section .bootpg is placed in the
4478 previous 4k of the .text section.
4479
Simon Glass4213fc22013-02-24 17:33:14 +00004480- CONFIG_ARCH_MAP_SYSMEM
4481 Generally U-Boot (and in particular the md command) uses
4482 effective address. It is therefore not necessary to regard
4483 U-Boot address as virtual addresses that need to be translated
4484 to physical addresses. However, sandbox requires this, since
4485 it maintains its own little RAM buffer which contains all
4486 addressable memory. This option causes some memory accesses
4487 to be mapped through map_sysmem() / unmap_sysmem().
4488
Matthias Weisserd8834a12011-03-10 21:36:32 +00004489- CONFIG_USE_ARCH_MEMCPY
4490 CONFIG_USE_ARCH_MEMSET
4491 If these options are used a optimized version of memcpy/memset will
4492 be used if available. These functions may be faster under some
4493 conditions but may increase the binary size.
4494
Simon Glass588a13f2013-02-14 04:18:54 +00004495- CONFIG_X86_RESET_VECTOR
4496 If defined, the x86 reset vector code is included. This is not
4497 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004498
Mark Jacksonfc337052013-03-04 01:27:20 +00004499- CONFIG_SYS_MPUCLK
4500 Defines the MPU clock speed (in MHz).
4501
4502 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004503
Heiko Schocher16678eb2013-11-04 14:05:00 +01004504- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4505 Enables the RTC32K OSC on AM33xx based plattforms
4506
Timur Tabif2717b42011-11-22 09:21:25 -06004507Freescale QE/FMAN Firmware Support:
4508-----------------------------------
4509
4510The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4511loading of "firmware", which is encoded in the QE firmware binary format.
4512This firmware often needs to be loaded during U-Boot booting, so macros
4513are used to identify the storage device (NOR flash, SPI, etc) and the address
4514within that device.
4515
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004516- CONFIG_SYS_FMAN_FW_ADDR
4517 The address in the storage device where the FMAN microcode is located. The
4518 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4519 is also specified.
4520
4521- CONFIG_SYS_QE_FW_ADDR
4522 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004523 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4524 is also specified.
4525
4526- CONFIG_SYS_QE_FMAN_FW_LENGTH
4527 The maximum possible size of the firmware. The firmware binary format
4528 has a field that specifies the actual size of the firmware, but it
4529 might not be possible to read any part of the firmware unless some
4530 local storage is allocated to hold the entire firmware first.
4531
4532- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4533 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4534 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4535 virtual address in NOR flash.
4536
4537- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4538 Specifies that QE/FMAN firmware is located in NAND flash.
4539 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4540
4541- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4542 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4543 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4544
4545- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4546 Specifies that QE/FMAN firmware is located on the primary SPI
4547 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4548
Liu Gang292dc6c2012-03-08 00:33:18 +00004549- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4550 Specifies that QE/FMAN firmware is located in the remote (master)
4551 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004552 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4553 window->master inbound window->master LAW->the ucode address in
4554 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004555
wdenkc6097192002-11-03 00:24:07 +00004556Building the Software:
4557======================
4558
Wolfgang Denk218ca722008-03-26 10:40:12 +01004559Building U-Boot has been tested in several native build environments
4560and in many different cross environments. Of course we cannot support
4561all possibly existing versions of cross development tools in all
4562(potentially obsolete) versions. In case of tool chain problems we
4563recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4564which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004565
Wolfgang Denk218ca722008-03-26 10:40:12 +01004566If you are not using a native environment, it is assumed that you
4567have GNU cross compiling tools available in your path. In this case,
4568you must set the environment variable CROSS_COMPILE in your shell.
4569Note that no changes to the Makefile or any other source files are
4570necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004571
Wolfgang Denk218ca722008-03-26 10:40:12 +01004572 $ CROSS_COMPILE=ppc_4xx-
4573 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004574
Peter Tyser2f8d3962009-03-13 18:54:51 -05004575Note: If you wish to generate Windows versions of the utilities in
4576 the tools directory you can use the MinGW toolchain
4577 (http://www.mingw.org). Set your HOST tools to the MinGW
4578 toolchain and execute 'make tools'. For example:
4579
4580 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4581
4582 Binaries such as tools/mkimage.exe will be created which can
4583 be executed on computers running Windows.
4584
Wolfgang Denk218ca722008-03-26 10:40:12 +01004585U-Boot is intended to be simple to build. After installing the
4586sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004587is done by typing:
4588
4589 make NAME_config
4590
Wolfgang Denk218ca722008-03-26 10:40:12 +01004591where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004592rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004593
wdenk2729af92004-05-03 20:45:30 +00004594Note: for some board special configuration names may exist; check if
4595 additional information is available from the board vendor; for
4596 instance, the TQM823L systems are available without (standard)
4597 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004598 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600 make TQM823L_config
4601 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk2729af92004-05-03 20:45:30 +00004603 make TQM823L_LCD_config
4604 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606 etc.
wdenkc6097192002-11-03 00:24:07 +00004607
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609Finally, type "make all", and you should get some working U-Boot
4610images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612- "u-boot.bin" is a raw binary image
4613- "u-boot" is an image in ELF binary format
4614- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004615
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004616By default the build is performed locally and the objects are saved
4617in the source directory. One of the two methods can be used to change
4618this behavior and build U-Boot to some external directory:
4619
46201. Add O= to the make command line invocations:
4621
4622 make O=/tmp/build distclean
4623 make O=/tmp/build NAME_config
4624 make O=/tmp/build all
4625
46262. Set environment variable BUILD_DIR to point to the desired location:
4627
4628 export BUILD_DIR=/tmp/build
4629 make distclean
4630 make NAME_config
4631 make all
4632
4633Note that the command line "O=" setting overrides the BUILD_DIR environment
4634variable.
4635
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk2729af92004-05-03 20:45:30 +00004637Please be aware that the Makefiles assume you are using GNU make, so
4638for instance on NetBSD you might need to use "gmake" instead of
4639native "make".
wdenkc6097192002-11-03 00:24:07 +00004640
wdenkc6097192002-11-03 00:24:07 +00004641
wdenk2729af92004-05-03 20:45:30 +00004642If the system board that you have is not listed, then you will need
4643to port U-Boot to your hardware platform. To do this, follow these
4644steps:
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk2729af92004-05-03 20:45:30 +000046461. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004647 "boards.cfg" file, using the existing entries as examples.
4648 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000046492. Create a new directory to hold your board specific code. Add any
4650 files you need. In your board directory, you will need at least
4651 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
46523. Create a new configuration file "include/configs/<board>.h" for
4653 your board
46543. If you're porting U-Boot to a new CPU, then also create a new
4655 directory to hold your CPU specific code. Add any files you need.
46564. Run "make <board>_config" with your new name.
46575. Type "make", and you should get a working "u-boot.srec" file
4658 to be installed on your target system.
46596. Debug and solve any problems that might arise.
4660 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004661
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4664==============================================================
wdenkc6097192002-11-03 00:24:07 +00004665
Wolfgang Denk218ca722008-03-26 10:40:12 +01004666If you have modified U-Boot sources (for instance added a new board
4667or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004668provide feedback to the other developers. The feedback normally takes
4669the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004670official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004671
Wolfgang Denk218ca722008-03-26 10:40:12 +01004672But before you submit such a patch, please verify that your modifi-
4673cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004674the supported boards compile WITHOUT ANY compiler warnings. To do so,
4675just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004676for ALL supported system. Be warned, this will take a while. You can
4677select which (cross) compiler to use by passing a `CROSS_COMPILE'
4678environment variable to the script, i. e. to use the ELDK cross tools
4679you can type
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk2729af92004-05-03 20:45:30 +00004681 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk2729af92004-05-03 20:45:30 +00004683or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk2729af92004-05-03 20:45:30 +00004685 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004686
Wolfgang Denk218ca722008-03-26 10:40:12 +01004687When using the MAKEALL script, the default behaviour is to build
4688U-Boot in the source directory. This location can be changed by
4689setting the BUILD_DIR environment variable. Also, for each target
4690built, the MAKEALL script saves two log files (<target>.ERR and
4691<target>.MAKEALL) in the <source dir>/LOG directory. This default
4692location can be changed by setting the MAKEALL_LOGDIR environment
4693variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004694
4695 export BUILD_DIR=/tmp/build
4696 export MAKEALL_LOGDIR=/tmp/log
4697 CROSS_COMPILE=ppc_8xx- MAKEALL
4698
Wolfgang Denk218ca722008-03-26 10:40:12 +01004699With the above settings build objects are saved in the /tmp/build,
4700log files are saved in the /tmp/log and the source tree remains clean
4701during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004702
4703
wdenk2729af92004-05-03 20:45:30 +00004704See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004705
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk2729af92004-05-03 20:45:30 +00004707Monitor Commands - Overview:
4708============================
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk2729af92004-05-03 20:45:30 +00004710go - start application at address 'addr'
4711run - run commands in an environment variable
4712bootm - boot application image from memory
4713bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004714bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004715tftpboot- boot image via network using TFTP protocol
4716 and env variables "ipaddr" and "serverip"
4717 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004718tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004719rarpboot- boot image via network using RARP/TFTP protocol
4720diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4721loads - load S-Record file over serial line
4722loadb - load binary file over serial line (kermit mode)
4723md - memory display
4724mm - memory modify (auto-incrementing)
4725nm - memory modify (constant address)
4726mw - memory write (fill)
4727cp - memory copy
4728cmp - memory compare
4729crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004730i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004731sspi - SPI utility commands
4732base - print or set address offset
4733printenv- print environment variables
4734setenv - set environment variables
4735saveenv - save environment variables to persistent storage
4736protect - enable or disable FLASH write protection
4737erase - erase FLASH memory
4738flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004739nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004740bdinfo - print Board Info structure
4741iminfo - print header information for application image
4742coninfo - print console devices and informations
4743ide - IDE sub-system
4744loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004745loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004746mtest - simple RAM test
4747icache - enable or disable instruction cache
4748dcache - enable or disable data cache
4749reset - Perform RESET of the CPU
4750echo - echo args to console
4751version - print monitor version
4752help - print online help
4753? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004754
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk2729af92004-05-03 20:45:30 +00004756Monitor Commands - Detailed Description:
4757========================================
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk2729af92004-05-03 20:45:30 +00004759TODO.
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004762
4763
wdenk2729af92004-05-03 20:45:30 +00004764Environment Variables:
4765======================
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767U-Boot supports user configuration using Environment Variables which
4768can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk2729af92004-05-03 20:45:30 +00004770Environment Variables are set using "setenv", printed using
4771"printenv", and saved to Flash using "saveenv". Using "setenv"
4772without a value can be used to delete a variable from the
4773environment. As long as you don't save the environment you are
4774working with an in-memory copy. In case the Flash area containing the
4775environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004776
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004777Some configuration options can be set using Environment Variables.
4778
4779List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk2729af92004-05-03 20:45:30 +00004781 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk2729af92004-05-03 20:45:30 +00004783 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004784
wdenk2729af92004-05-03 20:45:30 +00004785 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004786
wdenk2729af92004-05-03 20:45:30 +00004787 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004788
wdenk2729af92004-05-03 20:45:30 +00004789 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004790
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004791 bootm_low - Memory range available for image processing in the bootm
4792 command can be restricted. This variable is given as
4793 a hexadecimal number and defines lowest address allowed
4794 for use by the bootm command. See also "bootm_size"
4795 environment variable. Address defined by "bootm_low" is
4796 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004797 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4798 bootm_mapsize.
4799
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004800 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004801 This variable is given as a hexadecimal number and it
4802 defines the size of the memory region starting at base
4803 address bootm_low that is accessible by the Linux kernel
4804 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4805 as the default value if it is defined, and bootm_size is
4806 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004807
4808 bootm_size - Memory range available for image processing in the bootm
4809 command can be restricted. This variable is given as
4810 a hexadecimal number and defines the size of the region
4811 allowed for use by the bootm command. See also "bootm_low"
4812 environment variable.
4813
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004814 updatefile - Location of the software update file on a TFTP server, used
4815 by the automatic software update feature. Please refer to
4816 documentation in doc/README.update for more details.
4817
wdenk2729af92004-05-03 20:45:30 +00004818 autoload - if set to "no" (any string beginning with 'n'),
4819 "bootp" will just load perform a lookup of the
4820 configuration from the BOOTP server, but not try to
4821 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004822
wdenk2729af92004-05-03 20:45:30 +00004823 autostart - if set to "yes", an image loaded using the "bootp",
4824 "rarpboot", "tftpboot" or "diskboot" commands will
4825 be automatically started (by internally calling
4826 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828 If set to "no", a standalone image passed to the
4829 "bootm" command will be copied to the load address
4830 (and eventually uncompressed), but NOT be started.
4831 This can be used to load and uncompress arbitrary
4832 data.
wdenkc6097192002-11-03 00:24:07 +00004833
David A. Longa28afca2011-07-09 16:40:19 -04004834 fdt_high - if set this restricts the maximum address that the
4835 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004836 For example, if you have a system with 1 GB memory
4837 at physical address 0x10000000, while Linux kernel
4838 only recognizes the first 704 MB as low memory, you
4839 may need to set fdt_high as 0x3C000000 to have the
4840 device tree blob be copied to the maximum address
4841 of the 704 MB low memory, so that Linux kernel can
4842 access it during the boot procedure.
4843
David A. Longa28afca2011-07-09 16:40:19 -04004844 If this is set to the special value 0xFFFFFFFF then
4845 the fdt will not be copied at all on boot. For this
4846 to work it must reside in writable memory, have
4847 sufficient padding on the end of it for u-boot to
4848 add the information it needs into it, and the memory
4849 must be accessible by the kernel.
4850
Simon Glasseea63e02011-10-24 19:15:34 +00004851 fdtcontroladdr- if set this is the address of the control flattened
4852 device tree used by U-Boot when CONFIG_OF_CONTROL is
4853 defined.
4854
wdenk17ea1172004-06-06 21:51:03 +00004855 i2cfast - (PPC405GP|PPC405EP only)
4856 if set to 'y' configures Linux I2C driver for fast
4857 mode (400kHZ). This environment variable is used in
4858 initialization code. So, for changes to be effective
4859 it must be saved and board must be reset.
4860
wdenk2729af92004-05-03 20:45:30 +00004861 initrd_high - restrict positioning of initrd images:
4862 If this variable is not set, initrd images will be
4863 copied to the highest possible address in RAM; this
4864 is usually what you want since it allows for
4865 maximum initrd size. If for some reason you want to
4866 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004867 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004868 variable to a value of "no" or "off" or "0".
4869 Alternatively, you can set it to a maximum upper
4870 address to use (U-Boot will still check that it
4871 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk2729af92004-05-03 20:45:30 +00004873 For instance, when you have a system with 16 MB
4874 RAM, and want to reserve 4 MB from use by Linux,
4875 you can do this by adding "mem=12M" to the value of
4876 the "bootargs" variable. However, now you must make
4877 sure that the initrd image is placed in the first
4878 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk2729af92004-05-03 20:45:30 +00004880 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882 If you set initrd_high to 0xFFFFFFFF, this is an
4883 indication to U-Boot that all addresses are legal
4884 for the Linux kernel, including addresses in flash
4885 memory. In this case U-Boot will NOT COPY the
4886 ramdisk at all. This may be useful to reduce the
4887 boot time on your system, but requires that this
4888 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004889
wdenk2729af92004-05-03 20:45:30 +00004890 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk2729af92004-05-03 20:45:30 +00004892 loadaddr - Default load address for commands like "bootp",
4893 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk2729af92004-05-03 20:45:30 +00004895 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004896
wdenk2729af92004-05-03 20:45:30 +00004897 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004898
wdenk2729af92004-05-03 20:45:30 +00004899 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk2729af92004-05-03 20:45:30 +00004901 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk2729af92004-05-03 20:45:30 +00004903 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004904
Mike Frysingere2a53452011-10-02 10:01:27 +00004905 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004906
Mike Frysingere2a53452011-10-02 10:01:27 +00004907 ethact - controls which interface is currently active.
4908 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004909
Heiko Schocher48690d82010-07-20 17:45:02 +02004910 => setenv ethact FEC
4911 => ping 192.168.0.1 # traffic sent on FEC
4912 => setenv ethact SCC
4913 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004914
Matthias Fuchse1692572008-01-17 07:45:05 +01004915 ethrotate - When set to "no" U-Boot does not go through all
4916 available network interfaces.
4917 It just stays at the currently selected interface.
4918
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004919 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004920 either succeed or fail without retrying.
4921 When set to "once" the network operation will
4922 fail when all the available network interfaces
4923 are tried once without success.
4924 Useful on scripts which control the retry operation
4925 themselves.
wdenkc6097192002-11-03 00:24:07 +00004926
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004927 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004928
Simon Glass8d51aac2013-07-16 20:10:00 -07004929 silent_linux - If set then linux will be told to boot silently, by
4930 changing the console to be empty. If "yes" it will be
4931 made silent. If "no" it will not be made silent. If
4932 unset, then it will be made silent if the U-Boot console
4933 is silent.
4934
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004935 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004936 UDP source port.
4937
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004938 tftpdstport - If this is set, the value is used for TFTP's UDP
4939 destination port instead of the Well Know Port 69.
4940
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004941 tftpblocksize - Block size to use for TFTP transfers; if not set,
4942 we use the TFTP server's default block size
4943
4944 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4945 seconds, minimum value is 1000 = 1 second). Defines
4946 when a packet is considered to be lost so it has to
4947 be retransmitted. The default is 5000 = 5 seconds.
4948 Lowering this value may make downloads succeed
4949 faster in networks with high packet loss rates or
4950 with unreliable TFTP servers.
4951
4952 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004953 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004954 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004955
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004956The following image location variables contain the location of images
4957used in booting. The "Image" column gives the role of the image and is
4958not an environment variable name. The other columns are environment
4959variable names. "File Name" gives the name of the file on a TFTP
4960server, "RAM Address" gives the location in RAM the image will be
4961loaded to, and "Flash Location" gives the image's address in NOR
4962flash or offset in NAND flash.
4963
4964*Note* - these variables don't have to be defined for all boards, some
4965boards currenlty use other variables for these purposes, and some
4966boards use these variables for other purposes.
4967
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004968Image File Name RAM Address Flash Location
4969----- --------- ----------- --------------
4970u-boot u-boot u-boot_addr_r u-boot_addr
4971Linux kernel bootfile kernel_addr_r kernel_addr
4972device tree blob fdtfile fdt_addr_r fdt_addr
4973ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975The following environment variables may be used and automatically
4976updated by the network boot commands ("bootp" and "rarpboot"),
4977depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979 bootfile - see above
4980 dnsip - IP address of your Domain Name Server
4981 dnsip2 - IP address of your secondary Domain Name Server
4982 gatewayip - IP address of the Gateway (Router) to use
4983 hostname - Target hostname
4984 ipaddr - see above
4985 netmask - Subnet Mask
4986 rootpath - Pathname of the root filesystem on the NFS server
4987 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004988
wdenka3d991b2004-04-15 21:48:45 +00004989
wdenk2729af92004-05-03 20:45:30 +00004990There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992 serial# - contains hardware identification information such
4993 as type string and/or serial number
4994 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004995
wdenk2729af92004-05-03 20:45:30 +00004996These variables can be set only once (usually during manufacturing of
4997the board). U-Boot refuses to delete or overwrite these variables
4998once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004999
5000
wdenk2729af92004-05-03 20:45:30 +00005001Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk2729af92004-05-03 20:45:30 +00005003 ver - Contains the U-Boot version string as printed
5004 with the "version" command. This variable is
5005 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005006
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008Please note that changes to some configuration parameters may take
5009only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005010
stroesec1551ea2003-04-04 15:53:41 +00005011
Joe Hershberger170ab112012-12-11 22:16:24 -06005012Callback functions for environment variables:
5013---------------------------------------------
5014
5015For some environment variables, the behavior of u-boot needs to change
5016when their values are changed. This functionailty allows functions to
5017be associated with arbitrary variables. On creation, overwrite, or
5018deletion, the callback will provide the opportunity for some side
5019effect to happen or for the change to be rejected.
5020
5021The callbacks are named and associated with a function using the
5022U_BOOT_ENV_CALLBACK macro in your board or driver code.
5023
5024These callbacks are associated with variables in one of two ways. The
5025static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5026in the board configuration to a string that defines a list of
5027associations. The list must be in the following format:
5028
5029 entry = variable_name[:callback_name]
5030 list = entry[,list]
5031
5032If the callback name is not specified, then the callback is deleted.
5033Spaces are also allowed anywhere in the list.
5034
5035Callbacks can also be associated by defining the ".callbacks" variable
5036with the same list format above. Any association in ".callbacks" will
5037override any association in the static list. You can define
5038CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5039".callbacks" envirnoment variable in the default or embedded environment.
5040
5041
wdenk2729af92004-05-03 20:45:30 +00005042Command Line Parsing:
5043=====================
stroesec1551ea2003-04-04 15:53:41 +00005044
wdenk2729af92004-05-03 20:45:30 +00005045There are two different command line parsers available with U-Boot:
5046the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005047
wdenk2729af92004-05-03 20:45:30 +00005048Old, simple command line parser:
5049--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051- supports environment variables (through setenv / saveenv commands)
5052- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005053- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005054- special characters ('$', ';') can be escaped by prefixing with '\',
5055 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005056 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005057- You can also escape text by enclosing in single apostrophes, for example:
5058 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005059
wdenk2729af92004-05-03 20:45:30 +00005060Hush shell:
5061-----------
wdenkf07771c2003-05-28 08:06:31 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063- similar to Bourne shell, with control structures like
5064 if...then...else...fi, for...do...done; while...do...done,
5065 until...do...done, ...
5066- supports environment ("global") variables (through setenv / saveenv
5067 commands) and local shell variables (through standard shell syntax
5068 "name=value"); only environment variables can be used with "run"
5069 command
wdenkf07771c2003-05-28 08:06:31 +00005070
wdenk2729af92004-05-03 20:45:30 +00005071General rules:
5072--------------
wdenkf07771c2003-05-28 08:06:31 +00005073
wdenk2729af92004-05-03 20:45:30 +00005074(1) If a command line (or an environment variable executed by a "run"
5075 command) contains several commands separated by semicolon, and
5076 one of these commands fails, then the remaining commands will be
5077 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005078
wdenk2729af92004-05-03 20:45:30 +00005079(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005080 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005081 command will cause "run" to terminate, i. e. the remaining
5082 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084Note for Redundant Ethernet Interfaces:
5085=======================================
wdenkf07771c2003-05-28 08:06:31 +00005086
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005087Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005088such configurations and is capable of automatic selection of a
5089"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005090
wdenk2729af92004-05-03 20:45:30 +00005091Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5092MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5093"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095If the network interface stores some valid MAC address (for instance
5096in SROM), this is used as default address if there is NO correspon-
5097ding setting in the environment; if the corresponding environment
5098variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005099
wdenk2729af92004-05-03 20:45:30 +00005100o If the SROM has a valid MAC address, and there is no address in the
5101 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005102
wdenk2729af92004-05-03 20:45:30 +00005103o If there is no valid address in the SROM, and a definition in the
5104 environment exists, then the value from the environment variable is
5105 used.
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk2729af92004-05-03 20:45:30 +00005107o If both the SROM and the environment contain a MAC address, and
5108 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk2729af92004-05-03 20:45:30 +00005110o If both the SROM and the environment contain a MAC address, and the
5111 addresses differ, the value from the environment is used and a
5112 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk2729af92004-05-03 20:45:30 +00005114o If neither SROM nor the environment contain a MAC address, an error
5115 is raised.
wdenkc6097192002-11-03 00:24:07 +00005116
Ben Warrenecee9322010-04-26 11:11:46 -07005117If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005118will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005119may be skipped by setting the appropriate 'ethmacskip' environment variable.
5120The naming convention is as follows:
5121"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123Image Formats:
5124==============
wdenkc6097192002-11-03 00:24:07 +00005125
Marian Balakowicz3310c542008-03-12 12:13:13 +01005126U-Boot is capable of booting (and performing other auxiliary operations on)
5127images in two formats:
5128
5129New uImage format (FIT)
5130-----------------------
5131
5132Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5133to Flattened Device Tree). It allows the use of images with multiple
5134components (several kernels, ramdisks, etc.), with contents protected by
5135SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5136
5137
5138Old uImage format
5139-----------------
5140
5141Old image format is based on binary files which can be basically anything,
5142preceded by a special header; see the definitions in include/image.h for
5143details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk2729af92004-05-03 20:45:30 +00005145* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5146 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005147 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5148 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5149 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005150* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005151 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5152 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005153* Compression Type (uncompressed, gzip, bzip2)
5154* Load Address
5155* Entry Point
5156* Image Name
5157* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159The header is marked by a special Magic Number, and both the header
5160and the data portions of the image are secured against corruption by
5161CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005162
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164Linux Support:
5165==============
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167Although U-Boot should support any OS or standalone application
5168easily, the main focus has always been on Linux during the design of
5169U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171U-Boot includes many features that so far have been part of some
5172special "boot loader" code within the Linux kernel. Also, any
5173"initrd" images to be used are no longer part of one big Linux image;
5174instead, kernel and "initrd" are separate images. This implementation
5175serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk2729af92004-05-03 20:45:30 +00005177- the same features can be used for other OS or standalone
5178 applications (for instance: using compressed images to reduce the
5179 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk2729af92004-05-03 20:45:30 +00005181- it becomes much easier to port new Linux kernel versions because
5182 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk2729af92004-05-03 20:45:30 +00005184- the same Linux kernel image can now be used with different "initrd"
5185 images; of course this also means that different kernel images can
5186 be run with the same "initrd". This makes testing easier (you don't
5187 have to build a new "zImage.initrd" Linux image when you just
5188 change a file in your "initrd"). Also, a field-upgrade of the
5189 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005190
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192Linux HOWTO:
5193============
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195Porting Linux to U-Boot based systems:
5196---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198U-Boot cannot save you from doing all the necessary modifications to
5199configure the Linux device drivers for use with your target hardware
5200(no, we don't intend to provide a full virtual machine interface to
5201Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005202
Stefan Roesea47a12b2010-04-15 16:07:28 +02005203But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk2729af92004-05-03 20:45:30 +00005205Just make sure your machine specific header file (for instance
5206include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005207Information structure as we define in include/asm-<arch>/u-boot.h,
5208and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005209as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005210
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk2729af92004-05-03 20:45:30 +00005212Configuring the Linux kernel:
5213-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk2729af92004-05-03 20:45:30 +00005215No specific requirements for U-Boot. Make sure you have some root
5216device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005217
wdenkc6097192002-11-03 00:24:07 +00005218
wdenk2729af92004-05-03 20:45:30 +00005219Building a Linux Image:
5220-----------------------
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk2729af92004-05-03 20:45:30 +00005222With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5223not used. If you use recent kernel source, a new build target
5224"uImage" will exist which automatically builds an image usable by
5225U-Boot. Most older kernels also have support for a "pImage" target,
5226which was introduced for our predecessor project PPCBoot and uses a
5227100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk2729af92004-05-03 20:45:30 +00005229Example:
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231 make TQM850L_config
5232 make oldconfig
5233 make dep
5234 make uImage
wdenkc6097192002-11-03 00:24:07 +00005235
wdenk2729af92004-05-03 20:45:30 +00005236The "uImage" build target uses a special tool (in 'tools/mkimage') to
5237encapsulate a compressed Linux kernel image with header information,
5238CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk2729af92004-05-03 20:45:30 +00005240* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk2729af92004-05-03 20:45:30 +00005242* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244 ${CROSS_COMPILE}-objcopy -O binary \
5245 -R .note -R .comment \
5246 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005247
wdenk2729af92004-05-03 20:45:30 +00005248* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk2729af92004-05-03 20:45:30 +00005250 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk2729af92004-05-03 20:45:30 +00005252* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005253
wdenk2729af92004-05-03 20:45:30 +00005254 mkimage -A ppc -O linux -T kernel -C gzip \
5255 -a 0 -e 0 -n "Linux Kernel Image" \
5256 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005257
wdenk24ee89b2002-11-03 17:56:27 +00005258
wdenk2729af92004-05-03 20:45:30 +00005259The "mkimage" tool can also be used to create ramdisk images for use
5260with U-Boot, either separated from the Linux kernel image, or
5261combined into one file. "mkimage" encapsulates the images with a 64
5262byte header containing information about target architecture,
5263operating system, image type, compression method, entry points, time
5264stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266"mkimage" can be called in two ways: to verify existing images and
5267print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269In the first form (with "-l" option) mkimage lists the information
5270contained in the header of an existing U-Boot image; this includes
5271checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005272
wdenk2729af92004-05-03 20:45:30 +00005273 tools/mkimage -l image
5274 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005275
wdenk2729af92004-05-03 20:45:30 +00005276The second form (with "-d" option) is used to build a U-Boot image
5277from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005278
wdenk2729af92004-05-03 20:45:30 +00005279 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5280 -n name -d data_file image
5281 -A ==> set architecture to 'arch'
5282 -O ==> set operating system to 'os'
5283 -T ==> set image type to 'type'
5284 -C ==> set compression type 'comp'
5285 -a ==> set load address to 'addr' (hex)
5286 -e ==> set entry point to 'ep' (hex)
5287 -n ==> set image name to 'name'
5288 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005289
wdenk69459792004-05-29 16:53:29 +00005290Right now, all Linux kernels for PowerPC systems use the same load
5291address (0x00000000), but the entry point address depends on the
5292kernel version:
wdenkc6097192002-11-03 00:24:07 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294- 2.2.x kernels have the entry point at 0x0000000C,
5295- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk2729af92004-05-03 20:45:30 +00005299 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5300 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005301 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005302 > examples/uImage.TQM850L
5303 Image Name: 2.4.4 kernel for TQM850L
5304 Created: Wed Jul 19 02:34:59 2000
5305 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5306 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5307 Load Address: 0x00000000
5308 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk2729af92004-05-03 20:45:30 +00005310To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk2729af92004-05-03 20:45:30 +00005312 -> tools/mkimage -l examples/uImage.TQM850L
5313 Image Name: 2.4.4 kernel for TQM850L
5314 Created: Wed Jul 19 02:34:59 2000
5315 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5316 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5317 Load Address: 0x00000000
5318 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk2729af92004-05-03 20:45:30 +00005320NOTE: for embedded systems where boot time is critical you can trade
5321speed for memory and install an UNCOMPRESSED image instead: this
5322needs more space in Flash, but boots much faster since it does not
5323need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005324
Stefan Roesea47a12b2010-04-15 16:07:28 +02005325 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005326 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5327 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005328 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005329 > examples/uImage.TQM850L-uncompressed
5330 Image Name: 2.4.4 kernel for TQM850L
5331 Created: Wed Jul 19 02:34:59 2000
5332 Image Type: PowerPC Linux Kernel Image (uncompressed)
5333 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5334 Load Address: 0x00000000
5335 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005336
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk2729af92004-05-03 20:45:30 +00005338Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5339when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341 -> tools/mkimage -n 'Simple Ramdisk Image' \
5342 > -A ppc -O linux -T ramdisk -C gzip \
5343 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5344 Image Name: Simple Ramdisk Image
5345 Created: Wed Jan 12 14:01:50 2000
5346 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5347 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5348 Load Address: 0x00000000
5349 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005350
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005351The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5352option performs the converse operation of the mkimage's second form (the "-d"
5353option). Given an image built by mkimage, the dumpimage extracts a "data file"
5354from the image:
5355
5356 tools/dumpimage -i image -p position data_file
5357 -i ==> extract from the 'image' a specific 'data_file', \
5358 indexed by 'position'
5359
wdenkdb01a2e2004-04-15 23:14:49 +00005360
wdenk2729af92004-05-03 20:45:30 +00005361Installing a Linux Image:
5362-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364To downloading a U-Boot image over the serial (console) interface,
5365you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369The 'objcopy' does not understand the information in the U-Boot
5370image header, so the resulting S-Record file will be relative to
5371address 0x00000000. To load it to a given address, you need to
5372specify the target address as 'offset' parameter with the 'loads'
5373command.
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375Example: install the image to address 0x40100000 (which on the
5376TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380 .......... done
5381 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk2729af92004-05-03 20:45:30 +00005383 => loads 40100000
5384 ## Ready for S-Record download ...
5385 ~>examples/image.srec
5386 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5387 ...
5388 15989 15990 15991 15992
5389 [file transfer complete]
5390 [connected]
5391 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005392
5393
wdenk2729af92004-05-03 20:45:30 +00005394You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005395this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005396corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk2729af92004-05-03 20:45:30 +00005398 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk2729af92004-05-03 20:45:30 +00005400 ## Checking Image at 40100000 ...
5401 Image Name: 2.2.13 for initrd on TQM850L
5402 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5403 Data Size: 335725 Bytes = 327 kB = 0 MB
5404 Load Address: 00000000
5405 Entry Point: 0000000c
5406 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005407
5408
wdenk2729af92004-05-03 20:45:30 +00005409Boot Linux:
5410-----------
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk2729af92004-05-03 20:45:30 +00005412The "bootm" command is used to boot an application that is stored in
5413memory (RAM or Flash). In case of a Linux kernel image, the contents
5414of the "bootargs" environment variable is passed to the kernel as
5415parameters. You can check and modify this variable using the
5416"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005417
5418
wdenk2729af92004-05-03 20:45:30 +00005419 => printenv bootargs
5420 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk2729af92004-05-03 20:45:30 +00005422 => 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 +00005423
wdenk2729af92004-05-03 20:45:30 +00005424 => printenv bootargs
5425 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 +00005426
wdenk2729af92004-05-03 20:45:30 +00005427 => bootm 40020000
5428 ## Booting Linux kernel at 40020000 ...
5429 Image Name: 2.2.13 for NFS on TQM850L
5430 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5431 Data Size: 381681 Bytes = 372 kB = 0 MB
5432 Load Address: 00000000
5433 Entry Point: 0000000c
5434 Verifying Checksum ... OK
5435 Uncompressing Kernel Image ... OK
5436 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
5437 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5438 time_init: decrementer frequency = 187500000/60
5439 Calibrating delay loop... 49.77 BogoMIPS
5440 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5441 ...
wdenkc6097192002-11-03 00:24:07 +00005442
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005443If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005444the memory addresses of both the kernel and the initrd image (PPBCOOT
5445format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005446
wdenk2729af92004-05-03 20:45:30 +00005447 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005448
wdenk2729af92004-05-03 20:45:30 +00005449 ## Checking Image at 40100000 ...
5450 Image Name: 2.2.13 for initrd on TQM850L
5451 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5452 Data Size: 335725 Bytes = 327 kB = 0 MB
5453 Load Address: 00000000
5454 Entry Point: 0000000c
5455 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk2729af92004-05-03 20:45:30 +00005457 ## Checking Image at 40200000 ...
5458 Image Name: Simple Ramdisk Image
5459 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5460 Data Size: 566530 Bytes = 553 kB = 0 MB
5461 Load Address: 00000000
5462 Entry Point: 00000000
5463 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk2729af92004-05-03 20:45:30 +00005465 => bootm 40100000 40200000
5466 ## Booting Linux kernel at 40100000 ...
5467 Image Name: 2.2.13 for initrd on TQM850L
5468 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5469 Data Size: 335725 Bytes = 327 kB = 0 MB
5470 Load Address: 00000000
5471 Entry Point: 0000000c
5472 Verifying Checksum ... OK
5473 Uncompressing Kernel Image ... OK
5474 ## Loading RAMDisk Image at 40200000 ...
5475 Image Name: Simple Ramdisk Image
5476 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5477 Data Size: 566530 Bytes = 553 kB = 0 MB
5478 Load Address: 00000000
5479 Entry Point: 00000000
5480 Verifying Checksum ... OK
5481 Loading Ramdisk ... OK
5482 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
5483 Boot arguments: root=/dev/ram
5484 time_init: decrementer frequency = 187500000/60
5485 Calibrating delay loop... 49.77 BogoMIPS
5486 ...
5487 RAMDISK: Compressed image found at block 0
5488 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005489
wdenk2729af92004-05-03 20:45:30 +00005490 bash#
wdenkc6097192002-11-03 00:24:07 +00005491
Matthew McClintock02677682006-06-28 10:41:37 -05005492Boot Linux and pass a flat device tree:
5493-----------
5494
5495First, U-Boot must be compiled with the appropriate defines. See the section
5496titled "Linux Kernel Interface" above for a more in depth explanation. The
5497following is an example of how to start a kernel and pass an updated
5498flat device tree:
5499
5500=> print oftaddr
5501oftaddr=0x300000
5502=> print oft
5503oft=oftrees/mpc8540ads.dtb
5504=> tftp $oftaddr $oft
5505Speed: 1000, full duplex
5506Using TSEC0 device
5507TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5508Filename 'oftrees/mpc8540ads.dtb'.
5509Load address: 0x300000
5510Loading: #
5511done
5512Bytes transferred = 4106 (100a hex)
5513=> tftp $loadaddr $bootfile
5514Speed: 1000, full duplex
5515Using TSEC0 device
5516TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5517Filename 'uImage'.
5518Load address: 0x200000
5519Loading:############
5520done
5521Bytes transferred = 1029407 (fb51f hex)
5522=> print loadaddr
5523loadaddr=200000
5524=> print oftaddr
5525oftaddr=0x300000
5526=> bootm $loadaddr - $oftaddr
5527## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005528 Image Name: Linux-2.6.17-dirty
5529 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5530 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005531 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005532 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005533 Verifying Checksum ... OK
5534 Uncompressing Kernel Image ... OK
5535Booting using flat device tree at 0x300000
5536Using MPC85xx ADS machine description
5537Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5538[snip]
5539
5540
wdenk2729af92004-05-03 20:45:30 +00005541More About U-Boot Image Types:
5542------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005545
wdenk2729af92004-05-03 20:45:30 +00005546 "Standalone Programs" are directly runnable in the environment
5547 provided by U-Boot; it is expected that (if they behave
5548 well) you can continue to work in U-Boot after return from
5549 the Standalone Program.
5550 "OS Kernel Images" are usually images of some Embedded OS which
5551 will take over control completely. Usually these programs
5552 will install their own set of exception handlers, device
5553 drivers, set up the MMU, etc. - this means, that you cannot
5554 expect to re-enter U-Boot except by resetting the CPU.
5555 "RAMDisk Images" are more or less just data blocks, and their
5556 parameters (address, size) are passed to an OS kernel that is
5557 being started.
5558 "Multi-File Images" contain several images, typically an OS
5559 (Linux) kernel image and one or more data images like
5560 RAMDisks. This construct is useful for instance when you want
5561 to boot over the network using BOOTP etc., where the boot
5562 server provides just a single image file, but you want to get
5563 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005564
wdenk2729af92004-05-03 20:45:30 +00005565 "Multi-File Images" start with a list of image sizes, each
5566 image size (in bytes) specified by an "uint32_t" in network
5567 byte order. This list is terminated by an "(uint32_t)0".
5568 Immediately after the terminating 0 follow the images, one by
5569 one, all aligned on "uint32_t" boundaries (size rounded up to
5570 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005571
wdenk2729af92004-05-03 20:45:30 +00005572 "Firmware Images" are binary images containing firmware (like
5573 U-Boot or FPGA images) which usually will be programmed to
5574 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005575
wdenk2729af92004-05-03 20:45:30 +00005576 "Script files" are command sequences that will be executed by
5577 U-Boot's command interpreter; this feature is especially
5578 useful when you configure U-Boot to use a real shell (hush)
5579 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005580
Marek Vasut44f074c2012-03-14 21:52:45 +00005581Booting the Linux zImage:
5582-------------------------
5583
5584On some platforms, it's possible to boot Linux zImage. This is done
5585using the "bootz" command. The syntax of "bootz" command is the same
5586as the syntax of "bootm" command.
5587
Tom Rini8ac28562013-05-16 11:40:11 -04005588Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005589kernel with raw initrd images. The syntax is slightly different, the
5590address of the initrd must be augmented by it's size, in the following
5591format: "<initrd addres>:<initrd size>".
5592
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594Standalone HOWTO:
5595=================
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597One of the features of U-Boot is that you can dynamically load and
5598run "standalone" applications, which can use some resources of
5599U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk2729af92004-05-03 20:45:30 +00005603"Hello World" Demo:
5604-------------------
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606'examples/hello_world.c' contains a small "Hello World" Demo
5607application; it is automatically compiled when you build U-Boot.
5608It's configured to run at address 0x00040004, so you can play with it
5609like that:
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611 => loads
5612 ## Ready for S-Record download ...
5613 ~>examples/hello_world.srec
5614 1 2 3 4 5 6 7 8 9 10 11 ...
5615 [file transfer complete]
5616 [connected]
5617 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005618
wdenk2729af92004-05-03 20:45:30 +00005619 => go 40004 Hello World! This is a test.
5620 ## Starting application at 0x00040004 ...
5621 Hello World
5622 argc = 7
5623 argv[0] = "40004"
5624 argv[1] = "Hello"
5625 argv[2] = "World!"
5626 argv[3] = "This"
5627 argv[4] = "is"
5628 argv[5] = "a"
5629 argv[6] = "test."
5630 argv[7] = "<NULL>"
5631 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk2729af92004-05-03 20:45:30 +00005633 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk2729af92004-05-03 20:45:30 +00005635Another example, which demonstrates how to register a CPM interrupt
5636handler with the U-Boot code, can be found in 'examples/timer.c'.
5637Here, a CPM timer is set up to generate an interrupt every second.
5638The interrupt service routine is trivial, just printing a '.'
5639character, but this is just a demo program. The application can be
5640controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642 ? - print current values og the CPM Timer registers
5643 b - enable interrupts and start timer
5644 e - stop timer and disable interrupts
5645 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647 => loads
5648 ## Ready for S-Record download ...
5649 ~>examples/timer.srec
5650 1 2 3 4 5 6 7 8 9 10 11 ...
5651 [file transfer complete]
5652 [connected]
5653 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655 => go 40004
5656 ## Starting application at 0x00040004 ...
5657 TIMERS=0xfff00980
5658 Using timer 1
5659 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk2729af92004-05-03 20:45:30 +00005661Hit 'b':
5662 [q, b, e, ?] Set interval 1000000 us
5663 Enabling timer
5664Hit '?':
5665 [q, b, e, ?] ........
5666 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5667Hit '?':
5668 [q, b, e, ?] .
5669 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5670Hit '?':
5671 [q, b, e, ?] .
5672 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5673Hit '?':
5674 [q, b, e, ?] .
5675 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5676Hit 'e':
5677 [q, b, e, ?] ...Stopping timer
5678Hit 'q':
5679 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005680
5681
wdenk2729af92004-05-03 20:45:30 +00005682Minicom warning:
5683================
wdenk85ec0bc2003-03-31 16:34:49 +00005684
wdenk2729af92004-05-03 20:45:30 +00005685Over time, many people have reported problems when trying to use the
5686"minicom" terminal emulation program for serial download. I (wd)
5687consider minicom to be broken, and recommend not to use it. Under
5688Unix, I recommend to use C-Kermit for general purpose use (and
5689especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005690use "cu" for S-Record download ("loads" command). See
5691http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5692for help with kermit.
5693
wdenk85ec0bc2003-03-31 16:34:49 +00005694
wdenk2729af92004-05-03 20:45:30 +00005695Nevertheless, if you absolutely want to use it try adding this
5696configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698 Name Program Name U/D FullScr IO-Red. Multi
5699 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5700 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005701
5702
wdenk2729af92004-05-03 20:45:30 +00005703NetBSD Notes:
5704=============
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk2729af92004-05-03 20:45:30 +00005706Starting at version 0.9.2, U-Boot supports NetBSD both as host
5707(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk2729af92004-05-03 20:45:30 +00005709Building requires a cross environment; it is known to work on
5710NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5711need gmake since the Makefiles are not compatible with BSD make).
5712Note that the cross-powerpc package does not install include files;
5713attempting to build U-Boot will fail because <machine/ansi.h> is
5714missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk2729af92004-05-03 20:45:30 +00005716 # cd /usr/pkg/cross/powerpc-netbsd/include
5717 # mkdir powerpc
5718 # ln -s powerpc machine
5719 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5720 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk2729af92004-05-03 20:45:30 +00005722Native builds *don't* work due to incompatibilities between native
5723and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk2729af92004-05-03 20:45:30 +00005725Booting assumes that (the first part of) the image booted is a
5726stage-2 loader which in turn loads and then invokes the kernel
5727proper. Loader sources will eventually appear in the NetBSD source
5728tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005729meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005730
5731
wdenk2729af92004-05-03 20:45:30 +00005732Implementation Internals:
5733=========================
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk2729af92004-05-03 20:45:30 +00005735The following is not intended to be a complete description of every
5736implementation detail. However, it should help to understand the
5737inner workings of U-Boot and make it easier to port it to custom
5738hardware.
wdenkc6097192002-11-03 00:24:07 +00005739
5740
wdenk2729af92004-05-03 20:45:30 +00005741Initial Stack, Global Data:
5742---------------------------
wdenkc6097192002-11-03 00:24:07 +00005743
wdenk2729af92004-05-03 20:45:30 +00005744The implementation of U-Boot is complicated by the fact that U-Boot
5745starts running out of ROM (flash memory), usually without access to
5746system RAM (because the memory controller is not initialized yet).
5747This means that we don't have writable Data or BSS segments, and BSS
5748is not initialized as zero. To be able to get a C environment working
5749at all, we have to allocate at least a minimal stack. Implementation
5750options for this are defined and restricted by the CPU used: Some CPU
5751models provide on-chip memory (like the IMMR area on MPC8xx and
5752MPC826x processors), on others (parts of) the data cache can be
5753locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005754
Wolfgang Denk218ca722008-03-26 10:40:12 +01005755 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005756 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005757
wdenk2729af92004-05-03 20:45:30 +00005758 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5759 From: "Chris Hallinan" <clh@net1plus.com>
5760 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5761 ...
wdenk43d96162003-03-06 00:02:04 +00005762
wdenk2729af92004-05-03 20:45:30 +00005763 Correct me if I'm wrong, folks, but the way I understand it
5764 is this: Using DCACHE as initial RAM for Stack, etc, does not
5765 require any physical RAM backing up the cache. The cleverness
5766 is that the cache is being used as a temporary supply of
5767 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005768 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005769 can see how this works by studying the cache architecture and
5770 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005771
wdenk2729af92004-05-03 20:45:30 +00005772 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5773 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005774 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005775 option should work for you. Using CS 4 should be fine if your
5776 board designers haven't used it for something that would
5777 cause you grief during the initial boot! It is frequently not
5778 used.
wdenk43d96162003-03-06 00:02:04 +00005779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005780 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005781 with your processor/board/system design. The default value
5782 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005783 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005784 than your SDRAM module. If you have a 64MB SDRAM module, set
5785 it above 400_0000. Just make sure your board has no resources
5786 that are supposed to respond to that address! That code in
5787 start.S has been around a while and should work as is when
5788 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005789
wdenk2729af92004-05-03 20:45:30 +00005790 -Chris Hallinan
5791 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005792
wdenk2729af92004-05-03 20:45:30 +00005793It is essential to remember this, since it has some impact on the C
5794code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796* Initialized global data (data segment) is read-only. Do not attempt
5797 to write it.
wdenkc6097192002-11-03 00:24:07 +00005798
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005799* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005800 as zero data - BSS segment) at all - this is undefined, initiali-
5801 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803* Stack space is very limited. Avoid big data buffers or things like
5804 that.
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806Having only the stack as writable memory limits means we cannot use
5807normal global data to share information beween the code. But it
5808turned out that the implementation of U-Boot can be greatly
5809simplified by making a global data structure (gd_t) available to all
5810functions. We could pass a pointer to this data as argument to _all_
5811functions, but this would bloat the code. Instead we use a feature of
5812the GCC compiler (Global Register Variables) to share the data: we
5813place a pointer (gd) to the global data into a register which we
5814reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk2729af92004-05-03 20:45:30 +00005816When choosing a register for such a purpose we are restricted by the
5817relevant (E)ABI specifications for the current architecture, and by
5818GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk2729af92004-05-03 20:45:30 +00005820For PowerPC, the following registers have specific use:
5821 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005822 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005823 R3-R4: parameter passing and return values
5824 R5-R10: parameter passing
5825 R13: small data area pointer
5826 R30: GOT pointer
5827 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005828
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005829 (U-Boot also uses R12 as internal GOT pointer. r12
5830 is a volatile register so r12 needs to be reset when
5831 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005832
Wolfgang Denke7670f62008-02-14 22:43:22 +01005833 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk2729af92004-05-03 20:45:30 +00005835 Note: on PPC, we could use a static initializer (since the
5836 address of the global data structure is known at compile time),
5837 but it turned out that reserving a register results in somewhat
5838 smaller code - although the code savings are not that big (on
5839 average for all boards 752 bytes for the whole U-Boot image,
5840 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005841
Robin Getzc4db3352009-08-17 15:23:02 +00005842On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005843 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5844
Robin Getzc4db3352009-08-17 15:23:02 +00005845 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005846
wdenk2729af92004-05-03 20:45:30 +00005847On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005848
wdenk2729af92004-05-03 20:45:30 +00005849 R0: function argument word/integer result
5850 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005851 R9: platform specific
5852 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005853 R11: argument (frame) pointer
5854 R12: temporary workspace
5855 R13: stack pointer
5856 R14: link register
5857 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005858
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005859 ==> U-Boot will use R9 to hold a pointer to the global data
5860
5861 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005862
Thomas Chou0df01fd2010-05-21 11:08:03 +08005863On Nios II, the ABI is documented here:
5864 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5865
5866 ==> U-Boot will use gp to hold a pointer to the global data
5867
5868 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5869 to access small data sections, so gp is free.
5870
Macpaul Linafc1ce82011-10-19 20:41:11 +00005871On NDS32, the following registers are used:
5872
5873 R0-R1: argument/return
5874 R2-R5: argument
5875 R15: temporary register for assembler
5876 R16: trampoline register
5877 R28: frame pointer (FP)
5878 R29: global pointer (GP)
5879 R30: link register (LP)
5880 R31: stack pointer (SP)
5881 PC: program counter (PC)
5882
5883 ==> U-Boot will use R10 to hold a pointer to the global data
5884
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005885NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5886or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888Memory Management:
5889------------------
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk2729af92004-05-03 20:45:30 +00005891U-Boot runs in system state and uses physical addresses, i.e. the
5892MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk2729af92004-05-03 20:45:30 +00005894The available memory is mapped to fixed addresses using the memory
5895controller. In this process, a contiguous block is formed for each
5896memory type (Flash, SDRAM, SRAM), even when it consists of several
5897physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk2729af92004-05-03 20:45:30 +00005899U-Boot is installed in the first 128 kB of the first Flash bank (on
5900TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5901booting and sizing and initializing DRAM, the code relocates itself
5902to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005903memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005904configuration setting]. Below that, a structure with global Board
5905Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk2729af92004-05-03 20:45:30 +00005907Additionally, some exception handler code is copied to the low 8 kB
5908of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk2729af92004-05-03 20:45:30 +00005910So a typical memory configuration with 16 MB of DRAM could look like
5911this:
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk2729af92004-05-03 20:45:30 +00005913 0x0000 0000 Exception Vector code
5914 :
5915 0x0000 1FFF
5916 0x0000 2000 Free for Application Use
5917 :
5918 :
wdenkc6097192002-11-03 00:24:07 +00005919
wdenk2729af92004-05-03 20:45:30 +00005920 :
5921 :
5922 0x00FB FF20 Monitor Stack (Growing downward)
5923 0x00FB FFAC Board Info Data and permanent copy of global data
5924 0x00FC 0000 Malloc Arena
5925 :
5926 0x00FD FFFF
5927 0x00FE 0000 RAM Copy of Monitor Code
5928 ... eventually: LCD or video framebuffer
5929 ... eventually: pRAM (Protected RAM - unchanged by reset)
5930 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005931
5932
wdenk2729af92004-05-03 20:45:30 +00005933System Initialization:
5934----------------------
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk2729af92004-05-03 20:45:30 +00005936In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005937(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005938configuration for CS0# this is a mirror of the onboard Flash memory.
5939To be able to re-map memory U-Boot then jumps to its link address.
5940To be able to implement the initialization code in C, a (small!)
5941initial stack is set up in the internal Dual Ported RAM (in case CPUs
5942which provide such a feature like MPC8xx or MPC8260), or in a locked
5943part of the data cache. After that, U-Boot initializes the CPU core,
5944the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005945
wdenk2729af92004-05-03 20:45:30 +00005946Next, all (potentially) available memory banks are mapped using a
5947preliminary mapping. For example, we put them on 512 MB boundaries
5948(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5949on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5950programmed for SDRAM access. Using the temporary configuration, a
5951simple memory test is run that determines the size of the SDRAM
5952banks.
wdenkc6097192002-11-03 00:24:07 +00005953
wdenk2729af92004-05-03 20:45:30 +00005954When there is more than one SDRAM bank, and the banks are of
5955different size, the largest is mapped first. For equal size, the first
5956bank (CS2#) is mapped first. The first mapping is always for address
59570x00000000, with any additional banks following immediately to create
5958contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005959
wdenk2729af92004-05-03 20:45:30 +00005960Then, the monitor installs itself at the upper end of the SDRAM area
5961and allocates memory for use by malloc() and for the global Board
5962Info data; also, the exception vector code is copied to the low RAM
5963pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005964
wdenk2729af92004-05-03 20:45:30 +00005965Only after this relocation will you have a "normal" C environment;
5966until that you are restricted in several ways, mostly because you are
5967running from ROM, and because the code will have to be relocated to a
5968new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005969
5970
wdenk2729af92004-05-03 20:45:30 +00005971U-Boot Porting Guide:
5972----------------------
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk2729af92004-05-03 20:45:30 +00005974[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5975list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005976
5977
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005978int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005979{
5980 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005981
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005982 signal(SIGALRM, no_more_time);
5983 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk2729af92004-05-03 20:45:30 +00005985 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005986 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005987 return 0;
5988 }
5989
wdenk2729af92004-05-03 20:45:30 +00005990 Download latest U-Boot source;
5991
Wolfgang Denk06682362008-12-30 22:56:11 +01005992 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005993
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005994 if (clueless)
5995 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005996
wdenk2729af92004-05-03 20:45:30 +00005997 while (learning) {
5998 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005999 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6000 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006001 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006002 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006003 }
wdenkc6097192002-11-03 00:24:07 +00006004
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006005 if (available_money > toLocalCurrency ($2500))
6006 Buy a BDI3000;
6007 else
wdenk2729af92004-05-03 20:45:30 +00006008 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006009
6010 if (a similar board exists) { /* hopefully... */
6011 cp -a board/<similar> board/<myboard>
6012 cp include/configs/<similar>.h include/configs/<myboard>.h
6013 } else {
6014 Create your own board support subdirectory;
6015 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006016 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006017 Edit new board/<myboard> files
6018 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006019
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006020 while (!accepted) {
6021 while (!running) {
6022 do {
6023 Add / modify source code;
6024 } until (compiles);
6025 Debug;
6026 if (clueless)
6027 email("Hi, I am having problems...");
6028 }
6029 Send patch file to the U-Boot email list;
6030 if (reasonable critiques)
6031 Incorporate improvements from email list code review;
6032 else
6033 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006034 }
wdenkc6097192002-11-03 00:24:07 +00006035
wdenk2729af92004-05-03 20:45:30 +00006036 return 0;
6037}
6038
6039void no_more_time (int sig)
6040{
6041 hire_a_guru();
6042}
wdenkc6097192002-11-03 00:24:07 +00006043
6044
wdenk2729af92004-05-03 20:45:30 +00006045Coding Standards:
6046-----------------
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk2729af92004-05-03 20:45:30 +00006048All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006049coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006050"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006051
Detlev Zundel2c051652006-09-01 15:39:02 +02006052Source files originating from a different project (for example the
6053MTD subsystem) are generally exempt from these guidelines and are not
6054reformated to ease subsequent migration to newer versions of those
6055sources.
6056
6057Please note that U-Boot is implemented in C (and to some small parts in
6058Assembler); no C++ is used, so please do not use C++ style comments (//)
6059in your code.
wdenk2729af92004-05-03 20:45:30 +00006060
6061Please also stick to the following formatting rules:
6062- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006063- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006064- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006065- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006066- do not add trailing empty lines to source files
6067
6068Submissions which do not conform to the standards may be returned
6069with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006070
6071
wdenk2729af92004-05-03 20:45:30 +00006072Submitting Patches:
6073-------------------
wdenkc6097192002-11-03 00:24:07 +00006074
wdenk2729af92004-05-03 20:45:30 +00006075Since the number of patches for U-Boot is growing, we need to
6076establish some rules. Submissions which do not conform to these rules
6077may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006078
Magnus Lilja0d28f342008-08-06 19:32:33 +02006079Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006080
Wolfgang Denk06682362008-12-30 22:56:11 +01006081Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6082see http://lists.denx.de/mailman/listinfo/u-boot
6083
wdenk2729af92004-05-03 20:45:30 +00006084When you send a patch, please include the following information with
6085it:
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk2729af92004-05-03 20:45:30 +00006087* For bug fixes: a description of the bug and how your patch fixes
6088 this bug. Please try to include a way of demonstrating that the
6089 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006090
wdenk2729af92004-05-03 20:45:30 +00006091* For new features: a description of the feature and your
6092 implementation.
wdenkc6097192002-11-03 00:24:07 +00006093
wdenk2729af92004-05-03 20:45:30 +00006094* A CHANGELOG entry as plaintext (separate from the patch)
6095
6096* For major contributions, your entry to the CREDITS file
6097
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006098* When you add support for a new board, don't forget to add a
6099 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006100
6101* If your patch adds new configuration options, don't forget to
6102 document these in the README file.
6103
Wolfgang Denk218ca722008-03-26 10:40:12 +01006104* The patch itself. If you are using git (which is *strongly*
6105 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006106 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006107 the U-Boot mailing list, you will avoid most of the common problems
6108 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006109
Wolfgang Denk218ca722008-03-26 10:40:12 +01006110 If you cannot use git, use "diff -purN OLD NEW". If your version of
6111 diff does not support these options, then get the latest version of
6112 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006113
Wolfgang Denk218ca722008-03-26 10:40:12 +01006114 The current directory when running this command shall be the parent
6115 directory of the U-Boot source tree (i. e. please make sure that
6116 your patch includes sufficient directory information for the
6117 affected files).
6118
6119 We prefer patches as plain text. MIME attachments are discouraged,
6120 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006121
6122* If one logical set of modifications affects or creates several
6123 files, all these changes shall be submitted in a SINGLE patch file.
6124
6125* Changesets that contain different, unrelated modifications shall be
6126 submitted as SEPARATE patches, one patch per changeset.
6127
6128
6129Notes:
6130
6131* Before sending the patch, run the MAKEALL script on your patched
6132 source tree and make sure that no errors or warnings are reported
6133 for any of the boards.
6134
6135* Keep your modifications to the necessary minimum: A patch
6136 containing several unrelated changes or arbitrary reformats will be
6137 returned with a request to re-formatting / split it.
6138
6139* If you modify existing code, make sure that your new code does not
6140 add to the memory footprint of the code ;-) Small is beautiful!
6141 When adding new features, these should compile conditionally only
6142 (using #ifdef), and the resulting code with the new feature
6143 disabled must not need more memory than the old code without your
6144 modification.
wdenk90dc6702005-05-03 14:12:25 +00006145
Wolfgang Denk06682362008-12-30 22:56:11 +01006146* Remember that there is a size limit of 100 kB per message on the
6147 u-boot mailing list. Bigger patches will be moderated. If they are
6148 reasonable and not too big, they will be acknowledged. But patches
6149 bigger than the size limit should be avoided.