blob: 49dcd37a3c859484247e764b3a8551b9f6bfc787 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-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 Denk1234ce72013-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
wdenkce4832c2004-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 ARIBAUD48e910f2013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denkb240aef2008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Day974ed2f2012-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschin08337f32008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000110
wdenk24ee89b2002-11-03 17:56:27 +0000111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
113
wdenkc6097192002-11-03 00:24:07 +0000114
wdenk7474aca2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000124
Thomas Webere89e6282010-09-28 08:06:25 +0200125Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-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
wdenk7474aca2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tysere4d1abc2010-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ßmannd9a9d562011-07-18 09:41:08 +0000139 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200140 /imx Files specific to Freescale MC9328 i.MX CPUs
141 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /arm926ejs Files specific to ARM 926 CPUs
143 /arm1136 Files specific to ARM 1136 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500144 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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 Schwierzeckd52a6232011-07-27 13:22:39 +0200166 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800167 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500168 /lib Architecture specific library files
Macpaul Lin1cac36e2011-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400176 /openrisc Files generic to OpenRISC architecture
177 /cpu CPU specific files
178 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200179 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-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 Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400201 /x86 Files generic to x86 architecture
202 /cpu CPU specific files
203 /lib Architecture specific library files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400210/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400220/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-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-VILLARD03836942008-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 Ziswilerabd8dcb2008-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500281- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000282
Kim Phillips203fee32007-08-10 13:28:25 -0500283- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200284
285- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200306 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000307 a "rotator" |\-/|\-/
308
wdenk2bb11052003-07-17 23:16:40 +0000309- Board flavour: (if CONFIG_MPC8260ADS is defined)
310 CONFIG_ADSTYPE
311 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk2bb11052003-07-17 23:16:40 +0000316
Lei Wen20014762011-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)
wdenk9b7f3842003-10-09 20:09:04 +0000323 Define exactly one of
324 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000325
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200326- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000327 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
328 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000329 e.g. if there is no 32KHz
330 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000334- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200335 CONFIG_SYS_8xx_CPUCLK_MIN
336 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000337 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000338 See doc/README.MPC866
339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200340 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000341
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200347 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000348
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600354- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Kushwahaa6a30622012-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 Wood80806962012-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 Kushwahad324f472013-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 Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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
Tang Yuantiana7364af2014-04-17 15:33:46 +0800434 CONFIG_DEEP_SLEEP
435 Inidcates this SoC supports deep sleep feature. If deep sleep is
436 supported, core will start to execute uboot when wakes up.
437
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000438- Generic CPU options:
439 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
440
441 Defines the endianess of the CPU. Implementation of those
442 values is arch specific.
443
York Sunf0626592013-09-30 09:22:09 -0700444 CONFIG_SYS_FSL_DDR
445 Freescale DDR driver in use. This type of DDR controller is
446 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
447 SoCs.
448
449 CONFIG_SYS_FSL_DDR_ADDR
450 Freescale DDR memory-mapped register base.
451
452 CONFIG_SYS_FSL_DDR_EMU
453 Specify emulator support for DDR. Some DDR features such as
454 deskew training are not available.
455
456 CONFIG_SYS_FSL_DDRC_GEN1
457 Freescale DDR1 controller.
458
459 CONFIG_SYS_FSL_DDRC_GEN2
460 Freescale DDR2 controller.
461
462 CONFIG_SYS_FSL_DDRC_GEN3
463 Freescale DDR3 controller.
464
York Sun2896cb72014-03-27 17:54:47 -0700465 CONFIG_SYS_FSL_DDRC_GEN4
466 Freescale DDR4 controller.
467
York Sun461c9392013-09-30 14:20:51 -0700468 CONFIG_SYS_FSL_DDRC_ARM_GEN3
469 Freescale DDR3 controller for ARM-based SoCs.
470
York Sunf0626592013-09-30 09:22:09 -0700471 CONFIG_SYS_FSL_DDR1
472 Board config to use DDR1. It can be enabled for SoCs with
473 Freescale DDR1 or DDR2 controllers, depending on the board
474 implemetation.
475
476 CONFIG_SYS_FSL_DDR2
477 Board config to use DDR2. It can be eanbeld for SoCs with
478 Freescale DDR2 or DDR3 controllers, depending on the board
479 implementation.
480
481 CONFIG_SYS_FSL_DDR3
482 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700483 Freescale DDR3 or DDR3L controllers.
484
485 CONFIG_SYS_FSL_DDR3L
486 Board config to use DDR3L. It can be enabled for SoCs with
487 DDR3L controllers.
488
489 CONFIG_SYS_FSL_DDR4
490 Board config to use DDR4. It can be enabled for SoCs with
491 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700492
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530493 CONFIG_SYS_FSL_IFC_BE
494 Defines the IFC controller register space as Big Endian
495
496 CONFIG_SYS_FSL_IFC_LE
497 Defines the IFC controller register space as Little Endian
498
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530499 CONFIG_SYS_FSL_PBL_PBI
500 It enables addition of RCW (Power on reset configuration) in built image.
501 Please refer doc/README.pblimage for more details
502
503 CONFIG_SYS_FSL_PBL_RCW
504 It adds PBI(pre-boot instructions) commands in u-boot build image.
505 PBI commands can be used to configure SoC before it starts the execution.
506 Please refer doc/README.pblimage for more details
507
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530508 CONFIG_SPL_FSL_PBL
509 It adds a target to create boot binary having SPL binary in PBI format
510 concatenated with u-boot binary.
511
York Sun29647ab2014-02-10 13:59:42 -0800512 CONFIG_SYS_FSL_DDR_BE
513 Defines the DDR controller register space as Big Endian
514
515 CONFIG_SYS_FSL_DDR_LE
516 Defines the DDR controller register space as Little Endian
517
York Sun3a0916d2014-02-10 13:59:43 -0800518 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
519 Physical address from the view of DDR controllers. It is the
520 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
521 it could be different for ARM SoCs.
522
York Sunc459ae62014-02-10 13:59:44 -0800523 CONFIG_SYS_FSL_DDR_INTLV_256B
524 DDR controller interleaving on 256-byte. This is a special
525 interleaving mode, handled by Dickens for Freescale layerscape
526 SoCs with ARM core.
527
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100528- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200529 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100530
531 Defines the Monahans run mode to oscillator
532 ratio. Valid values are 8, 16, 24, 31. The core
533 frequency is this value multiplied by 13 MHz.
534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200535 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200536
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100537 Defines the Monahans turbo mode to oscillator
538 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200539 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100540 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200541
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200542- MIPS CPU options:
543 CONFIG_SYS_INIT_SP_OFFSET
544
545 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
546 pointer. This is needed for the temporary stack before
547 relocation.
548
549 CONFIG_SYS_MIPS_CACHE_MODE
550
551 Cache operation mode for the MIPS CPU.
552 See also arch/mips/include/asm/mipsregs.h.
553 Possible values are:
554 CONF_CM_CACHABLE_NO_WA
555 CONF_CM_CACHABLE_WA
556 CONF_CM_UNCACHED
557 CONF_CM_CACHABLE_NONCOHERENT
558 CONF_CM_CACHABLE_CE
559 CONF_CM_CACHABLE_COW
560 CONF_CM_CACHABLE_CUW
561 CONF_CM_CACHABLE_ACCELERATED
562
563 CONFIG_SYS_XWAY_EBU_BOOTCFG
564
565 Special option for Lantiq XWAY SoCs for booting from NOR flash.
566 See also arch/mips/cpu/mips32/start.S.
567
568 CONFIG_XWAY_SWAP_BYTES
569
570 Enable compilation of tools/xway-swap-bytes needed for Lantiq
571 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
572 be swapped if a flash programmer is used.
573
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000574- ARM options:
575 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
576
577 Select high exception vectors of the ARM core, e.g., do not
578 clear the V bit of the c1 register of CP15.
579
Aneesh Vb8e40802012-03-08 07:20:19 +0000580 CONFIG_SYS_THUMB_BUILD
581
582 Use this flag to build U-Boot using the Thumb instruction
583 set for ARM architectures. Thumb instruction set provides
584 better code density. For ARM architectures that support
585 Thumb2 this flag will result in Thumb2 code generated by
586 GCC.
587
Stephen Warrenc63c3502013-03-04 13:29:40 +0000588 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000589 CONFIG_ARM_ERRATA_742230
590 CONFIG_ARM_ERRATA_743622
591 CONFIG_ARM_ERRATA_751472
Nitin Garg7f17aed2014-04-02 08:55:01 -0500592 CONFIG_ARM_ERRATA_794072
Nitin Garg245defa2014-04-02 08:55:02 -0500593 CONFIG_ARM_ERRATA_761320
Stephen Warrene9d59c92013-02-26 12:28:27 +0000594
595 If set, the workarounds for these ARM errata are applied early
596 during U-Boot startup. Note that these options force the
597 workarounds to be applied; no CPU-type/version detection
598 exists, unlike the similar options in the Linux kernel. Do not
599 set these options unless they apply!
600
Stephen Warren445d56c2013-03-27 17:06:41 +0000601- CPU timer options:
602 CONFIG_SYS_HZ
603
604 The frequency of the timer returned by get_timer().
605 get_timer() must operate in milliseconds and this CONFIG
606 option must be set to 1000.
607
wdenk9b7f3842003-10-09 20:09:04 +0000608- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000609 CONFIG_CLOCKS_IN_MHZ
610
611 U-Boot stores all clock information in Hz
612 internally. For binary compatibility with older Linux
613 kernels (which expect the clocks passed in the
614 bd_info data to be in MHz) the environment variable
615 "clocks_in_mhz" can be defined so that U-Boot
616 converts clock data to MHZ before passing it to the
617 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000618 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100619 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000620 default environment.
621
wdenk9b7f3842003-10-09 20:09:04 +0000622 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
623
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200624 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000625 expect it to be in bytes, others in MB.
626 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
627
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400628 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200629
630 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400631 passed using flattened device trees (based on open firmware
632 concepts).
633
634 CONFIG_OF_LIBFDT
635 * New libfdt-based support
636 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500637 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400638
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200639 OF_CPU - The proper name of the cpus node (only required for
640 MPC512X and MPC5xxx based boards).
641 OF_SOC - The proper name of the soc node (only required for
642 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200643 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600644 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200645
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200646 boards with QUICC Engines require OF_QE to set UCC MAC
647 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500648
Kumar Gala1e26aa52006-01-11 13:54:17 -0600649 CONFIG_OF_BOARD_SETUP
650
651 Board code has addition modification that it wants to make
652 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000653
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500654 CONFIG_OF_BOOT_CPU
655
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200656 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500657 param header, the default value is zero if undefined.
658
Heiko Schocherffb293a2009-09-23 07:56:08 +0200659 CONFIG_OF_IDE_FIXUP
660
661 U-Boot can detect if an IDE device is present or not.
662 If not, and this new config option is activated, U-Boot
663 removes the ATA node from the DTS before booting Linux,
664 so the Linux IDE driver does not probe the device and
665 crash. This is needed for buggy hardware (uc101) where
666 no pull down resistor is connected to the signal IDE5V_DD7.
667
Igor Grinberg06890672011-07-14 05:45:07 +0000668 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
669
670 This setting is mandatory for all boards that have only one
671 machine type and must be used to specify the machine type
672 number as it appears in the ARM machine registry
673 (see http://www.arm.linux.org.uk/developer/machines/).
674 Only boards that have multiple machine types supported
675 in a single configuration file and the machine type is
676 runtime discoverable, do not have to use this setting.
677
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100678- vxWorks boot parameters:
679
680 bootvx constructs a valid bootline using the following
681 environments variables: bootfile, ipaddr, serverip, hostname.
682 It loads the vxWorks image pointed bootfile.
683
684 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
685 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
686 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
687 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
688
689 CONFIG_SYS_VXWORKS_ADD_PARAMS
690
691 Add it at the end of the bootline. E.g "u=username pw=secret"
692
693 Note: If a "bootargs" environment is defined, it will overwride
694 the defaults discussed just above.
695
Aneesh V960f5c02011-06-16 23:30:47 +0000696- Cache Configuration:
697 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
698 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
699 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
700
Aneesh V686a0752011-06-16 23:30:51 +0000701- Cache Configuration for ARM:
702 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
703 controller
704 CONFIG_SYS_PL310_BASE - Physical base address of PL310
705 controller register space
706
wdenkda04a8b2004-08-02 23:22:59 +0000707- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200708 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000709
710 Define this if you want support for Amba PrimeCell PL010 UARTs.
711
Andreas Engel0813b122008-09-08 14:30:53 +0200712 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000713
714 Define this if you want support for Amba PrimeCell PL011 UARTs.
715
716 CONFIG_PL011_CLOCK
717
718 If you have Amba PrimeCell PL011 UARTs, set this variable to
719 the clock speed of the UARTs.
720
721 CONFIG_PL01x_PORTS
722
723 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
724 define this to a list of base addresses for each (supported)
725 port. See e.g. include/configs/versatile.h
726
John Rigby34e21ee2011-04-19 10:42:39 +0000727 CONFIG_PL011_SERIAL_RLCR
728
729 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
730 have separate receive and transmit line control registers. Set
731 this variable to initialize the extra register.
732
733 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
734
735 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
736 boot loader that has already initialized the UART. Define this
737 variable to flush the UART at init time.
738
wdenkda04a8b2004-08-02 23:22:59 +0000739
wdenkc6097192002-11-03 00:24:07 +0000740- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000741 Depending on board, define exactly one serial port
742 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
743 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
744 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000745
746 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
747 port routines must be defined elsewhere
748 (i.e. serial_init(), serial_getc(), ...)
749
750 CONFIG_CFB_CONSOLE
751 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000752 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000753 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
754 (default big endian)
755 VIDEO_HW_RECTFILL graphic chip supports
756 rectangle fill
757 (cf. smiLynxEM)
758 VIDEO_HW_BITBLT graphic chip supports
759 bit-blit (cf. smiLynxEM)
760 VIDEO_VISIBLE_COLS visible pixel columns
761 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000762 VIDEO_VISIBLE_ROWS visible pixel rows
763 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000764 VIDEO_DATA_FORMAT graphic data format
765 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000766 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000767 VIDEO_KBD_INIT_FCT keyboard int fct
768 (i.e. i8042_kbd_init())
769 VIDEO_TSTC_FCT test char fct
770 (i.e. i8042_tstc)
771 VIDEO_GETC_FCT get char fct
772 (i.e. i8042_getc)
773 CONFIG_CONSOLE_CURSOR cursor drawing on/off
774 (requires blink timer
775 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200776 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000777 CONFIG_CONSOLE_TIME display time/date info in
778 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500779 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000780 CONFIG_VIDEO_LOGO display Linux logo in
781 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000782 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
783 linux_logo.h for logo.
784 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000785 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200786 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000787 the logo
788
Pali Rohár4a57da32012-10-19 13:30:09 +0000789 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
790 a limited number of ANSI escape sequences (cursor control,
791 erase functions and limited graphics rendition control).
792
wdenk4a5c8a72003-03-06 00:02:04 +0000793 When CONFIG_CFB_CONSOLE is defined, video console is
794 default i/o. Serial console can be forced with
795 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000796
wdenk1ebf41e2004-01-02 14:00:00 +0000797 When CONFIG_SILENT_CONSOLE is defined, all console
798 messages (by U-Boot and Linux!) can be silenced with
799 the "silent" environment variable. See
800 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000801
Heiko Schocher62759562013-10-22 11:06:06 +0200802 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
803 is 0x00.
804 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
805 is 0xa0.
806
wdenkc6097192002-11-03 00:24:07 +0000807- Console Baudrate:
808 CONFIG_BAUDRATE - in bps
809 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200810 CONFIG_SYS_BAUDRATE_TABLE, see below.
811 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000812
Heiko Schocher327480a2009-01-30 12:55:38 +0100813- Console Rx buffer length
814 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
815 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100816 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100817 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
818 must be defined, to setup the maximum idle timeout for
819 the SMC.
820
Graeme Russ3c28f482011-09-01 00:48:27 +0000821- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200822 Prior to the console being initialised (i.e. serial UART
823 initialised etc) all console output is silently discarded.
824 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
825 buffer any console messages prior to the console being
826 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
827 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
828 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200829 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200830 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000831
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200832 'Sane' compilers will generate smaller code if
833 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000834
Sonny Raocd55bde2011-11-02 09:52:08 +0000835- Safe printf() functions
836 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
837 the printf() functions. These are defined in
838 include/vsprintf.h and include snprintf(), vsnprintf() and
839 so on. Code size increase is approximately 300-500 bytes.
840 If this option is not given then these functions will
841 silently discard their buffer size argument - this means
842 you are not getting any overflow checking in this case.
843
wdenkc6097192002-11-03 00:24:07 +0000844- Boot Delay: CONFIG_BOOTDELAY - in seconds
845 Delay before automatically booting the default image;
846 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000847 set to -2 to autoboot with no delay and not check for abort
848 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000849
850 See doc/README.autoboot for these options that
851 work with CONFIG_BOOTDELAY. None are required.
852 CONFIG_BOOT_RETRY_TIME
853 CONFIG_BOOT_RETRY_MIN
854 CONFIG_AUTOBOOT_KEYED
855 CONFIG_AUTOBOOT_PROMPT
856 CONFIG_AUTOBOOT_DELAY_STR
857 CONFIG_AUTOBOOT_STOP_STR
858 CONFIG_AUTOBOOT_DELAY_STR2
859 CONFIG_AUTOBOOT_STOP_STR2
860 CONFIG_ZERO_BOOTDELAY_CHECK
861 CONFIG_RESET_TO_RETRY
862
863- Autoboot Command:
864 CONFIG_BOOTCOMMAND
865 Only needed when CONFIG_BOOTDELAY is enabled;
866 define a command string that is automatically executed
867 when no character is read on the console interface
868 within "Boot Delay" after reset.
869
870 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000871 This can be used to pass arguments to the bootm
872 command. The value of CONFIG_BOOTARGS goes into the
873 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000874
875 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000876 The value of these goes into the environment as
877 "ramboot" and "nfsboot" respectively, and can be used
878 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200879 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000880
Heiko Schocher040c5c32013-11-04 14:04:59 +0100881- Bootcount:
882 CONFIG_BOOTCOUNT_LIMIT
883 Implements a mechanism for detecting a repeating reboot
884 cycle, see:
885 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
886
887 CONFIG_BOOTCOUNT_ENV
888 If no softreset save registers are found on the hardware
889 "bootcount" is stored in the environment. To prevent a
890 saveenv on all reboots, the environment variable
891 "upgrade_available" is used. If "upgrade_available" is
892 0, "bootcount" is always 0, if "upgrade_available" is
893 1 "bootcount" is incremented in the environment.
894 So the Userspace Applikation must set the "upgrade_available"
895 and "bootcount" variable to 0, if a boot was successfully.
896
wdenkc6097192002-11-03 00:24:07 +0000897- Pre-Boot Commands:
898 CONFIG_PREBOOT
899
900 When this option is #defined, the existence of the
901 environment variable "preboot" will be checked
902 immediately before starting the CONFIG_BOOTDELAY
903 countdown and/or running the auto-boot command resp.
904 entering interactive mode.
905
906 This feature is especially useful when "preboot" is
907 automatically generated or modified. For an example
908 see the LWMON board specific code: here "preboot" is
909 modified when the user holds down a certain
910 combination of keys on the (special) keyboard when
911 booting the systems
912
913- Serial Download Echo Mode:
914 CONFIG_LOADS_ECHO
915 If defined to 1, all characters received during a
916 serial download (using the "loads" command) are
917 echoed back. This might be needed by some terminal
918 emulations (like "cu"), but may as well just take
919 time on others. This setting #define's the initial
920 value of the "loads_echo" environment variable.
921
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500922- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000923 CONFIG_KGDB_BAUDRATE
924 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200925 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000926
927- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 Monitor commands can be included or excluded
929 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000930 <config_cmd_all.h> and #undef'ing unwanted
931 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500932 and augmenting with additional #define's
933 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000934
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500935 The default command configuration includes all commands
936 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000937
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100938 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500939 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500940 CONFIG_CMD_BDI bdinfo
941 CONFIG_CMD_BEDBUG * Include BedBug Debugger
942 CONFIG_CMD_BMP * BMP support
943 CONFIG_CMD_BSP * Board specific commands
944 CONFIG_CMD_BOOTD bootd
945 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800946 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500947 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500948 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500949 CONFIG_CMD_DATE * support for RTC, date/time...
950 CONFIG_CMD_DHCP * DHCP support
951 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600952 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
953 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
954 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
955 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500956 CONFIG_CMD_DTT * Digital Therm and Thermostat
957 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500958 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500959 CONFIG_CMD_EEPROM * EEPROM read/write support
960 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600961 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600962 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500963 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500964 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000965 CONFIG_CMD_EXT2 * ext2 command support
966 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700967 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
968 that work for multiple fs types
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500969 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500970 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000971 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500972 CONFIG_CMD_FLASH flinfo, erase, protect
973 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200974 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000975 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500976 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000977 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000978 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500979 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
980 CONFIG_CMD_I2C * I2C serial bus support
981 CONFIG_CMD_IDE * IDE harddisk support
982 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000983 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200984 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500985 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500986 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000987 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500988 CONFIG_CMD_IRQ * irqinfo
989 CONFIG_CMD_ITEST Integer/string test of 2 values
990 CONFIG_CMD_JFFS2 * JFFS2 Support
991 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200992 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000993 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
994 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500995 CONFIG_CMD_LOADB loadb
996 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200997 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400998 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000999 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001000 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001001 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001002 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 CONFIG_CMD_MISC Misc functions like sleep etc
1004 CONFIG_CMD_MMC * MMC memory mapped support
1005 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001006 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 CONFIG_CMD_NAND * NAND support
1008 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001009 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001010 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001011 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001012 CONFIG_CMD_PCI * pciinfo
1013 CONFIG_CMD_PCMCIA * PCMCIA support
1014 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1015 host
1016 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001017 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018 CONFIG_CMD_REGINFO * Register dump
1019 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001020 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001021 CONFIG_CMD_SAVES * save S record dump
1022 CONFIG_CMD_SCSI * SCSI Support
1023 CONFIG_CMD_SDRAM * print SDRAM configuration information
1024 (requires CONFIG_CMD_I2C)
1025 CONFIG_CMD_SETGETDCR Support for DCR Register access
1026 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001027 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001028 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001029 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001030 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001031 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001032 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001033 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001034 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001035 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1036 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001037 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001038 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001039 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001040 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001041 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001042
1043 EXAMPLE: If you want all functions except of network
1044 support you can write:
1045
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001046 #include "config_cmd_all.h"
1047 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001048
Gerald Van Barend6abef42007-03-31 12:23:51 -04001049 Other Commands:
1050 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001051
1052 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001053 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001054 what you (and your U-Boot users) are doing. Data
1055 cache cannot be enabled on systems like the 8xx or
1056 8260 (where accesses to the IMMR region must be
1057 uncached), and it cannot be disabled on all other
1058 systems where we (mis-) use the data cache to hold an
1059 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001060
1061
1062 XXX - this list needs to get updated!
1063
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001064- Regular expression support:
1065 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001066 If this variable is defined, U-Boot is linked against
1067 the SLRE (Super Light Regular Expression) library,
1068 which adds regex support to some commands, as for
1069 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001070
Simon Glass3d686442011-10-15 05:48:20 +00001071- Device tree:
1072 CONFIG_OF_CONTROL
1073 If this variable is defined, U-Boot will use a device tree
1074 to configure its devices, instead of relying on statically
1075 compiled #defines in the board file. This option is
1076 experimental and only available on a few boards. The device
1077 tree is available in the global data as gd->fdt_blob.
1078
Simon Glass5cb34db2011-10-24 19:15:31 +00001079 U-Boot needs to get its device tree from somewhere. This can
1080 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001081
1082 CONFIG_OF_EMBED
1083 If this variable is defined, U-Boot will embed a device tree
1084 binary in its image. This device tree file should be in the
1085 board directory and called <soc>-<board>.dts. The binary file
1086 is then picked up in board_init_f() and made available through
1087 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001088
Simon Glass5cb34db2011-10-24 19:15:31 +00001089 CONFIG_OF_SEPARATE
1090 If this variable is defined, U-Boot will build a device tree
1091 binary. It will be called u-boot.dtb. Architecture-specific
1092 code will locate it at run-time. Generally this works by:
1093
1094 cat u-boot.bin u-boot.dtb >image.bin
1095
1096 and in fact, U-Boot does this for you, creating a file called
1097 u-boot-dtb.bin which is useful in the common case. You can
1098 still use the individual files if you need something more
1099 exotic.
1100
wdenkc6097192002-11-03 00:24:07 +00001101- Watchdog:
1102 CONFIG_WATCHDOG
1103 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001104 support for the SoC. There must be support in the SoC
1105 specific code for a watchdog. For the 8xx and 8260
1106 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1107 register. When supported for a specific SoC is
1108 available, then no further board specific code should
1109 be needed to use it.
1110
1111 CONFIG_HW_WATCHDOG
1112 When using a watchdog circuitry external to the used
1113 SoC, then define this variable and provide board
1114 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001115
stroeseb9c17c52003-04-04 15:53:41 +00001116- U-Boot Version:
1117 CONFIG_VERSION_VARIABLE
1118 If this variable is defined, an environment variable
1119 named "ver" is created by U-Boot showing the U-Boot
1120 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001121 Any change to this variable will be reverted at the
1122 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001123
wdenkc6097192002-11-03 00:24:07 +00001124- Real-Time Clock:
1125
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001126 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001127 has to be selected, too. Define exactly one of the
1128 following options:
1129
1130 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1131 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001132 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001133 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001134 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001135 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001136 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001137 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001138 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001139 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001140 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001141 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1142 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001143
wdenkb9bbd242003-06-30 16:24:52 +00001144 Note that if the RTC uses I2C, then the I2C interface
1145 must also be configured. See I2C Support, below.
1146
Peter Tyser9902e422008-12-17 16:36:21 -06001147- GPIO Support:
1148 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001149
Chris Packham9b383202010-12-19 10:12:13 +00001150 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1151 chip-ngpio pairs that tell the PCA953X driver the number of
1152 pins supported by a particular chip.
1153
Peter Tyser9902e422008-12-17 16:36:21 -06001154 Note that if the GPIO device uses I2C, then the I2C interface
1155 must also be configured. See I2C Support, below.
1156
wdenkc6097192002-11-03 00:24:07 +00001157- Timestamp Support:
1158
wdenk4a5c8a72003-03-06 00:02:04 +00001159 When CONFIG_TIMESTAMP is selected, the timestamp
1160 (date and time) of an image is printed by image
1161 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001162 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001163
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001164- Partition Labels (disklabels) Supported:
1165 Zero or more of the following:
1166 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1167 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1168 Intel architecture, USB sticks, etc.
1169 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1170 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1171 bootloader. Note 2TB partition limit; see
1172 disk/part_efi.c
1173 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001174
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001175 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1176 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001177 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001178
1179- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001180 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1181 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001182
wdenk369d43d2004-03-14 14:09:05 +00001183 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1184 be performed by calling the function
1185 ide_set_reset(int reset)
1186 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001187
1188- ATAPI Support:
1189 CONFIG_ATAPI
1190
1191 Set this to enable ATAPI support.
1192
wdenkf602aa02004-03-13 23:29:43 +00001193- LBA48 Support
1194 CONFIG_LBA48
1195
1196 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001197 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001198 Whithout these , LBA48 support uses 32bit variables and will 'only'
1199 support disks up to 2.1TB.
1200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001201 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001202 When enabled, makes the IDE subsystem use 64bit sector addresses.
1203 Default is 32bit.
1204
wdenkc6097192002-11-03 00:24:07 +00001205- SCSI Support:
1206 At the moment only there is only support for the
1207 SYM53C8XX SCSI controller; define
1208 CONFIG_SCSI_SYM53C8XX to enable it.
1209
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001210 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1211 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1212 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001213 maximum numbers of LUNs, SCSI ID's and target
1214 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001215 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001216
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001217 The environment variable 'scsidevs' is set to the number of
1218 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001219
wdenkc6097192002-11-03 00:24:07 +00001220- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001221 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001222 Support for Intel 8254x/8257x gigabit chips.
1223
1224 CONFIG_E1000_SPI
1225 Utility code for direct access to the SPI bus on Intel 8257x.
1226 This does not do anything useful unless you set at least one
1227 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1228
1229 CONFIG_E1000_SPI_GENERIC
1230 Allow generic access to the SPI bus on the Intel 8257x, for
1231 example with the "sspi" command.
1232
1233 CONFIG_CMD_E1000
1234 Management command for E1000 devices. When used on devices
1235 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001236
Andre Schwarz68c2a302008-03-06 16:45:44 +01001237 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001238 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001239
wdenkc6097192002-11-03 00:24:07 +00001240 CONFIG_EEPRO100
1241 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001242 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001243 write routine for first time initialisation.
1244
1245 CONFIG_TULIP
1246 Support for Digital 2114x chips.
1247 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1248 modem chip initialisation (KS8761/QS6611).
1249
1250 CONFIG_NATSEMI
1251 Support for National dp83815 chips.
1252
1253 CONFIG_NS8382X
1254 Support for National dp8382[01] gigabit chips.
1255
wdenkaa603362003-05-12 21:50:16 +00001256- NETWORK Support (other):
1257
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001258 CONFIG_DRIVER_AT91EMAC
1259 Support for AT91RM9200 EMAC.
1260
1261 CONFIG_RMII
1262 Define this to use reduced MII inteface
1263
1264 CONFIG_DRIVER_AT91EMAC_QUIET
1265 If this defined, the driver is quiet.
1266 The driver doen't show link status messages.
1267
Rob Herringc9830dc2011-12-15 11:15:49 +00001268 CONFIG_CALXEDA_XGMAC
1269 Support for the Calxeda XGMAC device
1270
Ashok93fb8722012-10-15 06:20:47 +00001271 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001272 Support for SMSC's LAN91C96 chips.
1273
1274 CONFIG_LAN91C96_BASE
1275 Define this to hold the physical address
1276 of the LAN91C96's I/O space
1277
1278 CONFIG_LAN91C96_USE_32_BIT
1279 Define this to enable 32 bit addressing
1280
Ashok93fb8722012-10-15 06:20:47 +00001281 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001282 Support for SMSC's LAN91C111 chip
1283
1284 CONFIG_SMC91111_BASE
1285 Define this to hold the physical address
1286 of the device (I/O space)
1287
1288 CONFIG_SMC_USE_32_BIT
1289 Define this if data bus is 32 bits
1290
1291 CONFIG_SMC_USE_IOFUNCS
1292 Define this to use i/o functions instead of macros
1293 (some hardware wont work with macros)
1294
Heiko Schocher7d037f72011-11-15 10:00:04 -05001295 CONFIG_DRIVER_TI_EMAC
1296 Support for davinci emac
1297
1298 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1299 Define this if you have more then 3 PHYs.
1300
Macpaul Lin199c6252010-12-21 16:59:46 +08001301 CONFIG_FTGMAC100
1302 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1303
1304 CONFIG_FTGMAC100_EGIGA
1305 Define this to use GE link update with gigabit PHY.
1306 Define this if FTGMAC100 is connected to gigabit PHY.
1307 If your system has 10/100 PHY only, it might not occur
1308 wrong behavior. Because PHY usually return timeout or
1309 useless data when polling gigabit status and gigabit
1310 control registers. This behavior won't affect the
1311 correctnessof 10/100 link speed update.
1312
Mike Rapoportf4761af2009-11-11 10:03:03 +02001313 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001314 Support for SMSC's LAN911x and LAN921x chips
1315
Mike Rapoportf4761af2009-11-11 10:03:03 +02001316 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001317 Define this to hold the physical address
1318 of the device (I/O space)
1319
Mike Rapoportf4761af2009-11-11 10:03:03 +02001320 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001321 Define this if data bus is 32 bits
1322
Mike Rapoportf4761af2009-11-11 10:03:03 +02001323 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001324 Define this if data bus is 16 bits. If your processor
1325 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001326 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001327
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001328 CONFIG_SH_ETHER
1329 Support for Renesas on-chip Ethernet controller
1330
1331 CONFIG_SH_ETHER_USE_PORT
1332 Define the number of ports to be used
1333
1334 CONFIG_SH_ETHER_PHY_ADDR
1335 Define the ETH PHY's address
1336
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001337 CONFIG_SH_ETHER_CACHE_WRITEBACK
1338 If this option is set, the driver enables cache flush.
1339
Vadim Bendeburydac69642011-10-17 08:36:14 +00001340- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001341 CONFIG_TPM
1342 Support TPM devices.
1343
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001344 CONFIG_TPM_TIS_I2C
1345 Support for i2c bus TPM devices. Only one device
1346 per system is supported at this time.
1347
1348 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1349 Define the the i2c bus number for the TPM device
1350
1351 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1352 Define the TPM's address on the i2c bus
1353
1354 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1355 Define the burst count bytes upper limit
1356
Dirk Eibach20489092013-06-26 15:55:15 +02001357 CONFIG_TPM_ATMEL_TWI
1358 Support for Atmel TWI TPM device. Requires I2C support.
1359
Che-liang Chiouacea5702013-04-12 11:04:34 +00001360 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001361 Support for generic parallel port TPM devices. Only one device
1362 per system is supported at this time.
1363
1364 CONFIG_TPM_TIS_BASE_ADDRESS
1365 Base address where the generic TPM device is mapped
1366 to. Contemporary x86 systems usually map it at
1367 0xfed40000.
1368
Reinhard Pfau4fece432013-06-26 15:55:13 +02001369 CONFIG_CMD_TPM
1370 Add tpm monitor functions.
1371 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1372 provides monitor access to authorized functions.
1373
1374 CONFIG_TPM
1375 Define this to enable the TPM support library which provides
1376 functional interfaces to some TPM commands.
1377 Requires support for a TPM device.
1378
1379 CONFIG_TPM_AUTH_SESSIONS
1380 Define this to enable authorized functions in the TPM library.
1381 Requires CONFIG_TPM and CONFIG_SHA1.
1382
wdenkc6097192002-11-03 00:24:07 +00001383- USB Support:
1384 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001385 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001386 CONFIG_USB_UHCI to enable it.
1387 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001388 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001389 storage devices.
1390 Note:
1391 Supported are USB Keyboards and USB Floppy drives
1392 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001393 MPC5200 USB requires additional defines:
1394 CONFIG_USB_CLOCK
1395 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001396 CONFIG_PSC3_USB
1397 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001398 CONFIG_USB_CONFIG
1399 for differential drivers: 0x00001000
1400 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001401 for differential drivers on PSC3: 0x00000100
1402 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001403 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001404 May be defined to allow interrupt polling
1405 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001406
Simon Glass5978cdb2012-02-27 10:52:47 +00001407 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1408 txfilltuning field in the EHCI controller on reset.
1409
Kuo-Jung Su4e5923f2013-05-15 15:29:22 +08001410 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1411 interval for usb hub power-on delay.(minimum 100msec)
1412
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001413- USB Device:
1414 Define the below if you wish to use the USB console.
1415 Once firmware is rebuilt from a serial console issue the
1416 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001417 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001418 it has found a new device. The environment variable usbtty
1419 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001420 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001421 Common Device Class Abstract Control Model serial device.
1422 If you select usbtty = gserial you should be able to enumerate
1423 a Linux host by
1424 # modprobe usbserial vendor=0xVendorID product=0xProductID
1425 else if using cdc_acm, simply setting the environment
1426 variable usbtty to be cdc_acm should suffice. The following
1427 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001428
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001429 CONFIG_USB_DEVICE
1430 Define this to build a UDC device
1431
1432 CONFIG_USB_TTY
1433 Define this to have a tty type of device available to
1434 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001435
Vipin KUMARbdb17702012-03-26 15:38:06 +05301436 CONFIG_USBD_HS
1437 Define this to enable the high speed support for usb
1438 device and usbtty. If this feature is enabled, a routine
1439 int is_usbd_high_speed(void)
1440 also needs to be defined by the driver to dynamically poll
1441 whether the enumeration has succeded at high speed or full
1442 speed.
1443
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001444 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001445 Define this if you want stdin, stdout &/or stderr to
1446 be set to usbtty.
1447
1448 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001449 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001450 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001451 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001453 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001454 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001455 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001456
Wolfgang Denke2601822006-06-14 18:14:56 +02001457 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001458 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001459 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001460 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1461 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1462 should pretend to be a Linux device to it's target host.
1463
1464 CONFIG_USBD_MANUFACTURER
1465 Define this string as the name of your company for
1466 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001467
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001468 CONFIG_USBD_PRODUCT_NAME
1469 Define this string as the name of your product
1470 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001471
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001472 CONFIG_USBD_VENDORID
1473 Define this as your assigned Vendor ID from the USB
1474 Implementors Forum. This *must* be a genuine Vendor ID
1475 to avoid polluting the USB namespace.
1476 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001477
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001478 CONFIG_USBD_PRODUCTID
1479 Define this as the unique Product ID
1480 for your device
1481 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001482
Przemyslaw Marczak06ef7cc2013-10-23 14:30:46 +02001483 Some USB device drivers may need to check USB cable attachment.
1484 In this case you can enable following config in BoardName.h:
1485 CONFIG_USB_CABLE_CHECK
1486 This enables function definition:
1487 - usb_cable_connected() in include/usb.h
1488 Implementation of this function is board-specific.
1489
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001490- ULPI Layer Support:
1491 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1492 the generic ULPI layer. The generic layer accesses the ULPI PHY
1493 via the platform viewport, so you need both the genric layer and
1494 the viewport enabled. Currently only Chipidea/ARC based
1495 viewport is supported.
1496 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1497 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001498 If your ULPI phy needs a different reference clock than the
1499 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1500 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001501
wdenk7a428cc2003-06-15 22:40:42 +00001502- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001503 The MMC controller on the Intel PXA is supported. To
1504 enable this define CONFIG_MMC. The MMC can be
1505 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001506 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001507 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1508 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001509
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001510 CONFIG_SH_MMCIF
1511 Support for Renesas on-chip MMCIF controller
1512
1513 CONFIG_SH_MMCIF_ADDR
1514 Define the base address of MMCIF registers
1515
1516 CONFIG_SH_MMCIF_CLK
1517 Define the clock frequency for MMCIF
1518
Tom Rini58a8d322013-03-14 05:32:47 +00001519- USB Device Firmware Update (DFU) class support:
1520 CONFIG_DFU_FUNCTION
1521 This enables the USB portion of the DFU USB class
1522
1523 CONFIG_CMD_DFU
1524 This enables the command "dfu" which is used to have
1525 U-Boot create a DFU class device via USB. This command
1526 requires that the "dfu_alt_info" environment variable be
1527 set and define the alt settings to expose to the host.
1528
1529 CONFIG_DFU_MMC
1530 This enables support for exposing (e)MMC devices via DFU.
1531
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001532 CONFIG_DFU_NAND
1533 This enables support for exposing NAND devices via DFU.
1534
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301535 CONFIG_DFU_RAM
1536 This enables support for exposing RAM via DFU.
1537 Note: DFU spec refer to non-volatile memory usage, but
1538 allow usages beyond the scope of spec - here RAM usage,
1539 one that would help mostly the developer.
1540
Heiko Schochera2f831e2013-06-12 06:05:51 +02001541 CONFIG_SYS_DFU_DATA_BUF_SIZE
1542 Dfu transfer uses a buffer before writing data to the
1543 raw storage device. Make the size (in bytes) of this buffer
1544 configurable. The size of this buffer is also configurable
1545 through the "dfu_bufsiz" environment variable.
1546
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001547 CONFIG_SYS_DFU_MAX_FILE_SIZE
1548 When updating files rather than the raw storage device,
1549 we use a static buffer to copy the file into and then write
1550 the buffer once we've been given the whole file. Define
1551 this to the maximum filesize (in bytes) for the buffer.
1552 Default is 4 MiB if undefined.
1553
Heiko Schochere1ba1512014-03-18 08:09:56 +01001554 DFU_DEFAULT_POLL_TIMEOUT
1555 Poll timeout [ms], is the timeout a device can send to the
1556 host. The host must wait for this timeout before sending
1557 a subsequent DFU_GET_STATUS request to the device.
1558
1559 DFU_MANIFEST_POLL_TIMEOUT
1560 Poll timeout [ms], which the device sends to the host when
1561 entering dfuMANIFEST state. Host waits this timeout, before
1562 sending again an USB request to the device.
1563
wdenkda04a8b2004-08-02 23:22:59 +00001564- Journaling Flash filesystem support:
1565 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1566 CONFIG_JFFS2_NAND_DEV
1567 Define these for a default partition on a NAND device
1568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001569 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1570 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001571 Define these for a default partition on a NOR device
1572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001573 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001574 Define this to create an own partition. You have to provide a
1575 function struct part_info* jffs2_part_info(int part_num)
1576
1577 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001578 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001579 to disable the command chpart. This is the default when you
1580 have not defined a custom partition
1581
Donggeun Kim8f814002011-10-24 21:15:28 +00001582- FAT(File Allocation Table) filesystem write function support:
1583 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001584
1585 Define this to enable support for saving memory data as a
1586 file in FAT formatted partition.
1587
1588 This will also enable the command "fatwrite" enabling the
1589 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001590
Gabe Black7f8574c2012-10-12 14:26:11 +00001591CBFS (Coreboot Filesystem) support
1592 CONFIG_CMD_CBFS
1593
1594 Define this to enable support for reading from a Coreboot
1595 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1596 and cbfsload.
1597
wdenkc6097192002-11-03 00:24:07 +00001598- Keyboard Support:
1599 CONFIG_ISA_KEYBOARD
1600
1601 Define this to enable standard (PC-Style) keyboard
1602 support
1603
1604 CONFIG_I8042_KBD
1605 Standard PC keyboard driver with US (is default) and
1606 GERMAN key layout (switch via environment 'keymap=de') support.
1607 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1608 for cfb_console. Supports cursor blinking.
1609
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001610 CONFIG_CROS_EC_KEYB
1611 Enables a Chrome OS keyboard using the CROS_EC interface.
1612 This uses CROS_EC to communicate with a second microcontroller
1613 which provides key scans on request.
1614
wdenkc6097192002-11-03 00:24:07 +00001615- Video support:
1616 CONFIG_VIDEO
1617
1618 Define this to enable video support (for output to
1619 video).
1620
1621 CONFIG_VIDEO_CT69000
1622
1623 Enable Chips & Technologies 69000 Video chip
1624
1625 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001626 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001627 video output is selected via environment 'videoout'
1628 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1629 assumed.
wdenkc6097192002-11-03 00:24:07 +00001630
wdenkd3602132004-03-25 15:14:43 +00001631 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001632 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001633 are possible:
1634 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001635 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001636
1637 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1638 -------------+---------------------------------------------
1639 8 bits | 0x301* 0x303 0x305 0x161 0x307
1640 15 bits | 0x310 0x313 0x316 0x162 0x319
1641 16 bits | 0x311 0x314 0x317 0x163 0x31A
1642 24 bits | 0x312 0x315 0x318 ? 0x31B
1643 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001644 (i.e. setenv videomode 317; saveenv; reset;)
1645
wdenkd3602132004-03-25 15:14:43 +00001646 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001647 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001648
1649
stroeseb9c17c52003-04-04 15:53:41 +00001650 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001651 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001652 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1653 or CONFIG_VIDEO_SED13806_16BPP
1654
Timur Tabi020edd22011-02-15 17:09:19 -06001655 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001656 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001657 SOCs that have a DIU should define this macro to enable DIU
1658 support, and should also define these other macros:
1659
1660 CONFIG_SYS_DIU_ADDR
1661 CONFIG_VIDEO
1662 CONFIG_CMD_BMP
1663 CONFIG_CFB_CONSOLE
1664 CONFIG_VIDEO_SW_CURSOR
1665 CONFIG_VGA_AS_SINGLE_DEVICE
1666 CONFIG_VIDEO_LOGO
1667 CONFIG_VIDEO_BMP_LOGO
1668
Timur Tabi32f709e2011-04-11 14:18:22 -05001669 The DIU driver will look for the 'video-mode' environment
1670 variable, and if defined, enable the DIU as a console during
1671 boot. See the documentation file README.video for a
1672 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001673
Simon Glass54df8ce2012-12-03 13:59:47 +00001674 CONFIG_VIDEO_VGA
1675
1676 Enable the VGA video / BIOS for x86. The alternative if you
1677 are using coreboot is to use the coreboot frame buffer
1678 driver.
1679
1680
wdenk4e112c12003-06-03 23:54:09 +00001681- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001682 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001683
wdenk57b2d802003-06-27 21:31:46 +00001684 Define this to enable a custom keyboard support.
1685 This simply calls drv_keyboard_init() which must be
1686 defined in your board-specific files.
1687 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001688
wdenkc6097192002-11-03 00:24:07 +00001689- LCD Support: CONFIG_LCD
1690
1691 Define this to enable LCD support (for output to LCD
1692 display); also select one of the supported displays
1693 by defining one of these:
1694
Stelian Popf6f86652008-05-09 21:57:18 +02001695 CONFIG_ATMEL_LCD:
1696
1697 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1698
wdenkc0d54ae2003-11-25 16:55:19 +00001699 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001700
wdenkc0d54ae2003-11-25 16:55:19 +00001701 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001702
wdenkc0d54ae2003-11-25 16:55:19 +00001703 CONFIG_NEC_NL6448BC20
1704
1705 NEC NL6448BC20-08. 6.5", 640x480.
1706 Active, color, single scan.
1707
1708 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001709
wdenkc0d54ae2003-11-25 16:55:19 +00001710 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001711 Active, color, single scan.
1712
1713 CONFIG_SHARP_16x9
1714
1715 Sharp 320x240. Active, color, single scan.
1716 It isn't 16x9, and I am not sure what it is.
1717
1718 CONFIG_SHARP_LQ64D341
1719
1720 Sharp LQ64D341 display, 640x480.
1721 Active, color, single scan.
1722
1723 CONFIG_HLD1045
1724
1725 HLD1045 display, 640x480.
1726 Active, color, single scan.
1727
1728 CONFIG_OPTREX_BW
1729
1730 Optrex CBL50840-2 NF-FW 99 22 M5
1731 or
1732 Hitachi LMG6912RPFC-00T
1733 or
1734 Hitachi SP14Q002
1735
1736 320x240. Black & white.
1737
1738 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001739 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001740
Simon Glass599a4df2012-10-17 13:24:54 +00001741 CONFIG_LCD_ALIGNMENT
1742
1743 Normally the LCD is page-aligned (tyically 4KB). If this is
1744 defined then the LCD will be aligned to this value instead.
1745 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1746 here, since it is cheaper to change data cache settings on
1747 a per-section basis.
1748
Simon Glassaf3e2802012-10-17 13:24:59 +00001749 CONFIG_CONSOLE_SCROLL_LINES
1750
1751 When the console need to be scrolled, this is the number of
1752 lines to scroll by. It defaults to 1. Increasing this makes
1753 the console jump but can help speed up operation when scrolling
1754 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001755
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001756 CONFIG_LCD_BMP_RLE8
1757
1758 Support drawing of RLE8-compressed bitmaps on the LCD.
1759
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001760 CONFIG_I2C_EDID
1761
1762 Enables an 'i2c edid' command which can read EDID
1763 information over I2C from an attached LCD display.
1764
wdenkeb20ad32003-09-05 23:19:14 +00001765- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001766
wdenk57b2d802003-06-27 21:31:46 +00001767 If this option is set, the environment is checked for
1768 a variable "splashimage". If found, the usual display
1769 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001770 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001771 specified in "splashimage" is loaded instead. The
1772 console is redirected to the "nulldev", too. This
1773 allows for a "silent" boot where a splash screen is
1774 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001775
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001776 CONFIG_SPLASHIMAGE_GUARD
1777
1778 If this option is set, then U-Boot will prevent the environment
1779 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001780 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001781 This option is useful for targets where, due to alignment
1782 restrictions, an improperly aligned BMP image will cause a data
1783 abort. If you think you will not have problems with unaligned
1784 accesses (for example because your toolchain prevents them)
1785 there is no need to set this option.
1786
Matthias Weisser53884182009-07-09 16:07:30 +02001787 CONFIG_SPLASH_SCREEN_ALIGN
1788
1789 If this option is set the splash image can be freely positioned
1790 on the screen. Environment variable "splashpos" specifies the
1791 position as "x,y". If a positive number is given it is used as
1792 number of pixel from left/top. If a negative number is given it
1793 is used as number of pixel from right/bottom. You can also
1794 specify 'm' for centering the image.
1795
1796 Example:
1797 setenv splashpos m,m
1798 => image at center of screen
1799
1800 setenv splashpos 30,20
1801 => image at x = 30 and y = 20
1802
1803 setenv splashpos -10,m
1804 => vertically centered image
1805 at x = dspWidth - bmpWidth - 9
1806
Stefan Roesed9d97742005-09-22 09:04:17 +02001807- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1808
1809 If this option is set, additionally to standard BMP
1810 images, gzipped BMP images can be displayed via the
1811 splashscreen support or the bmp command.
1812
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001813- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1814
1815 If this option is set, 8-bit RLE compressed BMP images
1816 can be displayed via the splashscreen support or the
1817 bmp command.
1818
Lei Wene4e248d2012-09-28 04:26:47 +00001819- Do compresssing for memory range:
1820 CONFIG_CMD_ZIP
1821
1822 If this option is set, it would use zlib deflate method
1823 to compress the specified memory at its best effort.
1824
wdenk710e3502003-08-29 20:57:53 +00001825- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001826 CONFIG_GZIP
1827
1828 Enabled by default to support gzip compressed images.
1829
wdenk710e3502003-08-29 20:57:53 +00001830 CONFIG_BZIP2
1831
1832 If this option is set, support for bzip2 compressed
1833 images is included. If not, only uncompressed and gzip
1834 compressed images are supported.
1835
wdenk9c53f402003-10-15 23:53:47 +00001836 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001837 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001838 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001839
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001840 CONFIG_LZMA
1841
1842 If this option is set, support for lzma compressed
1843 images is included.
1844
1845 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1846 requires an amount of dynamic memory that is given by the
1847 formula:
1848
1849 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1850
1851 Where lc and lp stand for, respectively, Literal context bits
1852 and Literal pos bits.
1853
1854 This value is upper-bounded by 14MB in the worst case. Anyway,
1855 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1856 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1857 a very small buffer.
1858
1859 Use the lzmainfo tool to determinate the lc and lp values and
1860 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001861 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001862
Kees Cook5b06e642013-08-16 07:59:12 -07001863 CONFIG_LZO
1864
1865 If this option is set, support for LZO compressed images
1866 is included.
1867
wdenk0e2bd9c2004-06-06 21:51:03 +00001868- MII/PHY support:
1869 CONFIG_PHY_ADDR
1870
1871 The address of PHY on MII bus.
1872
1873 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1874
1875 The clock frequency of the MII bus
1876
1877 CONFIG_PHY_GIGE
1878
1879 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001880 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001881
1882 CONFIG_PHY_RESET_DELAY
1883
1884 Some PHY like Intel LXT971A need extra delay after
1885 reset before any MII register access is possible.
1886 For such PHY, set this option to the usec delay
1887 required. (minimum 300usec for LXT971A)
1888
1889 CONFIG_PHY_CMD_DELAY (ppc4xx)
1890
1891 Some PHY like Intel LXT971A need extra delay after
1892 command issued before MII status register can be read
1893
wdenkc6097192002-11-03 00:24:07 +00001894- Ethernet address:
1895 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001896 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001897 CONFIG_ETH2ADDR
1898 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001899 CONFIG_ETH4ADDR
1900 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001901
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001902 Define a default value for Ethernet address to use
1903 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001904 is not determined automatically.
1905
1906- IP address:
1907 CONFIG_IPADDR
1908
1909 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001910 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001911 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001912 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001913
1914- Server IP address:
1915 CONFIG_SERVERIP
1916
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001917 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001918 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001919 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001920
Robin Getz470a6d42009-07-21 12:15:28 -04001921 CONFIG_KEEP_SERVERADDR
1922
1923 Keeps the server's MAC address, in the env 'serveraddr'
1924 for passing to bootargs (like Linux's netconsole option)
1925
Wolfgang Denk26da2992011-10-26 10:21:22 +00001926- Gateway IP address:
1927 CONFIG_GATEWAYIP
1928
1929 Defines a default value for the IP address of the
1930 default router where packets to other networks are
1931 sent to.
1932 (Environment variable "gatewayip")
1933
1934- Subnet mask:
1935 CONFIG_NETMASK
1936
1937 Defines a default value for the subnet mask (or
1938 routing prefix) which is used to determine if an IP
1939 address belongs to the local subnet or needs to be
1940 forwarded through a router.
1941 (Environment variable "netmask")
1942
David Updegraff7280da72007-06-11 10:41:07 -05001943- Multicast TFTP Mode:
1944 CONFIG_MCAST_TFTP
1945
1946 Defines whether you want to support multicast TFTP as per
1947 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001948 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001949 driver in use must provide a function: mcast() to join/leave a
1950 multicast group.
1951
wdenkc6097192002-11-03 00:24:07 +00001952- BOOTP Recovery Mode:
1953 CONFIG_BOOTP_RANDOM_DELAY
1954
1955 If you have many targets in a network that try to
1956 boot using BOOTP, you may want to avoid that all
1957 systems send out BOOTP requests at precisely the same
1958 moment (which would happen for instance at recovery
1959 from a power failure, when all systems will try to
1960 boot, thus flooding the BOOTP server. Defining
1961 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1962 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001963 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001964
1965 1st BOOTP request: delay 0 ... 1 sec
1966 2nd BOOTP request: delay 0 ... 2 sec
1967 3rd BOOTP request: delay 0 ... 4 sec
1968 4th and following
1969 BOOTP requests: delay 0 ... 8 sec
1970
stroesee0aadfb2003-08-28 14:17:32 +00001971- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001972 You can fine tune the DHCP functionality by defining
1973 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001974
Jon Loeliger5336a762007-07-09 22:08:34 -05001975 CONFIG_BOOTP_SUBNETMASK
1976 CONFIG_BOOTP_GATEWAY
1977 CONFIG_BOOTP_HOSTNAME
1978 CONFIG_BOOTP_NISDOMAIN
1979 CONFIG_BOOTP_BOOTPATH
1980 CONFIG_BOOTP_BOOTFILESIZE
1981 CONFIG_BOOTP_DNS
1982 CONFIG_BOOTP_DNS2
1983 CONFIG_BOOTP_SEND_HOSTNAME
1984 CONFIG_BOOTP_NTPSERVER
1985 CONFIG_BOOTP_TIMEOFFSET
1986 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001987 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001988
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001989 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1990 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001991
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001992 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1993 after the configured retry count, the call will fail
1994 instead of starting over. This can be used to fail over
1995 to Link-local IP address configuration if the DHCP server
1996 is not available.
1997
stroesee0aadfb2003-08-28 14:17:32 +00001998 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1999 serverip from a DHCP server, it is possible that more
2000 than one DNS serverip is offered to the client.
2001 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2002 serverip will be stored in the additional environment
2003 variable "dnsip2". The first DNS serverip is always
2004 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002005 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002006
2007 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2008 to do a dynamic update of a DNS server. To do this, they
2009 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002010 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002011 of the "hostname" environment variable is passed as
2012 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002013
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002014 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2015
2016 A 32bit value in microseconds for a delay between
2017 receiving a "DHCP Offer" and sending the "DHCP Request".
2018 This fixes a problem with certain DHCP servers that don't
2019 respond 100% of the time to a "DHCP request". E.g. On an
2020 AT91RM9200 processor running at 180MHz, this delay needed
2021 to be *at least* 15,000 usec before a Windows Server 2003
2022 DHCP server would reply 100% of the time. I recommend at
2023 least 50,000 usec to be safe. The alternative is to hope
2024 that one of the retries will be successful but note that
2025 the DHCP timeout and retry process takes a longer than
2026 this delay.
2027
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002028 - Link-local IP address negotiation:
2029 Negotiate with other link-local clients on the local network
2030 for an address that doesn't require explicit configuration.
2031 This is especially useful if a DHCP server cannot be guaranteed
2032 to exist in all environments that the device must operate.
2033
2034 See doc/README.link-local for more information.
2035
wdenk145d2c12004-04-15 21:48:45 +00002036 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002037 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002038
2039 The device id used in CDP trigger frames.
2040
2041 CONFIG_CDP_DEVICE_ID_PREFIX
2042
2043 A two character string which is prefixed to the MAC address
2044 of the device.
2045
2046 CONFIG_CDP_PORT_ID
2047
2048 A printf format string which contains the ascii name of
2049 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002050 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002051
2052 CONFIG_CDP_CAPABILITIES
2053
2054 A 32bit integer which indicates the device capabilities;
2055 0x00000010 for a normal host which does not forwards.
2056
2057 CONFIG_CDP_VERSION
2058
2059 An ascii string containing the version of the software.
2060
2061 CONFIG_CDP_PLATFORM
2062
2063 An ascii string containing the name of the platform.
2064
2065 CONFIG_CDP_TRIGGER
2066
2067 A 32bit integer sent on the trigger.
2068
2069 CONFIG_CDP_POWER_CONSUMPTION
2070
2071 A 16bit integer containing the power consumption of the
2072 device in .1 of milliwatts.
2073
2074 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2075
2076 A byte containing the id of the VLAN.
2077
wdenkc6097192002-11-03 00:24:07 +00002078- Status LED: CONFIG_STATUS_LED
2079
2080 Several configurations allow to display the current
2081 status using a LED. For instance, the LED will blink
2082 fast while running U-Boot code, stop blinking as
2083 soon as a reply to a BOOTP request was received, and
2084 start blinking slow once the Linux kernel is running
2085 (supported by a status LED driver in the Linux
2086 kernel). Defining CONFIG_STATUS_LED enables this
2087 feature in U-Boot.
2088
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002089 Additional options:
2090
2091 CONFIG_GPIO_LED
2092 The status LED can be connected to a GPIO pin.
2093 In such cases, the gpio_led driver can be used as a
2094 status LED backend implementation. Define CONFIG_GPIO_LED
2095 to include the gpio_led driver in the U-Boot binary.
2096
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002097 CONFIG_GPIO_LED_INVERTED_TABLE
2098 Some GPIO connected LEDs may have inverted polarity in which
2099 case the GPIO high value corresponds to LED off state and
2100 GPIO low value corresponds to LED on state.
2101 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2102 with a list of GPIO LEDs that have inverted polarity.
2103
wdenkc6097192002-11-03 00:24:07 +00002104- CAN Support: CONFIG_CAN_DRIVER
2105
2106 Defining CONFIG_CAN_DRIVER enables CAN driver support
2107 on those systems that support this (optional)
2108 feature, like the TQM8xxL modules.
2109
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002110- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002111
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002112 This enable the NEW i2c subsystem, and will allow you to use
2113 i2c commands at the u-boot command line (as long as you set
2114 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2115 based realtime clock chips or other i2c devices. See
2116 common/cmd_i2c.c for a description of the command line
2117 interface.
2118
2119 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002120 - drivers/i2c/soft_i2c.c:
2121 - activate first bus with CONFIG_SYS_I2C_SOFT define
2122 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2123 for defining speed and slave address
2124 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2125 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2126 for defining speed and slave address
2127 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2128 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2129 for defining speed and slave address
2130 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2131 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2132 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002133
Heiko Schocherf2850742012-10-24 13:48:22 +02002134 - drivers/i2c/fsl_i2c.c:
2135 - activate i2c driver with CONFIG_SYS_I2C_FSL
2136 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2137 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2138 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2139 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002140 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002141 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2142 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2143 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2144 second bus.
2145
Simon Glass026fefb2012-10-30 07:28:53 +00002146 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002147 - activate this driver with CONFIG_SYS_I2C_TEGRA
2148 - This driver adds 4 i2c buses with a fix speed from
2149 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002150
Dirk Eibach42b204f2013-04-25 02:40:01 +00002151 - drivers/i2c/ppc4xx_i2c.c
2152 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2153 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2154 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2155
trema49f40a2013-09-21 18:13:35 +02002156 - drivers/i2c/i2c_mxc.c
2157 - activate this driver with CONFIG_SYS_I2C_MXC
2158 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2159 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2160 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2161 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2162 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2163 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2164 If thoses defines are not set, default value is 100000
2165 for speed, and 0 for slave.
2166
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002167 - drivers/i2c/rcar_i2c.c:
2168 - activate this driver with CONFIG_SYS_I2C_RCAR
2169 - This driver adds 4 i2c buses
2170
2171 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2172 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2173 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2174 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2175 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2176 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2177 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2178 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2179 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2180
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002181 - drivers/i2c/sh_i2c.c:
2182 - activate this driver with CONFIG_SYS_I2C_SH
2183 - This driver adds from 2 to 5 i2c buses
2184
2185 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2186 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2187 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2188 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2189 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2190 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2191 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2192 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2193 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2194 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2195 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2196 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2197 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2198
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002199 - drivers/i2c/omap24xx_i2c.c
2200 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2201 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2202 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2203 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2204 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2205 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2206 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2207 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2208 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2209 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2210 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2211
Heiko Schocher465819a2013-11-08 07:30:53 +01002212 - drivers/i2c/zynq_i2c.c
2213 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2214 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2215 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2216
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302217 - drivers/i2c/s3c24x0_i2c.c:
2218 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2219 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2220 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2221 with a fix speed from 100000 and the slave addr 0!
2222
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002223 additional defines:
2224
2225 CONFIG_SYS_NUM_I2C_BUSES
2226 Hold the number of i2c busses you want to use. If you
2227 don't use/have i2c muxes on your i2c bus, this
2228 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2229 omit this define.
2230
2231 CONFIG_SYS_I2C_DIRECT_BUS
2232 define this, if you don't use i2c muxes on your hardware.
2233 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2234 omit this define.
2235
2236 CONFIG_SYS_I2C_MAX_HOPS
2237 define how many muxes are maximal consecutively connected
2238 on one i2c bus. If you not use i2c muxes, omit this
2239 define.
2240
2241 CONFIG_SYS_I2C_BUSES
2242 hold a list of busses you want to use, only used if
2243 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2244 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2245 CONFIG_SYS_NUM_I2C_BUSES = 9:
2246
2247 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2248 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2249 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2250 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2251 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2252 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2253 {1, {I2C_NULL_HOP}}, \
2254 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2255 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2256 }
2257
2258 which defines
2259 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002260 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2261 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2262 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2263 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2264 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002265 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002266 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2267 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002268
2269 If you do not have i2c muxes on your board, omit this define.
2270
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002271- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002272
2273 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2274 provides the following compelling advantages:
2275
2276 - more than one i2c adapter is usable
2277 - approved multibus support
2278 - better i2c mux support
2279
2280 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002281
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002282 These enable legacy I2C serial bus commands. Defining
2283 CONFIG_HARD_I2C will include the appropriate I2C driver
2284 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002285
wdenk21136db2003-07-16 21:53:01 +00002286 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002287 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002288 CONFIG_COMMANDS) and communicate with i2c based realtime
2289 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002290 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002291
Ben Warren45657152006-09-07 16:50:54 -04002292 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002293
wdenk21136db2003-07-16 21:53:01 +00002294 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002295 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002297 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002298 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002299 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002300 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002301
Peter Tysere4d1abc2010-04-12 22:28:21 -05002302 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002303 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002304 and so its address should therefore be cleared to 0 (See,
2305 eg, MPC823e User's Manual p.16-473). So, set
2306 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002307
Eric Millbrandt12990a42009-09-03 08:09:44 -05002308 CONFIG_SYS_I2C_INIT_MPC5XXX
2309
2310 When a board is reset during an i2c bus transfer
2311 chips might think that the current transfer is still
2312 in progress. Reset the slave devices by sending start
2313 commands until the slave device responds.
2314
wdenk21136db2003-07-16 21:53:01 +00002315 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002316
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002317 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002318 then the following macros need to be defined (examples are
2319 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002320
2321 I2C_INIT
2322
wdenkb9bbd242003-06-30 16:24:52 +00002323 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002324 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002325
wdenk544e9732004-02-06 23:19:44 +00002326 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002327
wdenkc6097192002-11-03 00:24:07 +00002328 I2C_PORT
2329
wdenk4a5c8a72003-03-06 00:02:04 +00002330 (Only for MPC8260 CPU). The I/O port to use (the code
2331 assumes both bits are on the same port). Valid values
2332 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002333
2334 I2C_ACTIVE
2335
2336 The code necessary to make the I2C data line active
2337 (driven). If the data line is open collector, this
2338 define can be null.
2339
wdenkb9bbd242003-06-30 16:24:52 +00002340 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2341
wdenkc6097192002-11-03 00:24:07 +00002342 I2C_TRISTATE
2343
2344 The code necessary to make the I2C data line tri-stated
2345 (inactive). If the data line is open collector, this
2346 define can be null.
2347
wdenkb9bbd242003-06-30 16:24:52 +00002348 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2349
wdenkc6097192002-11-03 00:24:07 +00002350 I2C_READ
2351
York Sun4a598092013-04-01 11:29:11 -07002352 Code that returns true if the I2C data line is high,
2353 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002354
wdenkb9bbd242003-06-30 16:24:52 +00002355 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2356
wdenkc6097192002-11-03 00:24:07 +00002357 I2C_SDA(bit)
2358
York Sun4a598092013-04-01 11:29:11 -07002359 If <bit> is true, sets the I2C data line high. If it
2360 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002361
wdenkb9bbd242003-06-30 16:24:52 +00002362 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002363 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002364 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002365
wdenkc6097192002-11-03 00:24:07 +00002366 I2C_SCL(bit)
2367
York Sun4a598092013-04-01 11:29:11 -07002368 If <bit> is true, sets the I2C clock line high. If it
2369 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002370
wdenkb9bbd242003-06-30 16:24:52 +00002371 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002372 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002373 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002374
wdenkc6097192002-11-03 00:24:07 +00002375 I2C_DELAY
2376
2377 This delay is invoked four times per clock cycle so this
2378 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002379 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002380 like:
2381
wdenkb9bbd242003-06-30 16:24:52 +00002382 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002383
Mike Frysingeree12d542010-07-21 13:38:02 -04002384 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2385
2386 If your arch supports the generic GPIO framework (asm/gpio.h),
2387 then you may alternatively define the two GPIOs that are to be
2388 used as SCL / SDA. Any of the previous I2C_xxx macros will
2389 have GPIO-based defaults assigned to them as appropriate.
2390
2391 You should define these to the GPIO value as given directly to
2392 the generic GPIO functions.
2393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002394 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002395
wdenk57b2d802003-06-27 21:31:46 +00002396 When a board is reset during an i2c bus transfer
2397 chips might think that the current transfer is still
2398 in progress. On some boards it is possible to access
2399 the i2c SCLK line directly, either by using the
2400 processor pin as a GPIO or by having a second pin
2401 connected to the bus. If this option is defined a
2402 custom i2c_init_board() routine in boards/xxx/board.c
2403 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002404
Richard Retanubundf0149c2010-04-12 15:08:17 -04002405 CONFIG_SYS_I2C_BOARD_LATE_INIT
2406
2407 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2408 defined a custom i2c_board_late_init() routine in
2409 boards/xxx/board.c is run AFTER the operations in i2c_init()
2410 is completed. This callpoint can be used to unreset i2c bus
2411 using CPU i2c controller register accesses for CPUs whose i2c
2412 controller provide such a method. It is called at the end of
2413 i2c_init() to allow i2c_init operations to setup the i2c bus
2414 controller on the CPU (e.g. setting bus speed & slave address).
2415
wdenk0e2bd9c2004-06-06 21:51:03 +00002416 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2417
2418 This option enables configuration of bi_iic_fast[] flags
2419 in u-boot bd_info structure based on u-boot environment
2420 variable "i2cfast". (see also i2cfast)
2421
Ben Warren45657152006-09-07 16:50:54 -04002422 CONFIG_I2C_MULTI_BUS
2423
2424 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002425 must have a controller. At any point in time, only one bus is
2426 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002427 Note that bus numbering is zero-based.
2428
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002429 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002430
2431 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002432 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002433 is set, specify a list of bus-device pairs. Otherwise, specify
2434 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002435
2436 e.g.
2437 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002438 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002439
2440 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2441
Wolfgang Denk092ae952011-10-26 10:21:21 +00002442 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002443 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002444
2445 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002447 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002448
2449 If defined, then this indicates the I2C bus number for DDR SPD.
2450 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2451
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002452 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002453
2454 If defined, then this indicates the I2C bus number for the RTC.
2455 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002457 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002458
2459 If defined, then this indicates the I2C bus number for the DTT.
2460 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002462 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002463
2464 If defined, specifies the I2C address of the DTT device.
2465 If not defined, then U-Boot uses predefined value for
2466 specified DTT device.
2467
Andrew Dyer58c41f92008-12-29 17:36:01 -06002468 CONFIG_SOFT_I2C_READ_REPEATED_START
2469
2470 defining this will force the i2c_read() function in
2471 the soft_i2c driver to perform an I2C repeated start
2472 between writing the address pointer and reading the
2473 data. If this define is omitted the default behaviour
2474 of doing a stop-start sequence will be used. Most I2C
2475 devices can use either method, but some require one or
2476 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002477
wdenkc6097192002-11-03 00:24:07 +00002478- SPI Support: CONFIG_SPI
2479
2480 Enables SPI driver (so far only tested with
2481 SPI EEPROM, also an instance works with Crystal A/D and
2482 D/As on the SACSng board)
2483
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002484 CONFIG_SH_SPI
2485
2486 Enables the driver for SPI controller on SuperH. Currently
2487 only SH7757 is supported.
2488
wdenkc6097192002-11-03 00:24:07 +00002489 CONFIG_SPI_X
2490
2491 Enables extended (16-bit) SPI EEPROM addressing.
2492 (symmetrical to CONFIG_I2C_X)
2493
2494 CONFIG_SOFT_SPI
2495
wdenk4a5c8a72003-03-06 00:02:04 +00002496 Enables a software (bit-bang) SPI driver rather than
2497 using hardware support. This is a general purpose
2498 driver that only requires three general I/O port pins
2499 (two outputs, one input) to function. If this is
2500 defined, the board configuration must define several
2501 SPI configuration items (port pins to use, etc). For
2502 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002503
Ben Warren7efe9272008-01-16 22:37:35 -05002504 CONFIG_HARD_SPI
2505
2506 Enables a hardware SPI driver for general-purpose reads
2507 and writes. As with CONFIG_SOFT_SPI, the board configuration
2508 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002509 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002510 example, see include/configs/mpc8349emds.h.
2511
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002512 CONFIG_MXC_SPI
2513
2514 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002515 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002516
Matthias Fuchsa4400872007-12-27 17:12:34 +01002517- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002518
Matthias Fuchsa4400872007-12-27 17:12:34 +01002519 Enables FPGA subsystem.
2520
2521 CONFIG_FPGA_<vendor>
2522
2523 Enables support for specific chip vendors.
2524 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002525
Matthias Fuchsa4400872007-12-27 17:12:34 +01002526 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002527
Matthias Fuchsa4400872007-12-27 17:12:34 +01002528 Enables support for FPGA family.
2529 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2530
2531 CONFIG_FPGA_COUNT
2532
2533 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk57b2d802003-06-27 21:31:46 +00002537 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002539 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002540
wdenk4a5c8a72003-03-06 00:02:04 +00002541 Enable checks on FPGA configuration interface busy
2542 status by the configuration function. This option
2543 will require a board or device specific function to
2544 be written.
wdenkc6097192002-11-03 00:24:07 +00002545
2546 CONFIG_FPGA_DELAY
2547
2548 If defined, a function that provides delays in the FPGA
2549 configuration driver.
2550
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002551 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002552 Allow Control-C to interrupt FPGA configuration
2553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002554 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002555
wdenk4a5c8a72003-03-06 00:02:04 +00002556 Check for configuration errors during FPGA bitfile
2557 loading. For example, abort during Virtex II
2558 configuration if the INIT_B line goes low (which
2559 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002561 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002562
wdenk4a5c8a72003-03-06 00:02:04 +00002563 Maximum time to wait for the INIT_B line to deassert
2564 after PROB_B has been deasserted during a Virtex II
2565 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002566 ms.
wdenkc6097192002-11-03 00:24:07 +00002567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002568 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002569
wdenk4a5c8a72003-03-06 00:02:04 +00002570 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002571 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002573 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002574
wdenk4a5c8a72003-03-06 00:02:04 +00002575 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002576 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002577
2578- Configuration Management:
2579 CONFIG_IDENT_STRING
2580
wdenk4a5c8a72003-03-06 00:02:04 +00002581 If defined, this string will be added to the U-Boot
2582 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002583
2584- Vendor Parameter Protection:
2585
wdenk4a5c8a72003-03-06 00:02:04 +00002586 U-Boot considers the values of the environment
2587 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002588 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002589 are set once by the board vendor / manufacturer, and
2590 protects these variables from casual modification by
2591 the user. Once set, these variables are read-only,
2592 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002593 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002594
2595 If CONFIG_ENV_OVERWRITE is #defined in your config
2596 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002597 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002598 these parameters.
2599
2600 Alternatively, if you #define _both_ CONFIG_ETHADDR
2601 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002602 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002603 which can be changed exactly ONCE by the user. [The
2604 serial# is unaffected by this, i. e. it remains
2605 read-only.]
2606
Joe Hershberger71497d02012-12-11 22:16:31 -06002607 The same can be accomplished in a more flexible way
2608 for any variable by configuring the type of access
2609 to allow for those variables in the ".flags" variable
2610 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2611
wdenkc6097192002-11-03 00:24:07 +00002612- Protected RAM:
2613 CONFIG_PRAM
2614
2615 Define this variable to enable the reservation of
2616 "protected RAM", i. e. RAM which is not overwritten
2617 by U-Boot. Define CONFIG_PRAM to hold the number of
2618 kB you want to reserve for pRAM. You can overwrite
2619 this default value by defining an environment
2620 variable "pram" to the number of kB you want to
2621 reserve. Note that the board info structure will
2622 still show the full amount of RAM. If pRAM is
2623 reserved, a new environment variable "mem" will
2624 automatically be defined to hold the amount of
2625 remaining RAM in a form that can be passed as boot
2626 argument to Linux, for instance like that:
2627
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002628 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002629 saveenv
2630
2631 This way you can tell Linux not to use this memory,
2632 either, which results in a memory region that will
2633 not be affected by reboots.
2634
2635 *WARNING* If your board configuration uses automatic
2636 detection of the RAM size, you must make sure that
2637 this memory test is non-destructive. So far, the
2638 following board configurations are known to be
2639 "pRAM-clean":
2640
Wolfgang Denk90326762012-10-24 02:36:15 +00002641 IVMS8, IVML24, SPD8xx, TQM8xxL,
2642 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002643 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002644
Gabe Blacka2f3a932012-12-02 04:55:18 +00002645- Access to physical memory region (> 4GB)
2646 Some basic support is provided for operations on memory not
2647 normally accessible to U-Boot - e.g. some architectures
2648 support access to more than 4GB of memory on 32-bit
2649 machines using physical address extension or similar.
2650 Define CONFIG_PHYSMEM to access this basic support, which
2651 currently only supports clearing the memory.
2652
wdenkc6097192002-11-03 00:24:07 +00002653- Error Recovery:
2654 CONFIG_PANIC_HANG
2655
2656 Define this variable to stop the system in case of a
2657 fatal error, so that you have to reset it manually.
2658 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002659 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002660 automatically as fast as possible, but it may be
2661 useful during development since you can try to debug
2662 the conditions that lead to the situation.
2663
2664 CONFIG_NET_RETRY_COUNT
2665
wdenk4a5c8a72003-03-06 00:02:04 +00002666 This variable defines the number of retries for
2667 network operations like ARP, RARP, TFTP, or BOOTP
2668 before giving up the operation. If not defined, a
2669 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002670
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002671 CONFIG_ARP_TIMEOUT
2672
2673 Timeout waiting for an ARP reply in milliseconds.
2674
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002675 CONFIG_NFS_TIMEOUT
2676
2677 Timeout in milliseconds used in NFS protocol.
2678 If you encounter "ERROR: Cannot umount" in nfs command,
2679 try longer timeout such as
2680 #define CONFIG_NFS_TIMEOUT 10000UL
2681
wdenkc6097192002-11-03 00:24:07 +00002682- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002683 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002684
2685 Enable auto completion of commands using TAB.
2686
Wolfgang Denk018147d2006-11-27 15:32:42 +01002687 Note that this feature has NOT been implemented yet
2688 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002689
2690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002691 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002692
2693 Define this variable to enable the "hush" shell (from
2694 Busybox) as command line interpreter, thus enabling
2695 powerful command line syntax like
2696 if...then...else...fi conditionals or `&&' and '||'
2697 constructs ("shell scripts").
2698
2699 If undefined, you get the old, much simpler behaviour
2700 with a somewhat smaller memory footprint.
2701
2702
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002703 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002704
2705 This defines the secondary prompt string, which is
2706 printed when the command interpreter needs more input
2707 to complete a command. Usually "> ".
2708
2709 Note:
2710
wdenk57b2d802003-06-27 21:31:46 +00002711 In the current implementation, the local variables
2712 space and global environment variables space are
2713 separated. Local variables are those you define by
2714 simply typing `name=value'. To access a local
2715 variable later on, you have write `$name' or
2716 `${name}'; to execute the contents of a variable
2717 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002718
wdenk4a5c8a72003-03-06 00:02:04 +00002719 Global environment variables are those you use
2720 setenv/printenv to work with. To run a command stored
2721 in such a variable, you need to use the run command,
2722 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002723
2724 To store commands and special characters in a
2725 variable, please use double quotation marks
2726 surrounding the whole text of the variable, instead
2727 of the backslashes before semicolons and special
2728 symbols.
2729
Wolfgang Denk2039a072006-07-21 11:35:21 +02002730- Commandline Editing and History:
2731 CONFIG_CMDLINE_EDITING
2732
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002733 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002734 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002735
wdenkc0aa5c52003-12-06 19:49:23 +00002736- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002737 CONFIG_EXTRA_ENV_SETTINGS
2738
wdenk4a5c8a72003-03-06 00:02:04 +00002739 Define this to contain any number of null terminated
2740 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002741 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002742
wdenk4a5c8a72003-03-06 00:02:04 +00002743 For example, place something like this in your
2744 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002745
2746 #define CONFIG_EXTRA_ENV_SETTINGS \
2747 "myvar1=value1\0" \
2748 "myvar2=value2\0"
2749
wdenk4a5c8a72003-03-06 00:02:04 +00002750 Warning: This method is based on knowledge about the
2751 internal format how the environment is stored by the
2752 U-Boot code. This is NOT an official, exported
2753 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002754 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002755 You better know what you are doing here.
2756
wdenk4a5c8a72003-03-06 00:02:04 +00002757 Note: overly (ab)use of the default environment is
2758 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002759 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002760 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002761
Stephen Warren1465d5f2012-05-22 09:21:54 +00002762 CONFIG_ENV_VARS_UBOOT_CONFIG
2763
2764 Define this in order to add variables describing the
2765 U-Boot build configuration to the default environment.
2766 These will be named arch, cpu, board, vendor, and soc.
2767
2768 Enabling this option will cause the following to be defined:
2769
2770 - CONFIG_SYS_ARCH
2771 - CONFIG_SYS_CPU
2772 - CONFIG_SYS_BOARD
2773 - CONFIG_SYS_VENDOR
2774 - CONFIG_SYS_SOC
2775
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002776 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2777
2778 Define this in order to add variables describing certain
2779 run-time determined information about the hardware to the
2780 environment. These will be named board_name, board_rev.
2781
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002782 CONFIG_DELAY_ENVIRONMENT
2783
2784 Normally the environment is loaded when the board is
2785 intialised so that it is available to U-Boot. This inhibits
2786 that so that the environment is not available until
2787 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2788 this is instead controlled by the value of
2789 /config/load-environment.
2790
wdenkc0aa5c52003-12-06 19:49:23 +00002791- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002792 CONFIG_HAS_DATAFLASH
2793
wdenk57b2d802003-06-27 21:31:46 +00002794 Defining this option enables DataFlash features and
2795 allows to read/write in Dataflash via the standard
2796 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002797
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002798- Serial Flash support
2799 CONFIG_CMD_SF
2800
2801 Defining this option enables SPI flash commands
2802 'sf probe/read/write/erase/update'.
2803
2804 Usage requires an initial 'probe' to define the serial
2805 flash parameters, followed by read/write/erase/update
2806 commands.
2807
2808 The following defaults may be provided by the platform
2809 to handle the common case when only a single serial
2810 flash is present on the system.
2811
2812 CONFIG_SF_DEFAULT_BUS Bus identifier
2813 CONFIG_SF_DEFAULT_CS Chip-select
2814 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2815 CONFIG_SF_DEFAULT_SPEED in Hz
2816
Simon Glass4b5545e2012-10-08 13:16:02 +00002817 CONFIG_CMD_SF_TEST
2818
2819 Define this option to include a destructive SPI flash
2820 test ('sf test').
2821
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302822 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2823
2824 Define this option to use the Bank addr/Extended addr
2825 support on SPI flashes which has size > 16Mbytes.
2826
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302827 CONFIG_SF_DUAL_FLASH Dual flash memories
2828
2829 Define this option to use dual flash support where two flash
2830 memories can be connected with a given cs line.
2831 currently Xilinx Zynq qspi support these type of connections.
2832
wdenkef893942004-02-23 16:11:30 +00002833- SystemACE Support:
2834 CONFIG_SYSTEMACE
2835
2836 Adding this option adds support for Xilinx SystemACE
2837 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002838 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002839 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002840
2841 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002842 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002843
2844 When SystemACE support is added, the "ace" device type
2845 becomes available to the fat commands, i.e. fatls.
2846
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002847- TFTP Fixed UDP Port:
2848 CONFIG_TFTP_PORT
2849
Wolfgang Denk227b5192005-09-24 23:25:46 +02002850 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002851 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002852 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002853 number generator is used.
2854
Wolfgang Denk227b5192005-09-24 23:25:46 +02002855 Also, the environment variable tftpdstp is used to supply
2856 the TFTP UDP destination port value. If tftpdstp isn't
2857 defined, the normal port 69 is used.
2858
2859 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002860 blindly start the TFTP transfer using the pre-configured
2861 target IP address and UDP port. This has the effect of
2862 "punching through" the (Windows XP) firewall, allowing
2863 the remainder of the TFTP transfer to proceed normally.
2864 A better solution is to properly configure the firewall,
2865 but sometimes that is not allowed.
2866
Simon Glass058bb8d2012-12-05 14:46:38 +00002867- Hashing support:
2868 CONFIG_CMD_HASH
2869
2870 This enables a generic 'hash' command which can produce
2871 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2872
2873 CONFIG_HASH_VERIFY
2874
2875 Enable the hash verify command (hash -v). This adds to code
2876 size a little.
2877
2878 CONFIG_SHA1 - support SHA1 hashing
2879 CONFIG_SHA256 - support SHA256 hashing
2880
2881 Note: There is also a sha1sum command, which should perhaps
2882 be deprecated in favour of 'hash sha1'.
2883
Robert Winkler765ccf42013-07-24 17:57:06 -07002884- Freescale i.MX specific commands:
2885 CONFIG_CMD_HDMIDETECT
2886 This enables 'hdmidet' command which returns true if an
2887 HDMI monitor is detected. This command is i.MX 6 specific.
2888
2889 CONFIG_CMD_BMODE
2890 This enables the 'bmode' (bootmode) command for forcing
2891 a boot from specific media.
2892
2893 This is useful for forcing the ROM's usb downloader to
2894 activate upon a watchdog reset which is nice when iterating
2895 on U-Boot. Using the reset button or running bmode normal
2896 will set it back to normal. This command currently
2897 supports i.MX53 and i.MX6.
2898
Simon Glass35191a32013-06-13 15:10:02 -07002899- Signing support:
2900 CONFIG_RSA
2901
2902 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01002903 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07002904
2905 The signing part is build into mkimage regardless of this
2906 option.
2907
Heiko Schocher443ca402014-01-25 07:27:13 +01002908- bootcount support:
2909 CONFIG_BOOTCOUNT_LIMIT
2910
2911 This enables the bootcounter support, see:
2912 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2913
2914 CONFIG_AT91SAM9XE
2915 enable special bootcounter support on at91sam9xe based boards.
2916 CONFIG_BLACKFIN
2917 enable special bootcounter support on blackfin based boards.
2918 CONFIG_SOC_DA8XX
2919 enable special bootcounter support on da850 based boards.
2920 CONFIG_BOOTCOUNT_RAM
2921 enable support for the bootcounter in RAM
2922 CONFIG_BOOTCOUNT_I2C
2923 enable support for the bootcounter on an i2c (like RTC) device.
2924 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2925 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2926 the bootcounter.
2927 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002928
wdenkc0aa5c52003-12-06 19:49:23 +00002929- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002930 CONFIG_SHOW_BOOT_PROGRESS
2931
wdenk4a5c8a72003-03-06 00:02:04 +00002932 Defining this option allows to add some board-
2933 specific code (calling a user-provided function
2934 "show_boot_progress(int)") that enables you to show
2935 the system's boot progress on some display (for
2936 example, some LED's) on your board. At the moment,
2937 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002938
Simon Glass31a870e2012-02-13 13:51:19 +00002939- Detailed boot stage timing
2940 CONFIG_BOOTSTAGE
2941 Define this option to get detailed timing of each stage
2942 of the boot process.
2943
2944 CONFIG_BOOTSTAGE_USER_COUNT
2945 This is the number of available user bootstage records.
2946 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2947 a new ID will be allocated from this stash. If you exceed
2948 the limit, recording will stop.
2949
2950 CONFIG_BOOTSTAGE_REPORT
2951 Define this to print a report before boot, similar to this:
2952
2953 Timer summary in microseconds:
2954 Mark Elapsed Stage
2955 0 0 reset
2956 3,575,678 3,575,678 board_init_f start
2957 3,575,695 17 arch_cpu_init A9
2958 3,575,777 82 arch_cpu_init done
2959 3,659,598 83,821 board_init_r start
2960 3,910,375 250,777 main_loop
2961 29,916,167 26,005,792 bootm_start
2962 30,361,327 445,160 start_kernel
2963
Simon Glass4afd88e2012-09-28 08:56:39 +00002964 CONFIG_CMD_BOOTSTAGE
2965 Add a 'bootstage' command which supports printing a report
2966 and un/stashing of bootstage data.
2967
Simon Glass0fa36a42012-09-28 08:56:37 +00002968 CONFIG_BOOTSTAGE_FDT
2969 Stash the bootstage information in the FDT. A root 'bootstage'
2970 node is created with each bootstage id as a child. Each child
2971 has a 'name' property and either 'mark' containing the
2972 mark time in microsecond, or 'accum' containing the
2973 accumulated time for that bootstage id in microseconds.
2974 For example:
2975
2976 bootstage {
2977 154 {
2978 name = "board_init_f";
2979 mark = <3575678>;
2980 };
2981 170 {
2982 name = "lcd";
2983 accum = <33482>;
2984 };
2985 };
2986
2987 Code in the Linux kernel can find this in /proc/devicetree.
2988
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002989Legacy uImage format:
2990
wdenkc6097192002-11-03 00:24:07 +00002991 Arg Where When
2992 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002993 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002994 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002995 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002996 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002997 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002998 4 common/cmd_bootm.c Image data has correct checksum
2999 -4 common/cmd_bootm.c Image is for unsupported architecture
3000 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003001 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003002 6 common/cmd_bootm.c Image Type check OK
3003 -6 common/cmd_bootm.c gunzip uncompression error
3004 -7 common/cmd_bootm.c Unimplemented compression type
3005 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003006 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003007 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003008
3009 9 common/image.c Start initial ramdisk verification
3010 -10 common/image.c Ramdisk header has bad magic number
3011 -11 common/image.c Ramdisk header has bad checksum
3012 10 common/image.c Ramdisk header is OK
3013 -12 common/image.c Ramdisk data has bad checksum
3014 11 common/image.c Ramdisk data has correct checksum
3015 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003016 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003017 13 common/image.c Start multifile image verification
3018 14 common/image.c No initial ramdisk, no multifile, continue.
3019
Wolfgang Denk092ae952011-10-26 10:21:21 +00003020 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003021
Stefan Roese88fbf932010-04-15 16:07:28 +02003022 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003023 -31 post/post.c POST test failed, detected by post_output_backlog()
3024 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003025
Heiko Schocher633e03a2007-06-22 19:11:54 +02003026 34 common/cmd_doc.c before loading a Image from a DOC device
3027 -35 common/cmd_doc.c Bad usage of "doc" command
3028 35 common/cmd_doc.c correct usage of "doc" command
3029 -36 common/cmd_doc.c No boot device
3030 36 common/cmd_doc.c correct boot device
3031 -37 common/cmd_doc.c Unknown Chip ID on boot device
3032 37 common/cmd_doc.c correct chip ID found, device available
3033 -38 common/cmd_doc.c Read Error on boot device
3034 38 common/cmd_doc.c reading Image header from DOC device OK
3035 -39 common/cmd_doc.c Image header has bad magic number
3036 39 common/cmd_doc.c Image header has correct magic number
3037 -40 common/cmd_doc.c Error reading Image from DOC device
3038 40 common/cmd_doc.c Image header has correct magic number
3039 41 common/cmd_ide.c before loading a Image from a IDE device
3040 -42 common/cmd_ide.c Bad usage of "ide" command
3041 42 common/cmd_ide.c correct usage of "ide" command
3042 -43 common/cmd_ide.c No boot device
3043 43 common/cmd_ide.c boot device found
3044 -44 common/cmd_ide.c Device not available
3045 44 common/cmd_ide.c Device available
3046 -45 common/cmd_ide.c wrong partition selected
3047 45 common/cmd_ide.c partition selected
3048 -46 common/cmd_ide.c Unknown partition table
3049 46 common/cmd_ide.c valid partition table found
3050 -47 common/cmd_ide.c Invalid partition type
3051 47 common/cmd_ide.c correct partition type
3052 -48 common/cmd_ide.c Error reading Image Header on boot device
3053 48 common/cmd_ide.c reading Image Header from IDE device OK
3054 -49 common/cmd_ide.c Image header has bad magic number
3055 49 common/cmd_ide.c Image header has correct magic number
3056 -50 common/cmd_ide.c Image header has bad checksum
3057 50 common/cmd_ide.c Image header has correct checksum
3058 -51 common/cmd_ide.c Error reading Image from IDE device
3059 51 common/cmd_ide.c reading Image from IDE device OK
3060 52 common/cmd_nand.c before loading a Image from a NAND device
3061 -53 common/cmd_nand.c Bad usage of "nand" command
3062 53 common/cmd_nand.c correct usage of "nand" command
3063 -54 common/cmd_nand.c No boot device
3064 54 common/cmd_nand.c boot device found
3065 -55 common/cmd_nand.c Unknown Chip ID on boot device
3066 55 common/cmd_nand.c correct chip ID found, device available
3067 -56 common/cmd_nand.c Error reading Image Header on boot device
3068 56 common/cmd_nand.c reading Image Header from NAND device OK
3069 -57 common/cmd_nand.c Image header has bad magic number
3070 57 common/cmd_nand.c Image header has correct magic number
3071 -58 common/cmd_nand.c Error reading Image from NAND device
3072 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003073
Heiko Schocher633e03a2007-06-22 19:11:54 +02003074 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003075
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003076 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003077 -64 net/eth.c no Ethernet found.
3078 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003079
Heiko Schocher633e03a2007-06-22 19:11:54 +02003080 -80 common/cmd_net.c usage wrong
3081 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003082 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02003083 81 common/cmd_net.c NetLoop() back without error
3084 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3085 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003086 83 common/cmd_net.c running "source" command
3087 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003088 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003089
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003090FIT uImage format:
3091
3092 Arg Where When
3093 100 common/cmd_bootm.c Kernel FIT Image has correct format
3094 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3095 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3096 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3097 102 common/cmd_bootm.c Kernel unit name specified
3098 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003099 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003100 104 common/cmd_bootm.c Got kernel subimage node offset
3101 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3102 105 common/cmd_bootm.c Kernel subimage hash verification OK
3103 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3104 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003105 -106 common/cmd_bootm.c Kernel subimage has wrong type
3106 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003107 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3108 108 common/cmd_bootm.c Got kernel subimage data/size
3109 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3110 -109 common/cmd_bootm.c Can't get kernel subimage type
3111 -110 common/cmd_bootm.c Can't get kernel subimage comp
3112 -111 common/cmd_bootm.c Can't get kernel subimage os
3113 -112 common/cmd_bootm.c Can't get kernel subimage load address
3114 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3115
3116 120 common/image.c Start initial ramdisk verification
3117 -120 common/image.c Ramdisk FIT image has incorrect format
3118 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003119 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003120 -122 common/image.c Can't get configuration for ramdisk subimage
3121 123 common/image.c Ramdisk unit name specified
3122 -124 common/image.c Can't get ramdisk subimage node offset
3123 125 common/image.c Got ramdisk subimage node offset
3124 -125 common/image.c Ramdisk subimage hash verification failed
3125 126 common/image.c Ramdisk subimage hash verification OK
3126 -126 common/image.c Ramdisk subimage for unsupported architecture
3127 127 common/image.c Architecture check OK
3128 -127 common/image.c Can't get ramdisk subimage data/size
3129 128 common/image.c Got ramdisk subimage data/size
3130 129 common/image.c Can't get ramdisk load address
3131 -129 common/image.c Got ramdisk load address
3132
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003133 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003134 131 common/cmd_doc.c FIT image format OK
3135
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003136 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003137 141 common/cmd_ide.c FIT image format OK
3138
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003139 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003140 151 common/cmd_nand.c FIT image format OK
3141
Gabe Blackd572e162012-10-25 16:31:10 +00003142- FIT image support:
3143 CONFIG_FIT
3144 Enable support for the FIT uImage format.
3145
3146 CONFIG_FIT_BEST_MATCH
3147 When no configuration is explicitly selected, default to the
3148 one whose fdt's compatibility field best matches that of
3149 U-Boot itself. A match is considered "best" if it matches the
3150 most specific compatibility entry of U-Boot's fdt's root node.
3151 The order of entries in the configuration's fdt is ignored.
3152
Simon Glass58fe7e52013-06-13 15:10:00 -07003153 CONFIG_FIT_SIGNATURE
3154 This option enables signature verification of FIT uImages,
3155 using a hash signed and verified using RSA. See
3156 doc/uImage.FIT/signature.txt for more details.
3157
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003158- Standalone program support:
3159 CONFIG_STANDALONE_LOAD_ADDR
3160
Wolfgang Denk23f78482011-10-09 21:06:34 +02003161 This option defines a board specific value for the
3162 address where standalone program gets loaded, thus
3163 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003164 settings.
3165
3166- Frame Buffer Address:
3167 CONFIG_FB_ADDR
3168
3169 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003170 address for frame buffer. This is typically the case
3171 when using a graphics controller has separate video
3172 memory. U-Boot will then place the frame buffer at
3173 the given address instead of dynamically reserving it
3174 in system RAM by calling lcd_setmem(), which grabs
3175 the memory for the frame buffer depending on the
3176 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003177
3178 Please see board_init_f function.
3179
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003180- Automatic software updates via TFTP server
3181 CONFIG_UPDATE_TFTP
3182 CONFIG_UPDATE_TFTP_CNT_MAX
3183 CONFIG_UPDATE_TFTP_MSEC_MAX
3184
3185 These options enable and control the auto-update feature;
3186 for a more detailed description refer to doc/README.update.
3187
3188- MTD Support (mtdparts command, UBI support)
3189 CONFIG_MTD_DEVICE
3190
3191 Adds the MTD device infrastructure from the Linux kernel.
3192 Needed for mtdparts command support.
3193
3194 CONFIG_MTD_PARTITIONS
3195
3196 Adds the MTD partitioning infrastructure from the Linux
3197 kernel. Needed for UBI support.
3198
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003199- UBI support
3200 CONFIG_CMD_UBI
3201
3202 Adds commands for interacting with MTD partitions formatted
3203 with the UBI flash translation layer
3204
3205 Requires also defining CONFIG_RBTREE
3206
Joe Hershberger47550fc2013-04-08 10:32:49 +00003207 CONFIG_UBI_SILENCE_MSG
3208
3209 Make the verbose messages from UBI stop printing. This leaves
3210 warnings and errors enabled.
3211
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003212- UBIFS support
3213 CONFIG_CMD_UBIFS
3214
3215 Adds commands for interacting with UBI volumes formatted as
3216 UBIFS. UBIFS is read-only in u-boot.
3217
3218 Requires UBI support as well as CONFIG_LZO
3219
Joe Hershberger47550fc2013-04-08 10:32:49 +00003220 CONFIG_UBIFS_SILENCE_MSG
3221
3222 Make the verbose messages from UBIFS stop printing. This leaves
3223 warnings and errors enabled.
3224
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003225- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003226 CONFIG_SPL
3227 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003228
Tom Rini36853852012-02-14 07:29:40 +00003229 CONFIG_SPL_LDSCRIPT
3230 LDSCRIPT for linking the SPL binary.
3231
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003232 CONFIG_SPL_MAX_FOOTPRINT
3233 Maximum size in memory allocated to the SPL, BSS included.
3234 When defined, the linker checks that the actual memory
3235 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003236 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003237 must not be both defined at the same time.
3238
Tom Rini36853852012-02-14 07:29:40 +00003239 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003240 Maximum size of the SPL image (text, data, rodata, and
3241 linker lists sections), BSS excluded.
3242 When defined, the linker checks that the actual size does
3243 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003244
Wolfgang Denk825223d2011-09-11 21:24:09 +02003245 CONFIG_SPL_TEXT_BASE
3246 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003247
Scott Woodc4f0d002012-09-20 19:05:12 -05003248 CONFIG_SPL_RELOC_TEXT_BASE
3249 Address to relocate to. If unspecified, this is equal to
3250 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3251
Tom Rini36853852012-02-14 07:29:40 +00003252 CONFIG_SPL_BSS_START_ADDR
3253 Link address for the BSS within the SPL binary.
3254
3255 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003256 Maximum size in memory allocated to the SPL BSS.
3257 When defined, the linker checks that the actual memory used
3258 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003259 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003260 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003261
3262 CONFIG_SPL_STACK
3263 Adress of the start of the stack SPL will use
3264
Scott Woodc4f0d002012-09-20 19:05:12 -05003265 CONFIG_SPL_RELOC_STACK
3266 Adress of the start of the stack SPL will use after
3267 relocation. If unspecified, this is equal to
3268 CONFIG_SPL_STACK.
3269
Tom Rini36853852012-02-14 07:29:40 +00003270 CONFIG_SYS_SPL_MALLOC_START
3271 Starting address of the malloc pool used in SPL.
3272
3273 CONFIG_SYS_SPL_MALLOC_SIZE
3274 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003275
Tom Rini28591df2012-08-13 12:03:19 -07003276 CONFIG_SPL_FRAMEWORK
3277 Enable the SPL framework under common/. This framework
3278 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3279 NAND loading of the Linux Kernel.
3280
Tom Rinife3b0c72012-08-13 11:37:56 -07003281 CONFIG_SPL_DISPLAY_PRINT
3282 For ARM, enable an optional function to print more information
3283 about the running system.
3284
Scott Wood7c810902012-09-20 16:35:21 -05003285 CONFIG_SPL_INIT_MINIMAL
3286 Arch init code should be built for a very small image
3287
Wolfgang Denk825223d2011-09-11 21:24:09 +02003288 CONFIG_SPL_LIBCOMMON_SUPPORT
3289 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003290
Wolfgang Denk825223d2011-09-11 21:24:09 +02003291 CONFIG_SPL_LIBDISK_SUPPORT
3292 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003293
Wolfgang Denk825223d2011-09-11 21:24:09 +02003294 CONFIG_SPL_I2C_SUPPORT
3295 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003296
Wolfgang Denk825223d2011-09-11 21:24:09 +02003297 CONFIG_SPL_GPIO_SUPPORT
3298 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003299
Wolfgang Denk825223d2011-09-11 21:24:09 +02003300 CONFIG_SPL_MMC_SUPPORT
3301 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003302
Tom Rini36853852012-02-14 07:29:40 +00003303 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3304 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3305 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3306 Address, size and partition on the MMC to load U-Boot from
3307 when the MMC is being used in raw mode.
3308
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003309 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3310 Sector to load kernel uImage from when MMC is being
3311 used in raw mode (for Falcon mode)
3312
3313 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3314 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3315 Sector and number of sectors to load kernel argument
3316 parameters from when MMC is being used in raw mode
3317 (for falcon mode)
3318
Tom Rini36853852012-02-14 07:29:40 +00003319 CONFIG_SPL_FAT_SUPPORT
3320 Support for fs/fat/libfat.o in SPL binary
3321
3322 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3323 Filename to read to load U-Boot when reading from FAT
3324
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003325 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3326 Filename to read to load kernel uImage when reading
3327 from FAT (for Falcon mode)
3328
3329 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3330 Filename to read to load kernel argument parameters
3331 when reading from FAT (for Falcon mode)
3332
Scott Wood2b36fbb2012-12-06 13:33:17 +00003333 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3334 Set this for NAND SPL on PPC mpc83xx targets, so that
3335 start.S waits for the rest of the SPL to load before
3336 continuing (the hardware starts execution after just
3337 loading the first page rather than the full 4K).
3338
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303339 CONFIG_SPL_SKIP_RELOCATE
3340 Avoid SPL relocation
3341
Scott Woodc352a0c2012-09-20 19:09:07 -05003342 CONFIG_SPL_NAND_BASE
3343 Include nand_base.c in the SPL. Requires
3344 CONFIG_SPL_NAND_DRIVERS.
3345
3346 CONFIG_SPL_NAND_DRIVERS
3347 SPL uses normal NAND drivers, not minimal drivers.
3348
3349 CONFIG_SPL_NAND_ECC
3350 Include standard software ECC in the SPL
3351
Tom Rini36853852012-02-14 07:29:40 +00003352 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003353 Support for NAND boot using simple NAND drivers that
3354 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003355
Ying Zhang9ff70262013-08-16 15:16:11 +08003356 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3357 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003358 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003359
Ying Zhangdfb2b152013-08-16 15:16:12 +08003360 CONFIG_SPL_COMMON_INIT_DDR
3361 Set for common ddr init with serial presence detect in
3362 SPL binary.
3363
Tom Rini36853852012-02-14 07:29:40 +00003364 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3365 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3366 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3367 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3368 CONFIG_SYS_NAND_ECCBYTES
3369 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003370 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003371
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303372 CONFIG_SPL_NAND_BOOT
3373 Add support NAND boot
3374
Tom Rini36853852012-02-14 07:29:40 +00003375 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003376 Location in NAND to read U-Boot from
3377
3378 CONFIG_SYS_NAND_U_BOOT_DST
3379 Location in memory to load U-Boot to
3380
3381 CONFIG_SYS_NAND_U_BOOT_SIZE
3382 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003383
3384 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003385 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003386
3387 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3388 Define this if you need to first read the OOB and then the
3389 data. This is used for example on davinci plattforms.
3390
3391 CONFIG_SPL_OMAP3_ID_NAND
3392 Support for an OMAP3-specific set of functions to return the
3393 ID and MFR of the first attached NAND chip, if present.
3394
Wolfgang Denk825223d2011-09-11 21:24:09 +02003395 CONFIG_SPL_SERIAL_SUPPORT
3396 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003397
Wolfgang Denk825223d2011-09-11 21:24:09 +02003398 CONFIG_SPL_SPI_FLASH_SUPPORT
3399 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003400
Wolfgang Denk825223d2011-09-11 21:24:09 +02003401 CONFIG_SPL_SPI_SUPPORT
3402 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003403
Pavel Machekde997252012-08-30 22:42:11 +02003404 CONFIG_SPL_RAM_DEVICE
3405 Support for running image already present in ram, in SPL binary
3406
Wolfgang Denk825223d2011-09-11 21:24:09 +02003407 CONFIG_SPL_LIBGENERIC_SUPPORT
3408 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003409
Ying Zhang602f7d32013-05-20 14:07:25 +08003410 CONFIG_SPL_ENV_SUPPORT
3411 Support for the environment operating in SPL binary
3412
3413 CONFIG_SPL_NET_SUPPORT
3414 Support for the net/libnet.o in SPL binary.
3415 It conflicts with SPL env from storage medium specified by
3416 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3417
Scott Woodeb7bd972012-12-06 13:33:16 +00003418 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003419 Image offset to which the SPL should be padded before appending
3420 the SPL payload. By default, this is defined as
3421 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3422 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3423 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003424
Scott Woodf147eb72012-09-21 16:27:32 -05003425 CONFIG_SPL_TARGET
3426 Final target image containing SPL and payload. Some SPLs
3427 use an arch-specific makefile fragment instead, for
3428 example if more than one image needs to be produced.
3429
Simon Glass82d94532013-05-08 08:05:59 +00003430 CONFIG_FIT_SPL_PRINT
3431 Printing information about a FIT image adds quite a bit of
3432 code to SPL. So this is normally disabled in SPL. Use this
3433 option to re-enable it. This will affect the output of the
3434 bootm command when booting a FIT image.
3435
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003436- TPL framework
3437 CONFIG_TPL
3438 Enable building of TPL globally.
3439
3440 CONFIG_TPL_PAD_TO
3441 Image offset to which the TPL should be padded before appending
3442 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003443 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3444 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3445 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003446
wdenkc6097192002-11-03 00:24:07 +00003447Modem Support:
3448--------------
3449
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003450[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003451
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003452- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003453 CONFIG_MODEM_SUPPORT
3454
3455- RTS/CTS Flow control enable:
3456 CONFIG_HWFLOW
3457
3458- Modem debug support:
3459 CONFIG_MODEM_SUPPORT_DEBUG
3460
wdenk4a5c8a72003-03-06 00:02:04 +00003461 Enables debugging stuff (char screen[1024], dbg())
3462 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003463
wdenkc0aa5c52003-12-06 19:49:23 +00003464- Interrupt support (PPC):
3465
wdenk1ebf41e2004-01-02 14:00:00 +00003466 There are common interrupt_init() and timer_interrupt()
3467 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003468 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003469 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003470 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003471 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003472 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003473 specific handling. If board has watchdog / status_led
3474 / other_activity_monitor it works automatically from
3475 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003476
wdenkc6097192002-11-03 00:24:07 +00003477- General:
3478
wdenk4a5c8a72003-03-06 00:02:04 +00003479 In the target system modem support is enabled when a
3480 specific key (key combination) is pressed during
3481 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003482 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003483 board_init(). Currently key_pressed() is a dummy
3484 function, returning 1 and thus enabling modem
3485 initialization.
wdenkc6097192002-11-03 00:24:07 +00003486
wdenk4a5c8a72003-03-06 00:02:04 +00003487 If there are no modem init strings in the
3488 environment, U-Boot proceed to autoboot; the
3489 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003490 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003491
3492 See also: doc/README.Modem
3493
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003494Board initialization settings:
3495------------------------------
3496
3497During Initialization u-boot calls a number of board specific functions
3498to allow the preparation of board specific prerequisites, e.g. pin setup
3499before drivers are initialized. To enable these callbacks the
3500following configuration macros have to be defined. Currently this is
3501architecture specific, so please check arch/your_architecture/lib/board.c
3502typically in board_init_f() and board_init_r().
3503
3504- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3505- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3506- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3507- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003508
wdenkc6097192002-11-03 00:24:07 +00003509Configuration Settings:
3510-----------------------
3511
York Sun6c480012014-02-26 17:03:19 -08003512- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3513 Optionally it can be defined to support 64-bit memory commands.
3514
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003515- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003516 undefine this when you're short of memory.
3517
Peter Tyserdfb72b82009-01-27 18:03:12 -06003518- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3519 width of the commands listed in the 'help' command output.
3520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003521- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003522 prompt for user input.
3523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003524- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003525
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003526- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003528- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003529
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003530- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003531 the application (usually a Linux kernel) when it is
3532 booted
3533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003534- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003535 List of legal baudrate settings for this board.
3536
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003537- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003538 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003540- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003541 If the board specific function
3542 extern int overwrite_console (void);
3543 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003544 serial port, else the settings in the environment are used.
3545
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003546- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003547 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003549- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003550 Enable overwrite of previous console environment settings.
3551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003552- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003553 Begin and End addresses of the area used by the
3554 simple memory test.
3555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003556- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003557 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003559- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003560 Scratch address used by the alternate memory test
3561 You only need to set this if address zero isn't writeable
3562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3564 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003565 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003566 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003567 fixing up gd->ram_size the Linux kernel should gets passed
3568 the now "corrected" memory size and won't touch it either.
3569 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003570 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003571 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003572 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003573
3574 This option can be used as a workaround for the 440EPx/GRx
3575 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3576 be touched.
3577
3578 WARNING: Please make sure that this value is a multiple of
3579 the Linux page size (normally 4k). If this is not the case,
3580 then the end address of the Linux memory will be located at a
3581 non page size aligned address and this could cause major
3582 problems.
3583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003584- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003585 Enable temporary baudrate change while serial download
3586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003587- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003588 Physical start address of SDRAM. _Must_ be 0 here.
3589
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003590- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003591 Physical start address of Motherboard I/O (if using a
3592 Cogent motherboard)
3593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003594- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003595 Physical start address of Flash memory.
3596
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003597- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003598 Physical start address of boot monitor code (set by
3599 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003600 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003601 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003603- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003604 Size of memory reserved for monitor code, used to
3605 determine _at_compile_time_ (!) if the environment is
3606 embedded within the U-Boot image, or in a separate
3607 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003609- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003610 Size of DRAM reserved for malloc() use.
3611
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003612- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003613 Normally compressed uImages are limited to an
3614 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003615 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003616 to adjust this setting to your needs.
3617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003618- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003619 Maximum size of memory mapped by the startup code of
3620 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003621 the Linux kernel (bd_info, boot arguments, FDT blob if
3622 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003623 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003624 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003625 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003626 variable "bootm_mapsize" will override the value of
3627 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3628 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003629
John Rigbyeea8e692010-10-13 13:57:35 -06003630- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3631 Enable initrd_high functionality. If defined then the
3632 initrd_high feature is enabled and the bootm ramdisk subcommand
3633 is enabled.
3634
3635- CONFIG_SYS_BOOT_GET_CMDLINE:
3636 Enables allocating and saving kernel cmdline in space between
3637 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3638
3639- CONFIG_SYS_BOOT_GET_KBD:
3640 Enables allocating and saving a kernel copy of the bd_info in
3641 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003643- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003644 Max number of Flash memory banks
3645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003647 Max number of sectors on a Flash chip
3648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003649- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003650 Timeout for Flash erase operations (in ms)
3651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003653 Timeout for Flash write operations (in ms)
3654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003655- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003656 Timeout for Flash set sector lock bit operation (in ms)
3657
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003658- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003659 Timeout for Flash clear lock bits operation (in ms)
3660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003661- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003662 If defined, hardware flash sectors protection is used
3663 instead of U-Boot software protection.
3664
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003665- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003666
3667 Enable TFTP transfers directly to flash memory;
3668 without this option such a download has to be
3669 performed in two steps: (1) download to RAM, and (2)
3670 copy from RAM to flash.
3671
3672 The two-step approach is usually more reliable, since
3673 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003674 the flash, but in some situations (when system RAM is
3675 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003676 downloaded image) this option may be very useful.
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003679 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003680 common flash structure for storing flash geometry.
3681
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003682- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003683 This option also enables the building of the cfi_flash driver
3684 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003685
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003686- CONFIG_FLASH_CFI_MTD
3687 This option enables the building of the cfi_mtd driver
3688 in the drivers directory. The driver exports CFI flash
3689 to the MTD layer.
3690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003691- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003692 Use buffered writes to flash.
3693
3694- CONFIG_FLASH_SPANSION_S29WS_N
3695 s29ws-n MirrorBit flash has non-standard addresses for buffered
3696 write commands.
3697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003698- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003699 If this option is defined, the common CFI flash doesn't
3700 print it's warning upon not recognized FLASH banks. This
3701 is useful, if some of the configured banks are only
3702 optionally available.
3703
Jerry Van Barenaae73572008-03-08 13:48:01 -05003704- CONFIG_FLASH_SHOW_PROGRESS
3705 If defined (must be an integer), print out countdown
3706 digits and dots. Recommended value: 45 (9..1) for 80
3707 column displays, 15 (3..1) for 40 column displays.
3708
Stefan Roesed20cba52013-04-04 15:53:14 +02003709- CONFIG_FLASH_VERIFY
3710 If defined, the content of the flash (destination) is compared
3711 against the source after the write operation. An error message
3712 will be printed when the contents are not identical.
3713 Please note that this option is useless in nearly all cases,
3714 since such flash programming errors usually are detected earlier
3715 while unprotecting/erasing/programming. Please only enable
3716 this option if you really know what you are doing.
3717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003718- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003719 Defines the number of Ethernet receive buffers. On some
3720 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003721 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3722 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003723 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003724 Defaults to 4 if not defined.
3725
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003726- CONFIG_ENV_MAX_ENTRIES
3727
Wolfgang Denk1136f692010-10-27 22:48:30 +02003728 Maximum number of entries in the hash table that is used
3729 internally to store the environment settings. The default
3730 setting is supposed to be generous and should work in most
3731 cases. This setting can be used to tune behaviour; see
3732 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003733
Joe Hershberger71497d02012-12-11 22:16:31 -06003734- CONFIG_ENV_FLAGS_LIST_DEFAULT
3735- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003736 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003737 calling env set. Variables can be restricted to only decimal,
3738 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3739 the variables can also be restricted to IP address or MAC address.
3740
3741 The format of the list is:
3742 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003743 access_atribute = [a|r|o|c]
3744 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003745 entry = variable_name[:attributes]
3746 list = entry[,list]
3747
3748 The type attributes are:
3749 s - String (default)
3750 d - Decimal
3751 x - Hexadecimal
3752 b - Boolean ([1yYtT|0nNfF])
3753 i - IP address
3754 m - MAC address
3755
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003756 The access attributes are:
3757 a - Any (default)
3758 r - Read-only
3759 o - Write-once
3760 c - Change-default
3761
Joe Hershberger71497d02012-12-11 22:16:31 -06003762 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3763 Define this to a list (string) to define the ".flags"
3764 envirnoment variable in the default or embedded environment.
3765
3766 - CONFIG_ENV_FLAGS_LIST_STATIC
3767 Define this to a list (string) to define validation that
3768 should be done if an entry is not found in the ".flags"
3769 environment variable. To override a setting in the static
3770 list, simply add an entry for the same variable name to the
3771 ".flags" variable.
3772
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003773- CONFIG_ENV_ACCESS_IGNORE_FORCE
3774 If defined, don't allow the -f switch to env set override variable
3775 access flags.
3776
Simon Glass66828322013-03-08 13:45:27 +00003777- CONFIG_SYS_GENERIC_BOARD
3778 This selects the architecture-generic board system instead of the
3779 architecture-specific board files. It is intended to move boards
3780 to this new framework over time. Defining this will disable the
3781 arch/foo/lib/board.c file and use common/board_f.c and
3782 common/board_r.c instead. To use this option your architecture
3783 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3784 its config.mk file). If you find problems enabling this option on
3785 your board please report the problem and send patches!
3786
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003787- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3788 This is set by OMAP boards for the max time that reset should
3789 be asserted. See doc/README.omap-reset-time for details on how
3790 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003791
wdenkc6097192002-11-03 00:24:07 +00003792The following definitions that deal with the placement and management
3793of environment data (variable area); in general, we support the
3794following configurations:
3795
Mike Frysinger63b8f122011-07-08 10:44:25 +00003796- CONFIG_BUILD_ENVCRC:
3797
3798 Builds up envcrc with the target environment so that external utils
3799 may easily extract it and embed it in final U-Boot images.
3800
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003801- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003802
3803 Define this if the environment is in flash memory.
3804
3805 a) The environment occupies one whole flash sector, which is
3806 "embedded" in the text segment with the U-Boot code. This
3807 happens usually with "bottom boot sector" or "top boot
3808 sector" type flash chips, which have several smaller
3809 sectors at the start or the end. For instance, such a
3810 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3811 such a case you would place the environment in one of the
3812 4 kB sectors - with U-Boot code before and after it. With
3813 "top boot sector" type flash chips, you would put the
3814 environment in one of the last sectors, leaving a gap
3815 between U-Boot and the environment.
3816
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003817 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003818
3819 Offset of environment data (variable area) to the
3820 beginning of flash memory; for instance, with bottom boot
3821 type flash chips the second sector can be used: the offset
3822 for this sector is given here.
3823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003824 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003825
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003826 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003827
3828 This is just another way to specify the start address of
3829 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003830 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003831
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003832 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003833
3834 Size of the sector containing the environment.
3835
3836
3837 b) Sometimes flash chips have few, equal sized, BIG sectors.
3838 In such a case you don't want to spend a whole sector for
3839 the environment.
3840
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003841 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003842
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003843 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003844 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003845 of this flash sector for the environment. This saves
3846 memory for the RAM copy of the environment.
3847
3848 It may also save flash memory if you decide to use this
3849 when your environment is "embedded" within U-Boot code,
3850 since then the remainder of the flash sector could be used
3851 for U-Boot code. It should be pointed out that this is
3852 STRONGLY DISCOURAGED from a robustness point of view:
3853 updating the environment in flash makes it always
3854 necessary to erase the WHOLE sector. If something goes
3855 wrong before the contents has been restored from a copy in
3856 RAM, your target system will be dead.
3857
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003858 - CONFIG_ENV_ADDR_REDUND
3859 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003860
wdenk4a5c8a72003-03-06 00:02:04 +00003861 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003862 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003863 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003864 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003865
3866BE CAREFUL! Any changes to the flash layout, and some changes to the
3867source code will make it necessary to adapt <board>/u-boot.lds*
3868accordingly!
3869
3870
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003871- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003872
3873 Define this if you have some non-volatile memory device
3874 (NVRAM, battery buffered SRAM) which you want to use for the
3875 environment.
3876
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003877 - CONFIG_ENV_ADDR:
3878 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003879
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003880 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003881 want to use for environment. It is assumed that this memory
3882 can just be read and written to, without any special
3883 provision.
3884
3885BE CAREFUL! The first access to the environment happens quite early
3886in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003887console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003888U-Boot will hang.
3889
3890Please note that even with NVRAM we still use a copy of the
3891environment in RAM: we could work on NVRAM directly, but we want to
3892keep settings there always unmodified except somebody uses "saveenv"
3893to save the current settings.
3894
3895
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003896- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003897
3898 Use this if you have an EEPROM or similar serial access
3899 device and a driver for it.
3900
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003901 - CONFIG_ENV_OFFSET:
3902 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003903
3904 These two #defines specify the offset and size of the
3905 environment area within the total memory of your EEPROM.
3906
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003907 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003908 If defined, specified the chip address of the EEPROM device.
3909 The default address is zero.
3910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003911 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003912 If defined, the number of bits used to address bytes in a
3913 single page in the EEPROM device. A 64 byte page, for example
3914 would require six bits.
3915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003916 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003917 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003918 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003920 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003921 The length in bytes of the EEPROM memory array address. Note
3922 that this is NOT the chip address length!
3923
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003924 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003925 EEPROM chips that implement "address overflow" are ones
3926 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3927 address and the extra bits end up in the "chip address" bit
3928 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3929 byte chips.
3930
3931 Note that we consider the length of the address field to
3932 still be one byte because the extra address bits are hidden
3933 in the chip address.
3934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003936 The size in bytes of the EEPROM device.
3937
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003938 - CONFIG_ENV_EEPROM_IS_ON_I2C
3939 define this, if you have I2C and SPI activated, and your
3940 EEPROM, which holds the environment, is on the I2C bus.
3941
3942 - CONFIG_I2C_ENV_EEPROM_BUS
3943 if you have an Environment on an EEPROM reached over
3944 I2C muxes, you can define here, how to reach this
3945 EEPROM. For example:
3946
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003947 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003948
3949 EEPROM which holds the environment, is reached over
3950 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003951
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003952- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003953
wdenk1ebf41e2004-01-02 14:00:00 +00003954 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003955 want to use for the environment.
3956
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003957 - CONFIG_ENV_OFFSET:
3958 - CONFIG_ENV_ADDR:
3959 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003960
3961 These three #defines specify the offset and size of the
3962 environment area within the total memory of your DataFlash placed
3963 at the specified address.
3964
Liu Gang85bcd732012-03-08 00:33:20 +00003965- CONFIG_ENV_IS_IN_REMOTE:
3966
3967 Define this if you have a remote memory space which you
3968 want to use for the local device's environment.
3969
3970 - CONFIG_ENV_ADDR:
3971 - CONFIG_ENV_SIZE:
3972
3973 These two #defines specify the address and size of the
3974 environment area within the remote memory space. The
3975 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003976 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003977
3978BE CAREFUL! For some special cases, the local device can not use
3979"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003980environment stored in a remote NOR flash by SRIO or PCIE link,
3981but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003982
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003983- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003984
3985 Define this if you have a NAND device which you want to use
3986 for the environment.
3987
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003988 - CONFIG_ENV_OFFSET:
3989 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003990
3991 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003992 area within the first NAND device. CONFIG_ENV_OFFSET must be
3993 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003994
Scott Wood08239322010-09-17 14:38:37 -05003995 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003996
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003997 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003998 size used to hold a redundant copy of the environment data, so
3999 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004000 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004001 aligned to an erase block boundary.
4002
4003 - CONFIG_ENV_RANGE (optional):
4004
4005 Specifies the length of the region in which the environment
4006 can be written. This should be a multiple of the NAND device's
4007 block size. Specifying a range with more erase blocks than
4008 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4009 the range to be avoided.
4010
4011 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004012
Scott Wood08239322010-09-17 14:38:37 -05004013 Enables support for dynamically retrieving the offset of the
4014 environment from block zero's out-of-band data. The
4015 "nand env.oob" command can be used to record this offset.
4016 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4017 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004018
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004019- CONFIG_NAND_ENV_DST
4020
4021 Defines address in RAM to which the nand_spl code should copy the
4022 environment. If redundant environment is used, it will be copied to
4023 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4024
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004025- CONFIG_ENV_IS_IN_UBI:
4026
4027 Define this if you have an UBI volume that you want to use for the
4028 environment. This has the benefit of wear-leveling the environment
4029 accesses, which is important on NAND.
4030
4031 - CONFIG_ENV_UBI_PART:
4032
4033 Define this to a string that is the mtd partition containing the UBI.
4034
4035 - CONFIG_ENV_UBI_VOLUME:
4036
4037 Define this to the name of the volume that you want to store the
4038 environment in.
4039
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004040 - CONFIG_ENV_UBI_VOLUME_REDUND:
4041
4042 Define this to the name of another volume to store a second copy of
4043 the environment in. This will enable redundant environments in UBI.
4044 It is assumed that both volumes are in the same MTD partition.
4045
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004046 - CONFIG_UBI_SILENCE_MSG
4047 - CONFIG_UBIFS_SILENCE_MSG
4048
4049 You will probably want to define these to avoid a really noisy system
4050 when storing the env in UBI.
4051
Stephen Warreneedcacd2013-06-11 15:14:00 -06004052- CONFIG_ENV_IS_IN_MMC:
4053
4054 Define this if you have an MMC device which you want to use for the
4055 environment.
4056
4057 - CONFIG_SYS_MMC_ENV_DEV:
4058
4059 Specifies which MMC device the environment is stored in.
4060
4061 - CONFIG_SYS_MMC_ENV_PART (optional):
4062
4063 Specifies which MMC partition the environment is stored in. If not
4064 set, defaults to partition 0, the user area. Common values might be
4065 1 (first MMC boot partition), 2 (second MMC boot partition).
4066
4067 - CONFIG_ENV_OFFSET:
4068 - CONFIG_ENV_SIZE:
4069
4070 These two #defines specify the offset and size of the environment
4071 area within the specified MMC device.
4072
Stephen Warren24dc2032013-06-11 15:14:02 -06004073 If offset is positive (the usual case), it is treated as relative to
4074 the start of the MMC partition. If offset is negative, it is treated
4075 as relative to the end of the MMC partition. This can be useful if
4076 your board may be fitted with different MMC devices, which have
4077 different sizes for the MMC partitions, and you always want the
4078 environment placed at the very end of the partition, to leave the
4079 maximum possible space before it, to store other data.
4080
Stephen Warreneedcacd2013-06-11 15:14:00 -06004081 These two values are in units of bytes, but must be aligned to an
4082 MMC sector boundary.
4083
4084 - CONFIG_ENV_OFFSET_REDUND (optional):
4085
4086 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4087 hold a redundant copy of the environment data. This provides a
4088 valid backup copy in case the other copy is corrupted, e.g. due
4089 to a power failure during a "saveenv" operation.
4090
Stephen Warren24dc2032013-06-11 15:14:02 -06004091 This value may also be positive or negative; this is handled in the
4092 same way as CONFIG_ENV_OFFSET.
4093
Stephen Warreneedcacd2013-06-11 15:14:00 -06004094 This value is also in units of bytes, but must also be aligned to
4095 an MMC sector boundary.
4096
4097 - CONFIG_ENV_SIZE_REDUND (optional):
4098
4099 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4100 set. If this value is set, it must be set to the same value as
4101 CONFIG_ENV_SIZE.
4102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004103- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004104
4105 Defines offset to the initial SPI buffer area in DPRAM. The
4106 area is used at an early stage (ROM part) if the environment
4107 is configured to reside in the SPI EEPROM: We need a 520 byte
4108 scratch DPRAM area. It is used between the two initialization
4109 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4110 to be a good choice since it makes it far enough from the
4111 start of the data area as well as from the stack pointer.
4112
Bruce Adleredecc942007-11-02 13:15:42 -07004113Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004114has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004115created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004116until then to read environment variables.
4117
wdenk8dba0502003-03-31 16:34:49 +00004118The environment is protected by a CRC32 checksum. Before the monitor
4119is relocated into RAM, as a result of a bad CRC you will be working
4120with the compiled-in default environment - *silently*!!! [This is
4121necessary, because the first environment variable we need is the
4122"baudrate" setting for the console - if we have a bad CRC, we don't
4123have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004124
4125Note: once the monitor has been relocated, then it will complain if
4126the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004127use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004129- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004130 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004132 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004133 also needs to be defined.
4134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004135- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004136 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004137
Ron Madriddfa028a2009-02-18 14:30:44 -08004138- CONFIG_NS16550_MIN_FUNCTIONS:
4139 Define this if you desire to only have use of the NS16550_init
4140 and NS16550_putc functions for the serial driver located at
4141 drivers/serial/ns16550.c. This option is useful for saving
4142 space for already greatly restricted images, including but not
4143 limited to NAND_SPL configurations.
4144
Simon Glass28a9e332012-11-30 13:01:18 +00004145- CONFIG_DISPLAY_BOARDINFO
4146 Display information about the board that U-Boot is running on
4147 when U-Boot starts up. The board function checkboard() is called
4148 to do this.
4149
Simon Glasse8822012012-11-30 13:01:19 +00004150- CONFIG_DISPLAY_BOARDINFO_LATE
4151 Similar to the previous option, but display this information
4152 later, once stdio is running and output goes to the LCD, if
4153 present.
4154
wdenkc6097192002-11-03 00:24:07 +00004155Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004156---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004159 Cache Line Size of the CPU.
4160
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004161- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004162 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004163
wdenk9c53f402003-10-15 23:53:47 +00004164 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4165 and RPXsuper) to be able to adjust the position of
4166 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004167
Timur Tabid8f341c2011-08-04 18:03:41 -05004168- CONFIG_SYS_CCSRBAR_DEFAULT:
4169 Default (power-on reset) physical address of CCSR on Freescale
4170 PowerPC SOCs.
4171
4172- CONFIG_SYS_CCSRBAR:
4173 Virtual address of CCSR. On a 32-bit build, this is typically
4174 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4175
4176 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4177 for cross-platform code that uses that macro instead.
4178
4179- CONFIG_SYS_CCSRBAR_PHYS:
4180 Physical address of CCSR. CCSR can be relocated to a new
4181 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004182 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004183 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4184 is typically relocated on 36-bit builds. It is recommended
4185 that this macro be defined via the _HIGH and _LOW macros:
4186
4187 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4188 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4189
4190- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004191 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4192 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004193 used in assembly code, so it must not contain typecasts or
4194 integer size suffixes (e.g. "ULL").
4195
4196- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4197 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4198 used in assembly code, so it must not contain typecasts or
4199 integer size suffixes (e.g. "ULL").
4200
4201- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4202 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4203 forced to a value that ensures that CCSR is not relocated.
4204
wdenk1272e232002-11-10 22:06:23 +00004205- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004206 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004207
4208 the default drive number (default value 0)
4209
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004210 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004211
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004212 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004213 (default value 1)
4214
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004215 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004216
wdenk4a5c8a72003-03-06 00:02:04 +00004217 defines the offset of register from address. It
4218 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004219 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004220
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004221 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4222 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004223 default value.
wdenk1272e232002-11-10 22:06:23 +00004224
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004225 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004226 fdc_hw_init() is called at the beginning of the FDC
4227 setup. fdc_hw_init() must be provided by the board
4228 source code. It is used to make hardware dependant
4229 initializations.
wdenk1272e232002-11-10 22:06:23 +00004230
Macpaul Lind1e49942011-04-11 20:45:32 +00004231- CONFIG_IDE_AHB:
4232 Most IDE controllers were designed to be connected with PCI
4233 interface. Only few of them were designed for AHB interface.
4234 When software is doing ATA command and data transfer to
4235 IDE devices through IDE-AHB controller, some additional
4236 registers accessing to these kind of IDE-AHB controller
4237 is requierd.
4238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004239- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004240 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004241 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004243- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004244
wdenkeb20ad32003-09-05 23:19:14 +00004245 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004246 initial data and stack; please note that this must be
4247 writable memory that is working WITHOUT special
4248 initialization, i. e. you CANNOT use normal RAM which
4249 will become available only after programming the
4250 memory controller and running certain initialization
4251 sequences.
4252
4253 U-Boot uses the following memory types:
4254 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4255 - MPC824X: data cache
4256 - PPC4xx: data cache
4257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004258- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004259
4260 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004261 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4262 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004263 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004264 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004265 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4266 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4267 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004268
4269 Note:
4270 On the MPC824X (or other systems that use the data
4271 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004272 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004273 point to an otherwise UNUSED address space between
4274 the top of RAM and the start of the PCI space.
4275
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004276- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004277
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004278- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004279
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004280- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004281
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004282- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004284- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004285
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004286- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004288- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004289 SDRAM timing
4290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004291- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004292 periodic timer for refresh
4293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004294- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004295
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004296- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4297 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4298 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4299 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004300 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4301
4302- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004303 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4304 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004305 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4306
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004307- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4308 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004309 Machine Mode Register and Memory Periodic Timer
4310 Prescaler definitions (SDRAM timing)
4311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004312- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004313 enable I2C microcode relocation patch (MPC8xx);
4314 define relocation offset in DPRAM [DSP2]
4315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004316- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004317 enable SMC microcode relocation patch (MPC8xx);
4318 define relocation offset in DPRAM [SMC1]
4319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004320- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004321 enable SPI microcode relocation patch (MPC8xx);
4322 define relocation offset in DPRAM [SCC4]
4323
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004324- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004325 Use OSCM clock mode on MBX8xx board. Be careful,
4326 wrong setting might damage your board. Read
4327 doc/README.MBX before setting this variable!
4328
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004329- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004330 Offset of the bootmode word in DPRAM used by post
4331 (Power On Self Tests). This definition overrides
4332 #define'd default value in commproc.h resp.
4333 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004334
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004335- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4336 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4337 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4338 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4339 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4340 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4341 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4342 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004343 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004344
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004345- CONFIG_PCI_DISABLE_PCIE:
4346 Disable PCI-Express on systems where it is supported but not
4347 required.
4348
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004349- CONFIG_PCI_ENUM_ONLY
4350 Only scan through and get the devices on the busses.
4351 Don't do any setup work, presumably because someone or
4352 something has already done it, and we don't need to do it
4353 a second time. Useful for platforms that are pre-booted
4354 by coreboot or similar.
4355
Gabor Juhosb4458732013-05-30 07:06:12 +00004356- CONFIG_PCI_INDIRECT_BRIDGE:
4357 Enable support for indirect PCI bridges.
4358
Kumar Gala8975d7a2010-12-30 12:09:53 -06004359- CONFIG_SYS_SRIO:
4360 Chip has SRIO or not
4361
4362- CONFIG_SRIO1:
4363 Board has SRIO 1 port available
4364
4365- CONFIG_SRIO2:
4366 Board has SRIO 2 port available
4367
Liu Gang27afb9c2013-05-07 16:30:46 +08004368- CONFIG_SRIO_PCIE_BOOT_MASTER
4369 Board can support master function for Boot from SRIO and PCIE
4370
Kumar Gala8975d7a2010-12-30 12:09:53 -06004371- CONFIG_SYS_SRIOn_MEM_VIRT:
4372 Virtual Address of SRIO port 'n' memory region
4373
4374- CONFIG_SYS_SRIOn_MEM_PHYS:
4375 Physical Address of SRIO port 'n' memory region
4376
4377- CONFIG_SYS_SRIOn_MEM_SIZE:
4378 Size of SRIO port 'n' memory region
4379
Fabio Estevamf17e8782013-04-11 09:35:34 +00004380- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4381 Defined to tell the NAND controller that the NAND chip is using
4382 a 16 bit bus.
4383 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004384 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004385 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004386 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004387
4388- CONFIG_SYS_NDFC_EBC0_CFG
4389 Sets the EBC0_CFG register for the NDFC. If not defined
4390 a default value will be used.
4391
Ben Warren45657152006-09-07 16:50:54 -04004392- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004393 Get DDR timing information from an I2C EEPROM. Common
4394 with pluggable memory modules such as SODIMMs
4395
Ben Warren45657152006-09-07 16:50:54 -04004396 SPD_EEPROM_ADDRESS
4397 I2C address of the SPD EEPROM
4398
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004399- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004400 If SPD EEPROM is on an I2C bus other than the first
4401 one, specify here. Note that the value must resolve
4402 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004403
York Sune73cc042011-06-07 09:42:16 +08004404- CONFIG_SYS_DDR_RAW_TIMING
4405 Get DDR timing information from other than SPD. Common with
4406 soldered DDR chips onboard without SPD. DDR raw timing
4407 parameters are extracted from datasheet and hard-coded into
4408 header files or board specific files.
4409
York Sunbd495cf2011-09-16 13:21:35 -07004410- CONFIG_FSL_DDR_INTERACTIVE
4411 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4412
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004413- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004414 Only for 83xx systems. If specified, then DDR should
4415 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004416
wdenk6203e402004-04-18 10:13:26 +00004417- CONFIG_ETHER_ON_FEC[12]
4418 Define to enable FEC[12] on a 8xx series processor.
4419
4420- CONFIG_FEC[12]_PHY
4421 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004422 to the given FEC; i. e.
4423 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004424 means that the PHY with address 4 is connected to FEC1
4425
4426 When set to -1, means to probe for first available.
4427
4428- CONFIG_FEC[12]_PHY_NORXERR
4429 The PHY does not have a RXERR line (RMII only).
4430 (so program the FEC to ignore it).
4431
4432- CONFIG_RMII
4433 Enable RMII mode for all FECs.
4434 Note that this is a global option, we can't
4435 have one FEC in standard MII mode and another in RMII mode.
4436
wdenk20c98a62004-04-23 20:32:05 +00004437- CONFIG_CRC32_VERIFY
4438 Add a verify option to the crc32 command.
4439 The syntax is:
4440
4441 => crc32 -v <address> <count> <crc32>
4442
4443 Where address/count indicate a memory area
4444 and crc32 is the correct crc32 which the
4445 area should have.
4446
wdenk64519362004-07-11 17:40:54 +00004447- CONFIG_LOOPW
4448 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004449 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004450
stroesecc3af832004-12-16 18:46:55 +00004451- CONFIG_MX_CYCLIC
4452 Add the "mdc" and "mwc" memory commands. These are cyclic
4453 "md/mw" commands.
4454 Examples:
4455
wdenk07d7e6b2004-12-16 21:44:03 +00004456 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004457 This command will print 4 bytes (10,11,12,13) each 500 ms.
4458
wdenk07d7e6b2004-12-16 21:44:03 +00004459 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004460 This command will write 12345678 to address 100 all 10 ms.
4461
wdenk07d7e6b2004-12-16 21:44:03 +00004462 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004463 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004464
wdenk3d3d99f2005-04-04 12:44:11 +00004465- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004466 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004467 low level initializations (like setting up the memory
4468 controller) are omitted and/or U-Boot does not
4469 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004470
Wolfgang Denk302141d2010-11-27 23:30:56 +01004471 Normally this variable MUST NOT be defined. The only
4472 exception is when U-Boot is loaded (to RAM) by some
4473 other boot loader or by a debugger which performs
4474 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004475
Aneesh V552a3192011-07-13 05:11:07 +00004476- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004477 Modifies the behaviour of start.S when compiling a loader
4478 that is executed before the actual U-Boot. E.g. when
4479 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004480
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004481- CONFIG_TPL_BUILD
4482 Modifies the behaviour of start.S when compiling a loader
4483 that is executed after the SPL and before the actual U-Boot.
4484 It is loaded by the SPL.
4485
Ying Zhang0d4f5442013-05-20 14:07:23 +08004486- CONFIG_SYS_MPC85XX_NO_RESETVEC
4487 Only for 85xx systems. If this variable is specified, the section
4488 .resetvec is not kept and the section .bootpg is placed in the
4489 previous 4k of the .text section.
4490
Simon Glass17dabf02013-02-24 17:33:14 +00004491- CONFIG_ARCH_MAP_SYSMEM
4492 Generally U-Boot (and in particular the md command) uses
4493 effective address. It is therefore not necessary to regard
4494 U-Boot address as virtual addresses that need to be translated
4495 to physical addresses. However, sandbox requires this, since
4496 it maintains its own little RAM buffer which contains all
4497 addressable memory. This option causes some memory accesses
4498 to be mapped through map_sysmem() / unmap_sysmem().
4499
Matthias Weisser93416c12011-03-10 21:36:32 +00004500- CONFIG_USE_ARCH_MEMCPY
4501 CONFIG_USE_ARCH_MEMSET
4502 If these options are used a optimized version of memcpy/memset will
4503 be used if available. These functions may be faster under some
4504 conditions but may increase the binary size.
4505
Simon Glassbfb59802013-02-14 04:18:54 +00004506- CONFIG_X86_RESET_VECTOR
4507 If defined, the x86 reset vector code is included. This is not
4508 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004509
Mark Jackson52b003c2013-03-04 01:27:20 +00004510- CONFIG_SYS_MPUCLK
4511 Defines the MPU clock speed (in MHz).
4512
4513 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004514
Heiko Schocher2233e462013-11-04 14:05:00 +01004515- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4516 Enables the RTC32K OSC on AM33xx based plattforms
4517
Timur Tabi275f4bb2011-11-22 09:21:25 -06004518Freescale QE/FMAN Firmware Support:
4519-----------------------------------
4520
4521The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4522loading of "firmware", which is encoded in the QE firmware binary format.
4523This firmware often needs to be loaded during U-Boot booting, so macros
4524are used to identify the storage device (NOR flash, SPI, etc) and the address
4525within that device.
4526
Zhao Qiang83a90842014-03-21 16:21:44 +08004527- CONFIG_SYS_FMAN_FW_ADDR
4528 The address in the storage device where the FMAN microcode is located. The
4529 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4530 is also specified.
4531
4532- CONFIG_SYS_QE_FW_ADDR
4533 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004534 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4535 is also specified.
4536
4537- CONFIG_SYS_QE_FMAN_FW_LENGTH
4538 The maximum possible size of the firmware. The firmware binary format
4539 has a field that specifies the actual size of the firmware, but it
4540 might not be possible to read any part of the firmware unless some
4541 local storage is allocated to hold the entire firmware first.
4542
4543- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4544 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4545 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4546 virtual address in NOR flash.
4547
4548- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4549 Specifies that QE/FMAN firmware is located in NAND flash.
4550 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4551
4552- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4553 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4554 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4555
4556- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4557 Specifies that QE/FMAN firmware is located on the primary SPI
4558 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4559
Liu Gang1e084582012-03-08 00:33:18 +00004560- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4561 Specifies that QE/FMAN firmware is located in the remote (master)
4562 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004563 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4564 window->master inbound window->master LAW->the ucode address in
4565 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004566
wdenkc6097192002-11-03 00:24:07 +00004567Building the Software:
4568======================
4569
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004570Building U-Boot has been tested in several native build environments
4571and in many different cross environments. Of course we cannot support
4572all possibly existing versions of cross development tools in all
4573(potentially obsolete) versions. In case of tool chain problems we
4574recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4575which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004576
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004577If you are not using a native environment, it is assumed that you
4578have GNU cross compiling tools available in your path. In this case,
4579you must set the environment variable CROSS_COMPILE in your shell.
4580Note that no changes to the Makefile or any other source files are
4581necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004582
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004583 $ CROSS_COMPILE=ppc_4xx-
4584 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004585
Peter Tyserb06976d2009-03-13 18:54:51 -05004586Note: If you wish to generate Windows versions of the utilities in
4587 the tools directory you can use the MinGW toolchain
4588 (http://www.mingw.org). Set your HOST tools to the MinGW
4589 toolchain and execute 'make tools'. For example:
4590
4591 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4592
4593 Binaries such as tools/mkimage.exe will be created which can
4594 be executed on computers running Windows.
4595
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004596U-Boot is intended to be simple to build. After installing the
4597sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004598is done by typing:
4599
4600 make NAME_config
4601
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004602where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004603rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004604
wdenk6c59edc2004-05-03 20:45:30 +00004605Note: for some board special configuration names may exist; check if
4606 additional information is available from the board vendor; for
4607 instance, the TQM823L systems are available without (standard)
4608 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004609 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk6c59edc2004-05-03 20:45:30 +00004611 make TQM823L_config
4612 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614 make TQM823L_LCD_config
4615 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004616
wdenk6c59edc2004-05-03 20:45:30 +00004617 etc.
wdenkc6097192002-11-03 00:24:07 +00004618
wdenkc6097192002-11-03 00:24:07 +00004619
wdenk6c59edc2004-05-03 20:45:30 +00004620Finally, type "make all", and you should get some working U-Boot
4621images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004622
wdenk6c59edc2004-05-03 20:45:30 +00004623- "u-boot.bin" is a raw binary image
4624- "u-boot" is an image in ELF binary format
4625- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004626
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004627By default the build is performed locally and the objects are saved
4628in the source directory. One of the two methods can be used to change
4629this behavior and build U-Boot to some external directory:
4630
46311. Add O= to the make command line invocations:
4632
4633 make O=/tmp/build distclean
4634 make O=/tmp/build NAME_config
4635 make O=/tmp/build all
4636
46372. Set environment variable BUILD_DIR to point to the desired location:
4638
4639 export BUILD_DIR=/tmp/build
4640 make distclean
4641 make NAME_config
4642 make all
4643
4644Note that the command line "O=" setting overrides the BUILD_DIR environment
4645variable.
4646
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk6c59edc2004-05-03 20:45:30 +00004648Please be aware that the Makefiles assume you are using GNU make, so
4649for instance on NetBSD you might need to use "gmake" instead of
4650native "make".
wdenkc6097192002-11-03 00:24:07 +00004651
wdenkc6097192002-11-03 00:24:07 +00004652
wdenk6c59edc2004-05-03 20:45:30 +00004653If the system board that you have is not listed, then you will need
4654to port U-Boot to your hardware platform. To do this, follow these
4655steps:
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +000046571. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004658 "boards.cfg" file, using the existing entries as examples.
4659 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000046602. Create a new directory to hold your board specific code. Add any
4661 files you need. In your board directory, you will need at least
4662 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
46633. Create a new configuration file "include/configs/<board>.h" for
4664 your board
46653. If you're porting U-Boot to a new CPU, then also create a new
4666 directory to hold your CPU specific code. Add any files you need.
46674. Run "make <board>_config" with your new name.
46685. Type "make", and you should get a working "u-boot.srec" file
4669 to be installed on your target system.
46706. Debug and solve any problems that might arise.
4671 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004672
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4675==============================================================
wdenkc6097192002-11-03 00:24:07 +00004676
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004677If you have modified U-Boot sources (for instance added a new board
4678or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004679provide feedback to the other developers. The feedback normally takes
4680the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004681official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004682
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004683But before you submit such a patch, please verify that your modifi-
4684cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004685the supported boards compile WITHOUT ANY compiler warnings. To do so,
4686just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004687for ALL supported system. Be warned, this will take a while. You can
4688select which (cross) compiler to use by passing a `CROSS_COMPILE'
4689environment variable to the script, i. e. to use the ELDK cross tools
4690you can type
wdenkc6097192002-11-03 00:24:07 +00004691
wdenk6c59edc2004-05-03 20:45:30 +00004692 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk6c59edc2004-05-03 20:45:30 +00004694or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004697
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004698When using the MAKEALL script, the default behaviour is to build
4699U-Boot in the source directory. This location can be changed by
4700setting the BUILD_DIR environment variable. Also, for each target
4701built, the MAKEALL script saves two log files (<target>.ERR and
4702<target>.MAKEALL) in the <source dir>/LOG directory. This default
4703location can be changed by setting the MAKEALL_LOGDIR environment
4704variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004705
4706 export BUILD_DIR=/tmp/build
4707 export MAKEALL_LOGDIR=/tmp/log
4708 CROSS_COMPILE=ppc_8xx- MAKEALL
4709
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004710With the above settings build objects are saved in the /tmp/build,
4711log files are saved in the /tmp/log and the source tree remains clean
4712during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004713
4714
wdenk6c59edc2004-05-03 20:45:30 +00004715See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004716
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk6c59edc2004-05-03 20:45:30 +00004718Monitor Commands - Overview:
4719============================
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk6c59edc2004-05-03 20:45:30 +00004721go - start application at address 'addr'
4722run - run commands in an environment variable
4723bootm - boot application image from memory
4724bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004725bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004726tftpboot- boot image via network using TFTP protocol
4727 and env variables "ipaddr" and "serverip"
4728 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004729tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004730rarpboot- boot image via network using RARP/TFTP protocol
4731diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4732loads - load S-Record file over serial line
4733loadb - load binary file over serial line (kermit mode)
4734md - memory display
4735mm - memory modify (auto-incrementing)
4736nm - memory modify (constant address)
4737mw - memory write (fill)
4738cp - memory copy
4739cmp - memory compare
4740crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004741i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004742sspi - SPI utility commands
4743base - print or set address offset
4744printenv- print environment variables
4745setenv - set environment variables
4746saveenv - save environment variables to persistent storage
4747protect - enable or disable FLASH write protection
4748erase - erase FLASH memory
4749flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004750nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004751bdinfo - print Board Info structure
4752iminfo - print header information for application image
4753coninfo - print console devices and informations
4754ide - IDE sub-system
4755loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004756loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004757mtest - simple RAM test
4758icache - enable or disable instruction cache
4759dcache - enable or disable data cache
4760reset - Perform RESET of the CPU
4761echo - echo args to console
4762version - print monitor version
4763help - print online help
4764? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004765
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk6c59edc2004-05-03 20:45:30 +00004767Monitor Commands - Detailed Description:
4768========================================
wdenkc6097192002-11-03 00:24:07 +00004769
wdenk6c59edc2004-05-03 20:45:30 +00004770TODO.
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004773
4774
wdenk6c59edc2004-05-03 20:45:30 +00004775Environment Variables:
4776======================
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk6c59edc2004-05-03 20:45:30 +00004778U-Boot supports user configuration using Environment Variables which
4779can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004780
wdenk6c59edc2004-05-03 20:45:30 +00004781Environment Variables are set using "setenv", printed using
4782"printenv", and saved to Flash using "saveenv". Using "setenv"
4783without a value can be used to delete a variable from the
4784environment. As long as you don't save the environment you are
4785working with an in-memory copy. In case the Flash area containing the
4786environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004787
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004788Some configuration options can be set using Environment Variables.
4789
4790List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk6c59edc2004-05-03 20:45:30 +00004792 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004793
wdenk6c59edc2004-05-03 20:45:30 +00004794 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk6c59edc2004-05-03 20:45:30 +00004796 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004797
wdenk6c59edc2004-05-03 20:45:30 +00004798 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004799
wdenk6c59edc2004-05-03 20:45:30 +00004800 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004801
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004802 bootm_low - Memory range available for image processing in the bootm
4803 command can be restricted. This variable is given as
4804 a hexadecimal number and defines lowest address allowed
4805 for use by the bootm command. See also "bootm_size"
4806 environment variable. Address defined by "bootm_low" is
4807 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004808 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4809 bootm_mapsize.
4810
Wolfgang Denk092ae952011-10-26 10:21:21 +00004811 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004812 This variable is given as a hexadecimal number and it
4813 defines the size of the memory region starting at base
4814 address bootm_low that is accessible by the Linux kernel
4815 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4816 as the default value if it is defined, and bootm_size is
4817 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004818
4819 bootm_size - Memory range available for image processing in the bootm
4820 command can be restricted. This variable is given as
4821 a hexadecimal number and defines the size of the region
4822 allowed for use by the bootm command. See also "bootm_low"
4823 environment variable.
4824
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004825 updatefile - Location of the software update file on a TFTP server, used
4826 by the automatic software update feature. Please refer to
4827 documentation in doc/README.update for more details.
4828
wdenk6c59edc2004-05-03 20:45:30 +00004829 autoload - if set to "no" (any string beginning with 'n'),
4830 "bootp" will just load perform a lookup of the
4831 configuration from the BOOTP server, but not try to
4832 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834 autostart - if set to "yes", an image loaded using the "bootp",
4835 "rarpboot", "tftpboot" or "diskboot" commands will
4836 be automatically started (by internally calling
4837 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk6c59edc2004-05-03 20:45:30 +00004839 If set to "no", a standalone image passed to the
4840 "bootm" command will be copied to the load address
4841 (and eventually uncompressed), but NOT be started.
4842 This can be used to load and uncompress arbitrary
4843 data.
wdenkc6097192002-11-03 00:24:07 +00004844
David A. Longd558a4e2011-07-09 16:40:19 -04004845 fdt_high - if set this restricts the maximum address that the
4846 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004847 For example, if you have a system with 1 GB memory
4848 at physical address 0x10000000, while Linux kernel
4849 only recognizes the first 704 MB as low memory, you
4850 may need to set fdt_high as 0x3C000000 to have the
4851 device tree blob be copied to the maximum address
4852 of the 704 MB low memory, so that Linux kernel can
4853 access it during the boot procedure.
4854
David A. Longd558a4e2011-07-09 16:40:19 -04004855 If this is set to the special value 0xFFFFFFFF then
4856 the fdt will not be copied at all on boot. For this
4857 to work it must reside in writable memory, have
4858 sufficient padding on the end of it for u-boot to
4859 add the information it needs into it, and the memory
4860 must be accessible by the kernel.
4861
Simon Glassdc6fa642011-10-24 19:15:34 +00004862 fdtcontroladdr- if set this is the address of the control flattened
4863 device tree used by U-Boot when CONFIG_OF_CONTROL is
4864 defined.
4865
wdenk0e2bd9c2004-06-06 21:51:03 +00004866 i2cfast - (PPC405GP|PPC405EP only)
4867 if set to 'y' configures Linux I2C driver for fast
4868 mode (400kHZ). This environment variable is used in
4869 initialization code. So, for changes to be effective
4870 it must be saved and board must be reset.
4871
wdenk6c59edc2004-05-03 20:45:30 +00004872 initrd_high - restrict positioning of initrd images:
4873 If this variable is not set, initrd images will be
4874 copied to the highest possible address in RAM; this
4875 is usually what you want since it allows for
4876 maximum initrd size. If for some reason you want to
4877 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004878 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004879 variable to a value of "no" or "off" or "0".
4880 Alternatively, you can set it to a maximum upper
4881 address to use (U-Boot will still check that it
4882 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk6c59edc2004-05-03 20:45:30 +00004884 For instance, when you have a system with 16 MB
4885 RAM, and want to reserve 4 MB from use by Linux,
4886 you can do this by adding "mem=12M" to the value of
4887 the "bootargs" variable. However, now you must make
4888 sure that the initrd image is placed in the first
4889 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 If you set initrd_high to 0xFFFFFFFF, this is an
4894 indication to U-Boot that all addresses are legal
4895 for the Linux kernel, including addresses in flash
4896 memory. In this case U-Boot will NOT COPY the
4897 ramdisk at all. This may be useful to reduce the
4898 boot time on your system, but requires that this
4899 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk6c59edc2004-05-03 20:45:30 +00004903 loadaddr - Default load address for commands like "bootp",
4904 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk6c59edc2004-05-03 20:45:30 +00004908 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004911
wdenk6c59edc2004-05-03 20:45:30 +00004912 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk6c59edc2004-05-03 20:45:30 +00004914 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004915
Mike Frysingera23230c2011-10-02 10:01:27 +00004916 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004917
Mike Frysingera23230c2011-10-02 10:01:27 +00004918 ethact - controls which interface is currently active.
4919 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004920
Heiko Schocherc5e84052010-07-20 17:45:02 +02004921 => setenv ethact FEC
4922 => ping 192.168.0.1 # traffic sent on FEC
4923 => setenv ethact SCC
4924 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004925
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004926 ethrotate - When set to "no" U-Boot does not go through all
4927 available network interfaces.
4928 It just stays at the currently selected interface.
4929
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004930 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004931 either succeed or fail without retrying.
4932 When set to "once" the network operation will
4933 fail when all the available network interfaces
4934 are tried once without success.
4935 Useful on scripts which control the retry operation
4936 themselves.
wdenkc6097192002-11-03 00:24:07 +00004937
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004938 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004939
Simon Glass5db3f932013-07-16 20:10:00 -07004940 silent_linux - If set then linux will be told to boot silently, by
4941 changing the console to be empty. If "yes" it will be
4942 made silent. If "no" it will not be made silent. If
4943 unset, then it will be made silent if the U-Boot console
4944 is silent.
4945
Wolfgang Denk227b5192005-09-24 23:25:46 +02004946 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004947 UDP source port.
4948
Wolfgang Denk227b5192005-09-24 23:25:46 +02004949 tftpdstport - If this is set, the value is used for TFTP's UDP
4950 destination port instead of the Well Know Port 69.
4951
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004952 tftpblocksize - Block size to use for TFTP transfers; if not set,
4953 we use the TFTP server's default block size
4954
4955 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4956 seconds, minimum value is 1000 = 1 second). Defines
4957 when a packet is considered to be lost so it has to
4958 be retransmitted. The default is 5000 = 5 seconds.
4959 Lowering this value may make downloads succeed
4960 faster in networks with high packet loss rates or
4961 with unreliable TFTP servers.
4962
4963 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004964 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004965 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004966
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004967The following image location variables contain the location of images
4968used in booting. The "Image" column gives the role of the image and is
4969not an environment variable name. The other columns are environment
4970variable names. "File Name" gives the name of the file on a TFTP
4971server, "RAM Address" gives the location in RAM the image will be
4972loaded to, and "Flash Location" gives the image's address in NOR
4973flash or offset in NAND flash.
4974
4975*Note* - these variables don't have to be defined for all boards, some
4976boards currenlty use other variables for these purposes, and some
4977boards use these variables for other purposes.
4978
Wolfgang Denk092ae952011-10-26 10:21:21 +00004979Image File Name RAM Address Flash Location
4980----- --------- ----------- --------------
4981u-boot u-boot u-boot_addr_r u-boot_addr
4982Linux kernel bootfile kernel_addr_r kernel_addr
4983device tree blob fdtfile fdt_addr_r fdt_addr
4984ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004985
wdenk6c59edc2004-05-03 20:45:30 +00004986The following environment variables may be used and automatically
4987updated by the network boot commands ("bootp" and "rarpboot"),
4988depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990 bootfile - see above
4991 dnsip - IP address of your Domain Name Server
4992 dnsip2 - IP address of your secondary Domain Name Server
4993 gatewayip - IP address of the Gateway (Router) to use
4994 hostname - Target hostname
4995 ipaddr - see above
4996 netmask - Subnet Mask
4997 rootpath - Pathname of the root filesystem on the NFS server
4998 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004999
wdenk145d2c12004-04-15 21:48:45 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003 serial# - contains hardware identification information such
5004 as type string and/or serial number
5005 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007These variables can be set only once (usually during manufacturing of
5008the board). U-Boot refuses to delete or overwrite these variables
5009once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005010
5011
wdenk6c59edc2004-05-03 20:45:30 +00005012Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk6c59edc2004-05-03 20:45:30 +00005014 ver - Contains the U-Boot version string as printed
5015 with the "version" command. This variable is
5016 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005017
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk6c59edc2004-05-03 20:45:30 +00005019Please note that changes to some configuration parameters may take
5020only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005021
stroeseb9c17c52003-04-04 15:53:41 +00005022
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005023Callback functions for environment variables:
5024---------------------------------------------
5025
5026For some environment variables, the behavior of u-boot needs to change
5027when their values are changed. This functionailty allows functions to
5028be associated with arbitrary variables. On creation, overwrite, or
5029deletion, the callback will provide the opportunity for some side
5030effect to happen or for the change to be rejected.
5031
5032The callbacks are named and associated with a function using the
5033U_BOOT_ENV_CALLBACK macro in your board or driver code.
5034
5035These callbacks are associated with variables in one of two ways. The
5036static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5037in the board configuration to a string that defines a list of
5038associations. The list must be in the following format:
5039
5040 entry = variable_name[:callback_name]
5041 list = entry[,list]
5042
5043If the callback name is not specified, then the callback is deleted.
5044Spaces are also allowed anywhere in the list.
5045
5046Callbacks can also be associated by defining the ".callbacks" variable
5047with the same list format above. Any association in ".callbacks" will
5048override any association in the static list. You can define
5049CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5050".callbacks" envirnoment variable in the default or embedded environment.
5051
5052
wdenk6c59edc2004-05-03 20:45:30 +00005053Command Line Parsing:
5054=====================
stroeseb9c17c52003-04-04 15:53:41 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056There are two different command line parsers available with U-Boot:
5057the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059Old, simple command line parser:
5060--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062- supports environment variables (through setenv / saveenv commands)
5063- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005064- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005065- special characters ('$', ';') can be escaped by prefixing with '\',
5066 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005067 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005068- You can also escape text by enclosing in single apostrophes, for example:
5069 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005070
wdenk6c59edc2004-05-03 20:45:30 +00005071Hush shell:
5072-----------
wdenkf4688a22003-05-28 08:06:31 +00005073
wdenk6c59edc2004-05-03 20:45:30 +00005074- similar to Bourne shell, with control structures like
5075 if...then...else...fi, for...do...done; while...do...done,
5076 until...do...done, ...
5077- supports environment ("global") variables (through setenv / saveenv
5078 commands) and local shell variables (through standard shell syntax
5079 "name=value"); only environment variables can be used with "run"
5080 command
wdenkf4688a22003-05-28 08:06:31 +00005081
wdenk6c59edc2004-05-03 20:45:30 +00005082General rules:
5083--------------
wdenkf4688a22003-05-28 08:06:31 +00005084
wdenk6c59edc2004-05-03 20:45:30 +00005085(1) If a command line (or an environment variable executed by a "run"
5086 command) contains several commands separated by semicolon, and
5087 one of these commands fails, then the remaining commands will be
5088 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005091 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005092 command will cause "run" to terminate, i. e. the remaining
5093 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095Note for Redundant Ethernet Interfaces:
5096=======================================
wdenkf4688a22003-05-28 08:06:31 +00005097
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005098Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005099such configurations and is capable of automatic selection of a
5100"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5103MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5104"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106If the network interface stores some valid MAC address (for instance
5107in SROM), this is used as default address if there is NO correspon-
5108ding setting in the environment; if the corresponding environment
5109variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111o If the SROM has a valid MAC address, and there is no address in the
5112 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114o If there is no valid address in the SROM, and a definition in the
5115 environment exists, then the value from the environment variable is
5116 used.
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118o If both the SROM and the environment contain a MAC address, and
5119 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121o If both the SROM and the environment contain a MAC address, and the
5122 addresses differ, the value from the environment is used and a
5123 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125o If neither SROM nor the environment contain a MAC address, an error
5126 is raised.
wdenkc6097192002-11-03 00:24:07 +00005127
Ben Warren6db991a2010-04-26 11:11:46 -07005128If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005129will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005130may be skipped by setting the appropriate 'ethmacskip' environment variable.
5131The naming convention is as follows:
5132"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005133
wdenk6c59edc2004-05-03 20:45:30 +00005134Image Formats:
5135==============
wdenkc6097192002-11-03 00:24:07 +00005136
Marian Balakowicz18710b82008-03-12 12:13:13 +01005137U-Boot is capable of booting (and performing other auxiliary operations on)
5138images in two formats:
5139
5140New uImage format (FIT)
5141-----------------------
5142
5143Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5144to Flattened Device Tree). It allows the use of images with multiple
5145components (several kernels, ramdisks, etc.), with contents protected by
5146SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5147
5148
5149Old uImage format
5150-----------------
5151
5152Old image format is based on binary files which can be basically anything,
5153preceded by a special header; see the definitions in include/image.h for
5154details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk6c59edc2004-05-03 20:45:30 +00005156* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5157 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005158 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5159 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5160 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005161* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005162 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5163 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005164* Compression Type (uncompressed, gzip, bzip2)
5165* Load Address
5166* Entry Point
5167* Image Name
5168* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170The header is marked by a special Magic Number, and both the header
5171and the data portions of the image are secured against corruption by
5172CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005173
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175Linux Support:
5176==============
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk6c59edc2004-05-03 20:45:30 +00005178Although U-Boot should support any OS or standalone application
5179easily, the main focus has always been on Linux during the design of
5180U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182U-Boot includes many features that so far have been part of some
5183special "boot loader" code within the Linux kernel. Also, any
5184"initrd" images to be used are no longer part of one big Linux image;
5185instead, kernel and "initrd" are separate images. This implementation
5186serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188- the same features can be used for other OS or standalone
5189 applications (for instance: using compressed images to reduce the
5190 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk6c59edc2004-05-03 20:45:30 +00005192- it becomes much easier to port new Linux kernel versions because
5193 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195- the same Linux kernel image can now be used with different "initrd"
5196 images; of course this also means that different kernel images can
5197 be run with the same "initrd". This makes testing easier (you don't
5198 have to build a new "zImage.initrd" Linux image when you just
5199 change a file in your "initrd"). Also, a field-upgrade of the
5200 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005201
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203Linux HOWTO:
5204============
wdenkc6097192002-11-03 00:24:07 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206Porting Linux to U-Boot based systems:
5207---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209U-Boot cannot save you from doing all the necessary modifications to
5210configure the Linux device drivers for use with your target hardware
5211(no, we don't intend to provide a full virtual machine interface to
5212Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005213
Stefan Roese88fbf932010-04-15 16:07:28 +02005214But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk6c59edc2004-05-03 20:45:30 +00005216Just make sure your machine specific header file (for instance
5217include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005218Information structure as we define in include/asm-<arch>/u-boot.h,
5219and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005220as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005221
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223Configuring the Linux kernel:
5224-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226No specific requirements for U-Boot. Make sure you have some root
5227device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk6c59edc2004-05-03 20:45:30 +00005230Building a Linux Image:
5231-----------------------
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk6c59edc2004-05-03 20:45:30 +00005233With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5234not used. If you use recent kernel source, a new build target
5235"uImage" will exist which automatically builds an image usable by
5236U-Boot. Most older kernels also have support for a "pImage" target,
5237which was introduced for our predecessor project PPCBoot and uses a
5238100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240Example:
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242 make TQM850L_config
5243 make oldconfig
5244 make dep
5245 make uImage
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247The "uImage" build target uses a special tool (in 'tools/mkimage') to
5248encapsulate a compressed Linux kernel image with header information,
5249CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk6c59edc2004-05-03 20:45:30 +00005251* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk6c59edc2004-05-03 20:45:30 +00005253* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk6c59edc2004-05-03 20:45:30 +00005255 ${CROSS_COMPILE}-objcopy -O binary \
5256 -R .note -R .comment \
5257 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005264
wdenk6c59edc2004-05-03 20:45:30 +00005265 mkimage -A ppc -O linux -T kernel -C gzip \
5266 -a 0 -e 0 -n "Linux Kernel Image" \
5267 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005268
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270The "mkimage" tool can also be used to create ramdisk images for use
5271with U-Boot, either separated from the Linux kernel image, or
5272combined into one file. "mkimage" encapsulates the images with a 64
5273byte header containing information about target architecture,
5274operating system, image type, compression method, entry points, time
5275stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk6c59edc2004-05-03 20:45:30 +00005277"mkimage" can be called in two ways: to verify existing images and
5278print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005279
wdenk6c59edc2004-05-03 20:45:30 +00005280In the first form (with "-l" option) mkimage lists the information
5281contained in the header of an existing U-Boot image; this includes
5282checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284 tools/mkimage -l image
5285 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287The second form (with "-d" option) is used to build a U-Boot image
5288from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005289
wdenk6c59edc2004-05-03 20:45:30 +00005290 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5291 -n name -d data_file image
5292 -A ==> set architecture to 'arch'
5293 -O ==> set operating system to 'os'
5294 -T ==> set image type to 'type'
5295 -C ==> set compression type 'comp'
5296 -a ==> set load address to 'addr' (hex)
5297 -e ==> set entry point to 'ep' (hex)
5298 -n ==> set image name to 'name'
5299 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005300
wdenkcd914452004-05-29 16:53:29 +00005301Right now, all Linux kernels for PowerPC systems use the same load
5302address (0x00000000), but the entry point address depends on the
5303kernel version:
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk6c59edc2004-05-03 20:45:30 +00005305- 2.2.x kernels have the entry point at 0x0000000C,
5306- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5311 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005312 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005313 > examples/uImage.TQM850L
5314 Image Name: 2.4.4 kernel for TQM850L
5315 Created: Wed Jul 19 02:34:59 2000
5316 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5317 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5318 Load Address: 0x00000000
5319 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk6c59edc2004-05-03 20:45:30 +00005321To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 -> tools/mkimage -l examples/uImage.TQM850L
5324 Image Name: 2.4.4 kernel for TQM850L
5325 Created: Wed Jul 19 02:34:59 2000
5326 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5327 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5328 Load Address: 0x00000000
5329 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331NOTE: for embedded systems where boot time is critical you can trade
5332speed for memory and install an UNCOMPRESSED image instead: this
5333needs more space in Flash, but boots much faster since it does not
5334need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005335
Stefan Roese88fbf932010-04-15 16:07:28 +02005336 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005337 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5338 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005339 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005340 > examples/uImage.TQM850L-uncompressed
5341 Image Name: 2.4.4 kernel for TQM850L
5342 Created: Wed Jul 19 02:34:59 2000
5343 Image Type: PowerPC Linux Kernel Image (uncompressed)
5344 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5345 Load Address: 0x00000000
5346 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005347
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5350when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005351
wdenk6c59edc2004-05-03 20:45:30 +00005352 -> tools/mkimage -n 'Simple Ramdisk Image' \
5353 > -A ppc -O linux -T ramdisk -C gzip \
5354 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5355 Image Name: Simple Ramdisk Image
5356 Created: Wed Jan 12 14:01:50 2000
5357 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5358 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5359 Load Address: 0x00000000
5360 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005361
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005362The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5363option performs the converse operation of the mkimage's second form (the "-d"
5364option). Given an image built by mkimage, the dumpimage extracts a "data file"
5365from the image:
5366
5367 tools/dumpimage -i image -p position data_file
5368 -i ==> extract from the 'image' a specific 'data_file', \
5369 indexed by 'position'
5370
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372Installing a Linux Image:
5373-------------------------
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375To downloading a U-Boot image over the serial (console) interface,
5376you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk6c59edc2004-05-03 20:45:30 +00005380The 'objcopy' does not understand the information in the U-Boot
5381image header, so the resulting S-Record file will be relative to
5382address 0x00000000. To load it to a given address, you need to
5383specify the target address as 'offset' parameter with the 'loads'
5384command.
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386Example: install the image to address 0x40100000 (which on the
5387TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391 .......... done
5392 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394 => loads 40100000
5395 ## Ready for S-Record download ...
5396 ~>examples/image.srec
5397 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5398 ...
5399 15989 15990 15991 15992
5400 [file transfer complete]
5401 [connected]
5402 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005403
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005406this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005407corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411 ## Checking Image at 40100000 ...
5412 Image Name: 2.2.13 for initrd on TQM850L
5413 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5414 Data Size: 335725 Bytes = 327 kB = 0 MB
5415 Load Address: 00000000
5416 Entry Point: 0000000c
5417 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005418
5419
wdenk6c59edc2004-05-03 20:45:30 +00005420Boot Linux:
5421-----------
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423The "bootm" command is used to boot an application that is stored in
5424memory (RAM or Flash). In case of a Linux kernel image, the contents
5425of the "bootargs" environment variable is passed to the kernel as
5426parameters. You can check and modify this variable using the
5427"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005428
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430 => printenv bootargs
5431 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433 => 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 +00005434
wdenk6c59edc2004-05-03 20:45:30 +00005435 => printenv bootargs
5436 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 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438 => bootm 40020000
5439 ## Booting Linux kernel at 40020000 ...
5440 Image Name: 2.2.13 for NFS on TQM850L
5441 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5442 Data Size: 381681 Bytes = 372 kB = 0 MB
5443 Load Address: 00000000
5444 Entry Point: 0000000c
5445 Verifying Checksum ... OK
5446 Uncompressing Kernel Image ... OK
5447 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
5448 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5449 time_init: decrementer frequency = 187500000/60
5450 Calibrating delay loop... 49.77 BogoMIPS
5451 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5452 ...
wdenkc6097192002-11-03 00:24:07 +00005453
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005454If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005455the memory addresses of both the kernel and the initrd image (PPBCOOT
5456format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk6c59edc2004-05-03 20:45:30 +00005460 ## Checking Image at 40100000 ...
5461 Image Name: 2.2.13 for initrd on TQM850L
5462 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5463 Data Size: 335725 Bytes = 327 kB = 0 MB
5464 Load Address: 00000000
5465 Entry Point: 0000000c
5466 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468 ## Checking Image at 40200000 ...
5469 Image Name: Simple Ramdisk Image
5470 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5471 Data Size: 566530 Bytes = 553 kB = 0 MB
5472 Load Address: 00000000
5473 Entry Point: 00000000
5474 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk6c59edc2004-05-03 20:45:30 +00005476 => bootm 40100000 40200000
5477 ## Booting Linux kernel at 40100000 ...
5478 Image Name: 2.2.13 for initrd on TQM850L
5479 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5480 Data Size: 335725 Bytes = 327 kB = 0 MB
5481 Load Address: 00000000
5482 Entry Point: 0000000c
5483 Verifying Checksum ... OK
5484 Uncompressing Kernel Image ... OK
5485 ## Loading RAMDisk Image at 40200000 ...
5486 Image Name: Simple Ramdisk Image
5487 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5488 Data Size: 566530 Bytes = 553 kB = 0 MB
5489 Load Address: 00000000
5490 Entry Point: 00000000
5491 Verifying Checksum ... OK
5492 Loading Ramdisk ... OK
5493 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
5494 Boot arguments: root=/dev/ram
5495 time_init: decrementer frequency = 187500000/60
5496 Calibrating delay loop... 49.77 BogoMIPS
5497 ...
5498 RAMDISK: Compressed image found at block 0
5499 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005500
wdenk6c59edc2004-05-03 20:45:30 +00005501 bash#
wdenkc6097192002-11-03 00:24:07 +00005502
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005503Boot Linux and pass a flat device tree:
5504-----------
5505
5506First, U-Boot must be compiled with the appropriate defines. See the section
5507titled "Linux Kernel Interface" above for a more in depth explanation. The
5508following is an example of how to start a kernel and pass an updated
5509flat device tree:
5510
5511=> print oftaddr
5512oftaddr=0x300000
5513=> print oft
5514oft=oftrees/mpc8540ads.dtb
5515=> tftp $oftaddr $oft
5516Speed: 1000, full duplex
5517Using TSEC0 device
5518TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5519Filename 'oftrees/mpc8540ads.dtb'.
5520Load address: 0x300000
5521Loading: #
5522done
5523Bytes transferred = 4106 (100a hex)
5524=> tftp $loadaddr $bootfile
5525Speed: 1000, full duplex
5526Using TSEC0 device
5527TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5528Filename 'uImage'.
5529Load address: 0x200000
5530Loading:############
5531done
5532Bytes transferred = 1029407 (fb51f hex)
5533=> print loadaddr
5534loadaddr=200000
5535=> print oftaddr
5536oftaddr=0x300000
5537=> bootm $loadaddr - $oftaddr
5538## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005539 Image Name: Linux-2.6.17-dirty
5540 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5541 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005542 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005543 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005544 Verifying Checksum ... OK
5545 Uncompressing Kernel Image ... OK
5546Booting using flat device tree at 0x300000
5547Using MPC85xx ADS machine description
5548Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5549[snip]
5550
5551
wdenk6c59edc2004-05-03 20:45:30 +00005552More About U-Boot Image Types:
5553------------------------------
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557 "Standalone Programs" are directly runnable in the environment
5558 provided by U-Boot; it is expected that (if they behave
5559 well) you can continue to work in U-Boot after return from
5560 the Standalone Program.
5561 "OS Kernel Images" are usually images of some Embedded OS which
5562 will take over control completely. Usually these programs
5563 will install their own set of exception handlers, device
5564 drivers, set up the MMU, etc. - this means, that you cannot
5565 expect to re-enter U-Boot except by resetting the CPU.
5566 "RAMDisk Images" are more or less just data blocks, and their
5567 parameters (address, size) are passed to an OS kernel that is
5568 being started.
5569 "Multi-File Images" contain several images, typically an OS
5570 (Linux) kernel image and one or more data images like
5571 RAMDisks. This construct is useful for instance when you want
5572 to boot over the network using BOOTP etc., where the boot
5573 server provides just a single image file, but you want to get
5574 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576 "Multi-File Images" start with a list of image sizes, each
5577 image size (in bytes) specified by an "uint32_t" in network
5578 byte order. This list is terminated by an "(uint32_t)0".
5579 Immediately after the terminating 0 follow the images, one by
5580 one, all aligned on "uint32_t" boundaries (size rounded up to
5581 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583 "Firmware Images" are binary images containing firmware (like
5584 U-Boot or FPGA images) which usually will be programmed to
5585 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005586
wdenk6c59edc2004-05-03 20:45:30 +00005587 "Script files" are command sequences that will be executed by
5588 U-Boot's command interpreter; this feature is especially
5589 useful when you configure U-Boot to use a real shell (hush)
5590 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005591
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005592Booting the Linux zImage:
5593-------------------------
5594
5595On some platforms, it's possible to boot Linux zImage. This is done
5596using the "bootz" command. The syntax of "bootz" command is the same
5597as the syntax of "bootm" command.
5598
Tom Rini45f46d12013-05-16 11:40:11 -04005599Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005600kernel with raw initrd images. The syntax is slightly different, the
5601address of the initrd must be augmented by it's size, in the following
5602format: "<initrd addres>:<initrd size>".
5603
stroeseb9c17c52003-04-04 15:53:41 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605Standalone HOWTO:
5606=================
stroeseb9c17c52003-04-04 15:53:41 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608One of the features of U-Boot is that you can dynamically load and
5609run "standalone" applications, which can use some resources of
5610U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614"Hello World" Demo:
5615-------------------
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617'examples/hello_world.c' contains a small "Hello World" Demo
5618application; it is automatically compiled when you build U-Boot.
5619It's configured to run at address 0x00040004, so you can play with it
5620like that:
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk6c59edc2004-05-03 20:45:30 +00005622 => loads
5623 ## Ready for S-Record download ...
5624 ~>examples/hello_world.srec
5625 1 2 3 4 5 6 7 8 9 10 11 ...
5626 [file transfer complete]
5627 [connected]
5628 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk6c59edc2004-05-03 20:45:30 +00005630 => go 40004 Hello World! This is a test.
5631 ## Starting application at 0x00040004 ...
5632 Hello World
5633 argc = 7
5634 argv[0] = "40004"
5635 argv[1] = "Hello"
5636 argv[2] = "World!"
5637 argv[3] = "This"
5638 argv[4] = "is"
5639 argv[5] = "a"
5640 argv[6] = "test."
5641 argv[7] = "<NULL>"
5642 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005645
wdenk6c59edc2004-05-03 20:45:30 +00005646Another example, which demonstrates how to register a CPM interrupt
5647handler with the U-Boot code, can be found in 'examples/timer.c'.
5648Here, a CPM timer is set up to generate an interrupt every second.
5649The interrupt service routine is trivial, just printing a '.'
5650character, but this is just a demo program. The application can be
5651controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653 ? - print current values og the CPM Timer registers
5654 b - enable interrupts and start timer
5655 e - stop timer and disable interrupts
5656 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658 => loads
5659 ## Ready for S-Record download ...
5660 ~>examples/timer.srec
5661 1 2 3 4 5 6 7 8 9 10 11 ...
5662 [file transfer complete]
5663 [connected]
5664 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666 => go 40004
5667 ## Starting application at 0x00040004 ...
5668 TIMERS=0xfff00980
5669 Using timer 1
5670 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672Hit 'b':
5673 [q, b, e, ?] Set interval 1000000 us
5674 Enabling timer
5675Hit '?':
5676 [q, b, e, ?] ........
5677 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5678Hit '?':
5679 [q, b, e, ?] .
5680 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5681Hit '?':
5682 [q, b, e, ?] .
5683 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5684Hit '?':
5685 [q, b, e, ?] .
5686 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5687Hit 'e':
5688 [q, b, e, ?] ...Stopping timer
5689Hit 'q':
5690 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005691
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk6c59edc2004-05-03 20:45:30 +00005693Minicom warning:
5694================
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696Over time, many people have reported problems when trying to use the
5697"minicom" terminal emulation program for serial download. I (wd)
5698consider minicom to be broken, and recommend not to use it. Under
5699Unix, I recommend to use C-Kermit for general purpose use (and
5700especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005701use "cu" for S-Record download ("loads" command). See
5702http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5703for help with kermit.
5704
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706Nevertheless, if you absolutely want to use it try adding this
5707configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709 Name Program Name U/D FullScr IO-Red. Multi
5710 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5711 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005712
wdenk8dba0502003-03-31 16:34:49 +00005713
wdenk6c59edc2004-05-03 20:45:30 +00005714NetBSD Notes:
5715=============
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717Starting at version 0.9.2, U-Boot supports NetBSD both as host
5718(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720Building requires a cross environment; it is known to work on
5721NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5722need gmake since the Makefiles are not compatible with BSD make).
5723Note that the cross-powerpc package does not install include files;
5724attempting to build U-Boot will fail because <machine/ansi.h> is
5725missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727 # cd /usr/pkg/cross/powerpc-netbsd/include
5728 # mkdir powerpc
5729 # ln -s powerpc machine
5730 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5731 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733Native builds *don't* work due to incompatibilities between native
5734and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736Booting assumes that (the first part of) the image booted is a
5737stage-2 loader which in turn loads and then invokes the kernel
5738proper. Loader sources will eventually appear in the NetBSD source
5739tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005740meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005741
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743Implementation Internals:
5744=========================
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746The following is not intended to be a complete description of every
5747implementation detail. However, it should help to understand the
5748inner workings of U-Boot and make it easier to port it to custom
5749hardware.
wdenkc6097192002-11-03 00:24:07 +00005750
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk6c59edc2004-05-03 20:45:30 +00005752Initial Stack, Global Data:
5753---------------------------
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755The implementation of U-Boot is complicated by the fact that U-Boot
5756starts running out of ROM (flash memory), usually without access to
5757system RAM (because the memory controller is not initialized yet).
5758This means that we don't have writable Data or BSS segments, and BSS
5759is not initialized as zero. To be able to get a C environment working
5760at all, we have to allocate at least a minimal stack. Implementation
5761options for this are defined and restricted by the CPU used: Some CPU
5762models provide on-chip memory (like the IMMR area on MPC8xx and
5763MPC826x processors), on others (parts of) the data cache can be
5764locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005765
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005766 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005767 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5770 From: "Chris Hallinan" <clh@net1plus.com>
5771 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5772 ...
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk6c59edc2004-05-03 20:45:30 +00005774 Correct me if I'm wrong, folks, but the way I understand it
5775 is this: Using DCACHE as initial RAM for Stack, etc, does not
5776 require any physical RAM backing up the cache. The cleverness
5777 is that the cache is being used as a temporary supply of
5778 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005779 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005780 can see how this works by studying the cache architecture and
5781 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5784 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005785 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005786 option should work for you. Using CS 4 should be fine if your
5787 board designers haven't used it for something that would
5788 cause you grief during the initial boot! It is frequently not
5789 used.
wdenkc6097192002-11-03 00:24:07 +00005790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005791 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005792 with your processor/board/system design. The default value
5793 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005794 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005795 than your SDRAM module. If you have a 64MB SDRAM module, set
5796 it above 400_0000. Just make sure your board has no resources
5797 that are supposed to respond to that address! That code in
5798 start.S has been around a while and should work as is when
5799 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801 -Chris Hallinan
5802 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804It is essential to remember this, since it has some impact on the C
5805code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807* Initialized global data (data segment) is read-only. Do not attempt
5808 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005809
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005810* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005811 as zero data - BSS segment) at all - this is undefined, initiali-
5812 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814* Stack space is very limited. Avoid big data buffers or things like
5815 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817Having only the stack as writable memory limits means we cannot use
5818normal global data to share information beween the code. But it
5819turned out that the implementation of U-Boot can be greatly
5820simplified by making a global data structure (gd_t) available to all
5821functions. We could pass a pointer to this data as argument to _all_
5822functions, but this would bloat the code. Instead we use a feature of
5823the GCC compiler (Global Register Variables) to share the data: we
5824place a pointer (gd) to the global data into a register which we
5825reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827When choosing a register for such a purpose we are restricted by the
5828relevant (E)ABI specifications for the current architecture, and by
5829GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831For PowerPC, the following registers have specific use:
5832 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005833 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005834 R3-R4: parameter passing and return values
5835 R5-R10: parameter passing
5836 R13: small data area pointer
5837 R30: GOT pointer
5838 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005839
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005840 (U-Boot also uses R12 as internal GOT pointer. r12
5841 is a volatile register so r12 needs to be reset when
5842 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005843
Wolfgang Denk69c09642008-02-14 22:43:22 +01005844 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk6c59edc2004-05-03 20:45:30 +00005846 Note: on PPC, we could use a static initializer (since the
5847 address of the global data structure is known at compile time),
5848 but it turned out that reserving a register results in somewhat
5849 smaller code - although the code savings are not that big (on
5850 average for all boards 752 bytes for the whole U-Boot image,
5851 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005852
Robin Getz2773d5f2009-08-17 15:23:02 +00005853On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005854 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5855
Robin Getz2773d5f2009-08-17 15:23:02 +00005856 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005857
wdenk6c59edc2004-05-03 20:45:30 +00005858On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005859
wdenk6c59edc2004-05-03 20:45:30 +00005860 R0: function argument word/integer result
5861 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005862 R9: platform specific
5863 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005864 R11: argument (frame) pointer
5865 R12: temporary workspace
5866 R13: stack pointer
5867 R14: link register
5868 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005869
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005870 ==> U-Boot will use R9 to hold a pointer to the global data
5871
5872 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005873
Thomas Chou8fa38582010-05-21 11:08:03 +08005874On Nios II, the ABI is documented here:
5875 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5876
5877 ==> U-Boot will use gp to hold a pointer to the global data
5878
5879 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5880 to access small data sections, so gp is free.
5881
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005882On NDS32, the following registers are used:
5883
5884 R0-R1: argument/return
5885 R2-R5: argument
5886 R15: temporary register for assembler
5887 R16: trampoline register
5888 R28: frame pointer (FP)
5889 R29: global pointer (GP)
5890 R30: link register (LP)
5891 R31: stack pointer (SP)
5892 PC: program counter (PC)
5893
5894 ==> U-Boot will use R10 to hold a pointer to the global data
5895
Wolfgang Denk6405a152006-03-31 18:32:53 +02005896NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5897or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk6c59edc2004-05-03 20:45:30 +00005899Memory Management:
5900------------------
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk6c59edc2004-05-03 20:45:30 +00005902U-Boot runs in system state and uses physical addresses, i.e. the
5903MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905The available memory is mapped to fixed addresses using the memory
5906controller. In this process, a contiguous block is formed for each
5907memory type (Flash, SDRAM, SRAM), even when it consists of several
5908physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk6c59edc2004-05-03 20:45:30 +00005910U-Boot is installed in the first 128 kB of the first Flash bank (on
5911TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5912booting and sizing and initializing DRAM, the code relocates itself
5913to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005914memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005915configuration setting]. Below that, a structure with global Board
5916Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005917
wdenk6c59edc2004-05-03 20:45:30 +00005918Additionally, some exception handler code is copied to the low 8 kB
5919of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk6c59edc2004-05-03 20:45:30 +00005921So a typical memory configuration with 16 MB of DRAM could look like
5922this:
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924 0x0000 0000 Exception Vector code
5925 :
5926 0x0000 1FFF
5927 0x0000 2000 Free for Application Use
5928 :
5929 :
wdenkc6097192002-11-03 00:24:07 +00005930
wdenk6c59edc2004-05-03 20:45:30 +00005931 :
5932 :
5933 0x00FB FF20 Monitor Stack (Growing downward)
5934 0x00FB FFAC Board Info Data and permanent copy of global data
5935 0x00FC 0000 Malloc Arena
5936 :
5937 0x00FD FFFF
5938 0x00FE 0000 RAM Copy of Monitor Code
5939 ... eventually: LCD or video framebuffer
5940 ... eventually: pRAM (Protected RAM - unchanged by reset)
5941 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005942
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944System Initialization:
5945----------------------
wdenkc6097192002-11-03 00:24:07 +00005946
wdenk6c59edc2004-05-03 20:45:30 +00005947In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005948(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005949configuration for CS0# this is a mirror of the onboard Flash memory.
5950To be able to re-map memory U-Boot then jumps to its link address.
5951To be able to implement the initialization code in C, a (small!)
5952initial stack is set up in the internal Dual Ported RAM (in case CPUs
5953which provide such a feature like MPC8xx or MPC8260), or in a locked
5954part of the data cache. After that, U-Boot initializes the CPU core,
5955the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005956
wdenk6c59edc2004-05-03 20:45:30 +00005957Next, all (potentially) available memory banks are mapped using a
5958preliminary mapping. For example, we put them on 512 MB boundaries
5959(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5960on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5961programmed for SDRAM access. Using the temporary configuration, a
5962simple memory test is run that determines the size of the SDRAM
5963banks.
wdenkc6097192002-11-03 00:24:07 +00005964
wdenk6c59edc2004-05-03 20:45:30 +00005965When there is more than one SDRAM bank, and the banks are of
5966different size, the largest is mapped first. For equal size, the first
5967bank (CS2#) is mapped first. The first mapping is always for address
59680x00000000, with any additional banks following immediately to create
5969contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971Then, the monitor installs itself at the upper end of the SDRAM area
5972and allocates memory for use by malloc() and for the global Board
5973Info data; also, the exception vector code is copied to the low RAM
5974pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005975
wdenk6c59edc2004-05-03 20:45:30 +00005976Only after this relocation will you have a "normal" C environment;
5977until that you are restricted in several ways, mostly because you are
5978running from ROM, and because the code will have to be relocated to a
5979new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005980
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk6c59edc2004-05-03 20:45:30 +00005982U-Boot Porting Guide:
5983----------------------
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5986list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005987
wdenkc6097192002-11-03 00:24:07 +00005988
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005989int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005990{
5991 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005992
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005993 signal(SIGALRM, no_more_time);
5994 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk6c59edc2004-05-03 20:45:30 +00005996 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005997 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005998 return 0;
5999 }
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006002
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006003 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006004
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006005 if (clueless)
6006 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008 while (learning) {
6009 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006010 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6011 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006012 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006013 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006014 }
wdenkc6097192002-11-03 00:24:07 +00006015
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006016 if (available_money > toLocalCurrency ($2500))
6017 Buy a BDI3000;
6018 else
wdenk6c59edc2004-05-03 20:45:30 +00006019 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006020
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006021 if (a similar board exists) { /* hopefully... */
6022 cp -a board/<similar> board/<myboard>
6023 cp include/configs/<similar>.h include/configs/<myboard>.h
6024 } else {
6025 Create your own board support subdirectory;
6026 Create your own board include/configs/<myboard>.h file;
6027 }
6028 Edit new board/<myboard> files
6029 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006030
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006031 while (!accepted) {
6032 while (!running) {
6033 do {
6034 Add / modify source code;
6035 } until (compiles);
6036 Debug;
6037 if (clueless)
6038 email("Hi, I am having problems...");
6039 }
6040 Send patch file to the U-Boot email list;
6041 if (reasonable critiques)
6042 Incorporate improvements from email list code review;
6043 else
6044 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006045 }
wdenkc6097192002-11-03 00:24:07 +00006046
wdenk6c59edc2004-05-03 20:45:30 +00006047 return 0;
6048}
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050void no_more_time (int sig)
6051{
6052 hire_a_guru();
6053}
wdenkc6097192002-11-03 00:24:07 +00006054
wdenkc6097192002-11-03 00:24:07 +00006055
wdenk6c59edc2004-05-03 20:45:30 +00006056Coding Standards:
6057-----------------
wdenkc6097192002-11-03 00:24:07 +00006058
wdenk6c59edc2004-05-03 20:45:30 +00006059All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006060coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006061"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006062
6063Source files originating from a different project (for example the
6064MTD subsystem) are generally exempt from these guidelines and are not
6065reformated to ease subsequent migration to newer versions of those
6066sources.
wdenkc6097192002-11-03 00:24:07 +00006067
Detlev Zundelaa63d482006-09-01 15:39:02 +02006068Please note that U-Boot is implemented in C (and to some small parts in
6069Assembler); no C++ is used, so please do not use C++ style comments (//)
6070in your code.
wdenkad276f22004-01-04 16:28:35 +00006071
wdenk6c59edc2004-05-03 20:45:30 +00006072Please also stick to the following formatting rules:
6073- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006074- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006075- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006076- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006077- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006078
wdenk6c59edc2004-05-03 20:45:30 +00006079Submissions which do not conform to the standards may be returned
6080with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006081
wdenkc6097192002-11-03 00:24:07 +00006082
wdenk6c59edc2004-05-03 20:45:30 +00006083Submitting Patches:
6084-------------------
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086Since the number of patches for U-Boot is growing, we need to
6087establish some rules. Submissions which do not conform to these rules
6088may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006089
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006090Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006091
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006092Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6093see http://lists.denx.de/mailman/listinfo/u-boot
6094
wdenk6c59edc2004-05-03 20:45:30 +00006095When you send a patch, please include the following information with
6096it:
wdenkc6097192002-11-03 00:24:07 +00006097
wdenk6c59edc2004-05-03 20:45:30 +00006098* For bug fixes: a description of the bug and how your patch fixes
6099 this bug. Please try to include a way of demonstrating that the
6100 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006101
wdenk6c59edc2004-05-03 20:45:30 +00006102* For new features: a description of the feature and your
6103 implementation.
wdenkc6097192002-11-03 00:24:07 +00006104
wdenk6c59edc2004-05-03 20:45:30 +00006105* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006106
wdenk6c59edc2004-05-03 20:45:30 +00006107* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00006108
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006109* When you add support for a new board, don't forget to add a
6110 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006111
wdenk6c59edc2004-05-03 20:45:30 +00006112* If your patch adds new configuration options, don't forget to
6113 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006114
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006115* The patch itself. If you are using git (which is *strongly*
6116 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006117 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006118 the U-Boot mailing list, you will avoid most of the common problems
6119 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006120
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006121 If you cannot use git, use "diff -purN OLD NEW". If your version of
6122 diff does not support these options, then get the latest version of
6123 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006124
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006125 The current directory when running this command shall be the parent
6126 directory of the U-Boot source tree (i. e. please make sure that
6127 your patch includes sufficient directory information for the
6128 affected files).
6129
6130 We prefer patches as plain text. MIME attachments are discouraged,
6131 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133* If one logical set of modifications affects or creates several
6134 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006135
wdenk6c59edc2004-05-03 20:45:30 +00006136* Changesets that contain different, unrelated modifications shall be
6137 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006138
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk6c59edc2004-05-03 20:45:30 +00006140Notes:
wdenkc6097192002-11-03 00:24:07 +00006141
wdenk6c59edc2004-05-03 20:45:30 +00006142* Before sending the patch, run the MAKEALL script on your patched
6143 source tree and make sure that no errors or warnings are reported
6144 for any of the boards.
6145
6146* Keep your modifications to the necessary minimum: A patch
6147 containing several unrelated changes or arbitrary reformats will be
6148 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006149
wdenk6c59edc2004-05-03 20:45:30 +00006150* If you modify existing code, make sure that your new code does not
6151 add to the memory footprint of the code ;-) Small is beautiful!
6152 When adding new features, these should compile conditionally only
6153 (using #ifdef), and the resulting code with the new feature
6154 disabled must not need more memory than the old code without your
6155 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006156
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006157* Remember that there is a size limit of 100 kB per message on the
6158 u-boot mailing list. Bigger patches will be moderated. If they are
6159 reasonable and not too big, they will be acknowledged. But patches
6160 bigger than the size limit should be avoided.