blob: 3c233db068c42e004c2350efecc40586ca149b8b [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
144 /ixp Files specific to Intel XScale IXP CPUs
145 /pxa Files specific to Intel XScale PXA CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500146 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
147 /lib Architecture specific library files
148 /avr32 Files generic to AVR32 architecture
149 /cpu CPU specific files
150 /lib Architecture specific library files
151 /blackfin Files generic to Analog Devices Blackfin architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500154 /m68k Files generic to m68k architecture
155 /cpu CPU specific files
156 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
157 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
158 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
159 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
160 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
161 /lib Architecture specific library files
162 /microblaze Files generic to microblaze architecture
163 /cpu CPU specific files
164 /lib Architecture specific library files
165 /mips Files generic to MIPS architecture
166 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200167 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800168 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500169 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000170 /nds32 Files generic to NDS32 architecture
171 /cpu CPU specific files
172 /n1213 Files specific to Andes Technology N1213 CPUs
173 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500174 /nios2 Files generic to Altera NIOS2 architecture
175 /cpu CPU specific files
176 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400177 /openrisc Files generic to OpenRISC architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200180 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500181 /cpu CPU specific files
182 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
183 /mpc5xx Files specific to Freescale MPC5xx CPUs
184 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
185 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500186 /mpc824x Files specific to Freescale MPC824x CPUs
187 /mpc8260 Files specific to Freescale MPC8260 CPUs
188 /mpc85xx Files specific to Freescale MPC85xx CPUs
189 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
190 /lib Architecture specific library files
191 /sh Files generic to SH architecture
192 /cpu CPU specific files
193 /sh2 Files specific to sh2 CPUs
194 /sh3 Files specific to sh3 CPUs
195 /sh4 Files specific to sh4 CPUs
196 /lib Architecture specific library files
197 /sparc Files generic to SPARC architecture
198 /cpu CPU specific files
199 /leon2 Files specific to Gaisler LEON2 SPARC CPU
200 /leon3 Files specific to Gaisler LEON3 SPARC CPU
201 /lib Architecture specific library files
Robert P. J. Daya269c932013-09-15 18:34:15 -0400202 /x86 Files generic to x86 architecture
203 /cpu CPU specific files
204 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500205/api Machine/arch independent API for external apps
206/board Board dependent files
207/common Misc architecture independent functions
208/disk Code for disk drive partition handling
209/doc Documentation (don't expect too much)
210/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400211/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500212/examples Example code for standalone applications, etc.
213/fs Filesystem code (cramfs, ext2, jffs2, etc.)
214/include Header Files
215/lib Files generic to all architectures
216 /libfdt Library files to support flattened device trees
217 /lzma Library files to support LZMA decompression
218 /lzo Library files to support LZO decompression
219/net Networking code
220/post Power On Self Test
Robert P. J. Daya269c932013-09-15 18:34:15 -0400221/spl Secondary Program Loader framework
Peter Tysere4d1abc2010-04-12 22:28:21 -0500222/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000223
wdenkc6097192002-11-03 00:24:07 +0000224Software Configuration:
225=======================
226
227Configuration is usually done using C preprocessor defines; the
228rationale behind that is to avoid dead code whenever possible.
229
230There are two classes of configuration variables:
231
232* Configuration _OPTIONS_:
233 These are selectable by the user and have names beginning with
234 "CONFIG_".
235
236* Configuration _SETTINGS_:
237 These depend on the hardware etc. and should not be meddled with if
238 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200239 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000240
241Later we will add a configuration tool - probably similar to or even
242identical to what's used for the Linux kernel. Right now, we have to
243do the configuration by hand, which means creating some symbolic
244links and editing some configuration files. We use the TQM8xxL boards
245as an example here.
246
247
248Selection of Processor Architecture and Board Type:
249---------------------------------------------------
250
251For all supported boards there are ready-to-use default
252configurations available; just type "make <board_name>_config".
253
254Example: For a TQM823L module type:
255
256 cd u-boot
257 make TQM823L_config
258
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200259For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000260e.g. "make cogent_mpc8xx_config". And also configure the cogent
261directory according to the instructions in cogent/README.
262
263
264Configuration Options:
265----------------------
266
267Configuration depends on the combination of board and CPU type; all
268such information is kept in a configuration file
269"include/configs/<board_name>.h".
270
271Example: For a TQM823L module, all configuration settings are in
272"include/configs/TQM823L.h".
273
274
wdenk1272e232002-11-10 22:06:23 +0000275Many of the options are named exactly as the corresponding Linux
276kernel configuration options. The intention is to make it easier to
277build a config tool - later.
278
279
wdenkc6097192002-11-03 00:24:07 +0000280The following options need to be configured:
281
Kim Phillips203fee32007-08-10 13:28:25 -0500282- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000283
Kim Phillips203fee32007-08-10 13:28:25 -0500284- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200285
286- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100287 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000288
289- CPU Module Type: (if CONFIG_COGENT is defined)
290 Define exactly one of
291 CONFIG_CMA286_60_OLD
292--- FIXME --- not tested yet:
293 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294 CONFIG_CMA287_23, CONFIG_CMA287_50
295
296- Motherboard Type: (if CONFIG_COGENT is defined)
297 Define exactly one of
298 CONFIG_CMA101, CONFIG_CMA102
299
300- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301 Define one or more of
302 CONFIG_CMA302
303
304- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305 Define one or more of
306 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200307 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000308 a "rotator" |\-/|\-/
309
wdenk2bb11052003-07-17 23:16:40 +0000310- Board flavour: (if CONFIG_MPC8260ADS is defined)
311 CONFIG_ADSTYPE
312 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200313 CONFIG_SYS_8260ADS - original MPC8260ADS
314 CONFIG_SYS_8266ADS - MPC8266ADS
315 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
316 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000317
Lei Wen20014762011-02-09 18:06:58 +0530318- Marvell Family Member
319 CONFIG_SYS_MVFS - define it if you want to enable
320 multiple fs option at one time
321 for marvell soc family
322
wdenkc6097192002-11-03 00:24:07 +0000323- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000324 Define exactly one of
325 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000326
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
333 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000334
wdenk20bddb32004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000342
wdenk544e9732004-02-06 23:19:44 +0000343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000349
Heiko Schocher734f0272009-03-12 07:37:15 +0100350 CONFIG_SYS_DELAYED_ICACHE
351
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
354
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000356 CONFIG_SYS_PPC64
357
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
361
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala179b1b22011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000373 CONFIG_SYS_PPC_E500_DEBUG_TLB
374
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
380 purpose.
381
Scott Wood80806962012-08-14 10:14:53 +0000382 CONFIG_SYS_FSL_ERRATUM_A004510
383
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
387
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
390
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
393
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
398
399 See Freescale App Note 4493 for more information about
400 this erratum.
401
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
404 requred during NOR boot.
405
Scott Wood80806962012-08-14 10:14:53 +0000406 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
407
408 This is the value to write into CCSR offset 0x18600
409 according to the A004510 workaround.
410
Priyanka Jainc73b9032013-07-02 09:21:04 +0530411 CONFIG_SYS_FSL_DSP_DDR_ADDR
412 This value denotes start offset of DDR memory which is
413 connected exclusively to the DSP cores.
414
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530415 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416 This value denotes start offset of M2 memory
417 which is directly connected to the DSP core.
418
Priyanka Jainc73b9032013-07-02 09:21:04 +0530419 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
420 This value denotes start offset of M3 memory which is directly
421 connected to the DSP core.
422
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530423 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424 This value denotes start offset of DSP CCSR space.
425
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000426- Generic CPU options:
427 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
428
429 Defines the endianess of the CPU. Implementation of those
430 values is arch specific.
431
York Sunf0626592013-09-30 09:22:09 -0700432 CONFIG_SYS_FSL_DDR
433 Freescale DDR driver in use. This type of DDR controller is
434 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
435 SoCs.
436
437 CONFIG_SYS_FSL_DDR_ADDR
438 Freescale DDR memory-mapped register base.
439
440 CONFIG_SYS_FSL_DDR_EMU
441 Specify emulator support for DDR. Some DDR features such as
442 deskew training are not available.
443
444 CONFIG_SYS_FSL_DDRC_GEN1
445 Freescale DDR1 controller.
446
447 CONFIG_SYS_FSL_DDRC_GEN2
448 Freescale DDR2 controller.
449
450 CONFIG_SYS_FSL_DDRC_GEN3
451 Freescale DDR3 controller.
452
York Sun461c9392013-09-30 14:20:51 -0700453 CONFIG_SYS_FSL_DDRC_ARM_GEN3
454 Freescale DDR3 controller for ARM-based SoCs.
455
York Sunf0626592013-09-30 09:22:09 -0700456 CONFIG_SYS_FSL_DDR1
457 Board config to use DDR1. It can be enabled for SoCs with
458 Freescale DDR1 or DDR2 controllers, depending on the board
459 implemetation.
460
461 CONFIG_SYS_FSL_DDR2
462 Board config to use DDR2. It can be eanbeld for SoCs with
463 Freescale DDR2 or DDR3 controllers, depending on the board
464 implementation.
465
466 CONFIG_SYS_FSL_DDR3
467 Board config to use DDR3. It can be enabled for SoCs with
468 Freescale DDR3 controllers.
469
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100470- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200471 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100472
473 Defines the Monahans run mode to oscillator
474 ratio. Valid values are 8, 16, 24, 31. The core
475 frequency is this value multiplied by 13 MHz.
476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200477 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200478
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100479 Defines the Monahans turbo mode to oscillator
480 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200481 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100482 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200483
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200484- MIPS CPU options:
485 CONFIG_SYS_INIT_SP_OFFSET
486
487 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
488 pointer. This is needed for the temporary stack before
489 relocation.
490
491 CONFIG_SYS_MIPS_CACHE_MODE
492
493 Cache operation mode for the MIPS CPU.
494 See also arch/mips/include/asm/mipsregs.h.
495 Possible values are:
496 CONF_CM_CACHABLE_NO_WA
497 CONF_CM_CACHABLE_WA
498 CONF_CM_UNCACHED
499 CONF_CM_CACHABLE_NONCOHERENT
500 CONF_CM_CACHABLE_CE
501 CONF_CM_CACHABLE_COW
502 CONF_CM_CACHABLE_CUW
503 CONF_CM_CACHABLE_ACCELERATED
504
505 CONFIG_SYS_XWAY_EBU_BOOTCFG
506
507 Special option for Lantiq XWAY SoCs for booting from NOR flash.
508 See also arch/mips/cpu/mips32/start.S.
509
510 CONFIG_XWAY_SWAP_BYTES
511
512 Enable compilation of tools/xway-swap-bytes needed for Lantiq
513 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
514 be swapped if a flash programmer is used.
515
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000516- ARM options:
517 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
518
519 Select high exception vectors of the ARM core, e.g., do not
520 clear the V bit of the c1 register of CP15.
521
Aneesh Vb8e40802012-03-08 07:20:19 +0000522 CONFIG_SYS_THUMB_BUILD
523
524 Use this flag to build U-Boot using the Thumb instruction
525 set for ARM architectures. Thumb instruction set provides
526 better code density. For ARM architectures that support
527 Thumb2 this flag will result in Thumb2 code generated by
528 GCC.
529
Stephen Warrenc63c3502013-03-04 13:29:40 +0000530 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000531 CONFIG_ARM_ERRATA_742230
532 CONFIG_ARM_ERRATA_743622
533 CONFIG_ARM_ERRATA_751472
534
535 If set, the workarounds for these ARM errata are applied early
536 during U-Boot startup. Note that these options force the
537 workarounds to be applied; no CPU-type/version detection
538 exists, unlike the similar options in the Linux kernel. Do not
539 set these options unless they apply!
540
Stephen Warren445d56c2013-03-27 17:06:41 +0000541- CPU timer options:
542 CONFIG_SYS_HZ
543
544 The frequency of the timer returned by get_timer().
545 get_timer() must operate in milliseconds and this CONFIG
546 option must be set to 1000.
547
wdenk9b7f3842003-10-09 20:09:04 +0000548- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000549 CONFIG_CLOCKS_IN_MHZ
550
551 U-Boot stores all clock information in Hz
552 internally. For binary compatibility with older Linux
553 kernels (which expect the clocks passed in the
554 bd_info data to be in MHz) the environment variable
555 "clocks_in_mhz" can be defined so that U-Boot
556 converts clock data to MHZ before passing it to the
557 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000558 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100559 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000560 default environment.
561
wdenk9b7f3842003-10-09 20:09:04 +0000562 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
563
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200564 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000565 expect it to be in bytes, others in MB.
566 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
567
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400568 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200569
570 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400571 passed using flattened device trees (based on open firmware
572 concepts).
573
574 CONFIG_OF_LIBFDT
575 * New libfdt-based support
576 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500577 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400578
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200579 OF_CPU - The proper name of the cpus node (only required for
580 MPC512X and MPC5xxx based boards).
581 OF_SOC - The proper name of the soc node (only required for
582 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200583 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600584 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200585
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200586 boards with QUICC Engines require OF_QE to set UCC MAC
587 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500588
Kumar Gala1e26aa52006-01-11 13:54:17 -0600589 CONFIG_OF_BOARD_SETUP
590
591 Board code has addition modification that it wants to make
592 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000593
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500594 CONFIG_OF_BOOT_CPU
595
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200596 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500597 param header, the default value is zero if undefined.
598
Heiko Schocherffb293a2009-09-23 07:56:08 +0200599 CONFIG_OF_IDE_FIXUP
600
601 U-Boot can detect if an IDE device is present or not.
602 If not, and this new config option is activated, U-Boot
603 removes the ATA node from the DTS before booting Linux,
604 so the Linux IDE driver does not probe the device and
605 crash. This is needed for buggy hardware (uc101) where
606 no pull down resistor is connected to the signal IDE5V_DD7.
607
Igor Grinberg06890672011-07-14 05:45:07 +0000608 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
609
610 This setting is mandatory for all boards that have only one
611 machine type and must be used to specify the machine type
612 number as it appears in the ARM machine registry
613 (see http://www.arm.linux.org.uk/developer/machines/).
614 Only boards that have multiple machine types supported
615 in a single configuration file and the machine type is
616 runtime discoverable, do not have to use this setting.
617
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100618- vxWorks boot parameters:
619
620 bootvx constructs a valid bootline using the following
621 environments variables: bootfile, ipaddr, serverip, hostname.
622 It loads the vxWorks image pointed bootfile.
623
624 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
625 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
626 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
627 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
628
629 CONFIG_SYS_VXWORKS_ADD_PARAMS
630
631 Add it at the end of the bootline. E.g "u=username pw=secret"
632
633 Note: If a "bootargs" environment is defined, it will overwride
634 the defaults discussed just above.
635
Aneesh V960f5c02011-06-16 23:30:47 +0000636- Cache Configuration:
637 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
638 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
639 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
640
Aneesh V686a0752011-06-16 23:30:51 +0000641- Cache Configuration for ARM:
642 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
643 controller
644 CONFIG_SYS_PL310_BASE - Physical base address of PL310
645 controller register space
646
wdenkda04a8b2004-08-02 23:22:59 +0000647- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200648 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000649
650 Define this if you want support for Amba PrimeCell PL010 UARTs.
651
Andreas Engel0813b122008-09-08 14:30:53 +0200652 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000653
654 Define this if you want support for Amba PrimeCell PL011 UARTs.
655
656 CONFIG_PL011_CLOCK
657
658 If you have Amba PrimeCell PL011 UARTs, set this variable to
659 the clock speed of the UARTs.
660
661 CONFIG_PL01x_PORTS
662
663 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
664 define this to a list of base addresses for each (supported)
665 port. See e.g. include/configs/versatile.h
666
John Rigby34e21ee2011-04-19 10:42:39 +0000667 CONFIG_PL011_SERIAL_RLCR
668
669 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
670 have separate receive and transmit line control registers. Set
671 this variable to initialize the extra register.
672
673 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
674
675 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
676 boot loader that has already initialized the UART. Define this
677 variable to flush the UART at init time.
678
wdenkda04a8b2004-08-02 23:22:59 +0000679
wdenkc6097192002-11-03 00:24:07 +0000680- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000681 Depending on board, define exactly one serial port
682 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
683 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
684 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000685
686 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
687 port routines must be defined elsewhere
688 (i.e. serial_init(), serial_getc(), ...)
689
690 CONFIG_CFB_CONSOLE
691 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000692 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000693 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
694 (default big endian)
695 VIDEO_HW_RECTFILL graphic chip supports
696 rectangle fill
697 (cf. smiLynxEM)
698 VIDEO_HW_BITBLT graphic chip supports
699 bit-blit (cf. smiLynxEM)
700 VIDEO_VISIBLE_COLS visible pixel columns
701 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000702 VIDEO_VISIBLE_ROWS visible pixel rows
703 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000704 VIDEO_DATA_FORMAT graphic data format
705 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000706 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000707 VIDEO_KBD_INIT_FCT keyboard int fct
708 (i.e. i8042_kbd_init())
709 VIDEO_TSTC_FCT test char fct
710 (i.e. i8042_tstc)
711 VIDEO_GETC_FCT get char fct
712 (i.e. i8042_getc)
713 CONFIG_CONSOLE_CURSOR cursor drawing on/off
714 (requires blink timer
715 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200716 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000717 CONFIG_CONSOLE_TIME display time/date info in
718 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500719 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000720 CONFIG_VIDEO_LOGO display Linux logo in
721 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000722 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
723 linux_logo.h for logo.
724 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000725 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200726 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000727 the logo
728
Pali Rohár4a57da32012-10-19 13:30:09 +0000729 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
730 a limited number of ANSI escape sequences (cursor control,
731 erase functions and limited graphics rendition control).
732
wdenk4a5c8a72003-03-06 00:02:04 +0000733 When CONFIG_CFB_CONSOLE is defined, video console is
734 default i/o. Serial console can be forced with
735 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000736
wdenk1ebf41e2004-01-02 14:00:00 +0000737 When CONFIG_SILENT_CONSOLE is defined, all console
738 messages (by U-Boot and Linux!) can be silenced with
739 the "silent" environment variable. See
740 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000741
Heiko Schocher62759562013-10-22 11:06:06 +0200742 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
743 is 0x00.
744 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
745 is 0xa0.
746
wdenkc6097192002-11-03 00:24:07 +0000747- Console Baudrate:
748 CONFIG_BAUDRATE - in bps
749 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200750 CONFIG_SYS_BAUDRATE_TABLE, see below.
751 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000752
Heiko Schocher327480a2009-01-30 12:55:38 +0100753- Console Rx buffer length
754 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
755 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100756 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100757 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
758 must be defined, to setup the maximum idle timeout for
759 the SMC.
760
Graeme Russ3c28f482011-09-01 00:48:27 +0000761- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200762 Prior to the console being initialised (i.e. serial UART
763 initialised etc) all console output is silently discarded.
764 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
765 buffer any console messages prior to the console being
766 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
767 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
768 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200769 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200770 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000771
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200772 'Sane' compilers will generate smaller code if
773 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000774
Sonny Raocd55bde2011-11-02 09:52:08 +0000775- Safe printf() functions
776 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
777 the printf() functions. These are defined in
778 include/vsprintf.h and include snprintf(), vsnprintf() and
779 so on. Code size increase is approximately 300-500 bytes.
780 If this option is not given then these functions will
781 silently discard their buffer size argument - this means
782 you are not getting any overflow checking in this case.
783
wdenkc6097192002-11-03 00:24:07 +0000784- Boot Delay: CONFIG_BOOTDELAY - in seconds
785 Delay before automatically booting the default image;
786 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000787 set to -2 to autoboot with no delay and not check for abort
788 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000789
790 See doc/README.autoboot for these options that
791 work with CONFIG_BOOTDELAY. None are required.
792 CONFIG_BOOT_RETRY_TIME
793 CONFIG_BOOT_RETRY_MIN
794 CONFIG_AUTOBOOT_KEYED
795 CONFIG_AUTOBOOT_PROMPT
796 CONFIG_AUTOBOOT_DELAY_STR
797 CONFIG_AUTOBOOT_STOP_STR
798 CONFIG_AUTOBOOT_DELAY_STR2
799 CONFIG_AUTOBOOT_STOP_STR2
800 CONFIG_ZERO_BOOTDELAY_CHECK
801 CONFIG_RESET_TO_RETRY
802
803- Autoboot Command:
804 CONFIG_BOOTCOMMAND
805 Only needed when CONFIG_BOOTDELAY is enabled;
806 define a command string that is automatically executed
807 when no character is read on the console interface
808 within "Boot Delay" after reset.
809
810 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000811 This can be used to pass arguments to the bootm
812 command. The value of CONFIG_BOOTARGS goes into the
813 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000814
815 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000816 The value of these goes into the environment as
817 "ramboot" and "nfsboot" respectively, and can be used
818 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200819 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000820
821- Pre-Boot Commands:
822 CONFIG_PREBOOT
823
824 When this option is #defined, the existence of the
825 environment variable "preboot" will be checked
826 immediately before starting the CONFIG_BOOTDELAY
827 countdown and/or running the auto-boot command resp.
828 entering interactive mode.
829
830 This feature is especially useful when "preboot" is
831 automatically generated or modified. For an example
832 see the LWMON board specific code: here "preboot" is
833 modified when the user holds down a certain
834 combination of keys on the (special) keyboard when
835 booting the systems
836
837- Serial Download Echo Mode:
838 CONFIG_LOADS_ECHO
839 If defined to 1, all characters received during a
840 serial download (using the "loads" command) are
841 echoed back. This might be needed by some terminal
842 emulations (like "cu"), but may as well just take
843 time on others. This setting #define's the initial
844 value of the "loads_echo" environment variable.
845
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500846- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000847 CONFIG_KGDB_BAUDRATE
848 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200849 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000850
851- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 Monitor commands can be included or excluded
853 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000854 <config_cmd_all.h> and #undef'ing unwanted
855 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500856 and augmenting with additional #define's
857 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000858
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500859 The default command configuration includes all commands
860 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000861
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500863 CONFIG_CMD_BDI bdinfo
864 CONFIG_CMD_BEDBUG * Include BedBug Debugger
865 CONFIG_CMD_BMP * BMP support
866 CONFIG_CMD_BSP * Board specific commands
867 CONFIG_CMD_BOOTD bootd
868 CONFIG_CMD_CACHE * icache, dcache
869 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500870 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_DATE * support for RTC, date/time...
872 CONFIG_CMD_DHCP * DHCP support
873 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600874 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
875 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
876 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
877 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500878 CONFIG_CMD_DTT * Digital Therm and Thermostat
879 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500880 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500881 CONFIG_CMD_EEPROM * EEPROM read/write support
882 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600883 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600884 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500885 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500886 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000887 CONFIG_CMD_EXT2 * ext2 command support
888 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500889 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000891 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500892 CONFIG_CMD_FDOS * Dos diskette Support
893 CONFIG_CMD_FLASH flinfo, erase, protect
894 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200895 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000896 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500897 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000898 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000899 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500900 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
901 CONFIG_CMD_I2C * I2C serial bus support
902 CONFIG_CMD_IDE * IDE harddisk support
903 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000904 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200905 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500906 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500907 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000908 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 CONFIG_CMD_IRQ * irqinfo
910 CONFIG_CMD_ITEST Integer/string test of 2 values
911 CONFIG_CMD_JFFS2 * JFFS2 Support
912 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200913 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000914 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
915 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 CONFIG_CMD_LOADB loadb
917 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200918 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400919 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000920 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500921 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000922 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200923 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500924 CONFIG_CMD_MISC Misc functions like sleep etc
925 CONFIG_CMD_MMC * MMC memory mapped support
926 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100927 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 CONFIG_CMD_NAND * NAND support
929 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200930 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600931 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000932 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500933 CONFIG_CMD_PCI * pciinfo
934 CONFIG_CMD_PCMCIA * PCMCIA support
935 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
936 host
937 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000938 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500939 CONFIG_CMD_REGINFO * Register dump
940 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000941 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500942 CONFIG_CMD_SAVES * save S record dump
943 CONFIG_CMD_SCSI * SCSI Support
944 CONFIG_CMD_SDRAM * print SDRAM configuration information
945 (requires CONFIG_CMD_I2C)
946 CONFIG_CMD_SETGETDCR Support for DCR Register access
947 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700948 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200949 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400950 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800951 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200952 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500953 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000954 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000955 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000956 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
957 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500958 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500959 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000960 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200961 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000962
wdenkc6097192002-11-03 00:24:07 +0000963
964 EXAMPLE: If you want all functions except of network
965 support you can write:
966
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500967 #include "config_cmd_all.h"
968 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000969
Gerald Van Barend6abef42007-03-31 12:23:51 -0400970 Other Commands:
971 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000972
973 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500974 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000975 what you (and your U-Boot users) are doing. Data
976 cache cannot be enabled on systems like the 8xx or
977 8260 (where accesses to the IMMR region must be
978 uncached), and it cannot be disabled on all other
979 systems where we (mis-) use the data cache to hold an
980 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000981
982
983 XXX - this list needs to get updated!
984
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000985- Regular expression support:
986 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200987 If this variable is defined, U-Boot is linked against
988 the SLRE (Super Light Regular Expression) library,
989 which adds regex support to some commands, as for
990 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000991
Simon Glass3d686442011-10-15 05:48:20 +0000992- Device tree:
993 CONFIG_OF_CONTROL
994 If this variable is defined, U-Boot will use a device tree
995 to configure its devices, instead of relying on statically
996 compiled #defines in the board file. This option is
997 experimental and only available on a few boards. The device
998 tree is available in the global data as gd->fdt_blob.
999
Simon Glass5cb34db2011-10-24 19:15:31 +00001000 U-Boot needs to get its device tree from somewhere. This can
1001 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001002
1003 CONFIG_OF_EMBED
1004 If this variable is defined, U-Boot will embed a device tree
1005 binary in its image. This device tree file should be in the
1006 board directory and called <soc>-<board>.dts. The binary file
1007 is then picked up in board_init_f() and made available through
1008 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001009
Simon Glass5cb34db2011-10-24 19:15:31 +00001010 CONFIG_OF_SEPARATE
1011 If this variable is defined, U-Boot will build a device tree
1012 binary. It will be called u-boot.dtb. Architecture-specific
1013 code will locate it at run-time. Generally this works by:
1014
1015 cat u-boot.bin u-boot.dtb >image.bin
1016
1017 and in fact, U-Boot does this for you, creating a file called
1018 u-boot-dtb.bin which is useful in the common case. You can
1019 still use the individual files if you need something more
1020 exotic.
1021
wdenkc6097192002-11-03 00:24:07 +00001022- Watchdog:
1023 CONFIG_WATCHDOG
1024 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001025 support for the SoC. There must be support in the SoC
1026 specific code for a watchdog. For the 8xx and 8260
1027 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1028 register. When supported for a specific SoC is
1029 available, then no further board specific code should
1030 be needed to use it.
1031
1032 CONFIG_HW_WATCHDOG
1033 When using a watchdog circuitry external to the used
1034 SoC, then define this variable and provide board
1035 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001036
stroeseb9c17c52003-04-04 15:53:41 +00001037- U-Boot Version:
1038 CONFIG_VERSION_VARIABLE
1039 If this variable is defined, an environment variable
1040 named "ver" is created by U-Boot showing the U-Boot
1041 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001042 Any change to this variable will be reverted at the
1043 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001044
wdenkc6097192002-11-03 00:24:07 +00001045- Real-Time Clock:
1046
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001047 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001048 has to be selected, too. Define exactly one of the
1049 following options:
1050
1051 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1052 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001053 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001054 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001055 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001056 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001057 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001058 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001059 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001060 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001061 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001062 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1063 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001064
wdenkb9bbd242003-06-30 16:24:52 +00001065 Note that if the RTC uses I2C, then the I2C interface
1066 must also be configured. See I2C Support, below.
1067
Peter Tyser9902e422008-12-17 16:36:21 -06001068- GPIO Support:
1069 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001070
Chris Packham9b383202010-12-19 10:12:13 +00001071 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1072 chip-ngpio pairs that tell the PCA953X driver the number of
1073 pins supported by a particular chip.
1074
Peter Tyser9902e422008-12-17 16:36:21 -06001075 Note that if the GPIO device uses I2C, then the I2C interface
1076 must also be configured. See I2C Support, below.
1077
wdenkc6097192002-11-03 00:24:07 +00001078- Timestamp Support:
1079
wdenk4a5c8a72003-03-06 00:02:04 +00001080 When CONFIG_TIMESTAMP is selected, the timestamp
1081 (date and time) of an image is printed by image
1082 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001083 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001084
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001085- Partition Labels (disklabels) Supported:
1086 Zero or more of the following:
1087 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1088 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1089 Intel architecture, USB sticks, etc.
1090 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1091 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1092 bootloader. Note 2TB partition limit; see
1093 disk/part_efi.c
1094 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001095
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001096 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1097 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001098 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001099
1100- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001101 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1102 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001103
wdenk369d43d2004-03-14 14:09:05 +00001104 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1105 be performed by calling the function
1106 ide_set_reset(int reset)
1107 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001108
1109- ATAPI Support:
1110 CONFIG_ATAPI
1111
1112 Set this to enable ATAPI support.
1113
wdenkf602aa02004-03-13 23:29:43 +00001114- LBA48 Support
1115 CONFIG_LBA48
1116
1117 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001118 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001119 Whithout these , LBA48 support uses 32bit variables and will 'only'
1120 support disks up to 2.1TB.
1121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001122 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001123 When enabled, makes the IDE subsystem use 64bit sector addresses.
1124 Default is 32bit.
1125
wdenkc6097192002-11-03 00:24:07 +00001126- SCSI Support:
1127 At the moment only there is only support for the
1128 SYM53C8XX SCSI controller; define
1129 CONFIG_SCSI_SYM53C8XX to enable it.
1130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001131 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1132 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1133 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001134 maximum numbers of LUNs, SCSI ID's and target
1135 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001136 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001137
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001138 The environment variable 'scsidevs' is set to the number of
1139 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001140
wdenkc6097192002-11-03 00:24:07 +00001141- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001142 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001143 Support for Intel 8254x/8257x gigabit chips.
1144
1145 CONFIG_E1000_SPI
1146 Utility code for direct access to the SPI bus on Intel 8257x.
1147 This does not do anything useful unless you set at least one
1148 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1149
1150 CONFIG_E1000_SPI_GENERIC
1151 Allow generic access to the SPI bus on the Intel 8257x, for
1152 example with the "sspi" command.
1153
1154 CONFIG_CMD_E1000
1155 Management command for E1000 devices. When used on devices
1156 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001157
Andre Schwarz68c2a302008-03-06 16:45:44 +01001158 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001159 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001160
wdenkc6097192002-11-03 00:24:07 +00001161 CONFIG_EEPRO100
1162 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001163 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001164 write routine for first time initialisation.
1165
1166 CONFIG_TULIP
1167 Support for Digital 2114x chips.
1168 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1169 modem chip initialisation (KS8761/QS6611).
1170
1171 CONFIG_NATSEMI
1172 Support for National dp83815 chips.
1173
1174 CONFIG_NS8382X
1175 Support for National dp8382[01] gigabit chips.
1176
wdenkaa603362003-05-12 21:50:16 +00001177- NETWORK Support (other):
1178
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001179 CONFIG_DRIVER_AT91EMAC
1180 Support for AT91RM9200 EMAC.
1181
1182 CONFIG_RMII
1183 Define this to use reduced MII inteface
1184
1185 CONFIG_DRIVER_AT91EMAC_QUIET
1186 If this defined, the driver is quiet.
1187 The driver doen't show link status messages.
1188
Rob Herringc9830dc2011-12-15 11:15:49 +00001189 CONFIG_CALXEDA_XGMAC
1190 Support for the Calxeda XGMAC device
1191
Ashok93fb8722012-10-15 06:20:47 +00001192 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001193 Support for SMSC's LAN91C96 chips.
1194
1195 CONFIG_LAN91C96_BASE
1196 Define this to hold the physical address
1197 of the LAN91C96's I/O space
1198
1199 CONFIG_LAN91C96_USE_32_BIT
1200 Define this to enable 32 bit addressing
1201
Ashok93fb8722012-10-15 06:20:47 +00001202 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001203 Support for SMSC's LAN91C111 chip
1204
1205 CONFIG_SMC91111_BASE
1206 Define this to hold the physical address
1207 of the device (I/O space)
1208
1209 CONFIG_SMC_USE_32_BIT
1210 Define this if data bus is 32 bits
1211
1212 CONFIG_SMC_USE_IOFUNCS
1213 Define this to use i/o functions instead of macros
1214 (some hardware wont work with macros)
1215
Heiko Schocher7d037f72011-11-15 10:00:04 -05001216 CONFIG_DRIVER_TI_EMAC
1217 Support for davinci emac
1218
1219 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1220 Define this if you have more then 3 PHYs.
1221
Macpaul Lin199c6252010-12-21 16:59:46 +08001222 CONFIG_FTGMAC100
1223 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1224
1225 CONFIG_FTGMAC100_EGIGA
1226 Define this to use GE link update with gigabit PHY.
1227 Define this if FTGMAC100 is connected to gigabit PHY.
1228 If your system has 10/100 PHY only, it might not occur
1229 wrong behavior. Because PHY usually return timeout or
1230 useless data when polling gigabit status and gigabit
1231 control registers. This behavior won't affect the
1232 correctnessof 10/100 link speed update.
1233
Mike Rapoportf4761af2009-11-11 10:03:03 +02001234 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001235 Support for SMSC's LAN911x and LAN921x chips
1236
Mike Rapoportf4761af2009-11-11 10:03:03 +02001237 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001238 Define this to hold the physical address
1239 of the device (I/O space)
1240
Mike Rapoportf4761af2009-11-11 10:03:03 +02001241 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001242 Define this if data bus is 32 bits
1243
Mike Rapoportf4761af2009-11-11 10:03:03 +02001244 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001245 Define this if data bus is 16 bits. If your processor
1246 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001247 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001248
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001249 CONFIG_SH_ETHER
1250 Support for Renesas on-chip Ethernet controller
1251
1252 CONFIG_SH_ETHER_USE_PORT
1253 Define the number of ports to be used
1254
1255 CONFIG_SH_ETHER_PHY_ADDR
1256 Define the ETH PHY's address
1257
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001258 CONFIG_SH_ETHER_CACHE_WRITEBACK
1259 If this option is set, the driver enables cache flush.
1260
Vadim Bendeburydac69642011-10-17 08:36:14 +00001261- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001262 CONFIG_TPM
1263 Support TPM devices.
1264
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001265 CONFIG_TPM_TIS_I2C
1266 Support for i2c bus TPM devices. Only one device
1267 per system is supported at this time.
1268
1269 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1270 Define the the i2c bus number for the TPM device
1271
1272 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1273 Define the TPM's address on the i2c bus
1274
1275 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1276 Define the burst count bytes upper limit
1277
Dirk Eibach20489092013-06-26 15:55:15 +02001278 CONFIG_TPM_ATMEL_TWI
1279 Support for Atmel TWI TPM device. Requires I2C support.
1280
Che-liang Chiouacea5702013-04-12 11:04:34 +00001281 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001282 Support for generic parallel port TPM devices. Only one device
1283 per system is supported at this time.
1284
1285 CONFIG_TPM_TIS_BASE_ADDRESS
1286 Base address where the generic TPM device is mapped
1287 to. Contemporary x86 systems usually map it at
1288 0xfed40000.
1289
Reinhard Pfau4fece432013-06-26 15:55:13 +02001290 CONFIG_CMD_TPM
1291 Add tpm monitor functions.
1292 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1293 provides monitor access to authorized functions.
1294
1295 CONFIG_TPM
1296 Define this to enable the TPM support library which provides
1297 functional interfaces to some TPM commands.
1298 Requires support for a TPM device.
1299
1300 CONFIG_TPM_AUTH_SESSIONS
1301 Define this to enable authorized functions in the TPM library.
1302 Requires CONFIG_TPM and CONFIG_SHA1.
1303
wdenkc6097192002-11-03 00:24:07 +00001304- USB Support:
1305 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001306 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001307 CONFIG_USB_UHCI to enable it.
1308 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001309 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001310 storage devices.
1311 Note:
1312 Supported are USB Keyboards and USB Floppy drives
1313 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001314 MPC5200 USB requires additional defines:
1315 CONFIG_USB_CLOCK
1316 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001317 CONFIG_PSC3_USB
1318 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001319 CONFIG_USB_CONFIG
1320 for differential drivers: 0x00001000
1321 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001322 for differential drivers on PSC3: 0x00000100
1323 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001324 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001325 May be defined to allow interrupt polling
1326 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001327
Simon Glass5978cdb2012-02-27 10:52:47 +00001328 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1329 txfilltuning field in the EHCI controller on reset.
1330
Kuo-Jung Su4e5923f2013-05-15 15:29:22 +08001331 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1332 interval for usb hub power-on delay.(minimum 100msec)
1333
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001334- USB Device:
1335 Define the below if you wish to use the USB console.
1336 Once firmware is rebuilt from a serial console issue the
1337 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001338 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001339 it has found a new device. The environment variable usbtty
1340 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001341 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001342 Common Device Class Abstract Control Model serial device.
1343 If you select usbtty = gserial you should be able to enumerate
1344 a Linux host by
1345 # modprobe usbserial vendor=0xVendorID product=0xProductID
1346 else if using cdc_acm, simply setting the environment
1347 variable usbtty to be cdc_acm should suffice. The following
1348 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001349
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001350 CONFIG_USB_DEVICE
1351 Define this to build a UDC device
1352
1353 CONFIG_USB_TTY
1354 Define this to have a tty type of device available to
1355 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001356
Vipin KUMARbdb17702012-03-26 15:38:06 +05301357 CONFIG_USBD_HS
1358 Define this to enable the high speed support for usb
1359 device and usbtty. If this feature is enabled, a routine
1360 int is_usbd_high_speed(void)
1361 also needs to be defined by the driver to dynamically poll
1362 whether the enumeration has succeded at high speed or full
1363 speed.
1364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001365 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001366 Define this if you want stdin, stdout &/or stderr to
1367 be set to usbtty.
1368
1369 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001370 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001371 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001372 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001373
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001374 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001375 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001376 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001377
Wolfgang Denke2601822006-06-14 18:14:56 +02001378 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001379 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001380 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001381 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1382 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1383 should pretend to be a Linux device to it's target host.
1384
1385 CONFIG_USBD_MANUFACTURER
1386 Define this string as the name of your company for
1387 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001388
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001389 CONFIG_USBD_PRODUCT_NAME
1390 Define this string as the name of your product
1391 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001392
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001393 CONFIG_USBD_VENDORID
1394 Define this as your assigned Vendor ID from the USB
1395 Implementors Forum. This *must* be a genuine Vendor ID
1396 to avoid polluting the USB namespace.
1397 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001398
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001399 CONFIG_USBD_PRODUCTID
1400 Define this as the unique Product ID
1401 for your device
1402 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001403
Przemyslaw Marczak06ef7cc2013-10-23 14:30:46 +02001404 Some USB device drivers may need to check USB cable attachment.
1405 In this case you can enable following config in BoardName.h:
1406 CONFIG_USB_CABLE_CHECK
1407 This enables function definition:
1408 - usb_cable_connected() in include/usb.h
1409 Implementation of this function is board-specific.
1410
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001411- ULPI Layer Support:
1412 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1413 the generic ULPI layer. The generic layer accesses the ULPI PHY
1414 via the platform viewport, so you need both the genric layer and
1415 the viewport enabled. Currently only Chipidea/ARC based
1416 viewport is supported.
1417 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1418 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001419 If your ULPI phy needs a different reference clock than the
1420 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1421 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001422
wdenk7a428cc2003-06-15 22:40:42 +00001423- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001424 The MMC controller on the Intel PXA is supported. To
1425 enable this define CONFIG_MMC. The MMC can be
1426 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001427 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001428 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1429 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001430
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001431 CONFIG_SH_MMCIF
1432 Support for Renesas on-chip MMCIF controller
1433
1434 CONFIG_SH_MMCIF_ADDR
1435 Define the base address of MMCIF registers
1436
1437 CONFIG_SH_MMCIF_CLK
1438 Define the clock frequency for MMCIF
1439
Tom Rini58a8d322013-03-14 05:32:47 +00001440- USB Device Firmware Update (DFU) class support:
1441 CONFIG_DFU_FUNCTION
1442 This enables the USB portion of the DFU USB class
1443
1444 CONFIG_CMD_DFU
1445 This enables the command "dfu" which is used to have
1446 U-Boot create a DFU class device via USB. This command
1447 requires that the "dfu_alt_info" environment variable be
1448 set and define the alt settings to expose to the host.
1449
1450 CONFIG_DFU_MMC
1451 This enables support for exposing (e)MMC devices via DFU.
1452
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001453 CONFIG_DFU_NAND
1454 This enables support for exposing NAND devices via DFU.
1455
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301456 CONFIG_DFU_RAM
1457 This enables support for exposing RAM via DFU.
1458 Note: DFU spec refer to non-volatile memory usage, but
1459 allow usages beyond the scope of spec - here RAM usage,
1460 one that would help mostly the developer.
1461
Heiko Schochera2f831e2013-06-12 06:05:51 +02001462 CONFIG_SYS_DFU_DATA_BUF_SIZE
1463 Dfu transfer uses a buffer before writing data to the
1464 raw storage device. Make the size (in bytes) of this buffer
1465 configurable. The size of this buffer is also configurable
1466 through the "dfu_bufsiz" environment variable.
1467
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001468 CONFIG_SYS_DFU_MAX_FILE_SIZE
1469 When updating files rather than the raw storage device,
1470 we use a static buffer to copy the file into and then write
1471 the buffer once we've been given the whole file. Define
1472 this to the maximum filesize (in bytes) for the buffer.
1473 Default is 4 MiB if undefined.
1474
wdenkda04a8b2004-08-02 23:22:59 +00001475- Journaling Flash filesystem support:
1476 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1477 CONFIG_JFFS2_NAND_DEV
1478 Define these for a default partition on a NAND device
1479
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001480 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1481 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001482 Define these for a default partition on a NOR device
1483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001484 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001485 Define this to create an own partition. You have to provide a
1486 function struct part_info* jffs2_part_info(int part_num)
1487
1488 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001489 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001490 to disable the command chpart. This is the default when you
1491 have not defined a custom partition
1492
Donggeun Kim8f814002011-10-24 21:15:28 +00001493- FAT(File Allocation Table) filesystem write function support:
1494 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001495
1496 Define this to enable support for saving memory data as a
1497 file in FAT formatted partition.
1498
1499 This will also enable the command "fatwrite" enabling the
1500 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001501
Gabe Black7f8574c2012-10-12 14:26:11 +00001502CBFS (Coreboot Filesystem) support
1503 CONFIG_CMD_CBFS
1504
1505 Define this to enable support for reading from a Coreboot
1506 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1507 and cbfsload.
1508
wdenkc6097192002-11-03 00:24:07 +00001509- Keyboard Support:
1510 CONFIG_ISA_KEYBOARD
1511
1512 Define this to enable standard (PC-Style) keyboard
1513 support
1514
1515 CONFIG_I8042_KBD
1516 Standard PC keyboard driver with US (is default) and
1517 GERMAN key layout (switch via environment 'keymap=de') support.
1518 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1519 for cfb_console. Supports cursor blinking.
1520
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001521 CONFIG_CROS_EC_KEYB
1522 Enables a Chrome OS keyboard using the CROS_EC interface.
1523 This uses CROS_EC to communicate with a second microcontroller
1524 which provides key scans on request.
1525
wdenkc6097192002-11-03 00:24:07 +00001526- Video support:
1527 CONFIG_VIDEO
1528
1529 Define this to enable video support (for output to
1530 video).
1531
1532 CONFIG_VIDEO_CT69000
1533
1534 Enable Chips & Technologies 69000 Video chip
1535
1536 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001537 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001538 video output is selected via environment 'videoout'
1539 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1540 assumed.
wdenkc6097192002-11-03 00:24:07 +00001541
wdenkd3602132004-03-25 15:14:43 +00001542 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001543 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001544 are possible:
1545 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001546 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001547
1548 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1549 -------------+---------------------------------------------
1550 8 bits | 0x301* 0x303 0x305 0x161 0x307
1551 15 bits | 0x310 0x313 0x316 0x162 0x319
1552 16 bits | 0x311 0x314 0x317 0x163 0x31A
1553 24 bits | 0x312 0x315 0x318 ? 0x31B
1554 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001555 (i.e. setenv videomode 317; saveenv; reset;)
1556
wdenkd3602132004-03-25 15:14:43 +00001557 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001558 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001559
1560
stroeseb9c17c52003-04-04 15:53:41 +00001561 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001562 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001563 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1564 or CONFIG_VIDEO_SED13806_16BPP
1565
Timur Tabi020edd22011-02-15 17:09:19 -06001566 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001567 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001568 SOCs that have a DIU should define this macro to enable DIU
1569 support, and should also define these other macros:
1570
1571 CONFIG_SYS_DIU_ADDR
1572 CONFIG_VIDEO
1573 CONFIG_CMD_BMP
1574 CONFIG_CFB_CONSOLE
1575 CONFIG_VIDEO_SW_CURSOR
1576 CONFIG_VGA_AS_SINGLE_DEVICE
1577 CONFIG_VIDEO_LOGO
1578 CONFIG_VIDEO_BMP_LOGO
1579
Timur Tabi32f709e2011-04-11 14:18:22 -05001580 The DIU driver will look for the 'video-mode' environment
1581 variable, and if defined, enable the DIU as a console during
1582 boot. See the documentation file README.video for a
1583 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001584
Simon Glass54df8ce2012-12-03 13:59:47 +00001585 CONFIG_VIDEO_VGA
1586
1587 Enable the VGA video / BIOS for x86. The alternative if you
1588 are using coreboot is to use the coreboot frame buffer
1589 driver.
1590
1591
wdenk4e112c12003-06-03 23:54:09 +00001592- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001593 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001594
wdenk57b2d802003-06-27 21:31:46 +00001595 Define this to enable a custom keyboard support.
1596 This simply calls drv_keyboard_init() which must be
1597 defined in your board-specific files.
1598 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001599
wdenkc6097192002-11-03 00:24:07 +00001600- LCD Support: CONFIG_LCD
1601
1602 Define this to enable LCD support (for output to LCD
1603 display); also select one of the supported displays
1604 by defining one of these:
1605
Stelian Popf6f86652008-05-09 21:57:18 +02001606 CONFIG_ATMEL_LCD:
1607
1608 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1609
wdenkc0d54ae2003-11-25 16:55:19 +00001610 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001611
wdenkc0d54ae2003-11-25 16:55:19 +00001612 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001613
wdenkc0d54ae2003-11-25 16:55:19 +00001614 CONFIG_NEC_NL6448BC20
1615
1616 NEC NL6448BC20-08. 6.5", 640x480.
1617 Active, color, single scan.
1618
1619 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001620
wdenkc0d54ae2003-11-25 16:55:19 +00001621 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001622 Active, color, single scan.
1623
1624 CONFIG_SHARP_16x9
1625
1626 Sharp 320x240. Active, color, single scan.
1627 It isn't 16x9, and I am not sure what it is.
1628
1629 CONFIG_SHARP_LQ64D341
1630
1631 Sharp LQ64D341 display, 640x480.
1632 Active, color, single scan.
1633
1634 CONFIG_HLD1045
1635
1636 HLD1045 display, 640x480.
1637 Active, color, single scan.
1638
1639 CONFIG_OPTREX_BW
1640
1641 Optrex CBL50840-2 NF-FW 99 22 M5
1642 or
1643 Hitachi LMG6912RPFC-00T
1644 or
1645 Hitachi SP14Q002
1646
1647 320x240. Black & white.
1648
1649 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001650 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001651
Simon Glass599a4df2012-10-17 13:24:54 +00001652 CONFIG_LCD_ALIGNMENT
1653
1654 Normally the LCD is page-aligned (tyically 4KB). If this is
1655 defined then the LCD will be aligned to this value instead.
1656 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1657 here, since it is cheaper to change data cache settings on
1658 a per-section basis.
1659
Simon Glassaf3e2802012-10-17 13:24:59 +00001660 CONFIG_CONSOLE_SCROLL_LINES
1661
1662 When the console need to be scrolled, this is the number of
1663 lines to scroll by. It defaults to 1. Increasing this makes
1664 the console jump but can help speed up operation when scrolling
1665 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001666
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001667 CONFIG_LCD_BMP_RLE8
1668
1669 Support drawing of RLE8-compressed bitmaps on the LCD.
1670
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001671 CONFIG_I2C_EDID
1672
1673 Enables an 'i2c edid' command which can read EDID
1674 information over I2C from an attached LCD display.
1675
wdenkeb20ad32003-09-05 23:19:14 +00001676- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001677
wdenk57b2d802003-06-27 21:31:46 +00001678 If this option is set, the environment is checked for
1679 a variable "splashimage". If found, the usual display
1680 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001681 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001682 specified in "splashimage" is loaded instead. The
1683 console is redirected to the "nulldev", too. This
1684 allows for a "silent" boot where a splash screen is
1685 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001686
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001687 CONFIG_SPLASHIMAGE_GUARD
1688
1689 If this option is set, then U-Boot will prevent the environment
1690 variable "splashimage" from being set to a problematic address
1691 (see README.displaying-bmps and README.arm-unaligned-accesses).
1692 This option is useful for targets where, due to alignment
1693 restrictions, an improperly aligned BMP image will cause a data
1694 abort. If you think you will not have problems with unaligned
1695 accesses (for example because your toolchain prevents them)
1696 there is no need to set this option.
1697
Matthias Weisser53884182009-07-09 16:07:30 +02001698 CONFIG_SPLASH_SCREEN_ALIGN
1699
1700 If this option is set the splash image can be freely positioned
1701 on the screen. Environment variable "splashpos" specifies the
1702 position as "x,y". If a positive number is given it is used as
1703 number of pixel from left/top. If a negative number is given it
1704 is used as number of pixel from right/bottom. You can also
1705 specify 'm' for centering the image.
1706
1707 Example:
1708 setenv splashpos m,m
1709 => image at center of screen
1710
1711 setenv splashpos 30,20
1712 => image at x = 30 and y = 20
1713
1714 setenv splashpos -10,m
1715 => vertically centered image
1716 at x = dspWidth - bmpWidth - 9
1717
Stefan Roesed9d97742005-09-22 09:04:17 +02001718- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1719
1720 If this option is set, additionally to standard BMP
1721 images, gzipped BMP images can be displayed via the
1722 splashscreen support or the bmp command.
1723
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001724- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1725
1726 If this option is set, 8-bit RLE compressed BMP images
1727 can be displayed via the splashscreen support or the
1728 bmp command.
1729
Lei Wene4e248d2012-09-28 04:26:47 +00001730- Do compresssing for memory range:
1731 CONFIG_CMD_ZIP
1732
1733 If this option is set, it would use zlib deflate method
1734 to compress the specified memory at its best effort.
1735
wdenk710e3502003-08-29 20:57:53 +00001736- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001737 CONFIG_GZIP
1738
1739 Enabled by default to support gzip compressed images.
1740
wdenk710e3502003-08-29 20:57:53 +00001741 CONFIG_BZIP2
1742
1743 If this option is set, support for bzip2 compressed
1744 images is included. If not, only uncompressed and gzip
1745 compressed images are supported.
1746
wdenk9c53f402003-10-15 23:53:47 +00001747 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001748 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001749 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001750
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001751 CONFIG_LZMA
1752
1753 If this option is set, support for lzma compressed
1754 images is included.
1755
1756 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1757 requires an amount of dynamic memory that is given by the
1758 formula:
1759
1760 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1761
1762 Where lc and lp stand for, respectively, Literal context bits
1763 and Literal pos bits.
1764
1765 This value is upper-bounded by 14MB in the worst case. Anyway,
1766 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1767 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1768 a very small buffer.
1769
1770 Use the lzmainfo tool to determinate the lc and lp values and
1771 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001772 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001773
Kees Cook5b06e642013-08-16 07:59:12 -07001774 CONFIG_LZO
1775
1776 If this option is set, support for LZO compressed images
1777 is included.
1778
wdenk0e2bd9c2004-06-06 21:51:03 +00001779- MII/PHY support:
1780 CONFIG_PHY_ADDR
1781
1782 The address of PHY on MII bus.
1783
1784 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1785
1786 The clock frequency of the MII bus
1787
1788 CONFIG_PHY_GIGE
1789
1790 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001791 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001792
1793 CONFIG_PHY_RESET_DELAY
1794
1795 Some PHY like Intel LXT971A need extra delay after
1796 reset before any MII register access is possible.
1797 For such PHY, set this option to the usec delay
1798 required. (minimum 300usec for LXT971A)
1799
1800 CONFIG_PHY_CMD_DELAY (ppc4xx)
1801
1802 Some PHY like Intel LXT971A need extra delay after
1803 command issued before MII status register can be read
1804
wdenkc6097192002-11-03 00:24:07 +00001805- Ethernet address:
1806 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001807 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001808 CONFIG_ETH2ADDR
1809 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001810 CONFIG_ETH4ADDR
1811 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001812
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001813 Define a default value for Ethernet address to use
1814 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001815 is not determined automatically.
1816
1817- IP address:
1818 CONFIG_IPADDR
1819
1820 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001821 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001822 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001823 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001824
1825- Server IP address:
1826 CONFIG_SERVERIP
1827
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001828 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001829 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001830 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001831
Robin Getz470a6d42009-07-21 12:15:28 -04001832 CONFIG_KEEP_SERVERADDR
1833
1834 Keeps the server's MAC address, in the env 'serveraddr'
1835 for passing to bootargs (like Linux's netconsole option)
1836
Wolfgang Denk26da2992011-10-26 10:21:22 +00001837- Gateway IP address:
1838 CONFIG_GATEWAYIP
1839
1840 Defines a default value for the IP address of the
1841 default router where packets to other networks are
1842 sent to.
1843 (Environment variable "gatewayip")
1844
1845- Subnet mask:
1846 CONFIG_NETMASK
1847
1848 Defines a default value for the subnet mask (or
1849 routing prefix) which is used to determine if an IP
1850 address belongs to the local subnet or needs to be
1851 forwarded through a router.
1852 (Environment variable "netmask")
1853
David Updegraff7280da72007-06-11 10:41:07 -05001854- Multicast TFTP Mode:
1855 CONFIG_MCAST_TFTP
1856
1857 Defines whether you want to support multicast TFTP as per
1858 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001859 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001860 driver in use must provide a function: mcast() to join/leave a
1861 multicast group.
1862
wdenkc6097192002-11-03 00:24:07 +00001863- BOOTP Recovery Mode:
1864 CONFIG_BOOTP_RANDOM_DELAY
1865
1866 If you have many targets in a network that try to
1867 boot using BOOTP, you may want to avoid that all
1868 systems send out BOOTP requests at precisely the same
1869 moment (which would happen for instance at recovery
1870 from a power failure, when all systems will try to
1871 boot, thus flooding the BOOTP server. Defining
1872 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1873 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001874 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001875
1876 1st BOOTP request: delay 0 ... 1 sec
1877 2nd BOOTP request: delay 0 ... 2 sec
1878 3rd BOOTP request: delay 0 ... 4 sec
1879 4th and following
1880 BOOTP requests: delay 0 ... 8 sec
1881
stroesee0aadfb2003-08-28 14:17:32 +00001882- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001883 You can fine tune the DHCP functionality by defining
1884 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001885
Jon Loeliger5336a762007-07-09 22:08:34 -05001886 CONFIG_BOOTP_SUBNETMASK
1887 CONFIG_BOOTP_GATEWAY
1888 CONFIG_BOOTP_HOSTNAME
1889 CONFIG_BOOTP_NISDOMAIN
1890 CONFIG_BOOTP_BOOTPATH
1891 CONFIG_BOOTP_BOOTFILESIZE
1892 CONFIG_BOOTP_DNS
1893 CONFIG_BOOTP_DNS2
1894 CONFIG_BOOTP_SEND_HOSTNAME
1895 CONFIG_BOOTP_NTPSERVER
1896 CONFIG_BOOTP_TIMEOFFSET
1897 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001898 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001899
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001900 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1901 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001902
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001903 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1904 after the configured retry count, the call will fail
1905 instead of starting over. This can be used to fail over
1906 to Link-local IP address configuration if the DHCP server
1907 is not available.
1908
stroesee0aadfb2003-08-28 14:17:32 +00001909 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1910 serverip from a DHCP server, it is possible that more
1911 than one DNS serverip is offered to the client.
1912 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1913 serverip will be stored in the additional environment
1914 variable "dnsip2". The first DNS serverip is always
1915 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001916 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001917
1918 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1919 to do a dynamic update of a DNS server. To do this, they
1920 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001921 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001922 of the "hostname" environment variable is passed as
1923 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001924
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001925 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1926
1927 A 32bit value in microseconds for a delay between
1928 receiving a "DHCP Offer" and sending the "DHCP Request".
1929 This fixes a problem with certain DHCP servers that don't
1930 respond 100% of the time to a "DHCP request". E.g. On an
1931 AT91RM9200 processor running at 180MHz, this delay needed
1932 to be *at least* 15,000 usec before a Windows Server 2003
1933 DHCP server would reply 100% of the time. I recommend at
1934 least 50,000 usec to be safe. The alternative is to hope
1935 that one of the retries will be successful but note that
1936 the DHCP timeout and retry process takes a longer than
1937 this delay.
1938
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001939 - Link-local IP address negotiation:
1940 Negotiate with other link-local clients on the local network
1941 for an address that doesn't require explicit configuration.
1942 This is especially useful if a DHCP server cannot be guaranteed
1943 to exist in all environments that the device must operate.
1944
1945 See doc/README.link-local for more information.
1946
wdenk145d2c12004-04-15 21:48:45 +00001947 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001948 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001949
1950 The device id used in CDP trigger frames.
1951
1952 CONFIG_CDP_DEVICE_ID_PREFIX
1953
1954 A two character string which is prefixed to the MAC address
1955 of the device.
1956
1957 CONFIG_CDP_PORT_ID
1958
1959 A printf format string which contains the ascii name of
1960 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001961 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001962
1963 CONFIG_CDP_CAPABILITIES
1964
1965 A 32bit integer which indicates the device capabilities;
1966 0x00000010 for a normal host which does not forwards.
1967
1968 CONFIG_CDP_VERSION
1969
1970 An ascii string containing the version of the software.
1971
1972 CONFIG_CDP_PLATFORM
1973
1974 An ascii string containing the name of the platform.
1975
1976 CONFIG_CDP_TRIGGER
1977
1978 A 32bit integer sent on the trigger.
1979
1980 CONFIG_CDP_POWER_CONSUMPTION
1981
1982 A 16bit integer containing the power consumption of the
1983 device in .1 of milliwatts.
1984
1985 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1986
1987 A byte containing the id of the VLAN.
1988
wdenkc6097192002-11-03 00:24:07 +00001989- Status LED: CONFIG_STATUS_LED
1990
1991 Several configurations allow to display the current
1992 status using a LED. For instance, the LED will blink
1993 fast while running U-Boot code, stop blinking as
1994 soon as a reply to a BOOTP request was received, and
1995 start blinking slow once the Linux kernel is running
1996 (supported by a status LED driver in the Linux
1997 kernel). Defining CONFIG_STATUS_LED enables this
1998 feature in U-Boot.
1999
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002000 Additional options:
2001
2002 CONFIG_GPIO_LED
2003 The status LED can be connected to a GPIO pin.
2004 In such cases, the gpio_led driver can be used as a
2005 status LED backend implementation. Define CONFIG_GPIO_LED
2006 to include the gpio_led driver in the U-Boot binary.
2007
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002008 CONFIG_GPIO_LED_INVERTED_TABLE
2009 Some GPIO connected LEDs may have inverted polarity in which
2010 case the GPIO high value corresponds to LED off state and
2011 GPIO low value corresponds to LED on state.
2012 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2013 with a list of GPIO LEDs that have inverted polarity.
2014
wdenkc6097192002-11-03 00:24:07 +00002015- CAN Support: CONFIG_CAN_DRIVER
2016
2017 Defining CONFIG_CAN_DRIVER enables CAN driver support
2018 on those systems that support this (optional)
2019 feature, like the TQM8xxL modules.
2020
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002021- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002022
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002023 This enable the NEW i2c subsystem, and will allow you to use
2024 i2c commands at the u-boot command line (as long as you set
2025 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2026 based realtime clock chips or other i2c devices. See
2027 common/cmd_i2c.c for a description of the command line
2028 interface.
2029
2030 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002031 - drivers/i2c/soft_i2c.c:
2032 - activate first bus with CONFIG_SYS_I2C_SOFT define
2033 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2034 for defining speed and slave address
2035 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2036 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2037 for defining speed and slave address
2038 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2039 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2040 for defining speed and slave address
2041 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2042 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2043 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002044
Heiko Schocherf2850742012-10-24 13:48:22 +02002045 - drivers/i2c/fsl_i2c.c:
2046 - activate i2c driver with CONFIG_SYS_I2C_FSL
2047 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2048 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2049 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2050 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002051 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002052 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2053 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2054 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2055 second bus.
2056
Simon Glass026fefb2012-10-30 07:28:53 +00002057 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002058 - activate this driver with CONFIG_SYS_I2C_TEGRA
2059 - This driver adds 4 i2c buses with a fix speed from
2060 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002061
Dirk Eibach42b204f2013-04-25 02:40:01 +00002062 - drivers/i2c/ppc4xx_i2c.c
2063 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2064 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2065 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2066
trema49f40a2013-09-21 18:13:35 +02002067 - drivers/i2c/i2c_mxc.c
2068 - activate this driver with CONFIG_SYS_I2C_MXC
2069 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2070 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2071 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2072 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2073 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2074 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2075 If thoses defines are not set, default value is 100000
2076 for speed, and 0 for slave.
2077
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002078 - drivers/i2c/rcar_i2c.c:
2079 - activate this driver with CONFIG_SYS_I2C_RCAR
2080 - This driver adds 4 i2c buses
2081
2082 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2083 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2084 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2085 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2086 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2087 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2088 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2089 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2090 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2091
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002092 - drivers/i2c/sh_i2c.c:
2093 - activate this driver with CONFIG_SYS_I2C_SH
2094 - This driver adds from 2 to 5 i2c buses
2095
2096 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2097 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2098 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2099 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2100 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2101 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2102 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2103 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2104 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2105 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2106 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2107 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2108 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2109
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002110 - drivers/i2c/omap24xx_i2c.c
2111 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2112 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2113 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2114 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2115 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2116 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2117 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2118 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2119 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2120 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2121 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2122
Heiko Schocher465819a2013-11-08 07:30:53 +01002123 - drivers/i2c/zynq_i2c.c
2124 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2125 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2126 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2127
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302128 - drivers/i2c/s3c24x0_i2c.c:
2129 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2130 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2131 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2132 with a fix speed from 100000 and the slave addr 0!
2133
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002134 additional defines:
2135
2136 CONFIG_SYS_NUM_I2C_BUSES
2137 Hold the number of i2c busses you want to use. If you
2138 don't use/have i2c muxes on your i2c bus, this
2139 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2140 omit this define.
2141
2142 CONFIG_SYS_I2C_DIRECT_BUS
2143 define this, if you don't use i2c muxes on your hardware.
2144 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2145 omit this define.
2146
2147 CONFIG_SYS_I2C_MAX_HOPS
2148 define how many muxes are maximal consecutively connected
2149 on one i2c bus. If you not use i2c muxes, omit this
2150 define.
2151
2152 CONFIG_SYS_I2C_BUSES
2153 hold a list of busses you want to use, only used if
2154 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2155 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2156 CONFIG_SYS_NUM_I2C_BUSES = 9:
2157
2158 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2159 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2160 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2161 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2162 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2163 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2164 {1, {I2C_NULL_HOP}}, \
2165 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2166 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2167 }
2168
2169 which defines
2170 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002171 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2172 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2173 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2174 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2175 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002176 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002177 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2178 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002179
2180 If you do not have i2c muxes on your board, omit this define.
2181
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002182- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002183
2184 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2185 provides the following compelling advantages:
2186
2187 - more than one i2c adapter is usable
2188 - approved multibus support
2189 - better i2c mux support
2190
2191 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002192
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002193 These enable legacy I2C serial bus commands. Defining
2194 CONFIG_HARD_I2C will include the appropriate I2C driver
2195 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002196
wdenk21136db2003-07-16 21:53:01 +00002197 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002198 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002199 CONFIG_COMMANDS) and communicate with i2c based realtime
2200 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002201 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002202
Ben Warren45657152006-09-07 16:50:54 -04002203 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002204
wdenk21136db2003-07-16 21:53:01 +00002205 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002206 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002208 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002209 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002210 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002211 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002212
Peter Tysere4d1abc2010-04-12 22:28:21 -05002213 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002214 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002215 and so its address should therefore be cleared to 0 (See,
2216 eg, MPC823e User's Manual p.16-473). So, set
2217 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002218
Eric Millbrandt12990a42009-09-03 08:09:44 -05002219 CONFIG_SYS_I2C_INIT_MPC5XXX
2220
2221 When a board is reset during an i2c bus transfer
2222 chips might think that the current transfer is still
2223 in progress. Reset the slave devices by sending start
2224 commands until the slave device responds.
2225
wdenk21136db2003-07-16 21:53:01 +00002226 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002227
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002228 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002229 then the following macros need to be defined (examples are
2230 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002231
2232 I2C_INIT
2233
wdenkb9bbd242003-06-30 16:24:52 +00002234 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002235 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002236
wdenk544e9732004-02-06 23:19:44 +00002237 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002238
wdenkc6097192002-11-03 00:24:07 +00002239 I2C_PORT
2240
wdenk4a5c8a72003-03-06 00:02:04 +00002241 (Only for MPC8260 CPU). The I/O port to use (the code
2242 assumes both bits are on the same port). Valid values
2243 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002244
2245 I2C_ACTIVE
2246
2247 The code necessary to make the I2C data line active
2248 (driven). If the data line is open collector, this
2249 define can be null.
2250
wdenkb9bbd242003-06-30 16:24:52 +00002251 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2252
wdenkc6097192002-11-03 00:24:07 +00002253 I2C_TRISTATE
2254
2255 The code necessary to make the I2C data line tri-stated
2256 (inactive). If the data line is open collector, this
2257 define can be null.
2258
wdenkb9bbd242003-06-30 16:24:52 +00002259 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2260
wdenkc6097192002-11-03 00:24:07 +00002261 I2C_READ
2262
York Sun4a598092013-04-01 11:29:11 -07002263 Code that returns true if the I2C data line is high,
2264 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002265
wdenkb9bbd242003-06-30 16:24:52 +00002266 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2267
wdenkc6097192002-11-03 00:24:07 +00002268 I2C_SDA(bit)
2269
York Sun4a598092013-04-01 11:29:11 -07002270 If <bit> is true, sets the I2C data line high. If it
2271 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002272
wdenkb9bbd242003-06-30 16:24:52 +00002273 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002274 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002275 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002276
wdenkc6097192002-11-03 00:24:07 +00002277 I2C_SCL(bit)
2278
York Sun4a598092013-04-01 11:29:11 -07002279 If <bit> is true, sets the I2C clock line high. If it
2280 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002281
wdenkb9bbd242003-06-30 16:24:52 +00002282 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002283 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002284 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002285
wdenkc6097192002-11-03 00:24:07 +00002286 I2C_DELAY
2287
2288 This delay is invoked four times per clock cycle so this
2289 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002290 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002291 like:
2292
wdenkb9bbd242003-06-30 16:24:52 +00002293 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002294
Mike Frysingeree12d542010-07-21 13:38:02 -04002295 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2296
2297 If your arch supports the generic GPIO framework (asm/gpio.h),
2298 then you may alternatively define the two GPIOs that are to be
2299 used as SCL / SDA. Any of the previous I2C_xxx macros will
2300 have GPIO-based defaults assigned to them as appropriate.
2301
2302 You should define these to the GPIO value as given directly to
2303 the generic GPIO functions.
2304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002305 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002306
wdenk57b2d802003-06-27 21:31:46 +00002307 When a board is reset during an i2c bus transfer
2308 chips might think that the current transfer is still
2309 in progress. On some boards it is possible to access
2310 the i2c SCLK line directly, either by using the
2311 processor pin as a GPIO or by having a second pin
2312 connected to the bus. If this option is defined a
2313 custom i2c_init_board() routine in boards/xxx/board.c
2314 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002315
Richard Retanubundf0149c2010-04-12 15:08:17 -04002316 CONFIG_SYS_I2C_BOARD_LATE_INIT
2317
2318 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2319 defined a custom i2c_board_late_init() routine in
2320 boards/xxx/board.c is run AFTER the operations in i2c_init()
2321 is completed. This callpoint can be used to unreset i2c bus
2322 using CPU i2c controller register accesses for CPUs whose i2c
2323 controller provide such a method. It is called at the end of
2324 i2c_init() to allow i2c_init operations to setup the i2c bus
2325 controller on the CPU (e.g. setting bus speed & slave address).
2326
wdenk0e2bd9c2004-06-06 21:51:03 +00002327 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2328
2329 This option enables configuration of bi_iic_fast[] flags
2330 in u-boot bd_info structure based on u-boot environment
2331 variable "i2cfast". (see also i2cfast)
2332
Ben Warren45657152006-09-07 16:50:54 -04002333 CONFIG_I2C_MULTI_BUS
2334
2335 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002336 must have a controller. At any point in time, only one bus is
2337 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002338 Note that bus numbering is zero-based.
2339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002340 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002341
2342 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002343 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002344 is set, specify a list of bus-device pairs. Otherwise, specify
2345 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002346
2347 e.g.
2348 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002349 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002350
2351 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2352
Wolfgang Denk092ae952011-10-26 10:21:21 +00002353 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002354 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002355
2356 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002358 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002359
2360 If defined, then this indicates the I2C bus number for DDR SPD.
2361 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2362
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002363 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002364
2365 If defined, then this indicates the I2C bus number for the RTC.
2366 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002368 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002369
2370 If defined, then this indicates the I2C bus number for the DTT.
2371 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2372
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002373 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002374
2375 If defined, specifies the I2C address of the DTT device.
2376 If not defined, then U-Boot uses predefined value for
2377 specified DTT device.
2378
Andrew Dyer58c41f92008-12-29 17:36:01 -06002379 CONFIG_SOFT_I2C_READ_REPEATED_START
2380
2381 defining this will force the i2c_read() function in
2382 the soft_i2c driver to perform an I2C repeated start
2383 between writing the address pointer and reading the
2384 data. If this define is omitted the default behaviour
2385 of doing a stop-start sequence will be used. Most I2C
2386 devices can use either method, but some require one or
2387 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002388
wdenkc6097192002-11-03 00:24:07 +00002389- SPI Support: CONFIG_SPI
2390
2391 Enables SPI driver (so far only tested with
2392 SPI EEPROM, also an instance works with Crystal A/D and
2393 D/As on the SACSng board)
2394
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002395 CONFIG_SH_SPI
2396
2397 Enables the driver for SPI controller on SuperH. Currently
2398 only SH7757 is supported.
2399
wdenkc6097192002-11-03 00:24:07 +00002400 CONFIG_SPI_X
2401
2402 Enables extended (16-bit) SPI EEPROM addressing.
2403 (symmetrical to CONFIG_I2C_X)
2404
2405 CONFIG_SOFT_SPI
2406
wdenk4a5c8a72003-03-06 00:02:04 +00002407 Enables a software (bit-bang) SPI driver rather than
2408 using hardware support. This is a general purpose
2409 driver that only requires three general I/O port pins
2410 (two outputs, one input) to function. If this is
2411 defined, the board configuration must define several
2412 SPI configuration items (port pins to use, etc). For
2413 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002414
Ben Warren7efe9272008-01-16 22:37:35 -05002415 CONFIG_HARD_SPI
2416
2417 Enables a hardware SPI driver for general-purpose reads
2418 and writes. As with CONFIG_SOFT_SPI, the board configuration
2419 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002420 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002421 example, see include/configs/mpc8349emds.h.
2422
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002423 CONFIG_MXC_SPI
2424
2425 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002426 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002427
Matthias Fuchsa4400872007-12-27 17:12:34 +01002428- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002429
Matthias Fuchsa4400872007-12-27 17:12:34 +01002430 Enables FPGA subsystem.
2431
2432 CONFIG_FPGA_<vendor>
2433
2434 Enables support for specific chip vendors.
2435 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002436
Matthias Fuchsa4400872007-12-27 17:12:34 +01002437 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002438
Matthias Fuchsa4400872007-12-27 17:12:34 +01002439 Enables support for FPGA family.
2440 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2441
2442 CONFIG_FPGA_COUNT
2443
2444 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002446 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002447
wdenk57b2d802003-06-27 21:31:46 +00002448 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002450 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002451
wdenk4a5c8a72003-03-06 00:02:04 +00002452 Enable checks on FPGA configuration interface busy
2453 status by the configuration function. This option
2454 will require a board or device specific function to
2455 be written.
wdenkc6097192002-11-03 00:24:07 +00002456
2457 CONFIG_FPGA_DELAY
2458
2459 If defined, a function that provides delays in the FPGA
2460 configuration driver.
2461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002462 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002463 Allow Control-C to interrupt FPGA configuration
2464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002465 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002466
wdenk4a5c8a72003-03-06 00:02:04 +00002467 Check for configuration errors during FPGA bitfile
2468 loading. For example, abort during Virtex II
2469 configuration if the INIT_B line goes low (which
2470 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002472 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002473
wdenk4a5c8a72003-03-06 00:02:04 +00002474 Maximum time to wait for the INIT_B line to deassert
2475 after PROB_B has been deasserted during a Virtex II
2476 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002477 ms.
wdenkc6097192002-11-03 00:24:07 +00002478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002479 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002480
wdenk4a5c8a72003-03-06 00:02:04 +00002481 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002482 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002484 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002485
wdenk4a5c8a72003-03-06 00:02:04 +00002486 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002487 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002488
2489- Configuration Management:
2490 CONFIG_IDENT_STRING
2491
wdenk4a5c8a72003-03-06 00:02:04 +00002492 If defined, this string will be added to the U-Boot
2493 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002494
2495- Vendor Parameter Protection:
2496
wdenk4a5c8a72003-03-06 00:02:04 +00002497 U-Boot considers the values of the environment
2498 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002499 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002500 are set once by the board vendor / manufacturer, and
2501 protects these variables from casual modification by
2502 the user. Once set, these variables are read-only,
2503 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002504 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002505
2506 If CONFIG_ENV_OVERWRITE is #defined in your config
2507 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002508 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002509 these parameters.
2510
2511 Alternatively, if you #define _both_ CONFIG_ETHADDR
2512 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002513 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002514 which can be changed exactly ONCE by the user. [The
2515 serial# is unaffected by this, i. e. it remains
2516 read-only.]
2517
Joe Hershberger71497d02012-12-11 22:16:31 -06002518 The same can be accomplished in a more flexible way
2519 for any variable by configuring the type of access
2520 to allow for those variables in the ".flags" variable
2521 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2522
wdenkc6097192002-11-03 00:24:07 +00002523- Protected RAM:
2524 CONFIG_PRAM
2525
2526 Define this variable to enable the reservation of
2527 "protected RAM", i. e. RAM which is not overwritten
2528 by U-Boot. Define CONFIG_PRAM to hold the number of
2529 kB you want to reserve for pRAM. You can overwrite
2530 this default value by defining an environment
2531 variable "pram" to the number of kB you want to
2532 reserve. Note that the board info structure will
2533 still show the full amount of RAM. If pRAM is
2534 reserved, a new environment variable "mem" will
2535 automatically be defined to hold the amount of
2536 remaining RAM in a form that can be passed as boot
2537 argument to Linux, for instance like that:
2538
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002539 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002540 saveenv
2541
2542 This way you can tell Linux not to use this memory,
2543 either, which results in a memory region that will
2544 not be affected by reboots.
2545
2546 *WARNING* If your board configuration uses automatic
2547 detection of the RAM size, you must make sure that
2548 this memory test is non-destructive. So far, the
2549 following board configurations are known to be
2550 "pRAM-clean":
2551
Wolfgang Denk90326762012-10-24 02:36:15 +00002552 IVMS8, IVML24, SPD8xx, TQM8xxL,
2553 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002554 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002555
Gabe Blacka2f3a932012-12-02 04:55:18 +00002556- Access to physical memory region (> 4GB)
2557 Some basic support is provided for operations on memory not
2558 normally accessible to U-Boot - e.g. some architectures
2559 support access to more than 4GB of memory on 32-bit
2560 machines using physical address extension or similar.
2561 Define CONFIG_PHYSMEM to access this basic support, which
2562 currently only supports clearing the memory.
2563
wdenkc6097192002-11-03 00:24:07 +00002564- Error Recovery:
2565 CONFIG_PANIC_HANG
2566
2567 Define this variable to stop the system in case of a
2568 fatal error, so that you have to reset it manually.
2569 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002570 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002571 automatically as fast as possible, but it may be
2572 useful during development since you can try to debug
2573 the conditions that lead to the situation.
2574
2575 CONFIG_NET_RETRY_COUNT
2576
wdenk4a5c8a72003-03-06 00:02:04 +00002577 This variable defines the number of retries for
2578 network operations like ARP, RARP, TFTP, or BOOTP
2579 before giving up the operation. If not defined, a
2580 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002581
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002582 CONFIG_ARP_TIMEOUT
2583
2584 Timeout waiting for an ARP reply in milliseconds.
2585
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002586 CONFIG_NFS_TIMEOUT
2587
2588 Timeout in milliseconds used in NFS protocol.
2589 If you encounter "ERROR: Cannot umount" in nfs command,
2590 try longer timeout such as
2591 #define CONFIG_NFS_TIMEOUT 10000UL
2592
wdenkc6097192002-11-03 00:24:07 +00002593- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002594 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002595
2596 Enable auto completion of commands using TAB.
2597
Wolfgang Denk018147d2006-11-27 15:32:42 +01002598 Note that this feature has NOT been implemented yet
2599 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002600
2601
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002602 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002603
2604 Define this variable to enable the "hush" shell (from
2605 Busybox) as command line interpreter, thus enabling
2606 powerful command line syntax like
2607 if...then...else...fi conditionals or `&&' and '||'
2608 constructs ("shell scripts").
2609
2610 If undefined, you get the old, much simpler behaviour
2611 with a somewhat smaller memory footprint.
2612
2613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002614 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002615
2616 This defines the secondary prompt string, which is
2617 printed when the command interpreter needs more input
2618 to complete a command. Usually "> ".
2619
2620 Note:
2621
wdenk57b2d802003-06-27 21:31:46 +00002622 In the current implementation, the local variables
2623 space and global environment variables space are
2624 separated. Local variables are those you define by
2625 simply typing `name=value'. To access a local
2626 variable later on, you have write `$name' or
2627 `${name}'; to execute the contents of a variable
2628 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002629
wdenk4a5c8a72003-03-06 00:02:04 +00002630 Global environment variables are those you use
2631 setenv/printenv to work with. To run a command stored
2632 in such a variable, you need to use the run command,
2633 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002634
2635 To store commands and special characters in a
2636 variable, please use double quotation marks
2637 surrounding the whole text of the variable, instead
2638 of the backslashes before semicolons and special
2639 symbols.
2640
Wolfgang Denk2039a072006-07-21 11:35:21 +02002641- Commandline Editing and History:
2642 CONFIG_CMDLINE_EDITING
2643
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002644 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002645 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002646
wdenkc0aa5c52003-12-06 19:49:23 +00002647- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002648 CONFIG_EXTRA_ENV_SETTINGS
2649
wdenk4a5c8a72003-03-06 00:02:04 +00002650 Define this to contain any number of null terminated
2651 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002652 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002653
wdenk4a5c8a72003-03-06 00:02:04 +00002654 For example, place something like this in your
2655 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002656
2657 #define CONFIG_EXTRA_ENV_SETTINGS \
2658 "myvar1=value1\0" \
2659 "myvar2=value2\0"
2660
wdenk4a5c8a72003-03-06 00:02:04 +00002661 Warning: This method is based on knowledge about the
2662 internal format how the environment is stored by the
2663 U-Boot code. This is NOT an official, exported
2664 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002665 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002666 You better know what you are doing here.
2667
wdenk4a5c8a72003-03-06 00:02:04 +00002668 Note: overly (ab)use of the default environment is
2669 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002670 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002671 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002672
Stephen Warren1465d5f2012-05-22 09:21:54 +00002673 CONFIG_ENV_VARS_UBOOT_CONFIG
2674
2675 Define this in order to add variables describing the
2676 U-Boot build configuration to the default environment.
2677 These will be named arch, cpu, board, vendor, and soc.
2678
2679 Enabling this option will cause the following to be defined:
2680
2681 - CONFIG_SYS_ARCH
2682 - CONFIG_SYS_CPU
2683 - CONFIG_SYS_BOARD
2684 - CONFIG_SYS_VENDOR
2685 - CONFIG_SYS_SOC
2686
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002687 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2688
2689 Define this in order to add variables describing certain
2690 run-time determined information about the hardware to the
2691 environment. These will be named board_name, board_rev.
2692
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002693 CONFIG_DELAY_ENVIRONMENT
2694
2695 Normally the environment is loaded when the board is
2696 intialised so that it is available to U-Boot. This inhibits
2697 that so that the environment is not available until
2698 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2699 this is instead controlled by the value of
2700 /config/load-environment.
2701
wdenkc0aa5c52003-12-06 19:49:23 +00002702- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002703 CONFIG_HAS_DATAFLASH
2704
wdenk57b2d802003-06-27 21:31:46 +00002705 Defining this option enables DataFlash features and
2706 allows to read/write in Dataflash via the standard
2707 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002708
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002709- Serial Flash support
2710 CONFIG_CMD_SF
2711
2712 Defining this option enables SPI flash commands
2713 'sf probe/read/write/erase/update'.
2714
2715 Usage requires an initial 'probe' to define the serial
2716 flash parameters, followed by read/write/erase/update
2717 commands.
2718
2719 The following defaults may be provided by the platform
2720 to handle the common case when only a single serial
2721 flash is present on the system.
2722
2723 CONFIG_SF_DEFAULT_BUS Bus identifier
2724 CONFIG_SF_DEFAULT_CS Chip-select
2725 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2726 CONFIG_SF_DEFAULT_SPEED in Hz
2727
Simon Glass4b5545e2012-10-08 13:16:02 +00002728 CONFIG_CMD_SF_TEST
2729
2730 Define this option to include a destructive SPI flash
2731 test ('sf test').
2732
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302733 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2734
2735 Define this option to use the Bank addr/Extended addr
2736 support on SPI flashes which has size > 16Mbytes.
2737
wdenkef893942004-02-23 16:11:30 +00002738- SystemACE Support:
2739 CONFIG_SYSTEMACE
2740
2741 Adding this option adds support for Xilinx SystemACE
2742 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002743 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002744 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002745
2746 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002747 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002748
2749 When SystemACE support is added, the "ace" device type
2750 becomes available to the fat commands, i.e. fatls.
2751
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002752- TFTP Fixed UDP Port:
2753 CONFIG_TFTP_PORT
2754
Wolfgang Denk227b5192005-09-24 23:25:46 +02002755 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002756 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002757 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002758 number generator is used.
2759
Wolfgang Denk227b5192005-09-24 23:25:46 +02002760 Also, the environment variable tftpdstp is used to supply
2761 the TFTP UDP destination port value. If tftpdstp isn't
2762 defined, the normal port 69 is used.
2763
2764 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002765 blindly start the TFTP transfer using the pre-configured
2766 target IP address and UDP port. This has the effect of
2767 "punching through" the (Windows XP) firewall, allowing
2768 the remainder of the TFTP transfer to proceed normally.
2769 A better solution is to properly configure the firewall,
2770 but sometimes that is not allowed.
2771
Simon Glass058bb8d2012-12-05 14:46:38 +00002772- Hashing support:
2773 CONFIG_CMD_HASH
2774
2775 This enables a generic 'hash' command which can produce
2776 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2777
2778 CONFIG_HASH_VERIFY
2779
2780 Enable the hash verify command (hash -v). This adds to code
2781 size a little.
2782
2783 CONFIG_SHA1 - support SHA1 hashing
2784 CONFIG_SHA256 - support SHA256 hashing
2785
2786 Note: There is also a sha1sum command, which should perhaps
2787 be deprecated in favour of 'hash sha1'.
2788
Robert Winkler765ccf42013-07-24 17:57:06 -07002789- Freescale i.MX specific commands:
2790 CONFIG_CMD_HDMIDETECT
2791 This enables 'hdmidet' command which returns true if an
2792 HDMI monitor is detected. This command is i.MX 6 specific.
2793
2794 CONFIG_CMD_BMODE
2795 This enables the 'bmode' (bootmode) command for forcing
2796 a boot from specific media.
2797
2798 This is useful for forcing the ROM's usb downloader to
2799 activate upon a watchdog reset which is nice when iterating
2800 on U-Boot. Using the reset button or running bmode normal
2801 will set it back to normal. This command currently
2802 supports i.MX53 and i.MX6.
2803
Simon Glass35191a32013-06-13 15:10:02 -07002804- Signing support:
2805 CONFIG_RSA
2806
2807 This enables the RSA algorithm used for FIT image verification
2808 in U-Boot. See doc/uImage/signature for more information.
2809
2810 The signing part is build into mkimage regardless of this
2811 option.
2812
2813
wdenkc0aa5c52003-12-06 19:49:23 +00002814- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002815 CONFIG_SHOW_BOOT_PROGRESS
2816
wdenk4a5c8a72003-03-06 00:02:04 +00002817 Defining this option allows to add some board-
2818 specific code (calling a user-provided function
2819 "show_boot_progress(int)") that enables you to show
2820 the system's boot progress on some display (for
2821 example, some LED's) on your board. At the moment,
2822 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002823
Simon Glass31a870e2012-02-13 13:51:19 +00002824- Detailed boot stage timing
2825 CONFIG_BOOTSTAGE
2826 Define this option to get detailed timing of each stage
2827 of the boot process.
2828
2829 CONFIG_BOOTSTAGE_USER_COUNT
2830 This is the number of available user bootstage records.
2831 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2832 a new ID will be allocated from this stash. If you exceed
2833 the limit, recording will stop.
2834
2835 CONFIG_BOOTSTAGE_REPORT
2836 Define this to print a report before boot, similar to this:
2837
2838 Timer summary in microseconds:
2839 Mark Elapsed Stage
2840 0 0 reset
2841 3,575,678 3,575,678 board_init_f start
2842 3,575,695 17 arch_cpu_init A9
2843 3,575,777 82 arch_cpu_init done
2844 3,659,598 83,821 board_init_r start
2845 3,910,375 250,777 main_loop
2846 29,916,167 26,005,792 bootm_start
2847 30,361,327 445,160 start_kernel
2848
Simon Glass4afd88e2012-09-28 08:56:39 +00002849 CONFIG_CMD_BOOTSTAGE
2850 Add a 'bootstage' command which supports printing a report
2851 and un/stashing of bootstage data.
2852
Simon Glass0fa36a42012-09-28 08:56:37 +00002853 CONFIG_BOOTSTAGE_FDT
2854 Stash the bootstage information in the FDT. A root 'bootstage'
2855 node is created with each bootstage id as a child. Each child
2856 has a 'name' property and either 'mark' containing the
2857 mark time in microsecond, or 'accum' containing the
2858 accumulated time for that bootstage id in microseconds.
2859 For example:
2860
2861 bootstage {
2862 154 {
2863 name = "board_init_f";
2864 mark = <3575678>;
2865 };
2866 170 {
2867 name = "lcd";
2868 accum = <33482>;
2869 };
2870 };
2871
2872 Code in the Linux kernel can find this in /proc/devicetree.
2873
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002874Legacy uImage format:
2875
wdenkc6097192002-11-03 00:24:07 +00002876 Arg Where When
2877 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002878 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002879 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002880 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002881 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002882 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002883 4 common/cmd_bootm.c Image data has correct checksum
2884 -4 common/cmd_bootm.c Image is for unsupported architecture
2885 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002886 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002887 6 common/cmd_bootm.c Image Type check OK
2888 -6 common/cmd_bootm.c gunzip uncompression error
2889 -7 common/cmd_bootm.c Unimplemented compression type
2890 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002891 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002892 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002893
2894 9 common/image.c Start initial ramdisk verification
2895 -10 common/image.c Ramdisk header has bad magic number
2896 -11 common/image.c Ramdisk header has bad checksum
2897 10 common/image.c Ramdisk header is OK
2898 -12 common/image.c Ramdisk data has bad checksum
2899 11 common/image.c Ramdisk data has correct checksum
2900 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002901 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002902 13 common/image.c Start multifile image verification
2903 14 common/image.c No initial ramdisk, no multifile, continue.
2904
Wolfgang Denk092ae952011-10-26 10:21:21 +00002905 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002906
Stefan Roese88fbf932010-04-15 16:07:28 +02002907 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002908 -31 post/post.c POST test failed, detected by post_output_backlog()
2909 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002910
Heiko Schocher633e03a2007-06-22 19:11:54 +02002911 34 common/cmd_doc.c before loading a Image from a DOC device
2912 -35 common/cmd_doc.c Bad usage of "doc" command
2913 35 common/cmd_doc.c correct usage of "doc" command
2914 -36 common/cmd_doc.c No boot device
2915 36 common/cmd_doc.c correct boot device
2916 -37 common/cmd_doc.c Unknown Chip ID on boot device
2917 37 common/cmd_doc.c correct chip ID found, device available
2918 -38 common/cmd_doc.c Read Error on boot device
2919 38 common/cmd_doc.c reading Image header from DOC device OK
2920 -39 common/cmd_doc.c Image header has bad magic number
2921 39 common/cmd_doc.c Image header has correct magic number
2922 -40 common/cmd_doc.c Error reading Image from DOC device
2923 40 common/cmd_doc.c Image header has correct magic number
2924 41 common/cmd_ide.c before loading a Image from a IDE device
2925 -42 common/cmd_ide.c Bad usage of "ide" command
2926 42 common/cmd_ide.c correct usage of "ide" command
2927 -43 common/cmd_ide.c No boot device
2928 43 common/cmd_ide.c boot device found
2929 -44 common/cmd_ide.c Device not available
2930 44 common/cmd_ide.c Device available
2931 -45 common/cmd_ide.c wrong partition selected
2932 45 common/cmd_ide.c partition selected
2933 -46 common/cmd_ide.c Unknown partition table
2934 46 common/cmd_ide.c valid partition table found
2935 -47 common/cmd_ide.c Invalid partition type
2936 47 common/cmd_ide.c correct partition type
2937 -48 common/cmd_ide.c Error reading Image Header on boot device
2938 48 common/cmd_ide.c reading Image Header from IDE device OK
2939 -49 common/cmd_ide.c Image header has bad magic number
2940 49 common/cmd_ide.c Image header has correct magic number
2941 -50 common/cmd_ide.c Image header has bad checksum
2942 50 common/cmd_ide.c Image header has correct checksum
2943 -51 common/cmd_ide.c Error reading Image from IDE device
2944 51 common/cmd_ide.c reading Image from IDE device OK
2945 52 common/cmd_nand.c before loading a Image from a NAND device
2946 -53 common/cmd_nand.c Bad usage of "nand" command
2947 53 common/cmd_nand.c correct usage of "nand" command
2948 -54 common/cmd_nand.c No boot device
2949 54 common/cmd_nand.c boot device found
2950 -55 common/cmd_nand.c Unknown Chip ID on boot device
2951 55 common/cmd_nand.c correct chip ID found, device available
2952 -56 common/cmd_nand.c Error reading Image Header on boot device
2953 56 common/cmd_nand.c reading Image Header from NAND device OK
2954 -57 common/cmd_nand.c Image header has bad magic number
2955 57 common/cmd_nand.c Image header has correct magic number
2956 -58 common/cmd_nand.c Error reading Image from NAND device
2957 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002958
Heiko Schocher633e03a2007-06-22 19:11:54 +02002959 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002960
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002961 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002962 -64 net/eth.c no Ethernet found.
2963 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002964
Heiko Schocher633e03a2007-06-22 19:11:54 +02002965 -80 common/cmd_net.c usage wrong
2966 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002967 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002968 81 common/cmd_net.c NetLoop() back without error
2969 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2970 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002971 83 common/cmd_net.c running "source" command
2972 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002973 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002974
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002975FIT uImage format:
2976
2977 Arg Where When
2978 100 common/cmd_bootm.c Kernel FIT Image has correct format
2979 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2980 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2981 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2982 102 common/cmd_bootm.c Kernel unit name specified
2983 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002984 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002985 104 common/cmd_bootm.c Got kernel subimage node offset
2986 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2987 105 common/cmd_bootm.c Kernel subimage hash verification OK
2988 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2989 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002990 -106 common/cmd_bootm.c Kernel subimage has wrong type
2991 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002992 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2993 108 common/cmd_bootm.c Got kernel subimage data/size
2994 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2995 -109 common/cmd_bootm.c Can't get kernel subimage type
2996 -110 common/cmd_bootm.c Can't get kernel subimage comp
2997 -111 common/cmd_bootm.c Can't get kernel subimage os
2998 -112 common/cmd_bootm.c Can't get kernel subimage load address
2999 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3000
3001 120 common/image.c Start initial ramdisk verification
3002 -120 common/image.c Ramdisk FIT image has incorrect format
3003 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003004 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003005 -122 common/image.c Can't get configuration for ramdisk subimage
3006 123 common/image.c Ramdisk unit name specified
3007 -124 common/image.c Can't get ramdisk subimage node offset
3008 125 common/image.c Got ramdisk subimage node offset
3009 -125 common/image.c Ramdisk subimage hash verification failed
3010 126 common/image.c Ramdisk subimage hash verification OK
3011 -126 common/image.c Ramdisk subimage for unsupported architecture
3012 127 common/image.c Architecture check OK
3013 -127 common/image.c Can't get ramdisk subimage data/size
3014 128 common/image.c Got ramdisk subimage data/size
3015 129 common/image.c Can't get ramdisk load address
3016 -129 common/image.c Got ramdisk load address
3017
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003018 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003019 131 common/cmd_doc.c FIT image format OK
3020
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003021 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003022 141 common/cmd_ide.c FIT image format OK
3023
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003024 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003025 151 common/cmd_nand.c FIT image format OK
3026
Gabe Blackd572e162012-10-25 16:31:10 +00003027- FIT image support:
3028 CONFIG_FIT
3029 Enable support for the FIT uImage format.
3030
3031 CONFIG_FIT_BEST_MATCH
3032 When no configuration is explicitly selected, default to the
3033 one whose fdt's compatibility field best matches that of
3034 U-Boot itself. A match is considered "best" if it matches the
3035 most specific compatibility entry of U-Boot's fdt's root node.
3036 The order of entries in the configuration's fdt is ignored.
3037
Simon Glass58fe7e52013-06-13 15:10:00 -07003038 CONFIG_FIT_SIGNATURE
3039 This option enables signature verification of FIT uImages,
3040 using a hash signed and verified using RSA. See
3041 doc/uImage.FIT/signature.txt for more details.
3042
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003043- Standalone program support:
3044 CONFIG_STANDALONE_LOAD_ADDR
3045
Wolfgang Denk23f78482011-10-09 21:06:34 +02003046 This option defines a board specific value for the
3047 address where standalone program gets loaded, thus
3048 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003049 settings.
3050
3051- Frame Buffer Address:
3052 CONFIG_FB_ADDR
3053
3054 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003055 address for frame buffer. This is typically the case
3056 when using a graphics controller has separate video
3057 memory. U-Boot will then place the frame buffer at
3058 the given address instead of dynamically reserving it
3059 in system RAM by calling lcd_setmem(), which grabs
3060 the memory for the frame buffer depending on the
3061 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003062
3063 Please see board_init_f function.
3064
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003065- Automatic software updates via TFTP server
3066 CONFIG_UPDATE_TFTP
3067 CONFIG_UPDATE_TFTP_CNT_MAX
3068 CONFIG_UPDATE_TFTP_MSEC_MAX
3069
3070 These options enable and control the auto-update feature;
3071 for a more detailed description refer to doc/README.update.
3072
3073- MTD Support (mtdparts command, UBI support)
3074 CONFIG_MTD_DEVICE
3075
3076 Adds the MTD device infrastructure from the Linux kernel.
3077 Needed for mtdparts command support.
3078
3079 CONFIG_MTD_PARTITIONS
3080
3081 Adds the MTD partitioning infrastructure from the Linux
3082 kernel. Needed for UBI support.
3083
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003084- UBI support
3085 CONFIG_CMD_UBI
3086
3087 Adds commands for interacting with MTD partitions formatted
3088 with the UBI flash translation layer
3089
3090 Requires also defining CONFIG_RBTREE
3091
Joe Hershberger47550fc2013-04-08 10:32:49 +00003092 CONFIG_UBI_SILENCE_MSG
3093
3094 Make the verbose messages from UBI stop printing. This leaves
3095 warnings and errors enabled.
3096
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003097- UBIFS support
3098 CONFIG_CMD_UBIFS
3099
3100 Adds commands for interacting with UBI volumes formatted as
3101 UBIFS. UBIFS is read-only in u-boot.
3102
3103 Requires UBI support as well as CONFIG_LZO
3104
Joe Hershberger47550fc2013-04-08 10:32:49 +00003105 CONFIG_UBIFS_SILENCE_MSG
3106
3107 Make the verbose messages from UBIFS stop printing. This leaves
3108 warnings and errors enabled.
3109
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003110- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003111 CONFIG_SPL
3112 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003113
Tom Rini36853852012-02-14 07:29:40 +00003114 CONFIG_SPL_LDSCRIPT
3115 LDSCRIPT for linking the SPL binary.
3116
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003117 CONFIG_SPL_MAX_FOOTPRINT
3118 Maximum size in memory allocated to the SPL, BSS included.
3119 When defined, the linker checks that the actual memory
3120 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003121 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003122 must not be both defined at the same time.
3123
Tom Rini36853852012-02-14 07:29:40 +00003124 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003125 Maximum size of the SPL image (text, data, rodata, and
3126 linker lists sections), BSS excluded.
3127 When defined, the linker checks that the actual size does
3128 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003129
Wolfgang Denk825223d2011-09-11 21:24:09 +02003130 CONFIG_SPL_TEXT_BASE
3131 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003132
Scott Woodc4f0d002012-09-20 19:05:12 -05003133 CONFIG_SPL_RELOC_TEXT_BASE
3134 Address to relocate to. If unspecified, this is equal to
3135 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3136
Tom Rini36853852012-02-14 07:29:40 +00003137 CONFIG_SPL_BSS_START_ADDR
3138 Link address for the BSS within the SPL binary.
3139
3140 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003141 Maximum size in memory allocated to the SPL BSS.
3142 When defined, the linker checks that the actual memory used
3143 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003144 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003145 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003146
3147 CONFIG_SPL_STACK
3148 Adress of the start of the stack SPL will use
3149
Scott Woodc4f0d002012-09-20 19:05:12 -05003150 CONFIG_SPL_RELOC_STACK
3151 Adress of the start of the stack SPL will use after
3152 relocation. If unspecified, this is equal to
3153 CONFIG_SPL_STACK.
3154
Tom Rini36853852012-02-14 07:29:40 +00003155 CONFIG_SYS_SPL_MALLOC_START
3156 Starting address of the malloc pool used in SPL.
3157
3158 CONFIG_SYS_SPL_MALLOC_SIZE
3159 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003160
Tom Rini28591df2012-08-13 12:03:19 -07003161 CONFIG_SPL_FRAMEWORK
3162 Enable the SPL framework under common/. This framework
3163 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3164 NAND loading of the Linux Kernel.
3165
Tom Rinife3b0c72012-08-13 11:37:56 -07003166 CONFIG_SPL_DISPLAY_PRINT
3167 For ARM, enable an optional function to print more information
3168 about the running system.
3169
Scott Wood7c810902012-09-20 16:35:21 -05003170 CONFIG_SPL_INIT_MINIMAL
3171 Arch init code should be built for a very small image
3172
Wolfgang Denk825223d2011-09-11 21:24:09 +02003173 CONFIG_SPL_LIBCOMMON_SUPPORT
3174 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003175
Wolfgang Denk825223d2011-09-11 21:24:09 +02003176 CONFIG_SPL_LIBDISK_SUPPORT
3177 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003178
Wolfgang Denk825223d2011-09-11 21:24:09 +02003179 CONFIG_SPL_I2C_SUPPORT
3180 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003181
Wolfgang Denk825223d2011-09-11 21:24:09 +02003182 CONFIG_SPL_GPIO_SUPPORT
3183 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003184
Wolfgang Denk825223d2011-09-11 21:24:09 +02003185 CONFIG_SPL_MMC_SUPPORT
3186 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003187
Tom Rini36853852012-02-14 07:29:40 +00003188 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3189 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3190 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3191 Address, size and partition on the MMC to load U-Boot from
3192 when the MMC is being used in raw mode.
3193
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003194 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3195 Sector to load kernel uImage from when MMC is being
3196 used in raw mode (for Falcon mode)
3197
3198 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3199 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3200 Sector and number of sectors to load kernel argument
3201 parameters from when MMC is being used in raw mode
3202 (for falcon mode)
3203
Tom Rini36853852012-02-14 07:29:40 +00003204 CONFIG_SPL_FAT_SUPPORT
3205 Support for fs/fat/libfat.o in SPL binary
3206
3207 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3208 Filename to read to load U-Boot when reading from FAT
3209
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003210 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3211 Filename to read to load kernel uImage when reading
3212 from FAT (for Falcon mode)
3213
3214 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3215 Filename to read to load kernel argument parameters
3216 when reading from FAT (for Falcon mode)
3217
Scott Wood2b36fbb2012-12-06 13:33:17 +00003218 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3219 Set this for NAND SPL on PPC mpc83xx targets, so that
3220 start.S waits for the rest of the SPL to load before
3221 continuing (the hardware starts execution after just
3222 loading the first page rather than the full 4K).
3223
Scott Woodc352a0c2012-09-20 19:09:07 -05003224 CONFIG_SPL_NAND_BASE
3225 Include nand_base.c in the SPL. Requires
3226 CONFIG_SPL_NAND_DRIVERS.
3227
3228 CONFIG_SPL_NAND_DRIVERS
3229 SPL uses normal NAND drivers, not minimal drivers.
3230
3231 CONFIG_SPL_NAND_ECC
3232 Include standard software ECC in the SPL
3233
Tom Rini36853852012-02-14 07:29:40 +00003234 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003235 Support for NAND boot using simple NAND drivers that
3236 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003237
Ying Zhang9ff70262013-08-16 15:16:11 +08003238 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3239 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003240 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003241
Ying Zhangdfb2b152013-08-16 15:16:12 +08003242 CONFIG_SPL_COMMON_INIT_DDR
3243 Set for common ddr init with serial presence detect in
3244 SPL binary.
3245
Tom Rini36853852012-02-14 07:29:40 +00003246 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3247 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3248 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3249 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3250 CONFIG_SYS_NAND_ECCBYTES
3251 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003252 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003253
3254 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003255 Location in NAND to read U-Boot from
3256
3257 CONFIG_SYS_NAND_U_BOOT_DST
3258 Location in memory to load U-Boot to
3259
3260 CONFIG_SYS_NAND_U_BOOT_SIZE
3261 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003262
3263 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003264 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003265
3266 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3267 Define this if you need to first read the OOB and then the
3268 data. This is used for example on davinci plattforms.
3269
3270 CONFIG_SPL_OMAP3_ID_NAND
3271 Support for an OMAP3-specific set of functions to return the
3272 ID and MFR of the first attached NAND chip, if present.
3273
Wolfgang Denk825223d2011-09-11 21:24:09 +02003274 CONFIG_SPL_SERIAL_SUPPORT
3275 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003276
Wolfgang Denk825223d2011-09-11 21:24:09 +02003277 CONFIG_SPL_SPI_FLASH_SUPPORT
3278 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003279
Wolfgang Denk825223d2011-09-11 21:24:09 +02003280 CONFIG_SPL_SPI_SUPPORT
3281 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003282
Pavel Machekde997252012-08-30 22:42:11 +02003283 CONFIG_SPL_RAM_DEVICE
3284 Support for running image already present in ram, in SPL binary
3285
Wolfgang Denk825223d2011-09-11 21:24:09 +02003286 CONFIG_SPL_LIBGENERIC_SUPPORT
3287 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003288
Ying Zhang602f7d32013-05-20 14:07:25 +08003289 CONFIG_SPL_ENV_SUPPORT
3290 Support for the environment operating in SPL binary
3291
3292 CONFIG_SPL_NET_SUPPORT
3293 Support for the net/libnet.o in SPL binary.
3294 It conflicts with SPL env from storage medium specified by
3295 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3296
Scott Woodeb7bd972012-12-06 13:33:16 +00003297 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003298 Image offset to which the SPL should be padded before appending
3299 the SPL payload. By default, this is defined as
3300 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3301 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3302 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003303
Scott Woodf147eb72012-09-21 16:27:32 -05003304 CONFIG_SPL_TARGET
3305 Final target image containing SPL and payload. Some SPLs
3306 use an arch-specific makefile fragment instead, for
3307 example if more than one image needs to be produced.
3308
Simon Glass82d94532013-05-08 08:05:59 +00003309 CONFIG_FIT_SPL_PRINT
3310 Printing information about a FIT image adds quite a bit of
3311 code to SPL. So this is normally disabled in SPL. Use this
3312 option to re-enable it. This will affect the output of the
3313 bootm command when booting a FIT image.
3314
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003315- TPL framework
3316 CONFIG_TPL
3317 Enable building of TPL globally.
3318
3319 CONFIG_TPL_PAD_TO
3320 Image offset to which the TPL should be padded before appending
3321 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003322 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3323 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3324 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003325
wdenkc6097192002-11-03 00:24:07 +00003326Modem Support:
3327--------------
3328
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003329[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003330
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003331- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003332 CONFIG_MODEM_SUPPORT
3333
3334- RTS/CTS Flow control enable:
3335 CONFIG_HWFLOW
3336
3337- Modem debug support:
3338 CONFIG_MODEM_SUPPORT_DEBUG
3339
wdenk4a5c8a72003-03-06 00:02:04 +00003340 Enables debugging stuff (char screen[1024], dbg())
3341 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003342
wdenkc0aa5c52003-12-06 19:49:23 +00003343- Interrupt support (PPC):
3344
wdenk1ebf41e2004-01-02 14:00:00 +00003345 There are common interrupt_init() and timer_interrupt()
3346 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003347 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003348 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003349 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003350 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003351 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003352 specific handling. If board has watchdog / status_led
3353 / other_activity_monitor it works automatically from
3354 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003355
wdenkc6097192002-11-03 00:24:07 +00003356- General:
3357
wdenk4a5c8a72003-03-06 00:02:04 +00003358 In the target system modem support is enabled when a
3359 specific key (key combination) is pressed during
3360 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003361 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003362 board_init(). Currently key_pressed() is a dummy
3363 function, returning 1 and thus enabling modem
3364 initialization.
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk4a5c8a72003-03-06 00:02:04 +00003366 If there are no modem init strings in the
3367 environment, U-Boot proceed to autoboot; the
3368 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003369 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003370
3371 See also: doc/README.Modem
3372
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003373Board initialization settings:
3374------------------------------
3375
3376During Initialization u-boot calls a number of board specific functions
3377to allow the preparation of board specific prerequisites, e.g. pin setup
3378before drivers are initialized. To enable these callbacks the
3379following configuration macros have to be defined. Currently this is
3380architecture specific, so please check arch/your_architecture/lib/board.c
3381typically in board_init_f() and board_init_r().
3382
3383- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3384- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3385- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3386- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003387
wdenkc6097192002-11-03 00:24:07 +00003388Configuration Settings:
3389-----------------------
3390
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003391- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003392 undefine this when you're short of memory.
3393
Peter Tyserdfb72b82009-01-27 18:03:12 -06003394- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3395 width of the commands listed in the 'help' command output.
3396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003397- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003398 prompt for user input.
3399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003400- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003401
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003402- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003404- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003405
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003406- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003407 the application (usually a Linux kernel) when it is
3408 booted
3409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003410- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003411 List of legal baudrate settings for this board.
3412
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003413- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003414 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003415
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003416- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003417 If the board specific function
3418 extern int overwrite_console (void);
3419 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003420 serial port, else the settings in the environment are used.
3421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003422- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003423 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003425- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003426 Enable overwrite of previous console environment settings.
3427
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003428- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003429 Begin and End addresses of the area used by the
3430 simple memory test.
3431
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003432- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003433 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003434
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003435- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003436 Scratch address used by the alternate memory test
3437 You only need to set this if address zero isn't writeable
3438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003439- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3440 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003441 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003442 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003443 fixing up gd->ram_size the Linux kernel should gets passed
3444 the now "corrected" memory size and won't touch it either.
3445 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003446 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003447 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003448 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003449
3450 This option can be used as a workaround for the 440EPx/GRx
3451 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3452 be touched.
3453
3454 WARNING: Please make sure that this value is a multiple of
3455 the Linux page size (normally 4k). If this is not the case,
3456 then the end address of the Linux memory will be located at a
3457 non page size aligned address and this could cause major
3458 problems.
3459
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003460- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003461 Enable temporary baudrate change while serial download
3462
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003463- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003464 Physical start address of SDRAM. _Must_ be 0 here.
3465
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003466- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003467 Physical start address of Motherboard I/O (if using a
3468 Cogent motherboard)
3469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003470- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003471 Physical start address of Flash memory.
3472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003473- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003474 Physical start address of boot monitor code (set by
3475 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003476 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003477 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003479- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003480 Size of memory reserved for monitor code, used to
3481 determine _at_compile_time_ (!) if the environment is
3482 embedded within the U-Boot image, or in a separate
3483 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003484
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003485- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003486 Size of DRAM reserved for malloc() use.
3487
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003488- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003489 Normally compressed uImages are limited to an
3490 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003491 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003492 to adjust this setting to your needs.
3493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003494- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003495 Maximum size of memory mapped by the startup code of
3496 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003497 the Linux kernel (bd_info, boot arguments, FDT blob if
3498 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003499 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003500 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003501 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003502 variable "bootm_mapsize" will override the value of
3503 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3504 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003505
John Rigbyeea8e692010-10-13 13:57:35 -06003506- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3507 Enable initrd_high functionality. If defined then the
3508 initrd_high feature is enabled and the bootm ramdisk subcommand
3509 is enabled.
3510
3511- CONFIG_SYS_BOOT_GET_CMDLINE:
3512 Enables allocating and saving kernel cmdline in space between
3513 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3514
3515- CONFIG_SYS_BOOT_GET_KBD:
3516 Enables allocating and saving a kernel copy of the bd_info in
3517 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003519- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003520 Max number of Flash memory banks
3521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003522- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003523 Max number of sectors on a Flash chip
3524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003525- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003526 Timeout for Flash erase operations (in ms)
3527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003528- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003529 Timeout for Flash write operations (in ms)
3530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003531- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003532 Timeout for Flash set sector lock bit operation (in ms)
3533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003534- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003535 Timeout for Flash clear lock bits operation (in ms)
3536
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003537- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003538 If defined, hardware flash sectors protection is used
3539 instead of U-Boot software protection.
3540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003541- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003542
3543 Enable TFTP transfers directly to flash memory;
3544 without this option such a download has to be
3545 performed in two steps: (1) download to RAM, and (2)
3546 copy from RAM to flash.
3547
3548 The two-step approach is usually more reliable, since
3549 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003550 the flash, but in some situations (when system RAM is
3551 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003552 downloaded image) this option may be very useful.
3553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003554- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003555 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003556 common flash structure for storing flash geometry.
3557
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003558- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003559 This option also enables the building of the cfi_flash driver
3560 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003561
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003562- CONFIG_FLASH_CFI_MTD
3563 This option enables the building of the cfi_mtd driver
3564 in the drivers directory. The driver exports CFI flash
3565 to the MTD layer.
3566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003568 Use buffered writes to flash.
3569
3570- CONFIG_FLASH_SPANSION_S29WS_N
3571 s29ws-n MirrorBit flash has non-standard addresses for buffered
3572 write commands.
3573
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003574- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003575 If this option is defined, the common CFI flash doesn't
3576 print it's warning upon not recognized FLASH banks. This
3577 is useful, if some of the configured banks are only
3578 optionally available.
3579
Jerry Van Barenaae73572008-03-08 13:48:01 -05003580- CONFIG_FLASH_SHOW_PROGRESS
3581 If defined (must be an integer), print out countdown
3582 digits and dots. Recommended value: 45 (9..1) for 80
3583 column displays, 15 (3..1) for 40 column displays.
3584
Stefan Roesed20cba52013-04-04 15:53:14 +02003585- CONFIG_FLASH_VERIFY
3586 If defined, the content of the flash (destination) is compared
3587 against the source after the write operation. An error message
3588 will be printed when the contents are not identical.
3589 Please note that this option is useless in nearly all cases,
3590 since such flash programming errors usually are detected earlier
3591 while unprotecting/erasing/programming. Please only enable
3592 this option if you really know what you are doing.
3593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003594- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003595 Defines the number of Ethernet receive buffers. On some
3596 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003597 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3598 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003599 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003600 Defaults to 4 if not defined.
3601
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003602- CONFIG_ENV_MAX_ENTRIES
3603
Wolfgang Denk1136f692010-10-27 22:48:30 +02003604 Maximum number of entries in the hash table that is used
3605 internally to store the environment settings. The default
3606 setting is supposed to be generous and should work in most
3607 cases. This setting can be used to tune behaviour; see
3608 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003609
Joe Hershberger71497d02012-12-11 22:16:31 -06003610- CONFIG_ENV_FLAGS_LIST_DEFAULT
3611- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003612 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003613 calling env set. Variables can be restricted to only decimal,
3614 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3615 the variables can also be restricted to IP address or MAC address.
3616
3617 The format of the list is:
3618 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003619 access_atribute = [a|r|o|c]
3620 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003621 entry = variable_name[:attributes]
3622 list = entry[,list]
3623
3624 The type attributes are:
3625 s - String (default)
3626 d - Decimal
3627 x - Hexadecimal
3628 b - Boolean ([1yYtT|0nNfF])
3629 i - IP address
3630 m - MAC address
3631
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003632 The access attributes are:
3633 a - Any (default)
3634 r - Read-only
3635 o - Write-once
3636 c - Change-default
3637
Joe Hershberger71497d02012-12-11 22:16:31 -06003638 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3639 Define this to a list (string) to define the ".flags"
3640 envirnoment variable in the default or embedded environment.
3641
3642 - CONFIG_ENV_FLAGS_LIST_STATIC
3643 Define this to a list (string) to define validation that
3644 should be done if an entry is not found in the ".flags"
3645 environment variable. To override a setting in the static
3646 list, simply add an entry for the same variable name to the
3647 ".flags" variable.
3648
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003649- CONFIG_ENV_ACCESS_IGNORE_FORCE
3650 If defined, don't allow the -f switch to env set override variable
3651 access flags.
3652
Simon Glass66828322013-03-08 13:45:27 +00003653- CONFIG_SYS_GENERIC_BOARD
3654 This selects the architecture-generic board system instead of the
3655 architecture-specific board files. It is intended to move boards
3656 to this new framework over time. Defining this will disable the
3657 arch/foo/lib/board.c file and use common/board_f.c and
3658 common/board_r.c instead. To use this option your architecture
3659 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3660 its config.mk file). If you find problems enabling this option on
3661 your board please report the problem and send patches!
3662
Simon Glass9c9f44a2013-03-11 07:06:48 +00003663- CONFIG_SYS_SYM_OFFSETS
3664 This is set by architectures that use offsets for link symbols
3665 instead of absolute values. So bss_start is obtained using an
3666 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3667 directly. You should not need to touch this setting.
3668
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003669- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3670 This is set by OMAP boards for the max time that reset should
3671 be asserted. See doc/README.omap-reset-time for details on how
3672 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003673
wdenkc6097192002-11-03 00:24:07 +00003674The following definitions that deal with the placement and management
3675of environment data (variable area); in general, we support the
3676following configurations:
3677
Mike Frysinger63b8f122011-07-08 10:44:25 +00003678- CONFIG_BUILD_ENVCRC:
3679
3680 Builds up envcrc with the target environment so that external utils
3681 may easily extract it and embed it in final U-Boot images.
3682
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003683- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003684
3685 Define this if the environment is in flash memory.
3686
3687 a) The environment occupies one whole flash sector, which is
3688 "embedded" in the text segment with the U-Boot code. This
3689 happens usually with "bottom boot sector" or "top boot
3690 sector" type flash chips, which have several smaller
3691 sectors at the start or the end. For instance, such a
3692 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3693 such a case you would place the environment in one of the
3694 4 kB sectors - with U-Boot code before and after it. With
3695 "top boot sector" type flash chips, you would put the
3696 environment in one of the last sectors, leaving a gap
3697 between U-Boot and the environment.
3698
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003699 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003700
3701 Offset of environment data (variable area) to the
3702 beginning of flash memory; for instance, with bottom boot
3703 type flash chips the second sector can be used: the offset
3704 for this sector is given here.
3705
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003706 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003707
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003708 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003709
3710 This is just another way to specify the start address of
3711 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003712 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003713
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003714 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003715
3716 Size of the sector containing the environment.
3717
3718
3719 b) Sometimes flash chips have few, equal sized, BIG sectors.
3720 In such a case you don't want to spend a whole sector for
3721 the environment.
3722
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003723 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003724
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003725 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003726 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003727 of this flash sector for the environment. This saves
3728 memory for the RAM copy of the environment.
3729
3730 It may also save flash memory if you decide to use this
3731 when your environment is "embedded" within U-Boot code,
3732 since then the remainder of the flash sector could be used
3733 for U-Boot code. It should be pointed out that this is
3734 STRONGLY DISCOURAGED from a robustness point of view:
3735 updating the environment in flash makes it always
3736 necessary to erase the WHOLE sector. If something goes
3737 wrong before the contents has been restored from a copy in
3738 RAM, your target system will be dead.
3739
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003740 - CONFIG_ENV_ADDR_REDUND
3741 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003742
wdenk4a5c8a72003-03-06 00:02:04 +00003743 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003744 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003745 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003746 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003747
3748BE CAREFUL! Any changes to the flash layout, and some changes to the
3749source code will make it necessary to adapt <board>/u-boot.lds*
3750accordingly!
3751
3752
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003753- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003754
3755 Define this if you have some non-volatile memory device
3756 (NVRAM, battery buffered SRAM) which you want to use for the
3757 environment.
3758
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003759 - CONFIG_ENV_ADDR:
3760 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003761
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003762 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003763 want to use for environment. It is assumed that this memory
3764 can just be read and written to, without any special
3765 provision.
3766
3767BE CAREFUL! The first access to the environment happens quite early
3768in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003769console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003770U-Boot will hang.
3771
3772Please note that even with NVRAM we still use a copy of the
3773environment in RAM: we could work on NVRAM directly, but we want to
3774keep settings there always unmodified except somebody uses "saveenv"
3775to save the current settings.
3776
3777
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003778- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003779
3780 Use this if you have an EEPROM or similar serial access
3781 device and a driver for it.
3782
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003783 - CONFIG_ENV_OFFSET:
3784 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003785
3786 These two #defines specify the offset and size of the
3787 environment area within the total memory of your EEPROM.
3788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003789 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003790 If defined, specified the chip address of the EEPROM device.
3791 The default address is zero.
3792
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003793 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003794 If defined, the number of bits used to address bytes in a
3795 single page in the EEPROM device. A 64 byte page, for example
3796 would require six bits.
3797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003798 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003799 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003800 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003801
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003802 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003803 The length in bytes of the EEPROM memory array address. Note
3804 that this is NOT the chip address length!
3805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003806 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003807 EEPROM chips that implement "address overflow" are ones
3808 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3809 address and the extra bits end up in the "chip address" bit
3810 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3811 byte chips.
3812
3813 Note that we consider the length of the address field to
3814 still be one byte because the extra address bits are hidden
3815 in the chip address.
3816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003818 The size in bytes of the EEPROM device.
3819
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003820 - CONFIG_ENV_EEPROM_IS_ON_I2C
3821 define this, if you have I2C and SPI activated, and your
3822 EEPROM, which holds the environment, is on the I2C bus.
3823
3824 - CONFIG_I2C_ENV_EEPROM_BUS
3825 if you have an Environment on an EEPROM reached over
3826 I2C muxes, you can define here, how to reach this
3827 EEPROM. For example:
3828
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003829 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003830
3831 EEPROM which holds the environment, is reached over
3832 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003833
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003834- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003835
wdenk1ebf41e2004-01-02 14:00:00 +00003836 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003837 want to use for the environment.
3838
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003839 - CONFIG_ENV_OFFSET:
3840 - CONFIG_ENV_ADDR:
3841 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003842
3843 These three #defines specify the offset and size of the
3844 environment area within the total memory of your DataFlash placed
3845 at the specified address.
3846
Liu Gang85bcd732012-03-08 00:33:20 +00003847- CONFIG_ENV_IS_IN_REMOTE:
3848
3849 Define this if you have a remote memory space which you
3850 want to use for the local device's environment.
3851
3852 - CONFIG_ENV_ADDR:
3853 - CONFIG_ENV_SIZE:
3854
3855 These two #defines specify the address and size of the
3856 environment area within the remote memory space. The
3857 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003858 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003859
3860BE CAREFUL! For some special cases, the local device can not use
3861"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003862environment stored in a remote NOR flash by SRIO or PCIE link,
3863but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003864
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003865- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003866
3867 Define this if you have a NAND device which you want to use
3868 for the environment.
3869
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003870 - CONFIG_ENV_OFFSET:
3871 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003872
3873 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003874 area within the first NAND device. CONFIG_ENV_OFFSET must be
3875 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003876
Scott Wood08239322010-09-17 14:38:37 -05003877 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003878
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003879 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003880 size used to hold a redundant copy of the environment data, so
3881 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003882 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003883 aligned to an erase block boundary.
3884
3885 - CONFIG_ENV_RANGE (optional):
3886
3887 Specifies the length of the region in which the environment
3888 can be written. This should be a multiple of the NAND device's
3889 block size. Specifying a range with more erase blocks than
3890 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3891 the range to be avoided.
3892
3893 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003894
Scott Wood08239322010-09-17 14:38:37 -05003895 Enables support for dynamically retrieving the offset of the
3896 environment from block zero's out-of-band data. The
3897 "nand env.oob" command can be used to record this offset.
3898 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3899 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003900
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003901- CONFIG_NAND_ENV_DST
3902
3903 Defines address in RAM to which the nand_spl code should copy the
3904 environment. If redundant environment is used, it will be copied to
3905 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3906
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003907- CONFIG_ENV_IS_IN_UBI:
3908
3909 Define this if you have an UBI volume that you want to use for the
3910 environment. This has the benefit of wear-leveling the environment
3911 accesses, which is important on NAND.
3912
3913 - CONFIG_ENV_UBI_PART:
3914
3915 Define this to a string that is the mtd partition containing the UBI.
3916
3917 - CONFIG_ENV_UBI_VOLUME:
3918
3919 Define this to the name of the volume that you want to store the
3920 environment in.
3921
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003922 - CONFIG_ENV_UBI_VOLUME_REDUND:
3923
3924 Define this to the name of another volume to store a second copy of
3925 the environment in. This will enable redundant environments in UBI.
3926 It is assumed that both volumes are in the same MTD partition.
3927
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003928 - CONFIG_UBI_SILENCE_MSG
3929 - CONFIG_UBIFS_SILENCE_MSG
3930
3931 You will probably want to define these to avoid a really noisy system
3932 when storing the env in UBI.
3933
Stephen Warreneedcacd2013-06-11 15:14:00 -06003934- CONFIG_ENV_IS_IN_MMC:
3935
3936 Define this if you have an MMC device which you want to use for the
3937 environment.
3938
3939 - CONFIG_SYS_MMC_ENV_DEV:
3940
3941 Specifies which MMC device the environment is stored in.
3942
3943 - CONFIG_SYS_MMC_ENV_PART (optional):
3944
3945 Specifies which MMC partition the environment is stored in. If not
3946 set, defaults to partition 0, the user area. Common values might be
3947 1 (first MMC boot partition), 2 (second MMC boot partition).
3948
3949 - CONFIG_ENV_OFFSET:
3950 - CONFIG_ENV_SIZE:
3951
3952 These two #defines specify the offset and size of the environment
3953 area within the specified MMC device.
3954
Stephen Warren24dc2032013-06-11 15:14:02 -06003955 If offset is positive (the usual case), it is treated as relative to
3956 the start of the MMC partition. If offset is negative, it is treated
3957 as relative to the end of the MMC partition. This can be useful if
3958 your board may be fitted with different MMC devices, which have
3959 different sizes for the MMC partitions, and you always want the
3960 environment placed at the very end of the partition, to leave the
3961 maximum possible space before it, to store other data.
3962
Stephen Warreneedcacd2013-06-11 15:14:00 -06003963 These two values are in units of bytes, but must be aligned to an
3964 MMC sector boundary.
3965
3966 - CONFIG_ENV_OFFSET_REDUND (optional):
3967
3968 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3969 hold a redundant copy of the environment data. This provides a
3970 valid backup copy in case the other copy is corrupted, e.g. due
3971 to a power failure during a "saveenv" operation.
3972
Stephen Warren24dc2032013-06-11 15:14:02 -06003973 This value may also be positive or negative; this is handled in the
3974 same way as CONFIG_ENV_OFFSET.
3975
Stephen Warreneedcacd2013-06-11 15:14:00 -06003976 This value is also in units of bytes, but must also be aligned to
3977 an MMC sector boundary.
3978
3979 - CONFIG_ENV_SIZE_REDUND (optional):
3980
3981 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3982 set. If this value is set, it must be set to the same value as
3983 CONFIG_ENV_SIZE.
3984
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003985- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003986
3987 Defines offset to the initial SPI buffer area in DPRAM. The
3988 area is used at an early stage (ROM part) if the environment
3989 is configured to reside in the SPI EEPROM: We need a 520 byte
3990 scratch DPRAM area. It is used between the two initialization
3991 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3992 to be a good choice since it makes it far enough from the
3993 start of the data area as well as from the stack pointer.
3994
Bruce Adleredecc942007-11-02 13:15:42 -07003995Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003996has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003997created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003998until then to read environment variables.
3999
wdenk8dba0502003-03-31 16:34:49 +00004000The environment is protected by a CRC32 checksum. Before the monitor
4001is relocated into RAM, as a result of a bad CRC you will be working
4002with the compiled-in default environment - *silently*!!! [This is
4003necessary, because the first environment variable we need is the
4004"baudrate" setting for the console - if we have a bad CRC, we don't
4005have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004006
4007Note: once the monitor has been relocated, then it will complain if
4008the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004009use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004010
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004011- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004012 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004013
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004014 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004015 also needs to be defined.
4016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004017- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004018 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004019
Ron Madriddfa028a2009-02-18 14:30:44 -08004020- CONFIG_NS16550_MIN_FUNCTIONS:
4021 Define this if you desire to only have use of the NS16550_init
4022 and NS16550_putc functions for the serial driver located at
4023 drivers/serial/ns16550.c. This option is useful for saving
4024 space for already greatly restricted images, including but not
4025 limited to NAND_SPL configurations.
4026
Simon Glass28a9e332012-11-30 13:01:18 +00004027- CONFIG_DISPLAY_BOARDINFO
4028 Display information about the board that U-Boot is running on
4029 when U-Boot starts up. The board function checkboard() is called
4030 to do this.
4031
Simon Glasse8822012012-11-30 13:01:19 +00004032- CONFIG_DISPLAY_BOARDINFO_LATE
4033 Similar to the previous option, but display this information
4034 later, once stdio is running and output goes to the LCD, if
4035 present.
4036
wdenkc6097192002-11-03 00:24:07 +00004037Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004038---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004040- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004041 Cache Line Size of the CPU.
4042
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004043- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004044 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004045
wdenk9c53f402003-10-15 23:53:47 +00004046 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4047 and RPXsuper) to be able to adjust the position of
4048 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004049
Timur Tabid8f341c2011-08-04 18:03:41 -05004050- CONFIG_SYS_CCSRBAR_DEFAULT:
4051 Default (power-on reset) physical address of CCSR on Freescale
4052 PowerPC SOCs.
4053
4054- CONFIG_SYS_CCSRBAR:
4055 Virtual address of CCSR. On a 32-bit build, this is typically
4056 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4057
4058 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4059 for cross-platform code that uses that macro instead.
4060
4061- CONFIG_SYS_CCSRBAR_PHYS:
4062 Physical address of CCSR. CCSR can be relocated to a new
4063 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004064 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004065 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4066 is typically relocated on 36-bit builds. It is recommended
4067 that this macro be defined via the _HIGH and _LOW macros:
4068
4069 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4070 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4071
4072- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004073 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4074 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004075 used in assembly code, so it must not contain typecasts or
4076 integer size suffixes (e.g. "ULL").
4077
4078- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4079 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4080 used in assembly code, so it must not contain typecasts or
4081 integer size suffixes (e.g. "ULL").
4082
4083- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4084 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4085 forced to a value that ensures that CCSR is not relocated.
4086
wdenk1272e232002-11-10 22:06:23 +00004087- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004088 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004089
4090 the default drive number (default value 0)
4091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004092 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004093
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004094 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004095 (default value 1)
4096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004097 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004098
wdenk4a5c8a72003-03-06 00:02:04 +00004099 defines the offset of register from address. It
4100 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004101 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004103 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4104 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004105 default value.
wdenk1272e232002-11-10 22:06:23 +00004106
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004107 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004108 fdc_hw_init() is called at the beginning of the FDC
4109 setup. fdc_hw_init() must be provided by the board
4110 source code. It is used to make hardware dependant
4111 initializations.
wdenk1272e232002-11-10 22:06:23 +00004112
Macpaul Lind1e49942011-04-11 20:45:32 +00004113- CONFIG_IDE_AHB:
4114 Most IDE controllers were designed to be connected with PCI
4115 interface. Only few of them were designed for AHB interface.
4116 When software is doing ATA command and data transfer to
4117 IDE devices through IDE-AHB controller, some additional
4118 registers accessing to these kind of IDE-AHB controller
4119 is requierd.
4120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004121- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004122 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004123 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004125- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004126
wdenkeb20ad32003-09-05 23:19:14 +00004127 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004128 initial data and stack; please note that this must be
4129 writable memory that is working WITHOUT special
4130 initialization, i. e. you CANNOT use normal RAM which
4131 will become available only after programming the
4132 memory controller and running certain initialization
4133 sequences.
4134
4135 U-Boot uses the following memory types:
4136 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4137 - MPC824X: data cache
4138 - PPC4xx: data cache
4139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004140- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004141
4142 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004143 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4144 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004145 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004146 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004147 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4148 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4149 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004150
4151 Note:
4152 On the MPC824X (or other systems that use the data
4153 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004155 point to an otherwise UNUSED address space between
4156 the top of RAM and the start of the PCI space.
4157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004160- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004162- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004163
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004164- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004166- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004167
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004168- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004170- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004171 SDRAM timing
4172
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004173- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004174 periodic timer for refresh
4175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004176- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004178- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4179 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4180 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4181 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004182 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4183
4184- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004185 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4186 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004187 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4188
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004189- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4190 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004191 Machine Mode Register and Memory Periodic Timer
4192 Prescaler definitions (SDRAM timing)
4193
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004194- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004195 enable I2C microcode relocation patch (MPC8xx);
4196 define relocation offset in DPRAM [DSP2]
4197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004198- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004199 enable SMC microcode relocation patch (MPC8xx);
4200 define relocation offset in DPRAM [SMC1]
4201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004202- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004203 enable SPI microcode relocation patch (MPC8xx);
4204 define relocation offset in DPRAM [SCC4]
4205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004206- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004207 Use OSCM clock mode on MBX8xx board. Be careful,
4208 wrong setting might damage your board. Read
4209 doc/README.MBX before setting this variable!
4210
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004211- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004212 Offset of the bootmode word in DPRAM used by post
4213 (Power On Self Tests). This definition overrides
4214 #define'd default value in commproc.h resp.
4215 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004216
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004217- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4218 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4219 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4220 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4221 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4222 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4223 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4224 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004225 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004226
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004227- CONFIG_PCI_DISABLE_PCIE:
4228 Disable PCI-Express on systems where it is supported but not
4229 required.
4230
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004231- CONFIG_PCI_ENUM_ONLY
4232 Only scan through and get the devices on the busses.
4233 Don't do any setup work, presumably because someone or
4234 something has already done it, and we don't need to do it
4235 a second time. Useful for platforms that are pre-booted
4236 by coreboot or similar.
4237
Gabor Juhosb4458732013-05-30 07:06:12 +00004238- CONFIG_PCI_INDIRECT_BRIDGE:
4239 Enable support for indirect PCI bridges.
4240
Kumar Gala8975d7a2010-12-30 12:09:53 -06004241- CONFIG_SYS_SRIO:
4242 Chip has SRIO or not
4243
4244- CONFIG_SRIO1:
4245 Board has SRIO 1 port available
4246
4247- CONFIG_SRIO2:
4248 Board has SRIO 2 port available
4249
Liu Gang27afb9c2013-05-07 16:30:46 +08004250- CONFIG_SRIO_PCIE_BOOT_MASTER
4251 Board can support master function for Boot from SRIO and PCIE
4252
Kumar Gala8975d7a2010-12-30 12:09:53 -06004253- CONFIG_SYS_SRIOn_MEM_VIRT:
4254 Virtual Address of SRIO port 'n' memory region
4255
4256- CONFIG_SYS_SRIOn_MEM_PHYS:
4257 Physical Address of SRIO port 'n' memory region
4258
4259- CONFIG_SYS_SRIOn_MEM_SIZE:
4260 Size of SRIO port 'n' memory region
4261
Fabio Estevamf17e8782013-04-11 09:35:34 +00004262- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4263 Defined to tell the NAND controller that the NAND chip is using
4264 a 16 bit bus.
4265 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004266 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004267 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004268 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004269
4270- CONFIG_SYS_NDFC_EBC0_CFG
4271 Sets the EBC0_CFG register for the NDFC. If not defined
4272 a default value will be used.
4273
Ben Warren45657152006-09-07 16:50:54 -04004274- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004275 Get DDR timing information from an I2C EEPROM. Common
4276 with pluggable memory modules such as SODIMMs
4277
Ben Warren45657152006-09-07 16:50:54 -04004278 SPD_EEPROM_ADDRESS
4279 I2C address of the SPD EEPROM
4280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004281- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004282 If SPD EEPROM is on an I2C bus other than the first
4283 one, specify here. Note that the value must resolve
4284 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004285
York Sune73cc042011-06-07 09:42:16 +08004286- CONFIG_SYS_DDR_RAW_TIMING
4287 Get DDR timing information from other than SPD. Common with
4288 soldered DDR chips onboard without SPD. DDR raw timing
4289 parameters are extracted from datasheet and hard-coded into
4290 header files or board specific files.
4291
York Sunbd495cf2011-09-16 13:21:35 -07004292- CONFIG_FSL_DDR_INTERACTIVE
4293 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4294
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004295- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004296 Only for 83xx systems. If specified, then DDR should
4297 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004298
wdenk6203e402004-04-18 10:13:26 +00004299- CONFIG_ETHER_ON_FEC[12]
4300 Define to enable FEC[12] on a 8xx series processor.
4301
4302- CONFIG_FEC[12]_PHY
4303 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004304 to the given FEC; i. e.
4305 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004306 means that the PHY with address 4 is connected to FEC1
4307
4308 When set to -1, means to probe for first available.
4309
4310- CONFIG_FEC[12]_PHY_NORXERR
4311 The PHY does not have a RXERR line (RMII only).
4312 (so program the FEC to ignore it).
4313
4314- CONFIG_RMII
4315 Enable RMII mode for all FECs.
4316 Note that this is a global option, we can't
4317 have one FEC in standard MII mode and another in RMII mode.
4318
wdenk20c98a62004-04-23 20:32:05 +00004319- CONFIG_CRC32_VERIFY
4320 Add a verify option to the crc32 command.
4321 The syntax is:
4322
4323 => crc32 -v <address> <count> <crc32>
4324
4325 Where address/count indicate a memory area
4326 and crc32 is the correct crc32 which the
4327 area should have.
4328
wdenk64519362004-07-11 17:40:54 +00004329- CONFIG_LOOPW
4330 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004331 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004332
stroesecc3af832004-12-16 18:46:55 +00004333- CONFIG_MX_CYCLIC
4334 Add the "mdc" and "mwc" memory commands. These are cyclic
4335 "md/mw" commands.
4336 Examples:
4337
wdenk07d7e6b2004-12-16 21:44:03 +00004338 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004339 This command will print 4 bytes (10,11,12,13) each 500 ms.
4340
wdenk07d7e6b2004-12-16 21:44:03 +00004341 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004342 This command will write 12345678 to address 100 all 10 ms.
4343
wdenk07d7e6b2004-12-16 21:44:03 +00004344 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004345 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004346
wdenk3d3d99f2005-04-04 12:44:11 +00004347- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004348 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004349 low level initializations (like setting up the memory
4350 controller) are omitted and/or U-Boot does not
4351 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004352
Wolfgang Denk302141d2010-11-27 23:30:56 +01004353 Normally this variable MUST NOT be defined. The only
4354 exception is when U-Boot is loaded (to RAM) by some
4355 other boot loader or by a debugger which performs
4356 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004357
Aneesh V552a3192011-07-13 05:11:07 +00004358- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004359 Modifies the behaviour of start.S when compiling a loader
4360 that is executed before the actual U-Boot. E.g. when
4361 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004362
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004363- CONFIG_TPL_BUILD
4364 Modifies the behaviour of start.S when compiling a loader
4365 that is executed after the SPL and before the actual U-Boot.
4366 It is loaded by the SPL.
4367
Ying Zhang0d4f5442013-05-20 14:07:23 +08004368- CONFIG_SYS_MPC85XX_NO_RESETVEC
4369 Only for 85xx systems. If this variable is specified, the section
4370 .resetvec is not kept and the section .bootpg is placed in the
4371 previous 4k of the .text section.
4372
Simon Glass17dabf02013-02-24 17:33:14 +00004373- CONFIG_ARCH_MAP_SYSMEM
4374 Generally U-Boot (and in particular the md command) uses
4375 effective address. It is therefore not necessary to regard
4376 U-Boot address as virtual addresses that need to be translated
4377 to physical addresses. However, sandbox requires this, since
4378 it maintains its own little RAM buffer which contains all
4379 addressable memory. This option causes some memory accesses
4380 to be mapped through map_sysmem() / unmap_sysmem().
4381
Matthias Weisser93416c12011-03-10 21:36:32 +00004382- CONFIG_USE_ARCH_MEMCPY
4383 CONFIG_USE_ARCH_MEMSET
4384 If these options are used a optimized version of memcpy/memset will
4385 be used if available. These functions may be faster under some
4386 conditions but may increase the binary size.
4387
Simon Glassbfb59802013-02-14 04:18:54 +00004388- CONFIG_X86_RESET_VECTOR
4389 If defined, the x86 reset vector code is included. This is not
4390 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004391
Mark Jackson52b003c2013-03-04 01:27:20 +00004392- CONFIG_SYS_MPUCLK
4393 Defines the MPU clock speed (in MHz).
4394
4395 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004396
Timur Tabi275f4bb2011-11-22 09:21:25 -06004397Freescale QE/FMAN Firmware Support:
4398-----------------------------------
4399
4400The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4401loading of "firmware", which is encoded in the QE firmware binary format.
4402This firmware often needs to be loaded during U-Boot booting, so macros
4403are used to identify the storage device (NOR flash, SPI, etc) and the address
4404within that device.
4405
4406- CONFIG_SYS_QE_FMAN_FW_ADDR
4407 The address in the storage device where the firmware is located. The
4408 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4409 is also specified.
4410
4411- CONFIG_SYS_QE_FMAN_FW_LENGTH
4412 The maximum possible size of the firmware. The firmware binary format
4413 has a field that specifies the actual size of the firmware, but it
4414 might not be possible to read any part of the firmware unless some
4415 local storage is allocated to hold the entire firmware first.
4416
4417- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4418 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4419 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4420 virtual address in NOR flash.
4421
4422- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4423 Specifies that QE/FMAN firmware is located in NAND flash.
4424 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4425
4426- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4427 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4428 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4429
4430- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4431 Specifies that QE/FMAN firmware is located on the primary SPI
4432 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4433
Liu Gang1e084582012-03-08 00:33:18 +00004434- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4435 Specifies that QE/FMAN firmware is located in the remote (master)
4436 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004437 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4438 window->master inbound window->master LAW->the ucode address in
4439 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004440
wdenkc6097192002-11-03 00:24:07 +00004441Building the Software:
4442======================
4443
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004444Building U-Boot has been tested in several native build environments
4445and in many different cross environments. Of course we cannot support
4446all possibly existing versions of cross development tools in all
4447(potentially obsolete) versions. In case of tool chain problems we
4448recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4449which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004450
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004451If you are not using a native environment, it is assumed that you
4452have GNU cross compiling tools available in your path. In this case,
4453you must set the environment variable CROSS_COMPILE in your shell.
4454Note that no changes to the Makefile or any other source files are
4455necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004456
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004457 $ CROSS_COMPILE=ppc_4xx-
4458 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004459
Peter Tyserb06976d2009-03-13 18:54:51 -05004460Note: If you wish to generate Windows versions of the utilities in
4461 the tools directory you can use the MinGW toolchain
4462 (http://www.mingw.org). Set your HOST tools to the MinGW
4463 toolchain and execute 'make tools'. For example:
4464
4465 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4466
4467 Binaries such as tools/mkimage.exe will be created which can
4468 be executed on computers running Windows.
4469
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004470U-Boot is intended to be simple to build. After installing the
4471sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004472is done by typing:
4473
4474 make NAME_config
4475
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004476where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004477rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004478
wdenk6c59edc2004-05-03 20:45:30 +00004479Note: for some board special configuration names may exist; check if
4480 additional information is available from the board vendor; for
4481 instance, the TQM823L systems are available without (standard)
4482 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004483 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485 make TQM823L_config
4486 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk6c59edc2004-05-03 20:45:30 +00004488 make TQM823L_LCD_config
4489 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk6c59edc2004-05-03 20:45:30 +00004491 etc.
wdenkc6097192002-11-03 00:24:07 +00004492
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk6c59edc2004-05-03 20:45:30 +00004494Finally, type "make all", and you should get some working U-Boot
4495images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk6c59edc2004-05-03 20:45:30 +00004497- "u-boot.bin" is a raw binary image
4498- "u-boot" is an image in ELF binary format
4499- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004500
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004501By default the build is performed locally and the objects are saved
4502in the source directory. One of the two methods can be used to change
4503this behavior and build U-Boot to some external directory:
4504
45051. Add O= to the make command line invocations:
4506
4507 make O=/tmp/build distclean
4508 make O=/tmp/build NAME_config
4509 make O=/tmp/build all
4510
45112. Set environment variable BUILD_DIR to point to the desired location:
4512
4513 export BUILD_DIR=/tmp/build
4514 make distclean
4515 make NAME_config
4516 make all
4517
4518Note that the command line "O=" setting overrides the BUILD_DIR environment
4519variable.
4520
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk6c59edc2004-05-03 20:45:30 +00004522Please be aware that the Makefiles assume you are using GNU make, so
4523for instance on NetBSD you might need to use "gmake" instead of
4524native "make".
wdenkc6097192002-11-03 00:24:07 +00004525
wdenkc6097192002-11-03 00:24:07 +00004526
wdenk6c59edc2004-05-03 20:45:30 +00004527If the system board that you have is not listed, then you will need
4528to port U-Boot to your hardware platform. To do this, follow these
4529steps:
wdenkc6097192002-11-03 00:24:07 +00004530
wdenk6c59edc2004-05-03 20:45:30 +000045311. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004532 "boards.cfg" file, using the existing entries as examples.
4533 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000045342. Create a new directory to hold your board specific code. Add any
4535 files you need. In your board directory, you will need at least
4536 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
45373. Create a new configuration file "include/configs/<board>.h" for
4538 your board
45393. If you're porting U-Boot to a new CPU, then also create a new
4540 directory to hold your CPU specific code. Add any files you need.
45414. Run "make <board>_config" with your new name.
45425. Type "make", and you should get a working "u-boot.srec" file
4543 to be installed on your target system.
45446. Debug and solve any problems that might arise.
4545 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004546
wdenkc6097192002-11-03 00:24:07 +00004547
wdenk6c59edc2004-05-03 20:45:30 +00004548Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4549==============================================================
wdenkc6097192002-11-03 00:24:07 +00004550
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004551If you have modified U-Boot sources (for instance added a new board
4552or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004553provide feedback to the other developers. The feedback normally takes
4554the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004555official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004556
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004557But before you submit such a patch, please verify that your modifi-
4558cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004559the supported boards compile WITHOUT ANY compiler warnings. To do so,
4560just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004561for ALL supported system. Be warned, this will take a while. You can
4562select which (cross) compiler to use by passing a `CROSS_COMPILE'
4563environment variable to the script, i. e. to use the ELDK cross tools
4564you can type
wdenkc6097192002-11-03 00:24:07 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004567
wdenk6c59edc2004-05-03 20:45:30 +00004568or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004569
wdenk6c59edc2004-05-03 20:45:30 +00004570 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004571
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004572When using the MAKEALL script, the default behaviour is to build
4573U-Boot in the source directory. This location can be changed by
4574setting the BUILD_DIR environment variable. Also, for each target
4575built, the MAKEALL script saves two log files (<target>.ERR and
4576<target>.MAKEALL) in the <source dir>/LOG directory. This default
4577location can be changed by setting the MAKEALL_LOGDIR environment
4578variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004579
4580 export BUILD_DIR=/tmp/build
4581 export MAKEALL_LOGDIR=/tmp/log
4582 CROSS_COMPILE=ppc_8xx- MAKEALL
4583
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004584With the above settings build objects are saved in the /tmp/build,
4585log files are saved in the /tmp/log and the source tree remains clean
4586during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004587
4588
wdenk6c59edc2004-05-03 20:45:30 +00004589See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004590
wdenkc6097192002-11-03 00:24:07 +00004591
wdenk6c59edc2004-05-03 20:45:30 +00004592Monitor Commands - Overview:
4593============================
wdenkc6097192002-11-03 00:24:07 +00004594
wdenk6c59edc2004-05-03 20:45:30 +00004595go - start application at address 'addr'
4596run - run commands in an environment variable
4597bootm - boot application image from memory
4598bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004599bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004600tftpboot- boot image via network using TFTP protocol
4601 and env variables "ipaddr" and "serverip"
4602 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004603tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004604rarpboot- boot image via network using RARP/TFTP protocol
4605diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4606loads - load S-Record file over serial line
4607loadb - load binary file over serial line (kermit mode)
4608md - memory display
4609mm - memory modify (auto-incrementing)
4610nm - memory modify (constant address)
4611mw - memory write (fill)
4612cp - memory copy
4613cmp - memory compare
4614crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004615i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004616sspi - SPI utility commands
4617base - print or set address offset
4618printenv- print environment variables
4619setenv - set environment variables
4620saveenv - save environment variables to persistent storage
4621protect - enable or disable FLASH write protection
4622erase - erase FLASH memory
4623flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004624nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004625bdinfo - print Board Info structure
4626iminfo - print header information for application image
4627coninfo - print console devices and informations
4628ide - IDE sub-system
4629loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004630loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004631mtest - simple RAM test
4632icache - enable or disable instruction cache
4633dcache - enable or disable data cache
4634reset - Perform RESET of the CPU
4635echo - echo args to console
4636version - print monitor version
4637help - print online help
4638? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004639
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk6c59edc2004-05-03 20:45:30 +00004641Monitor Commands - Detailed Description:
4642========================================
wdenkc6097192002-11-03 00:24:07 +00004643
wdenk6c59edc2004-05-03 20:45:30 +00004644TODO.
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004647
4648
wdenk6c59edc2004-05-03 20:45:30 +00004649Environment Variables:
4650======================
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk6c59edc2004-05-03 20:45:30 +00004652U-Boot supports user configuration using Environment Variables which
4653can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004654
wdenk6c59edc2004-05-03 20:45:30 +00004655Environment Variables are set using "setenv", printed using
4656"printenv", and saved to Flash using "saveenv". Using "setenv"
4657without a value can be used to delete a variable from the
4658environment. As long as you don't save the environment you are
4659working with an in-memory copy. In case the Flash area containing the
4660environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004661
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004662Some configuration options can be set using Environment Variables.
4663
4664List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk6c59edc2004-05-03 20:45:30 +00004670 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004675
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004676 bootm_low - Memory range available for image processing in the bootm
4677 command can be restricted. This variable is given as
4678 a hexadecimal number and defines lowest address allowed
4679 for use by the bootm command. See also "bootm_size"
4680 environment variable. Address defined by "bootm_low" is
4681 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004682 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4683 bootm_mapsize.
4684
Wolfgang Denk092ae952011-10-26 10:21:21 +00004685 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004686 This variable is given as a hexadecimal number and it
4687 defines the size of the memory region starting at base
4688 address bootm_low that is accessible by the Linux kernel
4689 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4690 as the default value if it is defined, and bootm_size is
4691 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004692
4693 bootm_size - Memory range available for image processing in the bootm
4694 command can be restricted. This variable is given as
4695 a hexadecimal number and defines the size of the region
4696 allowed for use by the bootm command. See also "bootm_low"
4697 environment variable.
4698
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004699 updatefile - Location of the software update file on a TFTP server, used
4700 by the automatic software update feature. Please refer to
4701 documentation in doc/README.update for more details.
4702
wdenk6c59edc2004-05-03 20:45:30 +00004703 autoload - if set to "no" (any string beginning with 'n'),
4704 "bootp" will just load perform a lookup of the
4705 configuration from the BOOTP server, but not try to
4706 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk6c59edc2004-05-03 20:45:30 +00004708 autostart - if set to "yes", an image loaded using the "bootp",
4709 "rarpboot", "tftpboot" or "diskboot" commands will
4710 be automatically started (by internally calling
4711 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713 If set to "no", a standalone image passed to the
4714 "bootm" command will be copied to the load address
4715 (and eventually uncompressed), but NOT be started.
4716 This can be used to load and uncompress arbitrary
4717 data.
wdenkc6097192002-11-03 00:24:07 +00004718
David A. Longd558a4e2011-07-09 16:40:19 -04004719 fdt_high - if set this restricts the maximum address that the
4720 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004721 For example, if you have a system with 1 GB memory
4722 at physical address 0x10000000, while Linux kernel
4723 only recognizes the first 704 MB as low memory, you
4724 may need to set fdt_high as 0x3C000000 to have the
4725 device tree blob be copied to the maximum address
4726 of the 704 MB low memory, so that Linux kernel can
4727 access it during the boot procedure.
4728
David A. Longd558a4e2011-07-09 16:40:19 -04004729 If this is set to the special value 0xFFFFFFFF then
4730 the fdt will not be copied at all on boot. For this
4731 to work it must reside in writable memory, have
4732 sufficient padding on the end of it for u-boot to
4733 add the information it needs into it, and the memory
4734 must be accessible by the kernel.
4735
Simon Glassdc6fa642011-10-24 19:15:34 +00004736 fdtcontroladdr- if set this is the address of the control flattened
4737 device tree used by U-Boot when CONFIG_OF_CONTROL is
4738 defined.
4739
wdenk0e2bd9c2004-06-06 21:51:03 +00004740 i2cfast - (PPC405GP|PPC405EP only)
4741 if set to 'y' configures Linux I2C driver for fast
4742 mode (400kHZ). This environment variable is used in
4743 initialization code. So, for changes to be effective
4744 it must be saved and board must be reset.
4745
wdenk6c59edc2004-05-03 20:45:30 +00004746 initrd_high - restrict positioning of initrd images:
4747 If this variable is not set, initrd images will be
4748 copied to the highest possible address in RAM; this
4749 is usually what you want since it allows for
4750 maximum initrd size. If for some reason you want to
4751 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004752 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004753 variable to a value of "no" or "off" or "0".
4754 Alternatively, you can set it to a maximum upper
4755 address to use (U-Boot will still check that it
4756 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004757
wdenk6c59edc2004-05-03 20:45:30 +00004758 For instance, when you have a system with 16 MB
4759 RAM, and want to reserve 4 MB from use by Linux,
4760 you can do this by adding "mem=12M" to the value of
4761 the "bootargs" variable. However, now you must make
4762 sure that the initrd image is placed in the first
4763 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk6c59edc2004-05-03 20:45:30 +00004765 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk6c59edc2004-05-03 20:45:30 +00004767 If you set initrd_high to 0xFFFFFFFF, this is an
4768 indication to U-Boot that all addresses are legal
4769 for the Linux kernel, including addresses in flash
4770 memory. In this case U-Boot will NOT COPY the
4771 ramdisk at all. This may be useful to reduce the
4772 boot time on your system, but requires that this
4773 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004774
wdenk6c59edc2004-05-03 20:45:30 +00004775 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk6c59edc2004-05-03 20:45:30 +00004777 loadaddr - Default load address for commands like "bootp",
4778 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk6c59edc2004-05-03 20:45:30 +00004780 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004783
wdenk6c59edc2004-05-03 20:45:30 +00004784 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk6c59edc2004-05-03 20:45:30 +00004786 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004789
Mike Frysingera23230c2011-10-02 10:01:27 +00004790 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004791
Mike Frysingera23230c2011-10-02 10:01:27 +00004792 ethact - controls which interface is currently active.
4793 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004794
Heiko Schocherc5e84052010-07-20 17:45:02 +02004795 => setenv ethact FEC
4796 => ping 192.168.0.1 # traffic sent on FEC
4797 => setenv ethact SCC
4798 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004799
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004800 ethrotate - When set to "no" U-Boot does not go through all
4801 available network interfaces.
4802 It just stays at the currently selected interface.
4803
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004804 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004805 either succeed or fail without retrying.
4806 When set to "once" the network operation will
4807 fail when all the available network interfaces
4808 are tried once without success.
4809 Useful on scripts which control the retry operation
4810 themselves.
wdenkc6097192002-11-03 00:24:07 +00004811
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004812 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004813
Simon Glass5db3f932013-07-16 20:10:00 -07004814 silent_linux - If set then linux will be told to boot silently, by
4815 changing the console to be empty. If "yes" it will be
4816 made silent. If "no" it will not be made silent. If
4817 unset, then it will be made silent if the U-Boot console
4818 is silent.
4819
Wolfgang Denk227b5192005-09-24 23:25:46 +02004820 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004821 UDP source port.
4822
Wolfgang Denk227b5192005-09-24 23:25:46 +02004823 tftpdstport - If this is set, the value is used for TFTP's UDP
4824 destination port instead of the Well Know Port 69.
4825
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004826 tftpblocksize - Block size to use for TFTP transfers; if not set,
4827 we use the TFTP server's default block size
4828
4829 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4830 seconds, minimum value is 1000 = 1 second). Defines
4831 when a packet is considered to be lost so it has to
4832 be retransmitted. The default is 5000 = 5 seconds.
4833 Lowering this value may make downloads succeed
4834 faster in networks with high packet loss rates or
4835 with unreliable TFTP servers.
4836
4837 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004838 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004839 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004840
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004841The following image location variables contain the location of images
4842used in booting. The "Image" column gives the role of the image and is
4843not an environment variable name. The other columns are environment
4844variable names. "File Name" gives the name of the file on a TFTP
4845server, "RAM Address" gives the location in RAM the image will be
4846loaded to, and "Flash Location" gives the image's address in NOR
4847flash or offset in NAND flash.
4848
4849*Note* - these variables don't have to be defined for all boards, some
4850boards currenlty use other variables for these purposes, and some
4851boards use these variables for other purposes.
4852
Wolfgang Denk092ae952011-10-26 10:21:21 +00004853Image File Name RAM Address Flash Location
4854----- --------- ----------- --------------
4855u-boot u-boot u-boot_addr_r u-boot_addr
4856Linux kernel bootfile kernel_addr_r kernel_addr
4857device tree blob fdtfile fdt_addr_r fdt_addr
4858ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004859
wdenk6c59edc2004-05-03 20:45:30 +00004860The following environment variables may be used and automatically
4861updated by the network boot commands ("bootp" and "rarpboot"),
4862depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004863
wdenk6c59edc2004-05-03 20:45:30 +00004864 bootfile - see above
4865 dnsip - IP address of your Domain Name Server
4866 dnsip2 - IP address of your secondary Domain Name Server
4867 gatewayip - IP address of the Gateway (Router) to use
4868 hostname - Target hostname
4869 ipaddr - see above
4870 netmask - Subnet Mask
4871 rootpath - Pathname of the root filesystem on the NFS server
4872 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004873
wdenk145d2c12004-04-15 21:48:45 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877 serial# - contains hardware identification information such
4878 as type string and/or serial number
4879 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881These variables can be set only once (usually during manufacturing of
4882the board). U-Boot refuses to delete or overwrite these variables
4883once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004884
4885
wdenk6c59edc2004-05-03 20:45:30 +00004886Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004887
wdenk6c59edc2004-05-03 20:45:30 +00004888 ver - Contains the U-Boot version string as printed
4889 with the "version" command. This variable is
4890 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004891
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893Please note that changes to some configuration parameters may take
4894only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004895
stroeseb9c17c52003-04-04 15:53:41 +00004896
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004897Callback functions for environment variables:
4898---------------------------------------------
4899
4900For some environment variables, the behavior of u-boot needs to change
4901when their values are changed. This functionailty allows functions to
4902be associated with arbitrary variables. On creation, overwrite, or
4903deletion, the callback will provide the opportunity for some side
4904effect to happen or for the change to be rejected.
4905
4906The callbacks are named and associated with a function using the
4907U_BOOT_ENV_CALLBACK macro in your board or driver code.
4908
4909These callbacks are associated with variables in one of two ways. The
4910static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4911in the board configuration to a string that defines a list of
4912associations. The list must be in the following format:
4913
4914 entry = variable_name[:callback_name]
4915 list = entry[,list]
4916
4917If the callback name is not specified, then the callback is deleted.
4918Spaces are also allowed anywhere in the list.
4919
4920Callbacks can also be associated by defining the ".callbacks" variable
4921with the same list format above. Any association in ".callbacks" will
4922override any association in the static list. You can define
4923CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4924".callbacks" envirnoment variable in the default or embedded environment.
4925
4926
wdenk6c59edc2004-05-03 20:45:30 +00004927Command Line Parsing:
4928=====================
stroeseb9c17c52003-04-04 15:53:41 +00004929
wdenk6c59edc2004-05-03 20:45:30 +00004930There are two different command line parsers available with U-Boot:
4931the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004932
wdenk6c59edc2004-05-03 20:45:30 +00004933Old, simple command line parser:
4934--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk6c59edc2004-05-03 20:45:30 +00004936- supports environment variables (through setenv / saveenv commands)
4937- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004938- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004939- special characters ('$', ';') can be escaped by prefixing with '\',
4940 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004941 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004942- You can also escape text by enclosing in single apostrophes, for example:
4943 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945Hush shell:
4946-----------
wdenkf4688a22003-05-28 08:06:31 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948- similar to Bourne shell, with control structures like
4949 if...then...else...fi, for...do...done; while...do...done,
4950 until...do...done, ...
4951- supports environment ("global") variables (through setenv / saveenv
4952 commands) and local shell variables (through standard shell syntax
4953 "name=value"); only environment variables can be used with "run"
4954 command
wdenkf4688a22003-05-28 08:06:31 +00004955
wdenk6c59edc2004-05-03 20:45:30 +00004956General rules:
4957--------------
wdenkf4688a22003-05-28 08:06:31 +00004958
wdenk6c59edc2004-05-03 20:45:30 +00004959(1) If a command line (or an environment variable executed by a "run"
4960 command) contains several commands separated by semicolon, and
4961 one of these commands fails, then the remaining commands will be
4962 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004963
wdenk6c59edc2004-05-03 20:45:30 +00004964(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004965 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004966 command will cause "run" to terminate, i. e. the remaining
4967 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969Note for Redundant Ethernet Interfaces:
4970=======================================
wdenkf4688a22003-05-28 08:06:31 +00004971
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004972Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004973such configurations and is capable of automatic selection of a
4974"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4977MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4978"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004979
wdenk6c59edc2004-05-03 20:45:30 +00004980If the network interface stores some valid MAC address (for instance
4981in SROM), this is used as default address if there is NO correspon-
4982ding setting in the environment; if the corresponding environment
4983variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985o If the SROM has a valid MAC address, and there is no address in the
4986 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk6c59edc2004-05-03 20:45:30 +00004988o If there is no valid address in the SROM, and a definition in the
4989 environment exists, then the value from the environment variable is
4990 used.
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992o If both the SROM and the environment contain a MAC address, and
4993 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995o If both the SROM and the environment contain a MAC address, and the
4996 addresses differ, the value from the environment is used and a
4997 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk6c59edc2004-05-03 20:45:30 +00004999o If neither SROM nor the environment contain a MAC address, an error
5000 is raised.
wdenkc6097192002-11-03 00:24:07 +00005001
Ben Warren6db991a2010-04-26 11:11:46 -07005002If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005003will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005004may be skipped by setting the appropriate 'ethmacskip' environment variable.
5005The naming convention is as follows:
5006"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008Image Formats:
5009==============
wdenkc6097192002-11-03 00:24:07 +00005010
Marian Balakowicz18710b82008-03-12 12:13:13 +01005011U-Boot is capable of booting (and performing other auxiliary operations on)
5012images in two formats:
5013
5014New uImage format (FIT)
5015-----------------------
5016
5017Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5018to Flattened Device Tree). It allows the use of images with multiple
5019components (several kernels, ramdisks, etc.), with contents protected by
5020SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5021
5022
5023Old uImage format
5024-----------------
5025
5026Old image format is based on binary files which can be basically anything,
5027preceded by a special header; see the definitions in include/image.h for
5028details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk6c59edc2004-05-03 20:45:30 +00005030* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5031 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005032 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5033 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5034 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005035* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005036 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5037 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005038* Compression Type (uncompressed, gzip, bzip2)
5039* Load Address
5040* Entry Point
5041* Image Name
5042* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk6c59edc2004-05-03 20:45:30 +00005044The header is marked by a special Magic Number, and both the header
5045and the data portions of the image are secured against corruption by
5046CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005047
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk6c59edc2004-05-03 20:45:30 +00005049Linux Support:
5050==============
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052Although U-Boot should support any OS or standalone application
5053easily, the main focus has always been on Linux during the design of
5054U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056U-Boot includes many features that so far have been part of some
5057special "boot loader" code within the Linux kernel. Also, any
5058"initrd" images to be used are no longer part of one big Linux image;
5059instead, kernel and "initrd" are separate images. This implementation
5060serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062- the same features can be used for other OS or standalone
5063 applications (for instance: using compressed images to reduce the
5064 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066- it becomes much easier to port new Linux kernel versions because
5067 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069- the same Linux kernel image can now be used with different "initrd"
5070 images; of course this also means that different kernel images can
5071 be run with the same "initrd". This makes testing easier (you don't
5072 have to build a new "zImage.initrd" Linux image when you just
5073 change a file in your "initrd"). Also, a field-upgrade of the
5074 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005075
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077Linux HOWTO:
5078============
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk6c59edc2004-05-03 20:45:30 +00005080Porting Linux to U-Boot based systems:
5081---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005082
wdenk6c59edc2004-05-03 20:45:30 +00005083U-Boot cannot save you from doing all the necessary modifications to
5084configure the Linux device drivers for use with your target hardware
5085(no, we don't intend to provide a full virtual machine interface to
5086Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005087
Stefan Roese88fbf932010-04-15 16:07:28 +02005088But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090Just make sure your machine specific header file (for instance
5091include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005092Information structure as we define in include/asm-<arch>/u-boot.h,
5093and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005094as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005095
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097Configuring the Linux kernel:
5098-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100No specific requirements for U-Boot. Make sure you have some root
5101device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005102
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk6c59edc2004-05-03 20:45:30 +00005104Building a Linux Image:
5105-----------------------
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk6c59edc2004-05-03 20:45:30 +00005107With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5108not used. If you use recent kernel source, a new build target
5109"uImage" will exist which automatically builds an image usable by
5110U-Boot. Most older kernels also have support for a "pImage" target,
5111which was introduced for our predecessor project PPCBoot and uses a
5112100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114Example:
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116 make TQM850L_config
5117 make oldconfig
5118 make dep
5119 make uImage
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121The "uImage" build target uses a special tool (in 'tools/mkimage') to
5122encapsulate a compressed Linux kernel image with header information,
5123CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk6c59edc2004-05-03 20:45:30 +00005127* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129 ${CROSS_COMPILE}-objcopy -O binary \
5130 -R .note -R .comment \
5131 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005134
wdenk6c59edc2004-05-03 20:45:30 +00005135 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005136
wdenk6c59edc2004-05-03 20:45:30 +00005137* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139 mkimage -A ppc -O linux -T kernel -C gzip \
5140 -a 0 -e 0 -n "Linux Kernel Image" \
5141 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005142
wdenkc6097192002-11-03 00:24:07 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144The "mkimage" tool can also be used to create ramdisk images for use
5145with U-Boot, either separated from the Linux kernel image, or
5146combined into one file. "mkimage" encapsulates the images with a 64
5147byte header containing information about target architecture,
5148operating system, image type, compression method, entry points, time
5149stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151"mkimage" can be called in two ways: to verify existing images and
5152print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154In the first form (with "-l" option) mkimage lists the information
5155contained in the header of an existing U-Boot image; this includes
5156checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005157
wdenk6c59edc2004-05-03 20:45:30 +00005158 tools/mkimage -l image
5159 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005160
wdenk6c59edc2004-05-03 20:45:30 +00005161The second form (with "-d" option) is used to build a U-Boot image
5162from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5165 -n name -d data_file image
5166 -A ==> set architecture to 'arch'
5167 -O ==> set operating system to 'os'
5168 -T ==> set image type to 'type'
5169 -C ==> set compression type 'comp'
5170 -a ==> set load address to 'addr' (hex)
5171 -e ==> set entry point to 'ep' (hex)
5172 -n ==> set image name to 'name'
5173 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005174
wdenkcd914452004-05-29 16:53:29 +00005175Right now, all Linux kernels for PowerPC systems use the same load
5176address (0x00000000), but the entry point address depends on the
5177kernel version:
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179- 2.2.x kernels have the entry point at 0x0000000C,
5180- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5185 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005186 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005187 > examples/uImage.TQM850L
5188 Image Name: 2.4.4 kernel for TQM850L
5189 Created: Wed Jul 19 02:34:59 2000
5190 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5191 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5192 Load Address: 0x00000000
5193 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197 -> tools/mkimage -l examples/uImage.TQM850L
5198 Image Name: 2.4.4 kernel for TQM850L
5199 Created: Wed Jul 19 02:34:59 2000
5200 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5201 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5202 Load Address: 0x00000000
5203 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205NOTE: for embedded systems where boot time is critical you can trade
5206speed for memory and install an UNCOMPRESSED image instead: this
5207needs more space in Flash, but boots much faster since it does not
5208need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005209
Stefan Roese88fbf932010-04-15 16:07:28 +02005210 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005211 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5212 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005213 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005214 > examples/uImage.TQM850L-uncompressed
5215 Image Name: 2.4.4 kernel for TQM850L
5216 Created: Wed Jul 19 02:34:59 2000
5217 Image Type: PowerPC Linux Kernel Image (uncompressed)
5218 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5219 Load Address: 0x00000000
5220 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005221
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5224when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226 -> tools/mkimage -n 'Simple Ramdisk Image' \
5227 > -A ppc -O linux -T ramdisk -C gzip \
5228 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5229 Image Name: Simple Ramdisk Image
5230 Created: Wed Jan 12 14:01:50 2000
5231 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5232 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5233 Load Address: 0x00000000
5234 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005235
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237Installing a Linux Image:
5238-------------------------
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240To downloading a U-Boot image over the serial (console) interface,
5241you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk6c59edc2004-05-03 20:45:30 +00005245The 'objcopy' does not understand the information in the U-Boot
5246image header, so the resulting S-Record file will be relative to
5247address 0x00000000. To load it to a given address, you need to
5248specify the target address as 'offset' parameter with the 'loads'
5249command.
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk6c59edc2004-05-03 20:45:30 +00005251Example: install the image to address 0x40100000 (which on the
5252TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005253
wdenk6c59edc2004-05-03 20:45:30 +00005254 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256 .......... done
5257 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259 => loads 40100000
5260 ## Ready for S-Record download ...
5261 ~>examples/image.srec
5262 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5263 ...
5264 15989 15990 15991 15992
5265 [file transfer complete]
5266 [connected]
5267 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005268
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005271this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005272corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276 ## Checking Image at 40100000 ...
5277 Image Name: 2.2.13 for initrd on TQM850L
5278 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5279 Data Size: 335725 Bytes = 327 kB = 0 MB
5280 Load Address: 00000000
5281 Entry Point: 0000000c
5282 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005283
5284
wdenk6c59edc2004-05-03 20:45:30 +00005285Boot Linux:
5286-----------
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk6c59edc2004-05-03 20:45:30 +00005288The "bootm" command is used to boot an application that is stored in
5289memory (RAM or Flash). In case of a Linux kernel image, the contents
5290of the "bootargs" environment variable is passed to the kernel as
5291parameters. You can check and modify this variable using the
5292"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005293
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 => printenv bootargs
5296 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk6c59edc2004-05-03 20:45:30 +00005298 => 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 +00005299
wdenk6c59edc2004-05-03 20:45:30 +00005300 => printenv bootargs
5301 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 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303 => bootm 40020000
5304 ## Booting Linux kernel at 40020000 ...
5305 Image Name: 2.2.13 for NFS on TQM850L
5306 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5307 Data Size: 381681 Bytes = 372 kB = 0 MB
5308 Load Address: 00000000
5309 Entry Point: 0000000c
5310 Verifying Checksum ... OK
5311 Uncompressing Kernel Image ... OK
5312 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
5313 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5314 time_init: decrementer frequency = 187500000/60
5315 Calibrating delay loop... 49.77 BogoMIPS
5316 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5317 ...
wdenkc6097192002-11-03 00:24:07 +00005318
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005319If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005320the memory addresses of both the kernel and the initrd image (PPBCOOT
5321format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325 ## Checking Image at 40100000 ...
5326 Image Name: 2.2.13 for initrd on TQM850L
5327 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5328 Data Size: 335725 Bytes = 327 kB = 0 MB
5329 Load Address: 00000000
5330 Entry Point: 0000000c
5331 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk6c59edc2004-05-03 20:45:30 +00005333 ## Checking Image at 40200000 ...
5334 Image Name: Simple Ramdisk Image
5335 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5336 Data Size: 566530 Bytes = 553 kB = 0 MB
5337 Load Address: 00000000
5338 Entry Point: 00000000
5339 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk6c59edc2004-05-03 20:45:30 +00005341 => bootm 40100000 40200000
5342 ## Booting Linux kernel at 40100000 ...
5343 Image Name: 2.2.13 for initrd on TQM850L
5344 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5345 Data Size: 335725 Bytes = 327 kB = 0 MB
5346 Load Address: 00000000
5347 Entry Point: 0000000c
5348 Verifying Checksum ... OK
5349 Uncompressing Kernel Image ... OK
5350 ## Loading RAMDisk Image at 40200000 ...
5351 Image Name: Simple Ramdisk Image
5352 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5353 Data Size: 566530 Bytes = 553 kB = 0 MB
5354 Load Address: 00000000
5355 Entry Point: 00000000
5356 Verifying Checksum ... OK
5357 Loading Ramdisk ... OK
5358 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
5359 Boot arguments: root=/dev/ram
5360 time_init: decrementer frequency = 187500000/60
5361 Calibrating delay loop... 49.77 BogoMIPS
5362 ...
5363 RAMDISK: Compressed image found at block 0
5364 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005365
wdenk6c59edc2004-05-03 20:45:30 +00005366 bash#
wdenkc6097192002-11-03 00:24:07 +00005367
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005368Boot Linux and pass a flat device tree:
5369-----------
5370
5371First, U-Boot must be compiled with the appropriate defines. See the section
5372titled "Linux Kernel Interface" above for a more in depth explanation. The
5373following is an example of how to start a kernel and pass an updated
5374flat device tree:
5375
5376=> print oftaddr
5377oftaddr=0x300000
5378=> print oft
5379oft=oftrees/mpc8540ads.dtb
5380=> tftp $oftaddr $oft
5381Speed: 1000, full duplex
5382Using TSEC0 device
5383TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5384Filename 'oftrees/mpc8540ads.dtb'.
5385Load address: 0x300000
5386Loading: #
5387done
5388Bytes transferred = 4106 (100a hex)
5389=> tftp $loadaddr $bootfile
5390Speed: 1000, full duplex
5391Using TSEC0 device
5392TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5393Filename 'uImage'.
5394Load address: 0x200000
5395Loading:############
5396done
5397Bytes transferred = 1029407 (fb51f hex)
5398=> print loadaddr
5399loadaddr=200000
5400=> print oftaddr
5401oftaddr=0x300000
5402=> bootm $loadaddr - $oftaddr
5403## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005404 Image Name: Linux-2.6.17-dirty
5405 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5406 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005407 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005408 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005409 Verifying Checksum ... OK
5410 Uncompressing Kernel Image ... OK
5411Booting using flat device tree at 0x300000
5412Using MPC85xx ADS machine description
5413Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5414[snip]
5415
5416
wdenk6c59edc2004-05-03 20:45:30 +00005417More About U-Boot Image Types:
5418------------------------------
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422 "Standalone Programs" are directly runnable in the environment
5423 provided by U-Boot; it is expected that (if they behave
5424 well) you can continue to work in U-Boot after return from
5425 the Standalone Program.
5426 "OS Kernel Images" are usually images of some Embedded OS which
5427 will take over control completely. Usually these programs
5428 will install their own set of exception handlers, device
5429 drivers, set up the MMU, etc. - this means, that you cannot
5430 expect to re-enter U-Boot except by resetting the CPU.
5431 "RAMDisk Images" are more or less just data blocks, and their
5432 parameters (address, size) are passed to an OS kernel that is
5433 being started.
5434 "Multi-File Images" contain several images, typically an OS
5435 (Linux) kernel image and one or more data images like
5436 RAMDisks. This construct is useful for instance when you want
5437 to boot over the network using BOOTP etc., where the boot
5438 server provides just a single image file, but you want to get
5439 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005440
wdenk6c59edc2004-05-03 20:45:30 +00005441 "Multi-File Images" start with a list of image sizes, each
5442 image size (in bytes) specified by an "uint32_t" in network
5443 byte order. This list is terminated by an "(uint32_t)0".
5444 Immediately after the terminating 0 follow the images, one by
5445 one, all aligned on "uint32_t" boundaries (size rounded up to
5446 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448 "Firmware Images" are binary images containing firmware (like
5449 U-Boot or FPGA images) which usually will be programmed to
5450 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452 "Script files" are command sequences that will be executed by
5453 U-Boot's command interpreter; this feature is especially
5454 useful when you configure U-Boot to use a real shell (hush)
5455 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005456
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005457Booting the Linux zImage:
5458-------------------------
5459
5460On some platforms, it's possible to boot Linux zImage. This is done
5461using the "bootz" command. The syntax of "bootz" command is the same
5462as the syntax of "bootm" command.
5463
Tom Rini45f46d12013-05-16 11:40:11 -04005464Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005465kernel with raw initrd images. The syntax is slightly different, the
5466address of the initrd must be augmented by it's size, in the following
5467format: "<initrd addres>:<initrd size>".
5468
stroeseb9c17c52003-04-04 15:53:41 +00005469
wdenk6c59edc2004-05-03 20:45:30 +00005470Standalone HOWTO:
5471=================
stroeseb9c17c52003-04-04 15:53:41 +00005472
wdenk6c59edc2004-05-03 20:45:30 +00005473One of the features of U-Boot is that you can dynamically load and
5474run "standalone" applications, which can use some resources of
5475U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005476
wdenk6c59edc2004-05-03 20:45:30 +00005477Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005478
wdenk6c59edc2004-05-03 20:45:30 +00005479"Hello World" Demo:
5480-------------------
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482'examples/hello_world.c' contains a small "Hello World" Demo
5483application; it is automatically compiled when you build U-Boot.
5484It's configured to run at address 0x00040004, so you can play with it
5485like that:
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487 => loads
5488 ## Ready for S-Record download ...
5489 ~>examples/hello_world.srec
5490 1 2 3 4 5 6 7 8 9 10 11 ...
5491 [file transfer complete]
5492 [connected]
5493 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005494
wdenk6c59edc2004-05-03 20:45:30 +00005495 => go 40004 Hello World! This is a test.
5496 ## Starting application at 0x00040004 ...
5497 Hello World
5498 argc = 7
5499 argv[0] = "40004"
5500 argv[1] = "Hello"
5501 argv[2] = "World!"
5502 argv[3] = "This"
5503 argv[4] = "is"
5504 argv[5] = "a"
5505 argv[6] = "test."
5506 argv[7] = "<NULL>"
5507 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511Another example, which demonstrates how to register a CPM interrupt
5512handler with the U-Boot code, can be found in 'examples/timer.c'.
5513Here, a CPM timer is set up to generate an interrupt every second.
5514The interrupt service routine is trivial, just printing a '.'
5515character, but this is just a demo program. The application can be
5516controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518 ? - print current values og the CPM Timer registers
5519 b - enable interrupts and start timer
5520 e - stop timer and disable interrupts
5521 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523 => loads
5524 ## Ready for S-Record download ...
5525 ~>examples/timer.srec
5526 1 2 3 4 5 6 7 8 9 10 11 ...
5527 [file transfer complete]
5528 [connected]
5529 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531 => go 40004
5532 ## Starting application at 0x00040004 ...
5533 TIMERS=0xfff00980
5534 Using timer 1
5535 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537Hit 'b':
5538 [q, b, e, ?] Set interval 1000000 us
5539 Enabling timer
5540Hit '?':
5541 [q, b, e, ?] ........
5542 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5543Hit '?':
5544 [q, b, e, ?] .
5545 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5546Hit '?':
5547 [q, b, e, ?] .
5548 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5549Hit '?':
5550 [q, b, e, ?] .
5551 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5552Hit 'e':
5553 [q, b, e, ?] ...Stopping timer
5554Hit 'q':
5555 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005556
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558Minicom warning:
5559================
wdenkc6097192002-11-03 00:24:07 +00005560
wdenk6c59edc2004-05-03 20:45:30 +00005561Over time, many people have reported problems when trying to use the
5562"minicom" terminal emulation program for serial download. I (wd)
5563consider minicom to be broken, and recommend not to use it. Under
5564Unix, I recommend to use C-Kermit for general purpose use (and
5565especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005566use "cu" for S-Record download ("loads" command). See
5567http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5568for help with kermit.
5569
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571Nevertheless, if you absolutely want to use it try adding this
5572configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574 Name Program Name U/D FullScr IO-Red. Multi
5575 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5576 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005577
wdenk8dba0502003-03-31 16:34:49 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579NetBSD Notes:
5580=============
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582Starting at version 0.9.2, U-Boot supports NetBSD both as host
5583(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005584
wdenk6c59edc2004-05-03 20:45:30 +00005585Building requires a cross environment; it is known to work on
5586NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5587need gmake since the Makefiles are not compatible with BSD make).
5588Note that the cross-powerpc package does not install include files;
5589attempting to build U-Boot will fail because <machine/ansi.h> is
5590missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592 # cd /usr/pkg/cross/powerpc-netbsd/include
5593 # mkdir powerpc
5594 # ln -s powerpc machine
5595 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5596 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005597
wdenk6c59edc2004-05-03 20:45:30 +00005598Native builds *don't* work due to incompatibilities between native
5599and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk6c59edc2004-05-03 20:45:30 +00005601Booting assumes that (the first part of) the image booted is a
5602stage-2 loader which in turn loads and then invokes the kernel
5603proper. Loader sources will eventually appear in the NetBSD source
5604tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005605meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005606
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608Implementation Internals:
5609=========================
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611The following is not intended to be a complete description of every
5612implementation detail. However, it should help to understand the
5613inner workings of U-Boot and make it easier to port it to custom
5614hardware.
wdenkc6097192002-11-03 00:24:07 +00005615
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617Initial Stack, Global Data:
5618---------------------------
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk6c59edc2004-05-03 20:45:30 +00005620The implementation of U-Boot is complicated by the fact that U-Boot
5621starts running out of ROM (flash memory), usually without access to
5622system RAM (because the memory controller is not initialized yet).
5623This means that we don't have writable Data or BSS segments, and BSS
5624is not initialized as zero. To be able to get a C environment working
5625at all, we have to allocate at least a minimal stack. Implementation
5626options for this are defined and restricted by the CPU used: Some CPU
5627models provide on-chip memory (like the IMMR area on MPC8xx and
5628MPC826x processors), on others (parts of) the data cache can be
5629locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005630
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005631 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005632 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005633
wdenk6c59edc2004-05-03 20:45:30 +00005634 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5635 From: "Chris Hallinan" <clh@net1plus.com>
5636 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5637 ...
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639 Correct me if I'm wrong, folks, but the way I understand it
5640 is this: Using DCACHE as initial RAM for Stack, etc, does not
5641 require any physical RAM backing up the cache. The cleverness
5642 is that the cache is being used as a temporary supply of
5643 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005644 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005645 can see how this works by studying the cache architecture and
5646 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5649 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005650 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005651 option should work for you. Using CS 4 should be fine if your
5652 board designers haven't used it for something that would
5653 cause you grief during the initial boot! It is frequently not
5654 used.
wdenkc6097192002-11-03 00:24:07 +00005655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005656 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005657 with your processor/board/system design. The default value
5658 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005659 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005660 than your SDRAM module. If you have a 64MB SDRAM module, set
5661 it above 400_0000. Just make sure your board has no resources
5662 that are supposed to respond to that address! That code in
5663 start.S has been around a while and should work as is when
5664 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666 -Chris Hallinan
5667 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005668
wdenk6c59edc2004-05-03 20:45:30 +00005669It is essential to remember this, since it has some impact on the C
5670code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672* Initialized global data (data segment) is read-only. Do not attempt
5673 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005674
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005675* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005676 as zero data - BSS segment) at all - this is undefined, initiali-
5677 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005678
wdenk6c59edc2004-05-03 20:45:30 +00005679* Stack space is very limited. Avoid big data buffers or things like
5680 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005681
wdenk6c59edc2004-05-03 20:45:30 +00005682Having only the stack as writable memory limits means we cannot use
5683normal global data to share information beween the code. But it
5684turned out that the implementation of U-Boot can be greatly
5685simplified by making a global data structure (gd_t) available to all
5686functions. We could pass a pointer to this data as argument to _all_
5687functions, but this would bloat the code. Instead we use a feature of
5688the GCC compiler (Global Register Variables) to share the data: we
5689place a pointer (gd) to the global data into a register which we
5690reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692When choosing a register for such a purpose we are restricted by the
5693relevant (E)ABI specifications for the current architecture, and by
5694GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696For PowerPC, the following registers have specific use:
5697 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005698 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005699 R3-R4: parameter passing and return values
5700 R5-R10: parameter passing
5701 R13: small data area pointer
5702 R30: GOT pointer
5703 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005704
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005705 (U-Boot also uses R12 as internal GOT pointer. r12
5706 is a volatile register so r12 needs to be reset when
5707 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005708
Wolfgang Denk69c09642008-02-14 22:43:22 +01005709 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711 Note: on PPC, we could use a static initializer (since the
5712 address of the global data structure is known at compile time),
5713 but it turned out that reserving a register results in somewhat
5714 smaller code - although the code savings are not that big (on
5715 average for all boards 752 bytes for the whole U-Boot image,
5716 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005717
Robin Getz2773d5f2009-08-17 15:23:02 +00005718On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005719 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5720
Robin Getz2773d5f2009-08-17 15:23:02 +00005721 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005722
wdenk6c59edc2004-05-03 20:45:30 +00005723On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725 R0: function argument word/integer result
5726 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005727 R9: platform specific
5728 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005729 R11: argument (frame) pointer
5730 R12: temporary workspace
5731 R13: stack pointer
5732 R14: link register
5733 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005734
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005735 ==> U-Boot will use R9 to hold a pointer to the global data
5736
5737 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005738
Thomas Chou8fa38582010-05-21 11:08:03 +08005739On Nios II, the ABI is documented here:
5740 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5741
5742 ==> U-Boot will use gp to hold a pointer to the global data
5743
5744 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5745 to access small data sections, so gp is free.
5746
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005747On NDS32, the following registers are used:
5748
5749 R0-R1: argument/return
5750 R2-R5: argument
5751 R15: temporary register for assembler
5752 R16: trampoline register
5753 R28: frame pointer (FP)
5754 R29: global pointer (GP)
5755 R30: link register (LP)
5756 R31: stack pointer (SP)
5757 PC: program counter (PC)
5758
5759 ==> U-Boot will use R10 to hold a pointer to the global data
5760
Wolfgang Denk6405a152006-03-31 18:32:53 +02005761NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5762or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764Memory Management:
5765------------------
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767U-Boot runs in system state and uses physical addresses, i.e. the
5768MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005769
wdenk6c59edc2004-05-03 20:45:30 +00005770The available memory is mapped to fixed addresses using the memory
5771controller. In this process, a contiguous block is formed for each
5772memory type (Flash, SDRAM, SRAM), even when it consists of several
5773physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005774
wdenk6c59edc2004-05-03 20:45:30 +00005775U-Boot is installed in the first 128 kB of the first Flash bank (on
5776TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5777booting and sizing and initializing DRAM, the code relocates itself
5778to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005779memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005780configuration setting]. Below that, a structure with global Board
5781Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783Additionally, some exception handler code is copied to the low 8 kB
5784of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005785
wdenk6c59edc2004-05-03 20:45:30 +00005786So a typical memory configuration with 16 MB of DRAM could look like
5787this:
wdenkc6097192002-11-03 00:24:07 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789 0x0000 0000 Exception Vector code
5790 :
5791 0x0000 1FFF
5792 0x0000 2000 Free for Application Use
5793 :
5794 :
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk6c59edc2004-05-03 20:45:30 +00005796 :
5797 :
5798 0x00FB FF20 Monitor Stack (Growing downward)
5799 0x00FB FFAC Board Info Data and permanent copy of global data
5800 0x00FC 0000 Malloc Arena
5801 :
5802 0x00FD FFFF
5803 0x00FE 0000 RAM Copy of Monitor Code
5804 ... eventually: LCD or video framebuffer
5805 ... eventually: pRAM (Protected RAM - unchanged by reset)
5806 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005807
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809System Initialization:
5810----------------------
wdenkc6097192002-11-03 00:24:07 +00005811
wdenk6c59edc2004-05-03 20:45:30 +00005812In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005813(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005814configuration for CS0# this is a mirror of the onboard Flash memory.
5815To be able to re-map memory U-Boot then jumps to its link address.
5816To be able to implement the initialization code in C, a (small!)
5817initial stack is set up in the internal Dual Ported RAM (in case CPUs
5818which provide such a feature like MPC8xx or MPC8260), or in a locked
5819part of the data cache. After that, U-Boot initializes the CPU core,
5820the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005821
wdenk6c59edc2004-05-03 20:45:30 +00005822Next, all (potentially) available memory banks are mapped using a
5823preliminary mapping. For example, we put them on 512 MB boundaries
5824(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5825on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5826programmed for SDRAM access. Using the temporary configuration, a
5827simple memory test is run that determines the size of the SDRAM
5828banks.
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk6c59edc2004-05-03 20:45:30 +00005830When there is more than one SDRAM bank, and the banks are of
5831different size, the largest is mapped first. For equal size, the first
5832bank (CS2#) is mapped first. The first mapping is always for address
58330x00000000, with any additional banks following immediately to create
5834contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk6c59edc2004-05-03 20:45:30 +00005836Then, the monitor installs itself at the upper end of the SDRAM area
5837and allocates memory for use by malloc() and for the global Board
5838Info data; also, the exception vector code is copied to the low RAM
5839pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005840
wdenk6c59edc2004-05-03 20:45:30 +00005841Only after this relocation will you have a "normal" C environment;
5842until that you are restricted in several ways, mostly because you are
5843running from ROM, and because the code will have to be relocated to a
5844new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005845
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk6c59edc2004-05-03 20:45:30 +00005847U-Boot Porting Guide:
5848----------------------
wdenkc6097192002-11-03 00:24:07 +00005849
wdenk6c59edc2004-05-03 20:45:30 +00005850[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5851list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005852
wdenkc6097192002-11-03 00:24:07 +00005853
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005854int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005855{
5856 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005857
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005858 signal(SIGALRM, no_more_time);
5859 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005862 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005863 return 0;
5864 }
wdenkc6097192002-11-03 00:24:07 +00005865
wdenk6c59edc2004-05-03 20:45:30 +00005866 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005867
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005868 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005869
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005870 if (clueless)
5871 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk6c59edc2004-05-03 20:45:30 +00005873 while (learning) {
5874 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005875 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5876 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005877 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005878 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005879 }
wdenkc6097192002-11-03 00:24:07 +00005880
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005881 if (available_money > toLocalCurrency ($2500))
5882 Buy a BDI3000;
5883 else
wdenk6c59edc2004-05-03 20:45:30 +00005884 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005885
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005886 if (a similar board exists) { /* hopefully... */
5887 cp -a board/<similar> board/<myboard>
5888 cp include/configs/<similar>.h include/configs/<myboard>.h
5889 } else {
5890 Create your own board support subdirectory;
5891 Create your own board include/configs/<myboard>.h file;
5892 }
5893 Edit new board/<myboard> files
5894 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005895
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005896 while (!accepted) {
5897 while (!running) {
5898 do {
5899 Add / modify source code;
5900 } until (compiles);
5901 Debug;
5902 if (clueless)
5903 email("Hi, I am having problems...");
5904 }
5905 Send patch file to the U-Boot email list;
5906 if (reasonable critiques)
5907 Incorporate improvements from email list code review;
5908 else
5909 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005910 }
wdenkc6097192002-11-03 00:24:07 +00005911
wdenk6c59edc2004-05-03 20:45:30 +00005912 return 0;
5913}
wdenkc6097192002-11-03 00:24:07 +00005914
wdenk6c59edc2004-05-03 20:45:30 +00005915void no_more_time (int sig)
5916{
5917 hire_a_guru();
5918}
wdenkc6097192002-11-03 00:24:07 +00005919
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk6c59edc2004-05-03 20:45:30 +00005921Coding Standards:
5922-----------------
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005925coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005926"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005927
5928Source files originating from a different project (for example the
5929MTD subsystem) are generally exempt from these guidelines and are not
5930reformated to ease subsequent migration to newer versions of those
5931sources.
wdenkc6097192002-11-03 00:24:07 +00005932
Detlev Zundelaa63d482006-09-01 15:39:02 +02005933Please note that U-Boot is implemented in C (and to some small parts in
5934Assembler); no C++ is used, so please do not use C++ style comments (//)
5935in your code.
wdenkad276f22004-01-04 16:28:35 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937Please also stick to the following formatting rules:
5938- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005939- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005940- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005941- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005942- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944Submissions which do not conform to the standards may be returned
5945with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005946
wdenkc6097192002-11-03 00:24:07 +00005947
wdenk6c59edc2004-05-03 20:45:30 +00005948Submitting Patches:
5949-------------------
wdenkc6097192002-11-03 00:24:07 +00005950
wdenk6c59edc2004-05-03 20:45:30 +00005951Since the number of patches for U-Boot is growing, we need to
5952establish some rules. Submissions which do not conform to these rules
5953may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005954
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005955Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005956
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005957Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5958see http://lists.denx.de/mailman/listinfo/u-boot
5959
wdenk6c59edc2004-05-03 20:45:30 +00005960When you send a patch, please include the following information with
5961it:
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963* For bug fixes: a description of the bug and how your patch fixes
5964 this bug. Please try to include a way of demonstrating that the
5965 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967* For new features: a description of the feature and your
5968 implementation.
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005971
wdenk6c59edc2004-05-03 20:45:30 +00005972* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005973
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005974* When you add support for a new board, don't forget to add a
5975 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk6c59edc2004-05-03 20:45:30 +00005977* If your patch adds new configuration options, don't forget to
5978 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005979
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005980* The patch itself. If you are using git (which is *strongly*
5981 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005982 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005983 the U-Boot mailing list, you will avoid most of the common problems
5984 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005985
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005986 If you cannot use git, use "diff -purN OLD NEW". If your version of
5987 diff does not support these options, then get the latest version of
5988 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005989
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005990 The current directory when running this command shall be the parent
5991 directory of the U-Boot source tree (i. e. please make sure that
5992 your patch includes sufficient directory information for the
5993 affected files).
5994
5995 We prefer patches as plain text. MIME attachments are discouraged,
5996 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005997
wdenk6c59edc2004-05-03 20:45:30 +00005998* If one logical set of modifications affects or creates several
5999 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001* Changesets that contain different, unrelated modifications shall be
6002 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006003
wdenkc6097192002-11-03 00:24:07 +00006004
wdenk6c59edc2004-05-03 20:45:30 +00006005Notes:
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk6c59edc2004-05-03 20:45:30 +00006007* Before sending the patch, run the MAKEALL script on your patched
6008 source tree and make sure that no errors or warnings are reported
6009 for any of the boards.
6010
6011* Keep your modifications to the necessary minimum: A patch
6012 containing several unrelated changes or arbitrary reformats will be
6013 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006014
wdenk6c59edc2004-05-03 20:45:30 +00006015* If you modify existing code, make sure that your new code does not
6016 add to the memory footprint of the code ;-) Small is beautiful!
6017 When adding new features, these should compile conditionally only
6018 (using #ifdef), and the resulting code with the new feature
6019 disabled must not need more memory than the old code without your
6020 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006021
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006022* Remember that there is a size limit of 100 kB per message on the
6023 u-boot mailing list. Bigger patches will be moderated. If they are
6024 reasonable and not too big, they will be acknowledged. But patches
6025 bigger than the size limit should be avoided.