blob: f38ab15b8b6499cbd214b73bf0d133e99761eaba [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass75b3c3a2014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600274
275
wdenkc6097192002-11-03 00:24:07 +0000276Configuration Options:
277----------------------
278
279Configuration depends on the combination of board and CPU type; all
280such information is kept in a configuration file
281"include/configs/<board_name>.h".
282
283Example: For a TQM823L module, all configuration settings are in
284"include/configs/TQM823L.h".
285
286
wdenk7f6c2cb2002-11-10 22:06:23 +0000287Many of the options are named exactly as the corresponding Linux
288kernel configuration options. The intention is to make it easier to
289build a config tool - later.
290
291
wdenkc6097192002-11-03 00:24:07 +0000292The following options need to be configured:
293
Kim Phillips26281142007-08-10 13:28:25 -0500294- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000295
Kim Phillips26281142007-08-10 13:28:25 -0500296- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200297
298- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100299 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000300
301- CPU Module Type: (if CONFIG_COGENT is defined)
302 Define exactly one of
303 CONFIG_CMA286_60_OLD
304--- FIXME --- not tested yet:
305 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
306 CONFIG_CMA287_23, CONFIG_CMA287_50
307
308- Motherboard Type: (if CONFIG_COGENT is defined)
309 Define exactly one of
310 CONFIG_CMA101, CONFIG_CMA102
311
312- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
313 Define one or more of
314 CONFIG_CMA302
315
316- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
317 Define one or more of
318 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200319 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000320 a "rotator" |\-/|\-/
321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000342
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000349
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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 Kushwaha74fa22e2013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800404 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530405
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530406 CONFIG_A008044_WORKAROUND
407 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800408 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530409
Scott Wood33eee332012-08-14 10:14:53 +0000410 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
411
412 This is the value to write into CCSR offset 0x18600
413 according to the A004510 workaround.
414
Priyanka Jain64501c62013-07-02 09:21:04 +0530415 CONFIG_SYS_FSL_DSP_DDR_ADDR
416 This value denotes start offset of DDR memory which is
417 connected exclusively to the DSP cores.
418
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530419 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
420 This value denotes start offset of M2 memory
421 which is directly connected to the DSP core.
422
Priyanka Jain64501c62013-07-02 09:21:04 +0530423 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
424 This value denotes start offset of M3 memory which is directly
425 connected to the DSP core.
426
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530427 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
428 This value denotes start offset of DSP CCSR space.
429
Priyanka Jainb1359912013-12-17 14:25:52 +0530430 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
431 Single Source Clock is clocking mode present in some of FSL SoC's.
432 In this mode, a single differential clock is used to supply
433 clocks to the sysclock, ddrclock and usbclock.
434
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530435 CONFIG_SYS_CPC_REINIT_F
436 This CONFIG is defined when the CPC is configured as SRAM at the
437 time of U-boot entry and is required to be re-initialized.
438
Tang Yuantianaade2002014-04-17 15:33:46 +0800439 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800440 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800441 supported, core will start to execute uboot when wakes up.
442
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000443- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700444 CONFIG_SYS_GENERIC_GLOBAL_DATA
445 Defines global data is initialized in generic board board_init_f().
446 If this macro is defined, global data is created and cleared in
447 generic board board_init_f(). Without this macro, architecture/board
448 should initialize global data before calling board_init_f().
449
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000450 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
451
452 Defines the endianess of the CPU. Implementation of those
453 values is arch specific.
454
York Sun5614e712013-09-30 09:22:09 -0700455 CONFIG_SYS_FSL_DDR
456 Freescale DDR driver in use. This type of DDR controller is
457 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
458 SoCs.
459
460 CONFIG_SYS_FSL_DDR_ADDR
461 Freescale DDR memory-mapped register base.
462
463 CONFIG_SYS_FSL_DDR_EMU
464 Specify emulator support for DDR. Some DDR features such as
465 deskew training are not available.
466
467 CONFIG_SYS_FSL_DDRC_GEN1
468 Freescale DDR1 controller.
469
470 CONFIG_SYS_FSL_DDRC_GEN2
471 Freescale DDR2 controller.
472
473 CONFIG_SYS_FSL_DDRC_GEN3
474 Freescale DDR3 controller.
475
York Sun34e026f2014-03-27 17:54:47 -0700476 CONFIG_SYS_FSL_DDRC_GEN4
477 Freescale DDR4 controller.
478
York Sun9ac4ffb2013-09-30 14:20:51 -0700479 CONFIG_SYS_FSL_DDRC_ARM_GEN3
480 Freescale DDR3 controller for ARM-based SoCs.
481
York Sun5614e712013-09-30 09:22:09 -0700482 CONFIG_SYS_FSL_DDR1
483 Board config to use DDR1. It can be enabled for SoCs with
484 Freescale DDR1 or DDR2 controllers, depending on the board
485 implemetation.
486
487 CONFIG_SYS_FSL_DDR2
488 Board config to use DDR2. It can be eanbeld for SoCs with
489 Freescale DDR2 or DDR3 controllers, depending on the board
490 implementation.
491
492 CONFIG_SYS_FSL_DDR3
493 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700494 Freescale DDR3 or DDR3L controllers.
495
496 CONFIG_SYS_FSL_DDR3L
497 Board config to use DDR3L. It can be enabled for SoCs with
498 DDR3L controllers.
499
500 CONFIG_SYS_FSL_DDR4
501 Board config to use DDR4. It can be enabled for SoCs with
502 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700503
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530504 CONFIG_SYS_FSL_IFC_BE
505 Defines the IFC controller register space as Big Endian
506
507 CONFIG_SYS_FSL_IFC_LE
508 Defines the IFC controller register space as Little Endian
509
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530510 CONFIG_SYS_FSL_PBL_PBI
511 It enables addition of RCW (Power on reset configuration) in built image.
512 Please refer doc/README.pblimage for more details
513
514 CONFIG_SYS_FSL_PBL_RCW
515 It adds PBI(pre-boot instructions) commands in u-boot build image.
516 PBI commands can be used to configure SoC before it starts the execution.
517 Please refer doc/README.pblimage for more details
518
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530519 CONFIG_SPL_FSL_PBL
520 It adds a target to create boot binary having SPL binary in PBI format
521 concatenated with u-boot binary.
522
York Sun4e5b1bd2014-02-10 13:59:42 -0800523 CONFIG_SYS_FSL_DDR_BE
524 Defines the DDR controller register space as Big Endian
525
526 CONFIG_SYS_FSL_DDR_LE
527 Defines the DDR controller register space as Little Endian
528
York Sun6b9e3092014-02-10 13:59:43 -0800529 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
530 Physical address from the view of DDR controllers. It is the
531 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
532 it could be different for ARM SoCs.
533
York Sun6b1e1252014-02-10 13:59:44 -0800534 CONFIG_SYS_FSL_DDR_INTLV_256B
535 DDR controller interleaving on 256-byte. This is a special
536 interleaving mode, handled by Dickens for Freescale layerscape
537 SoCs with ARM core.
538
York Sun1d71efb2014-08-01 15:51:00 -0700539 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
540 Number of controllers used as main memory.
541
542 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
543 Number of controllers used for other than main memory.
544
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530545 CONFIG_SYS_FSL_SEC_BE
546 Defines the SEC controller register space as Big Endian
547
548 CONFIG_SYS_FSL_SEC_LE
549 Defines the SEC controller register space as Little Endian
550
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100551- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200552 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553
554 Defines the Monahans run mode to oscillator
555 ratio. Valid values are 8, 16, 24, 31. The core
556 frequency is this value multiplied by 13 MHz.
557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200558 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200559
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100560 Defines the Monahans turbo mode to oscillator
561 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200562 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100563 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200564
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200565- MIPS CPU options:
566 CONFIG_SYS_INIT_SP_OFFSET
567
568 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
569 pointer. This is needed for the temporary stack before
570 relocation.
571
572 CONFIG_SYS_MIPS_CACHE_MODE
573
574 Cache operation mode for the MIPS CPU.
575 See also arch/mips/include/asm/mipsregs.h.
576 Possible values are:
577 CONF_CM_CACHABLE_NO_WA
578 CONF_CM_CACHABLE_WA
579 CONF_CM_UNCACHED
580 CONF_CM_CACHABLE_NONCOHERENT
581 CONF_CM_CACHABLE_CE
582 CONF_CM_CACHABLE_COW
583 CONF_CM_CACHABLE_CUW
584 CONF_CM_CACHABLE_ACCELERATED
585
586 CONFIG_SYS_XWAY_EBU_BOOTCFG
587
588 Special option for Lantiq XWAY SoCs for booting from NOR flash.
589 See also arch/mips/cpu/mips32/start.S.
590
591 CONFIG_XWAY_SWAP_BYTES
592
593 Enable compilation of tools/xway-swap-bytes needed for Lantiq
594 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
595 be swapped if a flash programmer is used.
596
Christian Rieschb67d8812012-02-02 00:44:39 +0000597- ARM options:
598 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
599
600 Select high exception vectors of the ARM core, e.g., do not
601 clear the V bit of the c1 register of CP15.
602
Aneesh V5356f542012-03-08 07:20:19 +0000603 CONFIG_SYS_THUMB_BUILD
604
605 Use this flag to build U-Boot using the Thumb instruction
606 set for ARM architectures. Thumb instruction set provides
607 better code density. For ARM architectures that support
608 Thumb2 this flag will result in Thumb2 code generated by
609 GCC.
610
Stephen Warrenc5d47522013-03-04 13:29:40 +0000611 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000612 CONFIG_ARM_ERRATA_742230
613 CONFIG_ARM_ERRATA_743622
614 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500615 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500616 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000617
618 If set, the workarounds for these ARM errata are applied early
619 during U-Boot startup. Note that these options force the
620 workarounds to be applied; no CPU-type/version detection
621 exists, unlike the similar options in the Linux kernel. Do not
622 set these options unless they apply!
623
Simon Glass38687ae2014-11-10 17:16:54 -0700624- Driver Model
625 Driver model is a new framework for devices in U-Boot
626 introduced in early 2014. U-Boot is being progressively
627 moved over to this. It offers a consistent device structure,
628 supports grouping devices into classes and has built-in
629 handling of platform data and device tree.
630
631 To enable transition to driver model in a relatively
632 painful fashion, each subsystem can be independently
633 switched between the legacy/ad-hoc approach and the new
634 driver model using the options below. Also, many uclass
635 interfaces include compatibility features which may be
636 removed once the conversion of that subsystem is complete.
637 As a result, the API provided by the subsystem may in fact
638 not change with driver model.
639
640 See doc/driver-model/README.txt for more information.
641
642 CONFIG_DM
643
644 Enable driver model. This brings in the core support,
645 including scanning of platform data on start-up. If
646 CONFIG_OF_CONTROL is enabled, the device tree will be
647 scanned also when available.
648
649 CONFIG_CMD_DM
650
651 Enable driver model test commands. These allow you to print
652 out the driver model tree and the uclasses.
653
654 CONFIG_DM_DEMO
655
656 Enable some demo devices and the 'demo' command. These are
657 really only useful for playing around while trying to
658 understand driver model in sandbox.
659
660 CONFIG_SPL_DM
661
662 Enable driver model in SPL. You will need to provide a
663 suitable malloc() implementation. If you are not using the
664 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
665 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
666 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
667 In most cases driver model will only allocate a few uclasses
668 and devices in SPL, so 1KB should be enable. See
669 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
670 it.
671
672 CONFIG_DM_SERIAL
673
674 Enable driver model for serial. This replaces
675 drivers/serial/serial.c with the serial uclass, which
676 implements serial_putc() etc. The uclass interface is
677 defined in include/serial.h.
678
679 CONFIG_DM_GPIO
680
681 Enable driver model for GPIO access. The standard GPIO
682 interface (gpio_get_value(), etc.) is then implemented by
683 the GPIO uclass. Drivers provide methods to query the
684 particular GPIOs that they provide. The uclass interface
685 is defined in include/asm-generic/gpio.h.
686
687 CONFIG_DM_SPI
688
689 Enable driver model for SPI. The SPI slave interface
690 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
691 the SPI uclass. Drivers provide methods to access the SPI
692 buses that they control. The uclass interface is defined in
693 include/spi.h. The existing spi_slave structure is attached
694 as 'parent data' to every slave on each bus. Slaves
695 typically use driver-private data instead of extending the
696 spi_slave structure.
697
698 CONFIG_DM_SPI_FLASH
699
700 Enable driver model for SPI flash. This SPI flash interface
701 (spi_flash_probe(), spi_flash_write(), etc.) is then
702 implemented by the SPI flash uclass. There is one standard
703 SPI flash driver which knows how to probe most chips
704 supported by U-Boot. The uclass interface is defined in
705 include/spi_flash.h, but is currently fully compatible
706 with the old interface to avoid confusion and duplication
707 during the transition parent. SPI and SPI flash must be
708 enabled together (it is not possible to use driver model
709 for one and not the other).
710
711 CONFIG_DM_CROS_EC
712
713 Enable driver model for the Chrome OS EC interface. This
714 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
715 but otherwise makes few changes. Since cros_ec also supports
716 I2C and LPC (which don't support driver model yet), a full
717 conversion is not yet possible.
718
719
720 ** Code size options: The following options are enabled by
721 default except in SPL. Enable them explicitly to get these
722 features in SPL.
723
724 CONFIG_DM_WARN
725
726 Enable the dm_warn() function. This can use up quite a bit
727 of space for its strings.
728
729 CONFIG_DM_STDIO
730
731 Enable registering a serial device with the stdio library.
732
733 CONFIG_DM_DEVICE_REMOVE
734
735 Enable removing of devices.
736
737
wdenk5da627a2003-10-09 20:09:04 +0000738- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000739 CONFIG_CLOCKS_IN_MHZ
740
741 U-Boot stores all clock information in Hz
742 internally. For binary compatibility with older Linux
743 kernels (which expect the clocks passed in the
744 bd_info data to be in MHz) the environment variable
745 "clocks_in_mhz" can be defined so that U-Boot
746 converts clock data to MHZ before passing it to the
747 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000748 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100749 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000750 default environment.
751
wdenk5da627a2003-10-09 20:09:04 +0000752 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
753
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800754 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000755 expect it to be in bytes, others in MB.
756 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
757
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400758 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200759
760 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400761 passed using flattened device trees (based on open firmware
762 concepts).
763
764 CONFIG_OF_LIBFDT
765 * New libfdt-based support
766 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500767 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400768
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200769 OF_CPU - The proper name of the cpus node (only required for
770 MPC512X and MPC5xxx based boards).
771 OF_SOC - The proper name of the soc node (only required for
772 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200773 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600774 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200775
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200776 boards with QUICC Engines require OF_QE to set UCC MAC
777 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500778
Kumar Gala4e253132006-01-11 13:54:17 -0600779 CONFIG_OF_BOARD_SETUP
780
781 Board code has addition modification that it wants to make
782 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000783
Simon Glassc654b512014-10-23 18:58:54 -0600784 CONFIG_OF_SYSTEM_SETUP
785
786 Other code has addition modification that it wants to make
787 to the flat device tree before handing it off to the kernel.
788 This causes ft_system_setup() to be called before booting
789 the kernel.
790
Matthew McClintock02677682006-06-28 10:41:37 -0500791 CONFIG_OF_BOOT_CPU
792
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200793 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500794 param header, the default value is zero if undefined.
795
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200796 CONFIG_OF_IDE_FIXUP
797
798 U-Boot can detect if an IDE device is present or not.
799 If not, and this new config option is activated, U-Boot
800 removes the ATA node from the DTS before booting Linux,
801 so the Linux IDE driver does not probe the device and
802 crash. This is needed for buggy hardware (uc101) where
803 no pull down resistor is connected to the signal IDE5V_DD7.
804
Igor Grinberg7eb29392011-07-14 05:45:07 +0000805 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
806
807 This setting is mandatory for all boards that have only one
808 machine type and must be used to specify the machine type
809 number as it appears in the ARM machine registry
810 (see http://www.arm.linux.org.uk/developer/machines/).
811 Only boards that have multiple machine types supported
812 in a single configuration file and the machine type is
813 runtime discoverable, do not have to use this setting.
814
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100815- vxWorks boot parameters:
816
817 bootvx constructs a valid bootline using the following
818 environments variables: bootfile, ipaddr, serverip, hostname.
819 It loads the vxWorks image pointed bootfile.
820
821 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
822 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
823 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
824 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
825
826 CONFIG_SYS_VXWORKS_ADD_PARAMS
827
828 Add it at the end of the bootline. E.g "u=username pw=secret"
829
830 Note: If a "bootargs" environment is defined, it will overwride
831 the defaults discussed just above.
832
Aneesh V2c451f72011-06-16 23:30:47 +0000833- Cache Configuration:
834 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
835 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
836 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
837
Aneesh V93bc2192011-06-16 23:30:51 +0000838- Cache Configuration for ARM:
839 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
840 controller
841 CONFIG_SYS_PL310_BASE - Physical base address of PL310
842 controller register space
843
wdenk6705d812004-08-02 23:22:59 +0000844- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200845 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000846
847 Define this if you want support for Amba PrimeCell PL010 UARTs.
848
Andreas Engel48d01922008-09-08 14:30:53 +0200849 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000850
851 Define this if you want support for Amba PrimeCell PL011 UARTs.
852
853 CONFIG_PL011_CLOCK
854
855 If you have Amba PrimeCell PL011 UARTs, set this variable to
856 the clock speed of the UARTs.
857
858 CONFIG_PL01x_PORTS
859
860 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
861 define this to a list of base addresses for each (supported)
862 port. See e.g. include/configs/versatile.h
863
John Rigby910f1ae2011-04-19 10:42:39 +0000864 CONFIG_PL011_SERIAL_RLCR
865
866 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
867 have separate receive and transmit line control registers. Set
868 this variable to initialize the extra register.
869
870 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
871
872 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
873 boot loader that has already initialized the UART. Define this
874 variable to flush the UART at init time.
875
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400876 CONFIG_SERIAL_HW_FLOW_CONTROL
877
878 Define this variable to enable hw flow control in serial driver.
879 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000880
wdenkc6097192002-11-03 00:24:07 +0000881- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000882 Depending on board, define exactly one serial port
883 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
884 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
885 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000886
887 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
888 port routines must be defined elsewhere
889 (i.e. serial_init(), serial_getc(), ...)
890
891 CONFIG_CFB_CONSOLE
892 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000893 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000894 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
895 (default big endian)
896 VIDEO_HW_RECTFILL graphic chip supports
897 rectangle fill
898 (cf. smiLynxEM)
899 VIDEO_HW_BITBLT graphic chip supports
900 bit-blit (cf. smiLynxEM)
901 VIDEO_VISIBLE_COLS visible pixel columns
902 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000903 VIDEO_VISIBLE_ROWS visible pixel rows
904 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000905 VIDEO_DATA_FORMAT graphic data format
906 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000907 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000908 VIDEO_KBD_INIT_FCT keyboard int fct
909 (i.e. i8042_kbd_init())
910 VIDEO_TSTC_FCT test char fct
911 (i.e. i8042_tstc)
912 VIDEO_GETC_FCT get char fct
913 (i.e. i8042_getc)
914 CONFIG_CONSOLE_CURSOR cursor drawing on/off
915 (requires blink timer
916 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200917 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000918 CONFIG_CONSOLE_TIME display time/date info in
919 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000921 CONFIG_VIDEO_LOGO display Linux logo in
922 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000923 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
924 linux_logo.h for logo.
925 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000926 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200927 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000928 the logo
929
Pali Rohár33a35bb2012-10-19 13:30:09 +0000930 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
931 a limited number of ANSI escape sequences (cursor control,
932 erase functions and limited graphics rendition control).
933
wdenk43d96162003-03-06 00:02:04 +0000934 When CONFIG_CFB_CONSOLE is defined, video console is
935 default i/o. Serial console can be forced with
936 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000937
wdenkd4ca31c2004-01-02 14:00:00 +0000938 When CONFIG_SILENT_CONSOLE is defined, all console
939 messages (by U-Boot and Linux!) can be silenced with
940 the "silent" environment variable. See
941 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000942
Heiko Schocher45ae2542013-10-22 11:06:06 +0200943 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
944 is 0x00.
945 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
946 is 0xa0.
947
wdenkc6097192002-11-03 00:24:07 +0000948- Console Baudrate:
949 CONFIG_BAUDRATE - in bps
950 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200951 CONFIG_SYS_BAUDRATE_TABLE, see below.
952 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000953
Heiko Schocherc92fac92009-01-30 12:55:38 +0100954- Console Rx buffer length
955 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
956 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100957 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100958 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
959 must be defined, to setup the maximum idle timeout for
960 the SMC.
961
Graeme Russ9558b482011-09-01 00:48:27 +0000962- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200963 Prior to the console being initialised (i.e. serial UART
964 initialised etc) all console output is silently discarded.
965 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
966 buffer any console messages prior to the console being
967 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
968 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
969 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200970 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200971 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000972
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200973 'Sane' compilers will generate smaller code if
974 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000975
Sonny Rao046a37b2011-11-02 09:52:08 +0000976- Safe printf() functions
977 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
978 the printf() functions. These are defined in
979 include/vsprintf.h and include snprintf(), vsnprintf() and
980 so on. Code size increase is approximately 300-500 bytes.
981 If this option is not given then these functions will
982 silently discard their buffer size argument - this means
983 you are not getting any overflow checking in this case.
984
wdenkc6097192002-11-03 00:24:07 +0000985- Boot Delay: CONFIG_BOOTDELAY - in seconds
986 Delay before automatically booting the default image;
987 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000988 set to -2 to autoboot with no delay and not check for abort
989 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000990
991 See doc/README.autoboot for these options that
992 work with CONFIG_BOOTDELAY. None are required.
993 CONFIG_BOOT_RETRY_TIME
994 CONFIG_BOOT_RETRY_MIN
995 CONFIG_AUTOBOOT_KEYED
996 CONFIG_AUTOBOOT_PROMPT
997 CONFIG_AUTOBOOT_DELAY_STR
998 CONFIG_AUTOBOOT_STOP_STR
999 CONFIG_AUTOBOOT_DELAY_STR2
1000 CONFIG_AUTOBOOT_STOP_STR2
1001 CONFIG_ZERO_BOOTDELAY_CHECK
1002 CONFIG_RESET_TO_RETRY
1003
1004- Autoboot Command:
1005 CONFIG_BOOTCOMMAND
1006 Only needed when CONFIG_BOOTDELAY is enabled;
1007 define a command string that is automatically executed
1008 when no character is read on the console interface
1009 within "Boot Delay" after reset.
1010
1011 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +00001012 This can be used to pass arguments to the bootm
1013 command. The value of CONFIG_BOOTARGS goes into the
1014 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +00001015
1016 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +00001017 The value of these goes into the environment as
1018 "ramboot" and "nfsboot" respectively, and can be used
1019 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001020 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +00001021
Heiko Schochereda0ba32013-11-04 14:04:59 +01001022- Bootcount:
1023 CONFIG_BOOTCOUNT_LIMIT
1024 Implements a mechanism for detecting a repeating reboot
1025 cycle, see:
1026 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1027
1028 CONFIG_BOOTCOUNT_ENV
1029 If no softreset save registers are found on the hardware
1030 "bootcount" is stored in the environment. To prevent a
1031 saveenv on all reboots, the environment variable
1032 "upgrade_available" is used. If "upgrade_available" is
1033 0, "bootcount" is always 0, if "upgrade_available" is
1034 1 "bootcount" is incremented in the environment.
1035 So the Userspace Applikation must set the "upgrade_available"
1036 and "bootcount" variable to 0, if a boot was successfully.
1037
wdenkc6097192002-11-03 00:24:07 +00001038- Pre-Boot Commands:
1039 CONFIG_PREBOOT
1040
1041 When this option is #defined, the existence of the
1042 environment variable "preboot" will be checked
1043 immediately before starting the CONFIG_BOOTDELAY
1044 countdown and/or running the auto-boot command resp.
1045 entering interactive mode.
1046
1047 This feature is especially useful when "preboot" is
1048 automatically generated or modified. For an example
1049 see the LWMON board specific code: here "preboot" is
1050 modified when the user holds down a certain
1051 combination of keys on the (special) keyboard when
1052 booting the systems
1053
1054- Serial Download Echo Mode:
1055 CONFIG_LOADS_ECHO
1056 If defined to 1, all characters received during a
1057 serial download (using the "loads" command) are
1058 echoed back. This might be needed by some terminal
1059 emulations (like "cu"), but may as well just take
1060 time on others. This setting #define's the initial
1061 value of the "loads_echo" environment variable.
1062
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001063- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001064 CONFIG_KGDB_BAUDRATE
1065 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001066 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001067
1068- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 Monitor commands can be included or excluded
1070 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001071 <config_cmd_all.h> and #undef'ing unwanted
1072 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001073 and augmenting with additional #define's
1074 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001075
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001076 The default command configuration includes all commands
1077 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001078
Marek Vasutb401b732014-03-05 19:58:39 +01001079 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001081 CONFIG_CMD_BDI bdinfo
1082 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1083 CONFIG_CMD_BMP * BMP support
1084 CONFIG_CMD_BSP * Board specific commands
1085 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001086 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001087 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001088 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001089 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001090 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001091 CONFIG_CMD_DATE * support for RTC, date/time...
1092 CONFIG_CMD_DHCP * DHCP support
1093 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001094 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1095 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1096 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1097 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001098 CONFIG_CMD_DTT * Digital Therm and Thermostat
1099 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001100 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001101 CONFIG_CMD_EEPROM * EEPROM read/write support
1102 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001103 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001104 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001105 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001106 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001107 CONFIG_CMD_EXT2 * ext2 command support
1108 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001109 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1110 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001111 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001112 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001113 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001114 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001115 CONFIG_CMD_FLASH flinfo, erase, protect
1116 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001117 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001118 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001119 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001120 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001121 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001122 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1123 CONFIG_CMD_I2C * I2C serial bus support
1124 CONFIG_CMD_IDE * IDE harddisk support
1125 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001126 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001127 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001128 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001129 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001130 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001131 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001132 CONFIG_CMD_IRQ * irqinfo
1133 CONFIG_CMD_ITEST Integer/string test of 2 values
1134 CONFIG_CMD_JFFS2 * JFFS2 Support
1135 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001136 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001137 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1138 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001139 CONFIG_CMD_LOADB loadb
1140 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001141 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001142 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001143 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001144 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001145 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001146 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001147 CONFIG_CMD_MISC Misc functions like sleep etc
1148 CONFIG_CMD_MMC * MMC memory mapped support
1149 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001150 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001151 CONFIG_CMD_NAND * NAND support
1152 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001153 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001154 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001155 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001156 CONFIG_CMD_PCI * pciinfo
1157 CONFIG_CMD_PCMCIA * PCMCIA support
1158 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1159 host
1160 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001161 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001162 CONFIG_CMD_REGINFO * Register dump
1163 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001164 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001165 CONFIG_CMD_SAVES * save S record dump
1166 CONFIG_CMD_SCSI * SCSI Support
1167 CONFIG_CMD_SDRAM * print SDRAM configuration information
1168 (requires CONFIG_CMD_I2C)
1169 CONFIG_CMD_SETGETDCR Support for DCR Register access
1170 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001171 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001172 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001173 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001174 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001175 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001176 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001177 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001178 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001179 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1180 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001181 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001182 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001183 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001184 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001185 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001186
1187 EXAMPLE: If you want all functions except of network
1188 support you can write:
1189
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001190 #include "config_cmd_all.h"
1191 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001192
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001193 Other Commands:
1194 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001195
1196 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001197 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001198 what you (and your U-Boot users) are doing. Data
1199 cache cannot be enabled on systems like the 8xx or
1200 8260 (where accesses to the IMMR region must be
1201 uncached), and it cannot be disabled on all other
1202 systems where we (mis-) use the data cache to hold an
1203 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001204
1205
1206 XXX - this list needs to get updated!
1207
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001208- Regular expression support:
1209 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001210 If this variable is defined, U-Boot is linked against
1211 the SLRE (Super Light Regular Expression) library,
1212 which adds regex support to some commands, as for
1213 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001214
Simon Glass45ba8072011-10-15 05:48:20 +00001215- Device tree:
1216 CONFIG_OF_CONTROL
1217 If this variable is defined, U-Boot will use a device tree
1218 to configure its devices, instead of relying on statically
1219 compiled #defines in the board file. This option is
1220 experimental and only available on a few boards. The device
1221 tree is available in the global data as gd->fdt_blob.
1222
Simon Glass2c0f79e2011-10-24 19:15:31 +00001223 U-Boot needs to get its device tree from somewhere. This can
1224 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001225
1226 CONFIG_OF_EMBED
1227 If this variable is defined, U-Boot will embed a device tree
1228 binary in its image. This device tree file should be in the
1229 board directory and called <soc>-<board>.dts. The binary file
1230 is then picked up in board_init_f() and made available through
1231 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001232
Simon Glass2c0f79e2011-10-24 19:15:31 +00001233 CONFIG_OF_SEPARATE
1234 If this variable is defined, U-Boot will build a device tree
1235 binary. It will be called u-boot.dtb. Architecture-specific
1236 code will locate it at run-time. Generally this works by:
1237
1238 cat u-boot.bin u-boot.dtb >image.bin
1239
1240 and in fact, U-Boot does this for you, creating a file called
1241 u-boot-dtb.bin which is useful in the common case. You can
1242 still use the individual files if you need something more
1243 exotic.
1244
wdenkc6097192002-11-03 00:24:07 +00001245- Watchdog:
1246 CONFIG_WATCHDOG
1247 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001248 support for the SoC. There must be support in the SoC
1249 specific code for a watchdog. For the 8xx and 8260
1250 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1251 register. When supported for a specific SoC is
1252 available, then no further board specific code should
1253 be needed to use it.
1254
1255 CONFIG_HW_WATCHDOG
1256 When using a watchdog circuitry external to the used
1257 SoC, then define this variable and provide board
1258 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001259
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001260 CONFIG_AT91_HW_WDT_TIMEOUT
1261 specify the timeout in seconds. default 2 seconds.
1262
stroesec1551ea2003-04-04 15:53:41 +00001263- U-Boot Version:
1264 CONFIG_VERSION_VARIABLE
1265 If this variable is defined, an environment variable
1266 named "ver" is created by U-Boot showing the U-Boot
1267 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001268 Any change to this variable will be reverted at the
1269 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001270
wdenkc6097192002-11-03 00:24:07 +00001271- Real-Time Clock:
1272
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001273 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001274 has to be selected, too. Define exactly one of the
1275 following options:
1276
1277 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1278 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001279 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001280 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001281 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001282 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001283 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001284 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001285 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001286 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001287 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001288 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001289 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1290 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001291
wdenkb37c7e52003-06-30 16:24:52 +00001292 Note that if the RTC uses I2C, then the I2C interface
1293 must also be configured. See I2C Support, below.
1294
Peter Tysere92739d2008-12-17 16:36:21 -06001295- GPIO Support:
1296 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001297
Chris Packham5dec49c2010-12-19 10:12:13 +00001298 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1299 chip-ngpio pairs that tell the PCA953X driver the number of
1300 pins supported by a particular chip.
1301
Peter Tysere92739d2008-12-17 16:36:21 -06001302 Note that if the GPIO device uses I2C, then the I2C interface
1303 must also be configured. See I2C Support, below.
1304
Simon Glassaa532332014-06-11 23:29:41 -06001305- I/O tracing:
1306 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1307 accesses and can checksum them or write a list of them out
1308 to memory. See the 'iotrace' command for details. This is
1309 useful for testing device drivers since it can confirm that
1310 the driver behaves the same way before and after a code
1311 change. Currently this is supported on sandbox and arm. To
1312 add support for your architecture, add '#include <iotrace.h>'
1313 to the bottom of arch/<arch>/include/asm/io.h and test.
1314
1315 Example output from the 'iotrace stats' command is below.
1316 Note that if the trace buffer is exhausted, the checksum will
1317 still continue to operate.
1318
1319 iotrace is enabled
1320 Start: 10000000 (buffer start address)
1321 Size: 00010000 (buffer size)
1322 Offset: 00000120 (current buffer offset)
1323 Output: 10000120 (start + offset)
1324 Count: 00000018 (number of trace records)
1325 CRC32: 9526fb66 (CRC32 of all trace records)
1326
wdenkc6097192002-11-03 00:24:07 +00001327- Timestamp Support:
1328
wdenk43d96162003-03-06 00:02:04 +00001329 When CONFIG_TIMESTAMP is selected, the timestamp
1330 (date and time) of an image is printed by image
1331 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001332 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001333
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001334- Partition Labels (disklabels) Supported:
1335 Zero or more of the following:
1336 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1337 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1338 Intel architecture, USB sticks, etc.
1339 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1340 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1341 bootloader. Note 2TB partition limit; see
1342 disk/part_efi.c
1343 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001344
Wolfgang Denk218ca722008-03-26 10:40:12 +01001345 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1346 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001347 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001348
1349- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001350 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1351 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001352
wdenk4d13cba2004-03-14 14:09:05 +00001353 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1354 be performed by calling the function
1355 ide_set_reset(int reset)
1356 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001357
1358- ATAPI Support:
1359 CONFIG_ATAPI
1360
1361 Set this to enable ATAPI support.
1362
wdenkc40b2952004-03-13 23:29:43 +00001363- LBA48 Support
1364 CONFIG_LBA48
1365
1366 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001367 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001368 Whithout these , LBA48 support uses 32bit variables and will 'only'
1369 support disks up to 2.1TB.
1370
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001371 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001372 When enabled, makes the IDE subsystem use 64bit sector addresses.
1373 Default is 32bit.
1374
wdenkc6097192002-11-03 00:24:07 +00001375- SCSI Support:
1376 At the moment only there is only support for the
1377 SYM53C8XX SCSI controller; define
1378 CONFIG_SCSI_SYM53C8XX to enable it.
1379
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001380 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1381 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1382 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001383 maximum numbers of LUNs, SCSI ID's and target
1384 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001385 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001386
Wolfgang Denk93e14592013-10-04 17:43:24 +02001387 The environment variable 'scsidevs' is set to the number of
1388 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001389
wdenkc6097192002-11-03 00:24:07 +00001390- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001391 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001392 Support for Intel 8254x/8257x gigabit chips.
1393
1394 CONFIG_E1000_SPI
1395 Utility code for direct access to the SPI bus on Intel 8257x.
1396 This does not do anything useful unless you set at least one
1397 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1398
1399 CONFIG_E1000_SPI_GENERIC
1400 Allow generic access to the SPI bus on the Intel 8257x, for
1401 example with the "sspi" command.
1402
1403 CONFIG_CMD_E1000
1404 Management command for E1000 devices. When used on devices
1405 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001406
Andre Schwarzac3315c2008-03-06 16:45:44 +01001407 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001408 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001409
wdenkc6097192002-11-03 00:24:07 +00001410 CONFIG_EEPRO100
1411 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001412 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001413 write routine for first time initialisation.
1414
1415 CONFIG_TULIP
1416 Support for Digital 2114x chips.
1417 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1418 modem chip initialisation (KS8761/QS6611).
1419
1420 CONFIG_NATSEMI
1421 Support for National dp83815 chips.
1422
1423 CONFIG_NS8382X
1424 Support for National dp8382[01] gigabit chips.
1425
wdenk45219c42003-05-12 21:50:16 +00001426- NETWORK Support (other):
1427
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001428 CONFIG_DRIVER_AT91EMAC
1429 Support for AT91RM9200 EMAC.
1430
1431 CONFIG_RMII
1432 Define this to use reduced MII inteface
1433
1434 CONFIG_DRIVER_AT91EMAC_QUIET
1435 If this defined, the driver is quiet.
1436 The driver doen't show link status messages.
1437
Rob Herringefdd7312011-12-15 11:15:49 +00001438 CONFIG_CALXEDA_XGMAC
1439 Support for the Calxeda XGMAC device
1440
Ashok3bb46d22012-10-15 06:20:47 +00001441 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001442 Support for SMSC's LAN91C96 chips.
1443
1444 CONFIG_LAN91C96_BASE
1445 Define this to hold the physical address
1446 of the LAN91C96's I/O space
1447
1448 CONFIG_LAN91C96_USE_32_BIT
1449 Define this to enable 32 bit addressing
1450
Ashok3bb46d22012-10-15 06:20:47 +00001451 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001452 Support for SMSC's LAN91C111 chip
1453
1454 CONFIG_SMC91111_BASE
1455 Define this to hold the physical address
1456 of the device (I/O space)
1457
1458 CONFIG_SMC_USE_32_BIT
1459 Define this if data bus is 32 bits
1460
1461 CONFIG_SMC_USE_IOFUNCS
1462 Define this to use i/o functions instead of macros
1463 (some hardware wont work with macros)
1464
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001465 CONFIG_DRIVER_TI_EMAC
1466 Support for davinci emac
1467
1468 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1469 Define this if you have more then 3 PHYs.
1470
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001471 CONFIG_FTGMAC100
1472 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1473
1474 CONFIG_FTGMAC100_EGIGA
1475 Define this to use GE link update with gigabit PHY.
1476 Define this if FTGMAC100 is connected to gigabit PHY.
1477 If your system has 10/100 PHY only, it might not occur
1478 wrong behavior. Because PHY usually return timeout or
1479 useless data when polling gigabit status and gigabit
1480 control registers. This behavior won't affect the
1481 correctnessof 10/100 link speed update.
1482
Mike Rapoportc2fff332009-11-11 10:03:03 +02001483 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001484 Support for SMSC's LAN911x and LAN921x chips
1485
Mike Rapoportc2fff332009-11-11 10:03:03 +02001486 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001487 Define this to hold the physical address
1488 of the device (I/O space)
1489
Mike Rapoportc2fff332009-11-11 10:03:03 +02001490 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001491 Define this if data bus is 32 bits
1492
Mike Rapoportc2fff332009-11-11 10:03:03 +02001493 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001494 Define this if data bus is 16 bits. If your processor
1495 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001496 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001497
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001498 CONFIG_SH_ETHER
1499 Support for Renesas on-chip Ethernet controller
1500
1501 CONFIG_SH_ETHER_USE_PORT
1502 Define the number of ports to be used
1503
1504 CONFIG_SH_ETHER_PHY_ADDR
1505 Define the ETH PHY's address
1506
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001507 CONFIG_SH_ETHER_CACHE_WRITEBACK
1508 If this option is set, the driver enables cache flush.
1509
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001510- PWM Support:
1511 CONFIG_PWM_IMX
1512 Support for PWM modul on the imx6.
1513
Vadim Bendebury5e124722011-10-17 08:36:14 +00001514- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001515 CONFIG_TPM
1516 Support TPM devices.
1517
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001518 CONFIG_TPM_TIS_I2C
1519 Support for i2c bus TPM devices. Only one device
1520 per system is supported at this time.
1521
1522 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1523 Define the the i2c bus number for the TPM device
1524
1525 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1526 Define the TPM's address on the i2c bus
1527
1528 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1529 Define the burst count bytes upper limit
1530
Dirk Eibachc01939c2013-06-26 15:55:15 +02001531 CONFIG_TPM_ATMEL_TWI
1532 Support for Atmel TWI TPM device. Requires I2C support.
1533
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001534 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001535 Support for generic parallel port TPM devices. Only one device
1536 per system is supported at this time.
1537
1538 CONFIG_TPM_TIS_BASE_ADDRESS
1539 Base address where the generic TPM device is mapped
1540 to. Contemporary x86 systems usually map it at
1541 0xfed40000.
1542
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001543 CONFIG_CMD_TPM
1544 Add tpm monitor functions.
1545 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1546 provides monitor access to authorized functions.
1547
1548 CONFIG_TPM
1549 Define this to enable the TPM support library which provides
1550 functional interfaces to some TPM commands.
1551 Requires support for a TPM device.
1552
1553 CONFIG_TPM_AUTH_SESSIONS
1554 Define this to enable authorized functions in the TPM library.
1555 Requires CONFIG_TPM and CONFIG_SHA1.
1556
wdenkc6097192002-11-03 00:24:07 +00001557- USB Support:
1558 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001559 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001560 CONFIG_USB_UHCI to enable it.
1561 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001562 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001563 storage devices.
1564 Note:
1565 Supported are USB Keyboards and USB Floppy drives
1566 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001567 MPC5200 USB requires additional defines:
1568 CONFIG_USB_CLOCK
1569 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001570 CONFIG_PSC3_USB
1571 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001572 CONFIG_USB_CONFIG
1573 for differential drivers: 0x00001000
1574 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001575 for differential drivers on PSC3: 0x00000100
1576 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001577 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001578 May be defined to allow interrupt polling
1579 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001580
Simon Glass9ab4ce22012-02-27 10:52:47 +00001581 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1582 txfilltuning field in the EHCI controller on reset.
1583
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001584 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1585 HW module registers.
1586
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001587- USB Device:
1588 Define the below if you wish to use the USB console.
1589 Once firmware is rebuilt from a serial console issue the
1590 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001591 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001592 it has found a new device. The environment variable usbtty
1593 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001594 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001595 Common Device Class Abstract Control Model serial device.
1596 If you select usbtty = gserial you should be able to enumerate
1597 a Linux host by
1598 # modprobe usbserial vendor=0xVendorID product=0xProductID
1599 else if using cdc_acm, simply setting the environment
1600 variable usbtty to be cdc_acm should suffice. The following
1601 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001602
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001603 CONFIG_USB_DEVICE
1604 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001605
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001606 CONFIG_USB_TTY
1607 Define this to have a tty type of device available to
1608 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001609
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301610 CONFIG_USBD_HS
1611 Define this to enable the high speed support for usb
1612 device and usbtty. If this feature is enabled, a routine
1613 int is_usbd_high_speed(void)
1614 also needs to be defined by the driver to dynamically poll
1615 whether the enumeration has succeded at high speed or full
1616 speed.
1617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001618 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001619 Define this if you want stdin, stdout &/or stderr to
1620 be set to usbtty.
1621
1622 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001623 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001624 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001625 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001627 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001628 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001629 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001630
Wolfgang Denk386eda02006-06-14 18:14:56 +02001631 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001632 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001633 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001634 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1635 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1636 should pretend to be a Linux device to it's target host.
1637
1638 CONFIG_USBD_MANUFACTURER
1639 Define this string as the name of your company for
1640 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001641
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001642 CONFIG_USBD_PRODUCT_NAME
1643 Define this string as the name of your product
1644 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1645
1646 CONFIG_USBD_VENDORID
1647 Define this as your assigned Vendor ID from the USB
1648 Implementors Forum. This *must* be a genuine Vendor ID
1649 to avoid polluting the USB namespace.
1650 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001651
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001652 CONFIG_USBD_PRODUCTID
1653 Define this as the unique Product ID
1654 for your device
1655 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001656
Igor Grinbergd70a5602011-12-12 12:08:35 +02001657- ULPI Layer Support:
1658 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1659 the generic ULPI layer. The generic layer accesses the ULPI PHY
1660 via the platform viewport, so you need both the genric layer and
1661 the viewport enabled. Currently only Chipidea/ARC based
1662 viewport is supported.
1663 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1664 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001665 If your ULPI phy needs a different reference clock than the
1666 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1667 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001668
1669- MMC Support:
1670 The MMC controller on the Intel PXA is supported. To
1671 enable this define CONFIG_MMC. The MMC can be
1672 accessed from the boot prompt by mapping the device
1673 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001674 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1675 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001676
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001677 CONFIG_SH_MMCIF
1678 Support for Renesas on-chip MMCIF controller
1679
1680 CONFIG_SH_MMCIF_ADDR
1681 Define the base address of MMCIF registers
1682
1683 CONFIG_SH_MMCIF_CLK
1684 Define the clock frequency for MMCIF
1685
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001686 CONFIG_GENERIC_MMC
1687 Enable the generic MMC driver
1688
1689 CONFIG_SUPPORT_EMMC_BOOT
1690 Enable some additional features of the eMMC boot partitions.
1691
1692 CONFIG_SUPPORT_EMMC_RPMB
1693 Enable the commands for reading, writing and programming the
1694 key for the Replay Protection Memory Block partition in eMMC.
1695
Tom Rinib3ba6e92013-03-14 05:32:47 +00001696- USB Device Firmware Update (DFU) class support:
1697 CONFIG_DFU_FUNCTION
1698 This enables the USB portion of the DFU USB class
1699
1700 CONFIG_CMD_DFU
1701 This enables the command "dfu" which is used to have
1702 U-Boot create a DFU class device via USB. This command
1703 requires that the "dfu_alt_info" environment variable be
1704 set and define the alt settings to expose to the host.
1705
1706 CONFIG_DFU_MMC
1707 This enables support for exposing (e)MMC devices via DFU.
1708
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001709 CONFIG_DFU_NAND
1710 This enables support for exposing NAND devices via DFU.
1711
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301712 CONFIG_DFU_RAM
1713 This enables support for exposing RAM via DFU.
1714 Note: DFU spec refer to non-volatile memory usage, but
1715 allow usages beyond the scope of spec - here RAM usage,
1716 one that would help mostly the developer.
1717
Heiko Schochere7e75c72013-06-12 06:05:51 +02001718 CONFIG_SYS_DFU_DATA_BUF_SIZE
1719 Dfu transfer uses a buffer before writing data to the
1720 raw storage device. Make the size (in bytes) of this buffer
1721 configurable. The size of this buffer is also configurable
1722 through the "dfu_bufsiz" environment variable.
1723
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001724 CONFIG_SYS_DFU_MAX_FILE_SIZE
1725 When updating files rather than the raw storage device,
1726 we use a static buffer to copy the file into and then write
1727 the buffer once we've been given the whole file. Define
1728 this to the maximum filesize (in bytes) for the buffer.
1729 Default is 4 MiB if undefined.
1730
Heiko Schocher001a8312014-03-18 08:09:56 +01001731 DFU_DEFAULT_POLL_TIMEOUT
1732 Poll timeout [ms], is the timeout a device can send to the
1733 host. The host must wait for this timeout before sending
1734 a subsequent DFU_GET_STATUS request to the device.
1735
1736 DFU_MANIFEST_POLL_TIMEOUT
1737 Poll timeout [ms], which the device sends to the host when
1738 entering dfuMANIFEST state. Host waits this timeout, before
1739 sending again an USB request to the device.
1740
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001741- USB Device Android Fastboot support:
1742 CONFIG_CMD_FASTBOOT
1743 This enables the command "fastboot" which enables the Android
1744 fastboot mode for the platform's USB device. Fastboot is a USB
1745 protocol for downloading images, flashing and device control
1746 used on Android devices.
1747 See doc/README.android-fastboot for more information.
1748
1749 CONFIG_ANDROID_BOOT_IMAGE
1750 This enables support for booting images which use the Android
1751 image format header.
1752
1753 CONFIG_USB_FASTBOOT_BUF_ADDR
1754 The fastboot protocol requires a large memory buffer for
1755 downloads. Define this to the starting RAM address to use for
1756 downloaded images.
1757
1758 CONFIG_USB_FASTBOOT_BUF_SIZE
1759 The fastboot protocol requires a large memory buffer for
1760 downloads. This buffer should be as large as possible for a
1761 platform. Define this to the size available RAM for fastboot.
1762
Steve Raed1b5ed02014-08-26 11:47:28 -07001763 CONFIG_FASTBOOT_FLASH
1764 The fastboot protocol includes a "flash" command for writing
1765 the downloaded image to a non-volatile storage device. Define
1766 this to enable the "fastboot flash" command.
1767
1768 CONFIG_FASTBOOT_FLASH_MMC_DEV
1769 The fastboot "flash" command requires additional information
1770 regarding the non-volatile storage device. Define this to
1771 the eMMC device that fastboot should use to store the image.
1772
Steve Rae0ff7e582014-12-12 15:51:54 -08001773 CONFIG_FASTBOOT_GPT_NAME
1774 The fastboot "flash" command supports writing the downloaded
1775 image to the Protective MBR and the Primary GUID Partition
1776 Table. (Additionally, this downloaded image is post-processed
1777 to generate and write the Backup GUID Partition Table.)
1778 This occurs when the specified "partition name" on the
1779 "fastboot flash" command line matches this value.
1780 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1781
wdenk6705d812004-08-02 23:22:59 +00001782- Journaling Flash filesystem support:
1783 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1784 CONFIG_JFFS2_NAND_DEV
1785 Define these for a default partition on a NAND device
1786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001787 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1788 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001789 Define these for a default partition on a NOR device
1790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001791 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001792 Define this to create an own partition. You have to provide a
1793 function struct part_info* jffs2_part_info(int part_num)
1794
1795 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001796 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001797 to disable the command chpart. This is the default when you
1798 have not defined a custom partition
1799
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001800- FAT(File Allocation Table) filesystem write function support:
1801 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001802
1803 Define this to enable support for saving memory data as a
1804 file in FAT formatted partition.
1805
1806 This will also enable the command "fatwrite" enabling the
1807 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001808
Gabe Black84cd9322012-10-12 14:26:11 +00001809CBFS (Coreboot Filesystem) support
1810 CONFIG_CMD_CBFS
1811
1812 Define this to enable support for reading from a Coreboot
1813 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1814 and cbfsload.
1815
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301816- FAT(File Allocation Table) filesystem cluster size:
1817 CONFIG_FS_FAT_MAX_CLUSTSIZE
1818
1819 Define the max cluster size for fat operations else
1820 a default value of 65536 will be defined.
1821
wdenkc6097192002-11-03 00:24:07 +00001822- Keyboard Support:
1823 CONFIG_ISA_KEYBOARD
1824
1825 Define this to enable standard (PC-Style) keyboard
1826 support
1827
1828 CONFIG_I8042_KBD
1829 Standard PC keyboard driver with US (is default) and
1830 GERMAN key layout (switch via environment 'keymap=de') support.
1831 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1832 for cfb_console. Supports cursor blinking.
1833
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001834 CONFIG_CROS_EC_KEYB
1835 Enables a Chrome OS keyboard using the CROS_EC interface.
1836 This uses CROS_EC to communicate with a second microcontroller
1837 which provides key scans on request.
1838
wdenkc6097192002-11-03 00:24:07 +00001839- Video support:
1840 CONFIG_VIDEO
1841
1842 Define this to enable video support (for output to
1843 video).
1844
1845 CONFIG_VIDEO_CT69000
1846
1847 Enable Chips & Technologies 69000 Video chip
1848
1849 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001850 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001851 video output is selected via environment 'videoout'
1852 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1853 assumed.
wdenkc6097192002-11-03 00:24:07 +00001854
wdenkb79a11c2004-03-25 15:14:43 +00001855 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001856 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001857 are possible:
1858 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001859 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001860
1861 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1862 -------------+---------------------------------------------
1863 8 bits | 0x301* 0x303 0x305 0x161 0x307
1864 15 bits | 0x310 0x313 0x316 0x162 0x319
1865 16 bits | 0x311 0x314 0x317 0x163 0x31A
1866 24 bits | 0x312 0x315 0x318 ? 0x31B
1867 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001868 (i.e. setenv videomode 317; saveenv; reset;)
1869
wdenkb79a11c2004-03-25 15:14:43 +00001870 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001871 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001872
1873
stroesec1551ea2003-04-04 15:53:41 +00001874 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001875 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001876 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1877 or CONFIG_VIDEO_SED13806_16BPP
1878
Timur Tabi7d3053f2011-02-15 17:09:19 -06001879 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001880 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001881 SOCs that have a DIU should define this macro to enable DIU
1882 support, and should also define these other macros:
1883
1884 CONFIG_SYS_DIU_ADDR
1885 CONFIG_VIDEO
1886 CONFIG_CMD_BMP
1887 CONFIG_CFB_CONSOLE
1888 CONFIG_VIDEO_SW_CURSOR
1889 CONFIG_VGA_AS_SINGLE_DEVICE
1890 CONFIG_VIDEO_LOGO
1891 CONFIG_VIDEO_BMP_LOGO
1892
Timur Tabiba8e76b2011-04-11 14:18:22 -05001893 The DIU driver will look for the 'video-mode' environment
1894 variable, and if defined, enable the DIU as a console during
1895 boot. See the documentation file README.video for a
1896 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001897
Simon Glass058d59b2012-12-03 13:59:47 +00001898 CONFIG_VIDEO_VGA
1899
1900 Enable the VGA video / BIOS for x86. The alternative if you
1901 are using coreboot is to use the coreboot frame buffer
1902 driver.
1903
1904
wdenk682011f2003-06-03 23:54:09 +00001905- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001906 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001907
wdenk8bde7f72003-06-27 21:31:46 +00001908 Define this to enable a custom keyboard support.
1909 This simply calls drv_keyboard_init() which must be
1910 defined in your board-specific files.
1911 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001912
wdenkc6097192002-11-03 00:24:07 +00001913- LCD Support: CONFIG_LCD
1914
1915 Define this to enable LCD support (for output to LCD
1916 display); also select one of the supported displays
1917 by defining one of these:
1918
Stelian Pop39cf4802008-05-09 21:57:18 +02001919 CONFIG_ATMEL_LCD:
1920
1921 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1922
wdenkfd3103b2003-11-25 16:55:19 +00001923 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001924
wdenkfd3103b2003-11-25 16:55:19 +00001925 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001926
wdenkfd3103b2003-11-25 16:55:19 +00001927 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001928
wdenkfd3103b2003-11-25 16:55:19 +00001929 NEC NL6448BC20-08. 6.5", 640x480.
1930 Active, color, single scan.
1931
1932 CONFIG_NEC_NL6448BC33_54
1933
1934 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001935 Active, color, single scan.
1936
1937 CONFIG_SHARP_16x9
1938
1939 Sharp 320x240. Active, color, single scan.
1940 It isn't 16x9, and I am not sure what it is.
1941
1942 CONFIG_SHARP_LQ64D341
1943
1944 Sharp LQ64D341 display, 640x480.
1945 Active, color, single scan.
1946
1947 CONFIG_HLD1045
1948
1949 HLD1045 display, 640x480.
1950 Active, color, single scan.
1951
1952 CONFIG_OPTREX_BW
1953
1954 Optrex CBL50840-2 NF-FW 99 22 M5
1955 or
1956 Hitachi LMG6912RPFC-00T
1957 or
1958 Hitachi SP14Q002
1959
1960 320x240. Black & white.
1961
1962 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001963 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001964
Simon Glass676d3192012-10-17 13:24:54 +00001965 CONFIG_LCD_ALIGNMENT
1966
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001967 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001968 defined then the LCD will be aligned to this value instead.
1969 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1970 here, since it is cheaper to change data cache settings on
1971 a per-section basis.
1972
Simon Glass0d89efe2012-10-17 13:24:59 +00001973 CONFIG_CONSOLE_SCROLL_LINES
1974
1975 When the console need to be scrolled, this is the number of
1976 lines to scroll by. It defaults to 1. Increasing this makes
1977 the console jump but can help speed up operation when scrolling
1978 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001979
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001980 CONFIG_LCD_BMP_RLE8
1981
1982 Support drawing of RLE8-compressed bitmaps on the LCD.
1983
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001984 CONFIG_I2C_EDID
1985
1986 Enables an 'i2c edid' command which can read EDID
1987 information over I2C from an attached LCD display.
1988
wdenk7152b1d2003-09-05 23:19:14 +00001989- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001990
wdenk8bde7f72003-06-27 21:31:46 +00001991 If this option is set, the environment is checked for
1992 a variable "splashimage". If found, the usual display
1993 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001994 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001995 specified in "splashimage" is loaded instead. The
1996 console is redirected to the "nulldev", too. This
1997 allows for a "silent" boot where a splash screen is
1998 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001999
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002000 CONFIG_SPLASHIMAGE_GUARD
2001
2002 If this option is set, then U-Boot will prevent the environment
2003 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05002004 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00002005 This option is useful for targets where, due to alignment
2006 restrictions, an improperly aligned BMP image will cause a data
2007 abort. If you think you will not have problems with unaligned
2008 accesses (for example because your toolchain prevents them)
2009 there is no need to set this option.
2010
Matthias Weisser1ca298c2009-07-09 16:07:30 +02002011 CONFIG_SPLASH_SCREEN_ALIGN
2012
2013 If this option is set the splash image can be freely positioned
2014 on the screen. Environment variable "splashpos" specifies the
2015 position as "x,y". If a positive number is given it is used as
2016 number of pixel from left/top. If a negative number is given it
2017 is used as number of pixel from right/bottom. You can also
2018 specify 'm' for centering the image.
2019
2020 Example:
2021 setenv splashpos m,m
2022 => image at center of screen
2023
2024 setenv splashpos 30,20
2025 => image at x = 30 and y = 20
2026
2027 setenv splashpos -10,m
2028 => vertically centered image
2029 at x = dspWidth - bmpWidth - 9
2030
Stefan Roese98f4a3d2005-09-22 09:04:17 +02002031- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2032
2033 If this option is set, additionally to standard BMP
2034 images, gzipped BMP images can be displayed via the
2035 splashscreen support or the bmp command.
2036
Anatolij Gustschind5011762010-03-15 14:50:25 +01002037- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2038
2039 If this option is set, 8-bit RLE compressed BMP images
2040 can be displayed via the splashscreen support or the
2041 bmp command.
2042
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002043- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002044 CONFIG_CMD_ZIP
2045
2046 If this option is set, it would use zlib deflate method
2047 to compress the specified memory at its best effort.
2048
wdenkc29fdfc2003-08-29 20:57:53 +00002049- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002050 CONFIG_GZIP
2051
2052 Enabled by default to support gzip compressed images.
2053
wdenkc29fdfc2003-08-29 20:57:53 +00002054 CONFIG_BZIP2
2055
2056 If this option is set, support for bzip2 compressed
2057 images is included. If not, only uncompressed and gzip
2058 compressed images are supported.
2059
wdenk42d1f032003-10-15 23:53:47 +00002060 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002061 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002062 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002063
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002064 CONFIG_LZMA
2065
2066 If this option is set, support for lzma compressed
2067 images is included.
2068
2069 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2070 requires an amount of dynamic memory that is given by the
2071 formula:
2072
2073 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2074
2075 Where lc and lp stand for, respectively, Literal context bits
2076 and Literal pos bits.
2077
2078 This value is upper-bounded by 14MB in the worst case. Anyway,
2079 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2080 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2081 a very small buffer.
2082
2083 Use the lzmainfo tool to determinate the lc and lp values and
2084 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002085 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002086
Kees Cook8ef70472013-08-16 07:59:12 -07002087 CONFIG_LZO
2088
2089 If this option is set, support for LZO compressed images
2090 is included.
2091
wdenk17ea1172004-06-06 21:51:03 +00002092- MII/PHY support:
2093 CONFIG_PHY_ADDR
2094
2095 The address of PHY on MII bus.
2096
2097 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2098
2099 The clock frequency of the MII bus
2100
2101 CONFIG_PHY_GIGE
2102
2103 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002104 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002105
2106 CONFIG_PHY_RESET_DELAY
2107
2108 Some PHY like Intel LXT971A need extra delay after
2109 reset before any MII register access is possible.
2110 For such PHY, set this option to the usec delay
2111 required. (minimum 300usec for LXT971A)
2112
2113 CONFIG_PHY_CMD_DELAY (ppc4xx)
2114
2115 Some PHY like Intel LXT971A need extra delay after
2116 command issued before MII status register can be read
2117
wdenkc6097192002-11-03 00:24:07 +00002118- Ethernet address:
2119 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002120 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00002121 CONFIG_ETH2ADDR
2122 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04002123 CONFIG_ETH4ADDR
2124 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00002125
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002126 Define a default value for Ethernet address to use
2127 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00002128 is not determined automatically.
2129
2130- IP address:
2131 CONFIG_IPADDR
2132
2133 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002134 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002135 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002136 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002137
2138- Server IP address:
2139 CONFIG_SERVERIP
2140
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002141 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002142 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002143 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002144
Robin Getz97cfe862009-07-21 12:15:28 -04002145 CONFIG_KEEP_SERVERADDR
2146
2147 Keeps the server's MAC address, in the env 'serveraddr'
2148 for passing to bootargs (like Linux's netconsole option)
2149
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002150- Gateway IP address:
2151 CONFIG_GATEWAYIP
2152
2153 Defines a default value for the IP address of the
2154 default router where packets to other networks are
2155 sent to.
2156 (Environment variable "gatewayip")
2157
2158- Subnet mask:
2159 CONFIG_NETMASK
2160
2161 Defines a default value for the subnet mask (or
2162 routing prefix) which is used to determine if an IP
2163 address belongs to the local subnet or needs to be
2164 forwarded through a router.
2165 (Environment variable "netmask")
2166
David Updegraff53a5c422007-06-11 10:41:07 -05002167- Multicast TFTP Mode:
2168 CONFIG_MCAST_TFTP
2169
2170 Defines whether you want to support multicast TFTP as per
2171 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002172 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002173 driver in use must provide a function: mcast() to join/leave a
2174 multicast group.
2175
wdenkc6097192002-11-03 00:24:07 +00002176- BOOTP Recovery Mode:
2177 CONFIG_BOOTP_RANDOM_DELAY
2178
2179 If you have many targets in a network that try to
2180 boot using BOOTP, you may want to avoid that all
2181 systems send out BOOTP requests at precisely the same
2182 moment (which would happen for instance at recovery
2183 from a power failure, when all systems will try to
2184 boot, thus flooding the BOOTP server. Defining
2185 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2186 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002187 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002188
2189 1st BOOTP request: delay 0 ... 1 sec
2190 2nd BOOTP request: delay 0 ... 2 sec
2191 3rd BOOTP request: delay 0 ... 4 sec
2192 4th and following
2193 BOOTP requests: delay 0 ... 8 sec
2194
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002195 CONFIG_BOOTP_ID_CACHE_SIZE
2196
2197 BOOTP packets are uniquely identified using a 32-bit ID. The
2198 server will copy the ID from client requests to responses and
2199 U-Boot will use this to determine if it is the destination of
2200 an incoming response. Some servers will check that addresses
2201 aren't in use before handing them out (usually using an ARP
2202 ping) and therefore take up to a few hundred milliseconds to
2203 respond. Network congestion may also influence the time it
2204 takes for a response to make it back to the client. If that
2205 time is too long, U-Boot will retransmit requests. In order
2206 to allow earlier responses to still be accepted after these
2207 retransmissions, U-Boot's BOOTP client keeps a small cache of
2208 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2209 cache. The default is to keep IDs for up to four outstanding
2210 requests. Increasing this will allow U-Boot to accept offers
2211 from a BOOTP client in networks with unusually high latency.
2212
stroesefe389a82003-08-28 14:17:32 +00002213- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002214 You can fine tune the DHCP functionality by defining
2215 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002216
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002217 CONFIG_BOOTP_SUBNETMASK
2218 CONFIG_BOOTP_GATEWAY
2219 CONFIG_BOOTP_HOSTNAME
2220 CONFIG_BOOTP_NISDOMAIN
2221 CONFIG_BOOTP_BOOTPATH
2222 CONFIG_BOOTP_BOOTFILESIZE
2223 CONFIG_BOOTP_DNS
2224 CONFIG_BOOTP_DNS2
2225 CONFIG_BOOTP_SEND_HOSTNAME
2226 CONFIG_BOOTP_NTPSERVER
2227 CONFIG_BOOTP_TIMEOFFSET
2228 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002229 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002230
Wilson Callan5d110f02007-07-28 10:56:13 -04002231 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2232 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002233
Joe Hershberger2c00e092012-05-23 07:59:19 +00002234 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2235 after the configured retry count, the call will fail
2236 instead of starting over. This can be used to fail over
2237 to Link-local IP address configuration if the DHCP server
2238 is not available.
2239
stroesefe389a82003-08-28 14:17:32 +00002240 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2241 serverip from a DHCP server, it is possible that more
2242 than one DNS serverip is offered to the client.
2243 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2244 serverip will be stored in the additional environment
2245 variable "dnsip2". The first DNS serverip is always
2246 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002247 is defined.
stroesefe389a82003-08-28 14:17:32 +00002248
2249 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2250 to do a dynamic update of a DNS server. To do this, they
2251 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002252 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002253 of the "hostname" environment variable is passed as
2254 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002255
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002256 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2257
2258 A 32bit value in microseconds for a delay between
2259 receiving a "DHCP Offer" and sending the "DHCP Request".
2260 This fixes a problem with certain DHCP servers that don't
2261 respond 100% of the time to a "DHCP request". E.g. On an
2262 AT91RM9200 processor running at 180MHz, this delay needed
2263 to be *at least* 15,000 usec before a Windows Server 2003
2264 DHCP server would reply 100% of the time. I recommend at
2265 least 50,000 usec to be safe. The alternative is to hope
2266 that one of the retries will be successful but note that
2267 the DHCP timeout and retry process takes a longer than
2268 this delay.
2269
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002270 - Link-local IP address negotiation:
2271 Negotiate with other link-local clients on the local network
2272 for an address that doesn't require explicit configuration.
2273 This is especially useful if a DHCP server cannot be guaranteed
2274 to exist in all environments that the device must operate.
2275
2276 See doc/README.link-local for more information.
2277
wdenka3d991b2004-04-15 21:48:45 +00002278 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002279 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002280
2281 The device id used in CDP trigger frames.
2282
2283 CONFIG_CDP_DEVICE_ID_PREFIX
2284
2285 A two character string which is prefixed to the MAC address
2286 of the device.
2287
2288 CONFIG_CDP_PORT_ID
2289
2290 A printf format string which contains the ascii name of
2291 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002292 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002293
2294 CONFIG_CDP_CAPABILITIES
2295
2296 A 32bit integer which indicates the device capabilities;
2297 0x00000010 for a normal host which does not forwards.
2298
2299 CONFIG_CDP_VERSION
2300
2301 An ascii string containing the version of the software.
2302
2303 CONFIG_CDP_PLATFORM
2304
2305 An ascii string containing the name of the platform.
2306
2307 CONFIG_CDP_TRIGGER
2308
2309 A 32bit integer sent on the trigger.
2310
2311 CONFIG_CDP_POWER_CONSUMPTION
2312
2313 A 16bit integer containing the power consumption of the
2314 device in .1 of milliwatts.
2315
2316 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2317
2318 A byte containing the id of the VLAN.
2319
wdenkc6097192002-11-03 00:24:07 +00002320- Status LED: CONFIG_STATUS_LED
2321
2322 Several configurations allow to display the current
2323 status using a LED. For instance, the LED will blink
2324 fast while running U-Boot code, stop blinking as
2325 soon as a reply to a BOOTP request was received, and
2326 start blinking slow once the Linux kernel is running
2327 (supported by a status LED driver in the Linux
2328 kernel). Defining CONFIG_STATUS_LED enables this
2329 feature in U-Boot.
2330
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002331 Additional options:
2332
2333 CONFIG_GPIO_LED
2334 The status LED can be connected to a GPIO pin.
2335 In such cases, the gpio_led driver can be used as a
2336 status LED backend implementation. Define CONFIG_GPIO_LED
2337 to include the gpio_led driver in the U-Boot binary.
2338
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002339 CONFIG_GPIO_LED_INVERTED_TABLE
2340 Some GPIO connected LEDs may have inverted polarity in which
2341 case the GPIO high value corresponds to LED off state and
2342 GPIO low value corresponds to LED on state.
2343 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2344 with a list of GPIO LEDs that have inverted polarity.
2345
wdenkc6097192002-11-03 00:24:07 +00002346- CAN Support: CONFIG_CAN_DRIVER
2347
2348 Defining CONFIG_CAN_DRIVER enables CAN driver support
2349 on those systems that support this (optional)
2350 feature, like the TQM8xxL modules.
2351
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002352- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002353
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002354 This enable the NEW i2c subsystem, and will allow you to use
2355 i2c commands at the u-boot command line (as long as you set
2356 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2357 based realtime clock chips or other i2c devices. See
2358 common/cmd_i2c.c for a description of the command line
2359 interface.
2360
2361 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002362 - drivers/i2c/soft_i2c.c:
2363 - activate first bus with CONFIG_SYS_I2C_SOFT define
2364 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2365 for defining speed and slave address
2366 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2367 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2368 for defining speed and slave address
2369 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2370 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2371 for defining speed and slave address
2372 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2373 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2374 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002375
Heiko Schocher00f792e2012-10-24 13:48:22 +02002376 - drivers/i2c/fsl_i2c.c:
2377 - activate i2c driver with CONFIG_SYS_I2C_FSL
2378 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2379 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2380 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2381 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002382 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002383 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2384 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2385 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2386 second bus.
2387
Simon Glass1f2ba722012-10-30 07:28:53 +00002388 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002389 - activate this driver with CONFIG_SYS_I2C_TEGRA
2390 - This driver adds 4 i2c buses with a fix speed from
2391 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002392
Dirk Eibach880540d2013-04-25 02:40:01 +00002393 - drivers/i2c/ppc4xx_i2c.c
2394 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2395 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2396 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2397
tremfac96402013-09-21 18:13:35 +02002398 - drivers/i2c/i2c_mxc.c
2399 - activate this driver with CONFIG_SYS_I2C_MXC
2400 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2401 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2402 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2403 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2404 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2405 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002406 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002407 for speed, and 0 for slave.
2408
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002409 - drivers/i2c/rcar_i2c.c:
2410 - activate this driver with CONFIG_SYS_I2C_RCAR
2411 - This driver adds 4 i2c buses
2412
2413 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2414 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2415 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2416 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2417 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2418 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2419 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2420 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2421 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2422
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002423 - drivers/i2c/sh_i2c.c:
2424 - activate this driver with CONFIG_SYS_I2C_SH
2425 - This driver adds from 2 to 5 i2c buses
2426
2427 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2428 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2429 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2430 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2431 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2432 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2433 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2434 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2435 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2436 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2437 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2438 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002439 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002440
Heiko Schocher6789e842013-10-22 11:03:18 +02002441 - drivers/i2c/omap24xx_i2c.c
2442 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2443 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2445 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2446 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2447 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2448 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2449 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2450 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2451 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2452 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2453
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002454 - drivers/i2c/zynq_i2c.c
2455 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2456 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2457 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2458
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302459 - drivers/i2c/s3c24x0_i2c.c:
2460 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2461 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2462 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2463 with a fix speed from 100000 and the slave addr 0!
2464
Dirk Eibachb46226b2014-07-03 09:28:18 +02002465 - drivers/i2c/ihs_i2c.c
2466 - activate this driver with CONFIG_SYS_I2C_IHS
2467 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2468 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2469 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2470 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2471 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2472 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2473 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2474 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2475 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2476 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2477 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2478 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2479
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002480 additional defines:
2481
2482 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002483 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002484 don't use/have i2c muxes on your i2c bus, this
2485 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2486 omit this define.
2487
2488 CONFIG_SYS_I2C_DIRECT_BUS
2489 define this, if you don't use i2c muxes on your hardware.
2490 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2491 omit this define.
2492
2493 CONFIG_SYS_I2C_MAX_HOPS
2494 define how many muxes are maximal consecutively connected
2495 on one i2c bus. If you not use i2c muxes, omit this
2496 define.
2497
2498 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002499 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002500 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2501 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2502 CONFIG_SYS_NUM_I2C_BUSES = 9:
2503
2504 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2505 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2506 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2507 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2508 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2509 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2510 {1, {I2C_NULL_HOP}}, \
2511 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2512 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2513 }
2514
2515 which defines
2516 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002517 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2518 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2519 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2520 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2521 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002522 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002523 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2524 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002525
2526 If you do not have i2c muxes on your board, omit this define.
2527
Heiko Schocherea818db2013-01-29 08:53:15 +01002528- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002529
2530 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2531 provides the following compelling advantages:
2532
2533 - more than one i2c adapter is usable
2534 - approved multibus support
2535 - better i2c mux support
2536
2537 ** Please consider updating your I2C driver now. **
2538
Heiko Schocherea818db2013-01-29 08:53:15 +01002539 These enable legacy I2C serial bus commands. Defining
2540 CONFIG_HARD_I2C will include the appropriate I2C driver
2541 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002542
wdenk945af8d2003-07-16 21:53:01 +00002543 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002544 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002545 CONFIG_COMMANDS) and communicate with i2c based realtime
2546 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002547 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002548
Ben Warrenbb99ad62006-09-07 16:50:54 -04002549 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002550
wdenk945af8d2003-07-16 21:53:01 +00002551 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002552 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002554 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002555 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002557 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002558
Peter Tyser8d321b82010-04-12 22:28:21 -05002559 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002560 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002561 and so its address should therefore be cleared to 0 (See,
2562 eg, MPC823e User's Manual p.16-473). So, set
2563 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002564
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002565 CONFIG_SYS_I2C_INIT_MPC5XXX
2566
2567 When a board is reset during an i2c bus transfer
2568 chips might think that the current transfer is still
2569 in progress. Reset the slave devices by sending start
2570 commands until the slave device responds.
2571
wdenk945af8d2003-07-16 21:53:01 +00002572 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002573
Heiko Schocherea818db2013-01-29 08:53:15 +01002574 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002575 then the following macros need to be defined (examples are
2576 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002577
2578 I2C_INIT
2579
wdenkb37c7e52003-06-30 16:24:52 +00002580 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002581 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenkba56f622004-02-06 23:19:44 +00002583 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002584
wdenkc6097192002-11-03 00:24:07 +00002585 I2C_PORT
2586
wdenk43d96162003-03-06 00:02:04 +00002587 (Only for MPC8260 CPU). The I/O port to use (the code
2588 assumes both bits are on the same port). Valid values
2589 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002590
2591 I2C_ACTIVE
2592
2593 The code necessary to make the I2C data line active
2594 (driven). If the data line is open collector, this
2595 define can be null.
2596
wdenkb37c7e52003-06-30 16:24:52 +00002597 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2598
wdenkc6097192002-11-03 00:24:07 +00002599 I2C_TRISTATE
2600
2601 The code necessary to make the I2C data line tri-stated
2602 (inactive). If the data line is open collector, this
2603 define can be null.
2604
wdenkb37c7e52003-06-30 16:24:52 +00002605 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2606
wdenkc6097192002-11-03 00:24:07 +00002607 I2C_READ
2608
York Sun472d5462013-04-01 11:29:11 -07002609 Code that returns true if the I2C data line is high,
2610 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002611
wdenkb37c7e52003-06-30 16:24:52 +00002612 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2613
wdenkc6097192002-11-03 00:24:07 +00002614 I2C_SDA(bit)
2615
York Sun472d5462013-04-01 11:29:11 -07002616 If <bit> is true, sets the I2C data line high. If it
2617 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002618
wdenkb37c7e52003-06-30 16:24:52 +00002619 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002620 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002621 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002622
wdenkc6097192002-11-03 00:24:07 +00002623 I2C_SCL(bit)
2624
York Sun472d5462013-04-01 11:29:11 -07002625 If <bit> is true, sets the I2C clock line high. If it
2626 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002627
wdenkb37c7e52003-06-30 16:24:52 +00002628 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002629 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002630 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002631
wdenkc6097192002-11-03 00:24:07 +00002632 I2C_DELAY
2633
2634 This delay is invoked four times per clock cycle so this
2635 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002636 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002637 like:
2638
wdenkb37c7e52003-06-30 16:24:52 +00002639 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002640
Mike Frysinger793b5722010-07-21 13:38:02 -04002641 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2642
2643 If your arch supports the generic GPIO framework (asm/gpio.h),
2644 then you may alternatively define the two GPIOs that are to be
2645 used as SCL / SDA. Any of the previous I2C_xxx macros will
2646 have GPIO-based defaults assigned to them as appropriate.
2647
2648 You should define these to the GPIO value as given directly to
2649 the generic GPIO functions.
2650
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002651 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002652
wdenk8bde7f72003-06-27 21:31:46 +00002653 When a board is reset during an i2c bus transfer
2654 chips might think that the current transfer is still
2655 in progress. On some boards it is possible to access
2656 the i2c SCLK line directly, either by using the
2657 processor pin as a GPIO or by having a second pin
2658 connected to the bus. If this option is defined a
2659 custom i2c_init_board() routine in boards/xxx/board.c
2660 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002661
Richard Retanubun26a33502010-04-12 15:08:17 -04002662 CONFIG_SYS_I2C_BOARD_LATE_INIT
2663
2664 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2665 defined a custom i2c_board_late_init() routine in
2666 boards/xxx/board.c is run AFTER the operations in i2c_init()
2667 is completed. This callpoint can be used to unreset i2c bus
2668 using CPU i2c controller register accesses for CPUs whose i2c
2669 controller provide such a method. It is called at the end of
2670 i2c_init() to allow i2c_init operations to setup the i2c bus
2671 controller on the CPU (e.g. setting bus speed & slave address).
2672
wdenk17ea1172004-06-06 21:51:03 +00002673 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2674
2675 This option enables configuration of bi_iic_fast[] flags
2676 in u-boot bd_info structure based on u-boot environment
2677 variable "i2cfast". (see also i2cfast)
2678
Ben Warrenbb99ad62006-09-07 16:50:54 -04002679 CONFIG_I2C_MULTI_BUS
2680
2681 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002682 must have a controller. At any point in time, only one bus is
2683 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002684 Note that bus numbering is zero-based.
2685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002687
2688 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002689 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002690 is set, specify a list of bus-device pairs. Otherwise, specify
2691 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002692
2693 e.g.
2694 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002695 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002696
2697 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2698
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002699 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002700 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002701
2702 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002704 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002705
2706 If defined, then this indicates the I2C bus number for DDR SPD.
2707 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002710
2711 If defined, then this indicates the I2C bus number for the RTC.
2712 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002715
2716 If defined, then this indicates the I2C bus number for the DTT.
2717 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002720
2721 If defined, specifies the I2C address of the DTT device.
2722 If not defined, then U-Boot uses predefined value for
2723 specified DTT device.
2724
Andrew Dyer2ac69852008-12-29 17:36:01 -06002725 CONFIG_SOFT_I2C_READ_REPEATED_START
2726
2727 defining this will force the i2c_read() function in
2728 the soft_i2c driver to perform an I2C repeated start
2729 between writing the address pointer and reading the
2730 data. If this define is omitted the default behaviour
2731 of doing a stop-start sequence will be used. Most I2C
2732 devices can use either method, but some require one or
2733 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002734
wdenkc6097192002-11-03 00:24:07 +00002735- SPI Support: CONFIG_SPI
2736
2737 Enables SPI driver (so far only tested with
2738 SPI EEPROM, also an instance works with Crystal A/D and
2739 D/As on the SACSng board)
2740
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002741 CONFIG_SH_SPI
2742
2743 Enables the driver for SPI controller on SuperH. Currently
2744 only SH7757 is supported.
2745
wdenkc6097192002-11-03 00:24:07 +00002746 CONFIG_SPI_X
2747
2748 Enables extended (16-bit) SPI EEPROM addressing.
2749 (symmetrical to CONFIG_I2C_X)
2750
2751 CONFIG_SOFT_SPI
2752
wdenk43d96162003-03-06 00:02:04 +00002753 Enables a software (bit-bang) SPI driver rather than
2754 using hardware support. This is a general purpose
2755 driver that only requires three general I/O port pins
2756 (two outputs, one input) to function. If this is
2757 defined, the board configuration must define several
2758 SPI configuration items (port pins to use, etc). For
2759 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002760
Ben Warren04a9e112008-01-16 22:37:35 -05002761 CONFIG_HARD_SPI
2762
2763 Enables a hardware SPI driver for general-purpose reads
2764 and writes. As with CONFIG_SOFT_SPI, the board configuration
2765 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002766 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002767 example, see include/configs/mpc8349emds.h.
2768
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002769 CONFIG_MXC_SPI
2770
2771 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002772 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002773
Heiko Schocherf659b572014-07-14 10:22:11 +02002774 CONFIG_SYS_SPI_MXC_WAIT
2775 Timeout for waiting until spi transfer completed.
2776 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2777
Matthias Fuchs01335022007-12-27 17:12:34 +01002778- FPGA Support: CONFIG_FPGA
2779
2780 Enables FPGA subsystem.
2781
2782 CONFIG_FPGA_<vendor>
2783
2784 Enables support for specific chip vendors.
2785 (ALTERA, XILINX)
2786
2787 CONFIG_FPGA_<family>
2788
2789 Enables support for FPGA family.
2790 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2791
2792 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002793
wdenk43d96162003-03-06 00:02:04 +00002794 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002795
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302796 CONFIG_CMD_FPGA_LOADMK
2797
2798 Enable support for fpga loadmk command
2799
Michal Simek67193862014-05-02 13:43:39 +02002800 CONFIG_CMD_FPGA_LOADP
2801
2802 Enable support for fpga loadp command - load partial bitstream
2803
2804 CONFIG_CMD_FPGA_LOADBP
2805
2806 Enable support for fpga loadbp command - load partial bitstream
2807 (Xilinx only)
2808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002810
wdenk8bde7f72003-06-27 21:31:46 +00002811 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk43d96162003-03-06 00:02:04 +00002815 Enable checks on FPGA configuration interface busy
2816 status by the configuration function. This option
2817 will require a board or device specific function to
2818 be written.
wdenkc6097192002-11-03 00:24:07 +00002819
2820 CONFIG_FPGA_DELAY
2821
2822 If defined, a function that provides delays in the FPGA
2823 configuration driver.
2824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002826 Allow Control-C to interrupt FPGA configuration
2827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk43d96162003-03-06 00:02:04 +00002830 Check for configuration errors during FPGA bitfile
2831 loading. For example, abort during Virtex II
2832 configuration if the INIT_B line goes low (which
2833 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002835 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002836
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002837 Maximum time to wait for the INIT_B line to de-assert
2838 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002839 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002840 ms.
wdenkc6097192002-11-03 00:24:07 +00002841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002842 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002843
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002844 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002845 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002847 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002848
wdenk43d96162003-03-06 00:02:04 +00002849 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002850 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002851
2852- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002853 CONFIG_BUILD_TARGET
2854
2855 Some SoCs need special image types (e.g. U-Boot binary
2856 with a special header) as build targets. By defining
2857 CONFIG_BUILD_TARGET in the SoC / board header, this
2858 special image will be automatically built upon calling
2859 make / MAKEALL.
2860
wdenkc6097192002-11-03 00:24:07 +00002861 CONFIG_IDENT_STRING
2862
wdenk43d96162003-03-06 00:02:04 +00002863 If defined, this string will be added to the U-Boot
2864 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002865
2866- Vendor Parameter Protection:
2867
wdenk43d96162003-03-06 00:02:04 +00002868 U-Boot considers the values of the environment
2869 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002870 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002871 are set once by the board vendor / manufacturer, and
2872 protects these variables from casual modification by
2873 the user. Once set, these variables are read-only,
2874 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002875 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002876
2877 If CONFIG_ENV_OVERWRITE is #defined in your config
2878 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002879 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002880 these parameters.
2881
2882 Alternatively, if you #define _both_ CONFIG_ETHADDR
2883 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002884 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002885 which can be changed exactly ONCE by the user. [The
2886 serial# is unaffected by this, i. e. it remains
2887 read-only.]
2888
Joe Hershberger25980902012-12-11 22:16:31 -06002889 The same can be accomplished in a more flexible way
2890 for any variable by configuring the type of access
2891 to allow for those variables in the ".flags" variable
2892 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2893
wdenkc6097192002-11-03 00:24:07 +00002894- Protected RAM:
2895 CONFIG_PRAM
2896
2897 Define this variable to enable the reservation of
2898 "protected RAM", i. e. RAM which is not overwritten
2899 by U-Boot. Define CONFIG_PRAM to hold the number of
2900 kB you want to reserve for pRAM. You can overwrite
2901 this default value by defining an environment
2902 variable "pram" to the number of kB you want to
2903 reserve. Note that the board info structure will
2904 still show the full amount of RAM. If pRAM is
2905 reserved, a new environment variable "mem" will
2906 automatically be defined to hold the amount of
2907 remaining RAM in a form that can be passed as boot
2908 argument to Linux, for instance like that:
2909
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002910 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002911 saveenv
2912
2913 This way you can tell Linux not to use this memory,
2914 either, which results in a memory region that will
2915 not be affected by reboots.
2916
2917 *WARNING* If your board configuration uses automatic
2918 detection of the RAM size, you must make sure that
2919 this memory test is non-destructive. So far, the
2920 following board configurations are known to be
2921 "pRAM-clean":
2922
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002923 IVMS8, IVML24, SPD8xx, TQM8xxL,
2924 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002925 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002926
Gabe Black40fef042012-12-02 04:55:18 +00002927- Access to physical memory region (> 4GB)
2928 Some basic support is provided for operations on memory not
2929 normally accessible to U-Boot - e.g. some architectures
2930 support access to more than 4GB of memory on 32-bit
2931 machines using physical address extension or similar.
2932 Define CONFIG_PHYSMEM to access this basic support, which
2933 currently only supports clearing the memory.
2934
wdenkc6097192002-11-03 00:24:07 +00002935- Error Recovery:
2936 CONFIG_PANIC_HANG
2937
2938 Define this variable to stop the system in case of a
2939 fatal error, so that you have to reset it manually.
2940 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002941 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002942 automatically as fast as possible, but it may be
2943 useful during development since you can try to debug
2944 the conditions that lead to the situation.
2945
2946 CONFIG_NET_RETRY_COUNT
2947
wdenk43d96162003-03-06 00:02:04 +00002948 This variable defines the number of retries for
2949 network operations like ARP, RARP, TFTP, or BOOTP
2950 before giving up the operation. If not defined, a
2951 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002952
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002953 CONFIG_ARP_TIMEOUT
2954
2955 Timeout waiting for an ARP reply in milliseconds.
2956
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002957 CONFIG_NFS_TIMEOUT
2958
2959 Timeout in milliseconds used in NFS protocol.
2960 If you encounter "ERROR: Cannot umount" in nfs command,
2961 try longer timeout such as
2962 #define CONFIG_NFS_TIMEOUT 10000UL
2963
wdenkc6097192002-11-03 00:24:07 +00002964- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002965 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002966
2967 Enable auto completion of commands using TAB.
2968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002969 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002970
2971 This defines the secondary prompt string, which is
2972 printed when the command interpreter needs more input
2973 to complete a command. Usually "> ".
2974
2975 Note:
2976
wdenk8bde7f72003-06-27 21:31:46 +00002977 In the current implementation, the local variables
2978 space and global environment variables space are
2979 separated. Local variables are those you define by
2980 simply typing `name=value'. To access a local
2981 variable later on, you have write `$name' or
2982 `${name}'; to execute the contents of a variable
2983 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk43d96162003-03-06 00:02:04 +00002985 Global environment variables are those you use
2986 setenv/printenv to work with. To run a command stored
2987 in such a variable, you need to use the run command,
2988 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002989
2990 To store commands and special characters in a
2991 variable, please use double quotation marks
2992 surrounding the whole text of the variable, instead
2993 of the backslashes before semicolons and special
2994 symbols.
2995
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002996- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002997 CONFIG_CMDLINE_EDITING
2998
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002999 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003000 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02003001
wdenka8c7c702003-12-06 19:49:23 +00003002- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00003003 CONFIG_EXTRA_ENV_SETTINGS
3004
wdenk43d96162003-03-06 00:02:04 +00003005 Define this to contain any number of null terminated
3006 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00003007 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00003008
wdenk43d96162003-03-06 00:02:04 +00003009 For example, place something like this in your
3010 board's config file:
wdenkc6097192002-11-03 00:24:07 +00003011
3012 #define CONFIG_EXTRA_ENV_SETTINGS \
3013 "myvar1=value1\0" \
3014 "myvar2=value2\0"
3015
wdenk43d96162003-03-06 00:02:04 +00003016 Warning: This method is based on knowledge about the
3017 internal format how the environment is stored by the
3018 U-Boot code. This is NOT an official, exported
3019 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00003020 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00003021 You better know what you are doing here.
3022
wdenk43d96162003-03-06 00:02:04 +00003023 Note: overly (ab)use of the default environment is
3024 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003025 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00003026 boot command first.
wdenkc6097192002-11-03 00:24:07 +00003027
Stephen Warren5e724ca2012-05-22 09:21:54 +00003028 CONFIG_ENV_VARS_UBOOT_CONFIG
3029
3030 Define this in order to add variables describing the
3031 U-Boot build configuration to the default environment.
3032 These will be named arch, cpu, board, vendor, and soc.
3033
3034 Enabling this option will cause the following to be defined:
3035
3036 - CONFIG_SYS_ARCH
3037 - CONFIG_SYS_CPU
3038 - CONFIG_SYS_BOARD
3039 - CONFIG_SYS_VENDOR
3040 - CONFIG_SYS_SOC
3041
Tom Rini7e27f892012-10-24 07:28:16 +00003042 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3043
3044 Define this in order to add variables describing certain
3045 run-time determined information about the hardware to the
3046 environment. These will be named board_name, board_rev.
3047
Simon Glass06fd8532012-11-30 13:01:17 +00003048 CONFIG_DELAY_ENVIRONMENT
3049
3050 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003051 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00003052 that so that the environment is not available until
3053 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3054 this is instead controlled by the value of
3055 /config/load-environment.
3056
wdenka8c7c702003-12-06 19:49:23 +00003057- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00003058 CONFIG_HAS_DATAFLASH
3059
wdenk8bde7f72003-06-27 21:31:46 +00003060 Defining this option enables DataFlash features and
3061 allows to read/write in Dataflash via the standard
3062 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00003063
Eric Nelsonf61ec452012-01-31 10:52:08 -07003064- Serial Flash support
3065 CONFIG_CMD_SF
3066
3067 Defining this option enables SPI flash commands
3068 'sf probe/read/write/erase/update'.
3069
3070 Usage requires an initial 'probe' to define the serial
3071 flash parameters, followed by read/write/erase/update
3072 commands.
3073
3074 The following defaults may be provided by the platform
3075 to handle the common case when only a single serial
3076 flash is present on the system.
3077
3078 CONFIG_SF_DEFAULT_BUS Bus identifier
3079 CONFIG_SF_DEFAULT_CS Chip-select
3080 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3081 CONFIG_SF_DEFAULT_SPEED in Hz
3082
Simon Glass24007272012-10-08 13:16:02 +00003083 CONFIG_CMD_SF_TEST
3084
3085 Define this option to include a destructive SPI flash
3086 test ('sf test').
3087
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05303088 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3089
3090 Define this option to use the Bank addr/Extended addr
3091 support on SPI flashes which has size > 16Mbytes.
3092
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303093 CONFIG_SF_DUAL_FLASH Dual flash memories
3094
3095 Define this option to use dual flash support where two flash
3096 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003097 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303098
Heiko Schocher562f8df2014-07-18 06:07:21 +02003099 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3100 enable the W#/Vpp signal to disable writing to the status
3101 register on ST MICRON flashes like the N25Q128.
3102 The status register write enable/disable bit, combined with
3103 the W#/VPP signal provides hardware data protection for the
3104 device as follows: When the enable/disable bit is set to 1,
3105 and the W#/VPP signal is driven LOW, the status register
3106 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3107 operation will not execute. The only way to exit this
3108 hardware-protected mode is to drive W#/VPP HIGH.
3109
wdenk3f85ce22004-02-23 16:11:30 +00003110- SystemACE Support:
3111 CONFIG_SYSTEMACE
3112
3113 Adding this option adds support for Xilinx SystemACE
3114 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003115 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003116 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003117
3118 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003120
3121 When SystemACE support is added, the "ace" device type
3122 becomes available to the fat commands, i.e. fatls.
3123
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003124- TFTP Fixed UDP Port:
3125 CONFIG_TFTP_PORT
3126
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003127 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003128 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003129 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003130 number generator is used.
3131
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003132 Also, the environment variable tftpdstp is used to supply
3133 the TFTP UDP destination port value. If tftpdstp isn't
3134 defined, the normal port 69 is used.
3135
3136 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003137 blindly start the TFTP transfer using the pre-configured
3138 target IP address and UDP port. This has the effect of
3139 "punching through" the (Windows XP) firewall, allowing
3140 the remainder of the TFTP transfer to proceed normally.
3141 A better solution is to properly configure the firewall,
3142 but sometimes that is not allowed.
3143
Simon Glassbf36c5d2012-12-05 14:46:38 +00003144- Hashing support:
3145 CONFIG_CMD_HASH
3146
3147 This enables a generic 'hash' command which can produce
3148 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3149
3150 CONFIG_HASH_VERIFY
3151
3152 Enable the hash verify command (hash -v). This adds to code
3153 size a little.
3154
3155 CONFIG_SHA1 - support SHA1 hashing
3156 CONFIG_SHA256 - support SHA256 hashing
3157
3158 Note: There is also a sha1sum command, which should perhaps
3159 be deprecated in favour of 'hash sha1'.
3160
Robert Winklera11f1872013-07-24 17:57:06 -07003161- Freescale i.MX specific commands:
3162 CONFIG_CMD_HDMIDETECT
3163 This enables 'hdmidet' command which returns true if an
3164 HDMI monitor is detected. This command is i.MX 6 specific.
3165
3166 CONFIG_CMD_BMODE
3167 This enables the 'bmode' (bootmode) command for forcing
3168 a boot from specific media.
3169
3170 This is useful for forcing the ROM's usb downloader to
3171 activate upon a watchdog reset which is nice when iterating
3172 on U-Boot. Using the reset button or running bmode normal
3173 will set it back to normal. This command currently
3174 supports i.MX53 and i.MX6.
3175
Simon Glass19c402a2013-06-13 15:10:02 -07003176- Signing support:
3177 CONFIG_RSA
3178
3179 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003180 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003181
Ruchika Guptac937ff62015-01-23 16:01:54 +05303182 The Modular Exponentiation algorithm in RSA is implemented using
3183 driver model. So CONFIG_DM needs to be enabled by default for this
3184 library to function.
3185
Simon Glass19c402a2013-06-13 15:10:02 -07003186 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303187 option. The software based modular exponentiation is built into
3188 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003189
Heiko Schocher9e50c402014-01-25 07:27:13 +01003190- bootcount support:
3191 CONFIG_BOOTCOUNT_LIMIT
3192
3193 This enables the bootcounter support, see:
3194 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3195
3196 CONFIG_AT91SAM9XE
3197 enable special bootcounter support on at91sam9xe based boards.
3198 CONFIG_BLACKFIN
3199 enable special bootcounter support on blackfin based boards.
3200 CONFIG_SOC_DA8XX
3201 enable special bootcounter support on da850 based boards.
3202 CONFIG_BOOTCOUNT_RAM
3203 enable support for the bootcounter in RAM
3204 CONFIG_BOOTCOUNT_I2C
3205 enable support for the bootcounter on an i2c (like RTC) device.
3206 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3207 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3208 the bootcounter.
3209 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003210
wdenka8c7c702003-12-06 19:49:23 +00003211- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003212 CONFIG_SHOW_BOOT_PROGRESS
3213
wdenk43d96162003-03-06 00:02:04 +00003214 Defining this option allows to add some board-
3215 specific code (calling a user-provided function
3216 "show_boot_progress(int)") that enables you to show
3217 the system's boot progress on some display (for
3218 example, some LED's) on your board. At the moment,
3219 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003220
Simon Glass3a608ca2012-02-13 13:51:19 +00003221- Detailed boot stage timing
3222 CONFIG_BOOTSTAGE
3223 Define this option to get detailed timing of each stage
3224 of the boot process.
3225
3226 CONFIG_BOOTSTAGE_USER_COUNT
3227 This is the number of available user bootstage records.
3228 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3229 a new ID will be allocated from this stash. If you exceed
3230 the limit, recording will stop.
3231
3232 CONFIG_BOOTSTAGE_REPORT
3233 Define this to print a report before boot, similar to this:
3234
3235 Timer summary in microseconds:
3236 Mark Elapsed Stage
3237 0 0 reset
3238 3,575,678 3,575,678 board_init_f start
3239 3,575,695 17 arch_cpu_init A9
3240 3,575,777 82 arch_cpu_init done
3241 3,659,598 83,821 board_init_r start
3242 3,910,375 250,777 main_loop
3243 29,916,167 26,005,792 bootm_start
3244 30,361,327 445,160 start_kernel
3245
Simon Glass2eba38c2012-09-28 08:56:39 +00003246 CONFIG_CMD_BOOTSTAGE
3247 Add a 'bootstage' command which supports printing a report
3248 and un/stashing of bootstage data.
3249
Simon Glass94fd1312012-09-28 08:56:37 +00003250 CONFIG_BOOTSTAGE_FDT
3251 Stash the bootstage information in the FDT. A root 'bootstage'
3252 node is created with each bootstage id as a child. Each child
3253 has a 'name' property and either 'mark' containing the
3254 mark time in microsecond, or 'accum' containing the
3255 accumulated time for that bootstage id in microseconds.
3256 For example:
3257
3258 bootstage {
3259 154 {
3260 name = "board_init_f";
3261 mark = <3575678>;
3262 };
3263 170 {
3264 name = "lcd";
3265 accum = <33482>;
3266 };
3267 };
3268
3269 Code in the Linux kernel can find this in /proc/devicetree.
3270
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003271Legacy uImage format:
3272
wdenkc6097192002-11-03 00:24:07 +00003273 Arg Where When
3274 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003275 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003276 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003277 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003278 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003279 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003280 4 common/cmd_bootm.c Image data has correct checksum
3281 -4 common/cmd_bootm.c Image is for unsupported architecture
3282 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003283 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003284 6 common/cmd_bootm.c Image Type check OK
3285 -6 common/cmd_bootm.c gunzip uncompression error
3286 -7 common/cmd_bootm.c Unimplemented compression type
3287 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003288 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003289 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003290
3291 9 common/image.c Start initial ramdisk verification
3292 -10 common/image.c Ramdisk header has bad magic number
3293 -11 common/image.c Ramdisk header has bad checksum
3294 10 common/image.c Ramdisk header is OK
3295 -12 common/image.c Ramdisk data has bad checksum
3296 11 common/image.c Ramdisk data has correct checksum
3297 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003298 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003299 13 common/image.c Start multifile image verification
3300 14 common/image.c No initial ramdisk, no multifile, continue.
3301
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003302 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003303
Stefan Roesea47a12b2010-04-15 16:07:28 +02003304 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003305 -31 post/post.c POST test failed, detected by post_output_backlog()
3306 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003307
Heiko Schocher566a4942007-06-22 19:11:54 +02003308 34 common/cmd_doc.c before loading a Image from a DOC device
3309 -35 common/cmd_doc.c Bad usage of "doc" command
3310 35 common/cmd_doc.c correct usage of "doc" command
3311 -36 common/cmd_doc.c No boot device
3312 36 common/cmd_doc.c correct boot device
3313 -37 common/cmd_doc.c Unknown Chip ID on boot device
3314 37 common/cmd_doc.c correct chip ID found, device available
3315 -38 common/cmd_doc.c Read Error on boot device
3316 38 common/cmd_doc.c reading Image header from DOC device OK
3317 -39 common/cmd_doc.c Image header has bad magic number
3318 39 common/cmd_doc.c Image header has correct magic number
3319 -40 common/cmd_doc.c Error reading Image from DOC device
3320 40 common/cmd_doc.c Image header has correct magic number
3321 41 common/cmd_ide.c before loading a Image from a IDE device
3322 -42 common/cmd_ide.c Bad usage of "ide" command
3323 42 common/cmd_ide.c correct usage of "ide" command
3324 -43 common/cmd_ide.c No boot device
3325 43 common/cmd_ide.c boot device found
3326 -44 common/cmd_ide.c Device not available
3327 44 common/cmd_ide.c Device available
3328 -45 common/cmd_ide.c wrong partition selected
3329 45 common/cmd_ide.c partition selected
3330 -46 common/cmd_ide.c Unknown partition table
3331 46 common/cmd_ide.c valid partition table found
3332 -47 common/cmd_ide.c Invalid partition type
3333 47 common/cmd_ide.c correct partition type
3334 -48 common/cmd_ide.c Error reading Image Header on boot device
3335 48 common/cmd_ide.c reading Image Header from IDE device OK
3336 -49 common/cmd_ide.c Image header has bad magic number
3337 49 common/cmd_ide.c Image header has correct magic number
3338 -50 common/cmd_ide.c Image header has bad checksum
3339 50 common/cmd_ide.c Image header has correct checksum
3340 -51 common/cmd_ide.c Error reading Image from IDE device
3341 51 common/cmd_ide.c reading Image from IDE device OK
3342 52 common/cmd_nand.c before loading a Image from a NAND device
3343 -53 common/cmd_nand.c Bad usage of "nand" command
3344 53 common/cmd_nand.c correct usage of "nand" command
3345 -54 common/cmd_nand.c No boot device
3346 54 common/cmd_nand.c boot device found
3347 -55 common/cmd_nand.c Unknown Chip ID on boot device
3348 55 common/cmd_nand.c correct chip ID found, device available
3349 -56 common/cmd_nand.c Error reading Image Header on boot device
3350 56 common/cmd_nand.c reading Image Header from NAND device OK
3351 -57 common/cmd_nand.c Image header has bad magic number
3352 57 common/cmd_nand.c Image header has correct magic number
3353 -58 common/cmd_nand.c Error reading Image from NAND device
3354 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003355
Heiko Schocher566a4942007-06-22 19:11:54 +02003356 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003357
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003358 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003359 -64 net/eth.c no Ethernet found.
3360 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003361
Heiko Schocher566a4942007-06-22 19:11:54 +02003362 -80 common/cmd_net.c usage wrong
3363 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003364 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003365 81 common/cmd_net.c NetLoop() back without error
3366 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3367 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003368 83 common/cmd_net.c running "source" command
3369 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003370 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003371
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003372FIT uImage format:
3373
3374 Arg Where When
3375 100 common/cmd_bootm.c Kernel FIT Image has correct format
3376 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3377 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3378 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3379 102 common/cmd_bootm.c Kernel unit name specified
3380 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003381 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003382 104 common/cmd_bootm.c Got kernel subimage node offset
3383 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3384 105 common/cmd_bootm.c Kernel subimage hash verification OK
3385 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3386 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003387 -106 common/cmd_bootm.c Kernel subimage has wrong type
3388 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003389 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3390 108 common/cmd_bootm.c Got kernel subimage data/size
3391 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3392 -109 common/cmd_bootm.c Can't get kernel subimage type
3393 -110 common/cmd_bootm.c Can't get kernel subimage comp
3394 -111 common/cmd_bootm.c Can't get kernel subimage os
3395 -112 common/cmd_bootm.c Can't get kernel subimage load address
3396 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3397
3398 120 common/image.c Start initial ramdisk verification
3399 -120 common/image.c Ramdisk FIT image has incorrect format
3400 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003401 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003402 -122 common/image.c Can't get configuration for ramdisk subimage
3403 123 common/image.c Ramdisk unit name specified
3404 -124 common/image.c Can't get ramdisk subimage node offset
3405 125 common/image.c Got ramdisk subimage node offset
3406 -125 common/image.c Ramdisk subimage hash verification failed
3407 126 common/image.c Ramdisk subimage hash verification OK
3408 -126 common/image.c Ramdisk subimage for unsupported architecture
3409 127 common/image.c Architecture check OK
3410 -127 common/image.c Can't get ramdisk subimage data/size
3411 128 common/image.c Got ramdisk subimage data/size
3412 129 common/image.c Can't get ramdisk load address
3413 -129 common/image.c Got ramdisk load address
3414
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003415 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003416 131 common/cmd_doc.c FIT image format OK
3417
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003418 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003419 141 common/cmd_ide.c FIT image format OK
3420
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003421 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003422 151 common/cmd_nand.c FIT image format OK
3423
Heiko Schocher21d29f72014-05-28 11:33:33 +02003424- legacy image format:
3425 CONFIG_IMAGE_FORMAT_LEGACY
3426 enables the legacy image format support in U-Boot.
3427
3428 Default:
3429 enabled if CONFIG_FIT_SIGNATURE is not defined.
3430
3431 CONFIG_DISABLE_IMAGE_LEGACY
3432 disable the legacy image format
3433
3434 This define is introduced, as the legacy image format is
3435 enabled per default for backward compatibility.
3436
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003437- FIT image support:
3438 CONFIG_FIT
3439 Enable support for the FIT uImage format.
3440
3441 CONFIG_FIT_BEST_MATCH
3442 When no configuration is explicitly selected, default to the
3443 one whose fdt's compatibility field best matches that of
3444 U-Boot itself. A match is considered "best" if it matches the
3445 most specific compatibility entry of U-Boot's fdt's root node.
3446 The order of entries in the configuration's fdt is ignored.
3447
Simon Glass3e569a62013-06-13 15:10:00 -07003448 CONFIG_FIT_SIGNATURE
3449 This option enables signature verification of FIT uImages,
3450 using a hash signed and verified using RSA. See
3451 doc/uImage.FIT/signature.txt for more details.
3452
Heiko Schocher21d29f72014-05-28 11:33:33 +02003453 WARNING: When relying on signed FIT images with required
3454 signature check the legacy image format is default
3455 disabled. If a board need legacy image format support
3456 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3457
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003458 CONFIG_FIT_DISABLE_SHA256
3459 Supporting SHA256 hashes has quite an impact on binary size.
3460 For constrained systems sha256 hash support can be disabled
3461 with this option.
3462
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003463- Standalone program support:
3464 CONFIG_STANDALONE_LOAD_ADDR
3465
Wolfgang Denk6feff892011-10-09 21:06:34 +02003466 This option defines a board specific value for the
3467 address where standalone program gets loaded, thus
3468 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003469 settings.
3470
3471- Frame Buffer Address:
3472 CONFIG_FB_ADDR
3473
3474 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003475 address for frame buffer. This is typically the case
3476 when using a graphics controller has separate video
3477 memory. U-Boot will then place the frame buffer at
3478 the given address instead of dynamically reserving it
3479 in system RAM by calling lcd_setmem(), which grabs
3480 the memory for the frame buffer depending on the
3481 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003482
3483 Please see board_init_f function.
3484
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003485- Automatic software updates via TFTP server
3486 CONFIG_UPDATE_TFTP
3487 CONFIG_UPDATE_TFTP_CNT_MAX
3488 CONFIG_UPDATE_TFTP_MSEC_MAX
3489
3490 These options enable and control the auto-update feature;
3491 for a more detailed description refer to doc/README.update.
3492
3493- MTD Support (mtdparts command, UBI support)
3494 CONFIG_MTD_DEVICE
3495
3496 Adds the MTD device infrastructure from the Linux kernel.
3497 Needed for mtdparts command support.
3498
3499 CONFIG_MTD_PARTITIONS
3500
3501 Adds the MTD partitioning infrastructure from the Linux
3502 kernel. Needed for UBI support.
3503
Heiko Schocherff94bc42014-06-24 10:10:04 +02003504 CONFIG_MTD_NAND_VERIFY_WRITE
3505 verify if the written data is correct reread.
3506
Joe Hershberger70c219c2013-04-08 10:32:48 +00003507- UBI support
3508 CONFIG_CMD_UBI
3509
3510 Adds commands for interacting with MTD partitions formatted
3511 with the UBI flash translation layer
3512
3513 Requires also defining CONFIG_RBTREE
3514
Joe Hershberger147162d2013-04-08 10:32:49 +00003515 CONFIG_UBI_SILENCE_MSG
3516
3517 Make the verbose messages from UBI stop printing. This leaves
3518 warnings and errors enabled.
3519
Heiko Schocherff94bc42014-06-24 10:10:04 +02003520
3521 CONFIG_MTD_UBI_WL_THRESHOLD
3522 This parameter defines the maximum difference between the highest
3523 erase counter value and the lowest erase counter value of eraseblocks
3524 of UBI devices. When this threshold is exceeded, UBI starts performing
3525 wear leveling by means of moving data from eraseblock with low erase
3526 counter to eraseblocks with high erase counter.
3527
3528 The default value should be OK for SLC NAND flashes, NOR flashes and
3529 other flashes which have eraseblock life-cycle 100000 or more.
3530 However, in case of MLC NAND flashes which typically have eraseblock
3531 life-cycle less than 10000, the threshold should be lessened (e.g.,
3532 to 128 or 256, although it does not have to be power of 2).
3533
3534 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003535
Heiko Schocherff94bc42014-06-24 10:10:04 +02003536 CONFIG_MTD_UBI_BEB_LIMIT
3537 This option specifies the maximum bad physical eraseblocks UBI
3538 expects on the MTD device (per 1024 eraseblocks). If the
3539 underlying flash does not admit of bad eraseblocks (e.g. NOR
3540 flash), this value is ignored.
3541
3542 NAND datasheets often specify the minimum and maximum NVM
3543 (Number of Valid Blocks) for the flashes' endurance lifetime.
3544 The maximum expected bad eraseblocks per 1024 eraseblocks
3545 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3546 which gives 20 for most NANDs (MaxNVB is basically the total
3547 count of eraseblocks on the chip).
3548
3549 To put it differently, if this value is 20, UBI will try to
3550 reserve about 1.9% of physical eraseblocks for bad blocks
3551 handling. And that will be 1.9% of eraseblocks on the entire
3552 NAND chip, not just the MTD partition UBI attaches. This means
3553 that if you have, say, a NAND flash chip admits maximum 40 bad
3554 eraseblocks, and it is split on two MTD partitions of the same
3555 size, UBI will reserve 40 eraseblocks when attaching a
3556 partition.
3557
3558 default: 20
3559
3560 CONFIG_MTD_UBI_FASTMAP
3561 Fastmap is a mechanism which allows attaching an UBI device
3562 in nearly constant time. Instead of scanning the whole MTD device it
3563 only has to locate a checkpoint (called fastmap) on the device.
3564 The on-flash fastmap contains all information needed to attach
3565 the device. Using fastmap makes only sense on large devices where
3566 attaching by scanning takes long. UBI will not automatically install
3567 a fastmap on old images, but you can set the UBI parameter
3568 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3569 that fastmap-enabled images are still usable with UBI implementations
3570 without fastmap support. On typical flash devices the whole fastmap
3571 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3572
3573 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3574 Set this parameter to enable fastmap automatically on images
3575 without a fastmap.
3576 default: 0
3577
Joe Hershberger70c219c2013-04-08 10:32:48 +00003578- UBIFS support
3579 CONFIG_CMD_UBIFS
3580
3581 Adds commands for interacting with UBI volumes formatted as
3582 UBIFS. UBIFS is read-only in u-boot.
3583
3584 Requires UBI support as well as CONFIG_LZO
3585
Joe Hershberger147162d2013-04-08 10:32:49 +00003586 CONFIG_UBIFS_SILENCE_MSG
3587
3588 Make the verbose messages from UBIFS stop printing. This leaves
3589 warnings and errors enabled.
3590
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003591- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003592 CONFIG_SPL
3593 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003594
Tom Rini95579792012-02-14 07:29:40 +00003595 CONFIG_SPL_LDSCRIPT
3596 LDSCRIPT for linking the SPL binary.
3597
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003598 CONFIG_SPL_MAX_FOOTPRINT
3599 Maximum size in memory allocated to the SPL, BSS included.
3600 When defined, the linker checks that the actual memory
3601 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003602 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003603 must not be both defined at the same time.
3604
Tom Rini95579792012-02-14 07:29:40 +00003605 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003606 Maximum size of the SPL image (text, data, rodata, and
3607 linker lists sections), BSS excluded.
3608 When defined, the linker checks that the actual size does
3609 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003610
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003611 CONFIG_SPL_TEXT_BASE
3612 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003613
Scott Wood94a45bb2012-09-20 19:05:12 -05003614 CONFIG_SPL_RELOC_TEXT_BASE
3615 Address to relocate to. If unspecified, this is equal to
3616 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3617
Tom Rini95579792012-02-14 07:29:40 +00003618 CONFIG_SPL_BSS_START_ADDR
3619 Link address for the BSS within the SPL binary.
3620
3621 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003622 Maximum size in memory allocated to the SPL BSS.
3623 When defined, the linker checks that the actual memory used
3624 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003625 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003626 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003627
3628 CONFIG_SPL_STACK
3629 Adress of the start of the stack SPL will use
3630
Scott Wood94a45bb2012-09-20 19:05:12 -05003631 CONFIG_SPL_RELOC_STACK
3632 Adress of the start of the stack SPL will use after
3633 relocation. If unspecified, this is equal to
3634 CONFIG_SPL_STACK.
3635
Tom Rini95579792012-02-14 07:29:40 +00003636 CONFIG_SYS_SPL_MALLOC_START
3637 Starting address of the malloc pool used in SPL.
3638
3639 CONFIG_SYS_SPL_MALLOC_SIZE
3640 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003641
Tom Rini47f7bca2012-08-13 12:03:19 -07003642 CONFIG_SPL_FRAMEWORK
3643 Enable the SPL framework under common/. This framework
3644 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3645 NAND loading of the Linux Kernel.
3646
Tom Rini9607faf2014-03-28 12:03:39 -04003647 CONFIG_SPL_OS_BOOT
3648 Enable booting directly to an OS from SPL.
3649 See also: doc/README.falcon
3650
Tom Rini861a86f2012-08-13 11:37:56 -07003651 CONFIG_SPL_DISPLAY_PRINT
3652 For ARM, enable an optional function to print more information
3653 about the running system.
3654
Scott Wood4b919722012-09-20 16:35:21 -05003655 CONFIG_SPL_INIT_MINIMAL
3656 Arch init code should be built for a very small image
3657
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003658 CONFIG_SPL_LIBCOMMON_SUPPORT
3659 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003660
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003661 CONFIG_SPL_LIBDISK_SUPPORT
3662 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003663
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003664 CONFIG_SPL_I2C_SUPPORT
3665 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003666
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003667 CONFIG_SPL_GPIO_SUPPORT
3668 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003669
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003670 CONFIG_SPL_MMC_SUPPORT
3671 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003672
Tom Rini95579792012-02-14 07:29:40 +00003673 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3674 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003675 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003676 when the MMC is being used in raw mode.
3677
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003678 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3679 Partition on the MMC to load U-Boot from when the MMC is being
3680 used in raw mode
3681
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003682 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3683 Sector to load kernel uImage from when MMC is being
3684 used in raw mode (for Falcon mode)
3685
3686 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3687 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3688 Sector and number of sectors to load kernel argument
3689 parameters from when MMC is being used in raw mode
3690 (for falcon mode)
3691
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003692 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3693 Partition on the MMC to load U-Boot from when the MMC is being
3694 used in fs mode
3695
Tom Rini95579792012-02-14 07:29:40 +00003696 CONFIG_SPL_FAT_SUPPORT
3697 Support for fs/fat/libfat.o in SPL binary
3698
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003699 CONFIG_SPL_EXT_SUPPORT
3700 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003701
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003702 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3703 Filename to read to load U-Boot when reading from filesystem
3704
3705 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003706 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003707 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003708
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003709 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003710 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003711 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003712
Scott Wood06f60ae2012-12-06 13:33:17 +00003713 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3714 Set this for NAND SPL on PPC mpc83xx targets, so that
3715 start.S waits for the rest of the SPL to load before
3716 continuing (the hardware starts execution after just
3717 loading the first page rather than the full 4K).
3718
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303719 CONFIG_SPL_SKIP_RELOCATE
3720 Avoid SPL relocation
3721
Scott Wood6f2f01b2012-09-20 19:09:07 -05003722 CONFIG_SPL_NAND_BASE
3723 Include nand_base.c in the SPL. Requires
3724 CONFIG_SPL_NAND_DRIVERS.
3725
3726 CONFIG_SPL_NAND_DRIVERS
3727 SPL uses normal NAND drivers, not minimal drivers.
3728
3729 CONFIG_SPL_NAND_ECC
3730 Include standard software ECC in the SPL
3731
Tom Rini95579792012-02-14 07:29:40 +00003732 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003733 Support for NAND boot using simple NAND drivers that
3734 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003735
Tom Rini6dd3b562014-03-28 12:03:36 -04003736 CONFIG_SPL_MTD_SUPPORT
3737 Support for the MTD subsystem within SPL. Useful for
3738 environment on NAND support within SPL.
3739
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003740 CONFIG_SPL_NAND_RAW_ONLY
3741 Support to boot only raw u-boot.bin images. Use this only
3742 if you need to save space.
3743
Ying Zhangbb0dc102013-08-16 15:16:11 +08003744 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3745 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003746 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003747
Ying Zhang7c8eea52013-08-16 15:16:12 +08003748 CONFIG_SPL_COMMON_INIT_DDR
3749 Set for common ddr init with serial presence detect in
3750 SPL binary.
3751
Tom Rini95579792012-02-14 07:29:40 +00003752 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3753 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3754 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3755 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3756 CONFIG_SYS_NAND_ECCBYTES
3757 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003758 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003759
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303760 CONFIG_SPL_NAND_BOOT
3761 Add support NAND boot
3762
Tom Rini95579792012-02-14 07:29:40 +00003763 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003764 Location in NAND to read U-Boot from
3765
3766 CONFIG_SYS_NAND_U_BOOT_DST
3767 Location in memory to load U-Boot to
3768
3769 CONFIG_SYS_NAND_U_BOOT_SIZE
3770 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003771
3772 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003773 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003774
3775 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3776 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003777 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003778
3779 CONFIG_SPL_OMAP3_ID_NAND
3780 Support for an OMAP3-specific set of functions to return the
3781 ID and MFR of the first attached NAND chip, if present.
3782
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003783 CONFIG_SPL_SERIAL_SUPPORT
3784 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003785
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003786 CONFIG_SPL_SPI_FLASH_SUPPORT
3787 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003788
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003789 CONFIG_SPL_SPI_SUPPORT
3790 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003791
Pavel Machekc57b9532012-08-30 22:42:11 +02003792 CONFIG_SPL_RAM_DEVICE
3793 Support for running image already present in ram, in SPL binary
3794
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003795 CONFIG_SPL_LIBGENERIC_SUPPORT
3796 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003797
Ying Zhangba1bee42013-05-20 14:07:25 +08003798 CONFIG_SPL_ENV_SUPPORT
3799 Support for the environment operating in SPL binary
3800
3801 CONFIG_SPL_NET_SUPPORT
3802 Support for the net/libnet.o in SPL binary.
3803 It conflicts with SPL env from storage medium specified by
3804 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3805
Scott Wood74752ba2012-12-06 13:33:16 +00003806 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003807 Image offset to which the SPL should be padded before appending
3808 the SPL payload. By default, this is defined as
3809 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3810 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3811 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003812
Scott Woodca2fca22012-09-21 16:27:32 -05003813 CONFIG_SPL_TARGET
3814 Final target image containing SPL and payload. Some SPLs
3815 use an arch-specific makefile fragment instead, for
3816 example if more than one image needs to be produced.
3817
Simon Glass87ebee32013-05-08 08:05:59 +00003818 CONFIG_FIT_SPL_PRINT
3819 Printing information about a FIT image adds quite a bit of
3820 code to SPL. So this is normally disabled in SPL. Use this
3821 option to re-enable it. This will affect the output of the
3822 bootm command when booting a FIT image.
3823
Ying Zhang3aa29de2013-08-16 15:16:15 +08003824- TPL framework
3825 CONFIG_TPL
3826 Enable building of TPL globally.
3827
3828 CONFIG_TPL_PAD_TO
3829 Image offset to which the TPL should be padded before appending
3830 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003831 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3832 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3833 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003834
wdenkc6097192002-11-03 00:24:07 +00003835Modem Support:
3836--------------
3837
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003838[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003839
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003840- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003841 CONFIG_MODEM_SUPPORT
3842
3843- RTS/CTS Flow control enable:
3844 CONFIG_HWFLOW
3845
3846- Modem debug support:
3847 CONFIG_MODEM_SUPPORT_DEBUG
3848
wdenk43d96162003-03-06 00:02:04 +00003849 Enables debugging stuff (char screen[1024], dbg())
3850 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003851
wdenka8c7c702003-12-06 19:49:23 +00003852- Interrupt support (PPC):
3853
wdenkd4ca31c2004-01-02 14:00:00 +00003854 There are common interrupt_init() and timer_interrupt()
3855 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003856 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003857 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003858 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003859 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003860 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003861 specific handling. If board has watchdog / status_led
3862 / other_activity_monitor it works automatically from
3863 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003864
wdenkc6097192002-11-03 00:24:07 +00003865- General:
3866
wdenk43d96162003-03-06 00:02:04 +00003867 In the target system modem support is enabled when a
3868 specific key (key combination) is pressed during
3869 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003870 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003871 board_init(). Currently key_pressed() is a dummy
3872 function, returning 1 and thus enabling modem
3873 initialization.
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk43d96162003-03-06 00:02:04 +00003875 If there are no modem init strings in the
3876 environment, U-Boot proceed to autoboot; the
3877 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003878 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003879
3880 See also: doc/README.Modem
3881
Helmut Raiger9660e442011-10-20 04:19:47 +00003882Board initialization settings:
3883------------------------------
3884
3885During Initialization u-boot calls a number of board specific functions
3886to allow the preparation of board specific prerequisites, e.g. pin setup
3887before drivers are initialized. To enable these callbacks the
3888following configuration macros have to be defined. Currently this is
3889architecture specific, so please check arch/your_architecture/lib/board.c
3890typically in board_init_f() and board_init_r().
3891
3892- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3893- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3894- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3895- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003896
wdenkc6097192002-11-03 00:24:07 +00003897Configuration Settings:
3898-----------------------
3899
York Sun4d1fd7f2014-02-26 17:03:19 -08003900- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3901 Optionally it can be defined to support 64-bit memory commands.
3902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003903- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003904 undefine this when you're short of memory.
3905
Peter Tyser2fb26042009-01-27 18:03:12 -06003906- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3907 width of the commands listed in the 'help' command output.
3908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003909- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003910 prompt for user input.
3911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003912- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003918- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003919 the application (usually a Linux kernel) when it is
3920 booted
3921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003922- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003923 List of legal baudrate settings for this board.
3924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003925- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003926 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003928- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003929 If the board specific function
3930 extern int overwrite_console (void);
3931 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003932 serial port, else the settings in the environment are used.
3933
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003934- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003935 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003936
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003937- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003938 Enable overwrite of previous console environment settings.
3939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003940- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003941 Begin and End addresses of the area used by the
3942 simple memory test.
3943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003944- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003945 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003947- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003948 Scratch address used by the alternate memory test
3949 You only need to set this if address zero isn't writeable
3950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003951- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3952 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003953 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003954 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003955 fixing up gd->ram_size the Linux kernel should gets passed
3956 the now "corrected" memory size and won't touch it either.
3957 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003958 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003959 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003960 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003961
3962 This option can be used as a workaround for the 440EPx/GRx
3963 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3964 be touched.
3965
3966 WARNING: Please make sure that this value is a multiple of
3967 the Linux page size (normally 4k). If this is not the case,
3968 then the end address of the Linux memory will be located at a
3969 non page size aligned address and this could cause major
3970 problems.
3971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003972- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003973 Enable temporary baudrate change while serial download
3974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003976 Physical start address of SDRAM. _Must_ be 0 here.
3977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003978- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003979 Physical start address of Motherboard I/O (if using a
3980 Cogent motherboard)
3981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003982- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003983 Physical start address of Flash memory.
3984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003985- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003986 Physical start address of boot monitor code (set by
3987 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003988 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003989 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003991- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003992 Size of memory reserved for monitor code, used to
3993 determine _at_compile_time_ (!) if the environment is
3994 embedded within the U-Boot image, or in a separate
3995 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003997- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003998 Size of DRAM reserved for malloc() use.
3999
Simon Glassd59476b2014-07-10 22:23:28 -06004000- CONFIG_SYS_MALLOC_F_LEN
4001 Size of the malloc() pool for use before relocation. If
4002 this is defined, then a very simple malloc() implementation
4003 will become available before relocation. The address is just
4004 below the global data, and the stack is moved down to make
4005 space.
4006
4007 This feature allocates regions with increasing addresses
4008 within the region. calloc() is supported, but realloc()
4009 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004010 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06004011 U-Boot relocates itself.
4012
Simon Glasse7b14e92014-09-15 06:33:18 -06004013 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06004014 at present but is fairly easy to enable for other archs.
4015
Simon Glass38687ae2014-11-10 17:16:54 -07004016- CONFIG_SYS_MALLOC_SIMPLE
4017 Provides a simple and small malloc() and calloc() for those
4018 boards which do not use the full malloc in SPL (which is
4019 enabled with CONFIG_SYS_SPL_MALLOC_START).
4020
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07004021- CONFIG_SYS_NONCACHED_MEMORY:
4022 Size of non-cached memory area. This area of memory will be
4023 typically located right below the malloc() area and mapped
4024 uncached in the MMU. This is useful for drivers that would
4025 otherwise require a lot of explicit cache maintenance. For
4026 some drivers it's also impossible to properly maintain the
4027 cache. For example if the regions that need to be flushed
4028 are not a multiple of the cache-line size, *and* padding
4029 cannot be allocated between the regions to align them (i.e.
4030 if the HW requires a contiguous array of regions, and the
4031 size of each region is not cache-aligned), then a flush of
4032 one region may result in overwriting data that hardware has
4033 written to another region in the same cache-line. This can
4034 happen for example in network drivers where descriptors for
4035 buffers are typically smaller than the CPU cache-line (e.g.
4036 16 bytes vs. 32 or 64 bytes).
4037
4038 Non-cached memory is only supported on 32-bit ARM at present.
4039
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004040- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01004041 Normally compressed uImages are limited to an
4042 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004043 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01004044 to adjust this setting to your needs.
4045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004046- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00004047 Maximum size of memory mapped by the startup code of
4048 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004049 the Linux kernel (bd_info, boot arguments, FDT blob if
4050 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004051 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004052 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004053 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00004054 variable "bootm_mapsize" will override the value of
4055 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4056 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00004057
John Rigbyfca43cc2010-10-13 13:57:35 -06004058- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4059 Enable initrd_high functionality. If defined then the
4060 initrd_high feature is enabled and the bootm ramdisk subcommand
4061 is enabled.
4062
4063- CONFIG_SYS_BOOT_GET_CMDLINE:
4064 Enables allocating and saving kernel cmdline in space between
4065 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4066
4067- CONFIG_SYS_BOOT_GET_KBD:
4068 Enables allocating and saving a kernel copy of the bd_info in
4069 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004071- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00004072 Max number of Flash memory banks
4073
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004074- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00004075 Max number of sectors on a Flash chip
4076
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004077- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004078 Timeout for Flash erase operations (in ms)
4079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004080- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00004081 Timeout for Flash write operations (in ms)
4082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004083- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004084 Timeout for Flash set sector lock bit operation (in ms)
4085
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004086- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00004087 Timeout for Flash clear lock bits operation (in ms)
4088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004089- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00004090 If defined, hardware flash sectors protection is used
4091 instead of U-Boot software protection.
4092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004093- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00004094
4095 Enable TFTP transfers directly to flash memory;
4096 without this option such a download has to be
4097 performed in two steps: (1) download to RAM, and (2)
4098 copy from RAM to flash.
4099
4100 The two-step approach is usually more reliable, since
4101 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004102 the flash, but in some situations (when system RAM is
4103 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00004104 downloaded image) this option may be very useful.
4105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004106- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00004107 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00004108 common flash structure for storing flash geometry.
4109
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02004110- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00004111 This option also enables the building of the cfi_flash driver
4112 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00004113
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004114- CONFIG_FLASH_CFI_MTD
4115 This option enables the building of the cfi_mtd driver
4116 in the drivers directory. The driver exports CFI flash
4117 to the MTD layer.
4118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004119- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004120 Use buffered writes to flash.
4121
4122- CONFIG_FLASH_SPANSION_S29WS_N
4123 s29ws-n MirrorBit flash has non-standard addresses for buffered
4124 write commands.
4125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004126- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004127 If this option is defined, the common CFI flash doesn't
4128 print it's warning upon not recognized FLASH banks. This
4129 is useful, if some of the configured banks are only
4130 optionally available.
4131
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004132- CONFIG_FLASH_SHOW_PROGRESS
4133 If defined (must be an integer), print out countdown
4134 digits and dots. Recommended value: 45 (9..1) for 80
4135 column displays, 15 (3..1) for 40 column displays.
4136
Stefan Roese352ef3f2013-04-04 15:53:14 +02004137- CONFIG_FLASH_VERIFY
4138 If defined, the content of the flash (destination) is compared
4139 against the source after the write operation. An error message
4140 will be printed when the contents are not identical.
4141 Please note that this option is useless in nearly all cases,
4142 since such flash programming errors usually are detected earlier
4143 while unprotecting/erasing/programming. Please only enable
4144 this option if you really know what you are doing.
4145
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004146- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004147 Defines the number of Ethernet receive buffers. On some
4148 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004149 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4150 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004151 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004152 Defaults to 4 if not defined.
4153
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004154- CONFIG_ENV_MAX_ENTRIES
4155
Wolfgang Denk071bc922010-10-27 22:48:30 +02004156 Maximum number of entries in the hash table that is used
4157 internally to store the environment settings. The default
4158 setting is supposed to be generous and should work in most
4159 cases. This setting can be used to tune behaviour; see
4160 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004161
Joe Hershberger25980902012-12-11 22:16:31 -06004162- CONFIG_ENV_FLAGS_LIST_DEFAULT
4163- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004164 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004165 calling env set. Variables can be restricted to only decimal,
4166 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4167 the variables can also be restricted to IP address or MAC address.
4168
4169 The format of the list is:
4170 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004171 access_attribute = [a|r|o|c]
4172 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004173 entry = variable_name[:attributes]
4174 list = entry[,list]
4175
4176 The type attributes are:
4177 s - String (default)
4178 d - Decimal
4179 x - Hexadecimal
4180 b - Boolean ([1yYtT|0nNfF])
4181 i - IP address
4182 m - MAC address
4183
Joe Hershberger267541f2012-12-11 22:16:34 -06004184 The access attributes are:
4185 a - Any (default)
4186 r - Read-only
4187 o - Write-once
4188 c - Change-default
4189
Joe Hershberger25980902012-12-11 22:16:31 -06004190 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4191 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004192 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004193
4194 - CONFIG_ENV_FLAGS_LIST_STATIC
4195 Define this to a list (string) to define validation that
4196 should be done if an entry is not found in the ".flags"
4197 environment variable. To override a setting in the static
4198 list, simply add an entry for the same variable name to the
4199 ".flags" variable.
4200
Joe Hershberger267541f2012-12-11 22:16:34 -06004201- CONFIG_ENV_ACCESS_IGNORE_FORCE
4202 If defined, don't allow the -f switch to env set override variable
4203 access flags.
4204
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004205- CONFIG_SYS_GENERIC_BOARD
4206 This selects the architecture-generic board system instead of the
4207 architecture-specific board files. It is intended to move boards
4208 to this new framework over time. Defining this will disable the
4209 arch/foo/lib/board.c file and use common/board_f.c and
4210 common/board_r.c instead. To use this option your architecture
4211 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4212 its config.mk file). If you find problems enabling this option on
4213 your board please report the problem and send patches!
4214
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004215- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4216 This is set by OMAP boards for the max time that reset should
4217 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004218 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004219
Gabe Black0d296cc2014-10-15 04:38:30 -06004220- CONFIG_USE_STDINT
4221 If stdint.h is available with your toolchain you can define this
4222 option to enable it. You can provide option 'USE_STDINT=1' when
4223 building U-Boot to enable this.
4224
wdenkc6097192002-11-03 00:24:07 +00004225The following definitions that deal with the placement and management
4226of environment data (variable area); in general, we support the
4227following configurations:
4228
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004229- CONFIG_BUILD_ENVCRC:
4230
4231 Builds up envcrc with the target environment so that external utils
4232 may easily extract it and embed it in final U-Boot images.
4233
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004234- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004235
4236 Define this if the environment is in flash memory.
4237
4238 a) The environment occupies one whole flash sector, which is
4239 "embedded" in the text segment with the U-Boot code. This
4240 happens usually with "bottom boot sector" or "top boot
4241 sector" type flash chips, which have several smaller
4242 sectors at the start or the end. For instance, such a
4243 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4244 such a case you would place the environment in one of the
4245 4 kB sectors - with U-Boot code before and after it. With
4246 "top boot sector" type flash chips, you would put the
4247 environment in one of the last sectors, leaving a gap
4248 between U-Boot and the environment.
4249
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004250 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004251
4252 Offset of environment data (variable area) to the
4253 beginning of flash memory; for instance, with bottom boot
4254 type flash chips the second sector can be used: the offset
4255 for this sector is given here.
4256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004257 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004258
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004259 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004260
4261 This is just another way to specify the start address of
4262 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004263 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004264
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004265 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004266
4267 Size of the sector containing the environment.
4268
4269
4270 b) Sometimes flash chips have few, equal sized, BIG sectors.
4271 In such a case you don't want to spend a whole sector for
4272 the environment.
4273
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004274 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004275
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004276 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004277 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004278 of this flash sector for the environment. This saves
4279 memory for the RAM copy of the environment.
4280
4281 It may also save flash memory if you decide to use this
4282 when your environment is "embedded" within U-Boot code,
4283 since then the remainder of the flash sector could be used
4284 for U-Boot code. It should be pointed out that this is
4285 STRONGLY DISCOURAGED from a robustness point of view:
4286 updating the environment in flash makes it always
4287 necessary to erase the WHOLE sector. If something goes
4288 wrong before the contents has been restored from a copy in
4289 RAM, your target system will be dead.
4290
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004291 - CONFIG_ENV_ADDR_REDUND
4292 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004293
wdenk43d96162003-03-06 00:02:04 +00004294 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004295 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004296 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004297 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004298
4299BE CAREFUL! Any changes to the flash layout, and some changes to the
4300source code will make it necessary to adapt <board>/u-boot.lds*
4301accordingly!
4302
4303
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004304- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004305
4306 Define this if you have some non-volatile memory device
4307 (NVRAM, battery buffered SRAM) which you want to use for the
4308 environment.
4309
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004310 - CONFIG_ENV_ADDR:
4311 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004312
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004313 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004314 want to use for environment. It is assumed that this memory
4315 can just be read and written to, without any special
4316 provision.
4317
4318BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004319in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004320console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004321U-Boot will hang.
4322
4323Please note that even with NVRAM we still use a copy of the
4324environment in RAM: we could work on NVRAM directly, but we want to
4325keep settings there always unmodified except somebody uses "saveenv"
4326to save the current settings.
4327
4328
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004329- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004330
4331 Use this if you have an EEPROM or similar serial access
4332 device and a driver for it.
4333
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004334 - CONFIG_ENV_OFFSET:
4335 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004336
4337 These two #defines specify the offset and size of the
4338 environment area within the total memory of your EEPROM.
4339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004340 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004341 If defined, specified the chip address of the EEPROM device.
4342 The default address is zero.
4343
Christian Gmeiner189d2572015-02-11 15:19:31 +01004344 - CONFIG_SYS_I2C_EEPROM_BUS:
4345 If defined, specified the i2c bus of the EEPROM device.
4346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004347 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004348 If defined, the number of bits used to address bytes in a
4349 single page in the EEPROM device. A 64 byte page, for example
4350 would require six bits.
4351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004352 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004353 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004354 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004356 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004357 The length in bytes of the EEPROM memory array address. Note
4358 that this is NOT the chip address length!
4359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004360 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004361 EEPROM chips that implement "address overflow" are ones
4362 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4363 address and the extra bits end up in the "chip address" bit
4364 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4365 byte chips.
4366
4367 Note that we consider the length of the address field to
4368 still be one byte because the extra address bits are hidden
4369 in the chip address.
4370
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004371 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004372 The size in bytes of the EEPROM device.
4373
Heiko Schocher548738b2010-01-07 08:55:40 +01004374 - CONFIG_ENV_EEPROM_IS_ON_I2C
4375 define this, if you have I2C and SPI activated, and your
4376 EEPROM, which holds the environment, is on the I2C bus.
4377
4378 - CONFIG_I2C_ENV_EEPROM_BUS
4379 if you have an Environment on an EEPROM reached over
4380 I2C muxes, you can define here, how to reach this
4381 EEPROM. For example:
4382
Heiko Schocherea818db2013-01-29 08:53:15 +01004383 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004384
4385 EEPROM which holds the environment, is reached over
4386 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004387
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004388- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004389
wdenkd4ca31c2004-01-02 14:00:00 +00004390 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004391 want to use for the environment.
4392
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004393 - CONFIG_ENV_OFFSET:
4394 - CONFIG_ENV_ADDR:
4395 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004396
4397 These three #defines specify the offset and size of the
4398 environment area within the total memory of your DataFlash placed
4399 at the specified address.
4400
Wu, Joshbd83b592014-07-01 19:30:13 +08004401- CONFIG_ENV_IS_IN_SPI_FLASH:
4402
4403 Define this if you have a SPI Flash memory device which you
4404 want to use for the environment.
4405
4406 - CONFIG_ENV_OFFSET:
4407 - CONFIG_ENV_SIZE:
4408
4409 These two #defines specify the offset and size of the
4410 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4411 aligned to an erase sector boundary.
4412
4413 - CONFIG_ENV_SECT_SIZE:
4414
4415 Define the SPI flash's sector size.
4416
4417 - CONFIG_ENV_OFFSET_REDUND (optional):
4418
4419 This setting describes a second storage area of CONFIG_ENV_SIZE
4420 size used to hold a redundant copy of the environment data, so
4421 that there is a valid backup copy in case there is a power failure
4422 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4423 aligned to an erase sector boundary.
4424
4425 - CONFIG_ENV_SPI_BUS (optional):
4426 - CONFIG_ENV_SPI_CS (optional):
4427
4428 Define the SPI bus and chip select. If not defined they will be 0.
4429
4430 - CONFIG_ENV_SPI_MAX_HZ (optional):
4431
4432 Define the SPI max work clock. If not defined then use 1MHz.
4433
4434 - CONFIG_ENV_SPI_MODE (optional):
4435
4436 Define the SPI work mode. If not defined then use SPI_MODE_3.
4437
Liu Gang0a85a9e2012-03-08 00:33:20 +00004438- CONFIG_ENV_IS_IN_REMOTE:
4439
4440 Define this if you have a remote memory space which you
4441 want to use for the local device's environment.
4442
4443 - CONFIG_ENV_ADDR:
4444 - CONFIG_ENV_SIZE:
4445
4446 These two #defines specify the address and size of the
4447 environment area within the remote memory space. The
4448 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004449 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004450
4451BE CAREFUL! For some special cases, the local device can not use
4452"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004453environment stored in a remote NOR flash by SRIO or PCIE link,
4454but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004455
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004456- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004457
4458 Define this if you have a NAND device which you want to use
4459 for the environment.
4460
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004461 - CONFIG_ENV_OFFSET:
4462 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004463
4464 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004465 area within the first NAND device. CONFIG_ENV_OFFSET must be
4466 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004467
Scott Woodfdd813d2010-09-17 14:38:37 -05004468 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004469
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004470 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004471 size used to hold a redundant copy of the environment data, so
4472 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004473 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004474 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004475
Scott Woodfdd813d2010-09-17 14:38:37 -05004476 - CONFIG_ENV_RANGE (optional):
4477
4478 Specifies the length of the region in which the environment
4479 can be written. This should be a multiple of the NAND device's
4480 block size. Specifying a range with more erase blocks than
4481 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4482 the range to be avoided.
4483
4484 - CONFIG_ENV_OFFSET_OOB (optional):
4485
4486 Enables support for dynamically retrieving the offset of the
4487 environment from block zero's out-of-band data. The
4488 "nand env.oob" command can be used to record this offset.
4489 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4490 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004491
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004492- CONFIG_NAND_ENV_DST
4493
4494 Defines address in RAM to which the nand_spl code should copy the
4495 environment. If redundant environment is used, it will be copied to
4496 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4497
Joe Hershberger2b744332013-04-08 10:32:51 +00004498- CONFIG_ENV_IS_IN_UBI:
4499
4500 Define this if you have an UBI volume that you want to use for the
4501 environment. This has the benefit of wear-leveling the environment
4502 accesses, which is important on NAND.
4503
4504 - CONFIG_ENV_UBI_PART:
4505
4506 Define this to a string that is the mtd partition containing the UBI.
4507
4508 - CONFIG_ENV_UBI_VOLUME:
4509
4510 Define this to the name of the volume that you want to store the
4511 environment in.
4512
Joe Hershberger785881f2013-04-08 10:32:52 +00004513 - CONFIG_ENV_UBI_VOLUME_REDUND:
4514
4515 Define this to the name of another volume to store a second copy of
4516 the environment in. This will enable redundant environments in UBI.
4517 It is assumed that both volumes are in the same MTD partition.
4518
Joe Hershberger2b744332013-04-08 10:32:51 +00004519 - CONFIG_UBI_SILENCE_MSG
4520 - CONFIG_UBIFS_SILENCE_MSG
4521
4522 You will probably want to define these to avoid a really noisy system
4523 when storing the env in UBI.
4524
Wu, Joshd1db76f2014-06-24 17:31:03 +08004525- CONFIG_ENV_IS_IN_FAT:
4526 Define this if you want to use the FAT file system for the environment.
4527
4528 - FAT_ENV_INTERFACE:
4529
4530 Define this to a string that is the name of the block device.
4531
4532 - FAT_ENV_DEV_AND_PART:
4533
4534 Define this to a string to specify the partition of the device. It can
4535 be as following:
4536
4537 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4538 - "D:P": device D partition P. Error occurs if device D has no
4539 partition table.
4540 - "D:0": device D.
4541 - "D" or "D:": device D partition 1 if device D has partition
4542 table, or the whole device D if has no partition
4543 table.
4544 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004545 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004546 partition table then means device D.
4547
4548 - FAT_ENV_FILE:
4549
4550 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004551 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004552
4553 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004554 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004555
Stephen Warren06e4ae52013-06-11 15:14:00 -06004556- CONFIG_ENV_IS_IN_MMC:
4557
4558 Define this if you have an MMC device which you want to use for the
4559 environment.
4560
4561 - CONFIG_SYS_MMC_ENV_DEV:
4562
4563 Specifies which MMC device the environment is stored in.
4564
4565 - CONFIG_SYS_MMC_ENV_PART (optional):
4566
4567 Specifies which MMC partition the environment is stored in. If not
4568 set, defaults to partition 0, the user area. Common values might be
4569 1 (first MMC boot partition), 2 (second MMC boot partition).
4570
4571 - CONFIG_ENV_OFFSET:
4572 - CONFIG_ENV_SIZE:
4573
4574 These two #defines specify the offset and size of the environment
4575 area within the specified MMC device.
4576
Stephen Warren5c088ee2013-06-11 15:14:02 -06004577 If offset is positive (the usual case), it is treated as relative to
4578 the start of the MMC partition. If offset is negative, it is treated
4579 as relative to the end of the MMC partition. This can be useful if
4580 your board may be fitted with different MMC devices, which have
4581 different sizes for the MMC partitions, and you always want the
4582 environment placed at the very end of the partition, to leave the
4583 maximum possible space before it, to store other data.
4584
Stephen Warren06e4ae52013-06-11 15:14:00 -06004585 These two values are in units of bytes, but must be aligned to an
4586 MMC sector boundary.
4587
4588 - CONFIG_ENV_OFFSET_REDUND (optional):
4589
4590 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4591 hold a redundant copy of the environment data. This provides a
4592 valid backup copy in case the other copy is corrupted, e.g. due
4593 to a power failure during a "saveenv" operation.
4594
Stephen Warren5c088ee2013-06-11 15:14:02 -06004595 This value may also be positive or negative; this is handled in the
4596 same way as CONFIG_ENV_OFFSET.
4597
Stephen Warren06e4ae52013-06-11 15:14:00 -06004598 This value is also in units of bytes, but must also be aligned to
4599 an MMC sector boundary.
4600
4601 - CONFIG_ENV_SIZE_REDUND (optional):
4602
4603 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4604 set. If this value is set, it must be set to the same value as
4605 CONFIG_ENV_SIZE.
4606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004607- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004608
4609 Defines offset to the initial SPI buffer area in DPRAM. The
4610 area is used at an early stage (ROM part) if the environment
4611 is configured to reside in the SPI EEPROM: We need a 520 byte
4612 scratch DPRAM area. It is used between the two initialization
4613 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4614 to be a good choice since it makes it far enough from the
4615 start of the data area as well as from the stack pointer.
4616
Bruce Adlere881cb52007-11-02 13:15:42 -07004617Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004618has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004619created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004620until then to read environment variables.
4621
wdenk85ec0bc2003-03-31 16:34:49 +00004622The environment is protected by a CRC32 checksum. Before the monitor
4623is relocated into RAM, as a result of a bad CRC you will be working
4624with the compiled-in default environment - *silently*!!! [This is
4625necessary, because the first environment variable we need is the
4626"baudrate" setting for the console - if we have a bad CRC, we don't
4627have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004628
4629Note: once the monitor has been relocated, then it will complain if
4630the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004631use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004633- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004634 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004636 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004637 also needs to be defined.
4638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004639- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004640 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004641
Ron Madridf5675aa2009-02-18 14:30:44 -08004642- CONFIG_NS16550_MIN_FUNCTIONS:
4643 Define this if you desire to only have use of the NS16550_init
4644 and NS16550_putc functions for the serial driver located at
4645 drivers/serial/ns16550.c. This option is useful for saving
4646 space for already greatly restricted images, including but not
4647 limited to NAND_SPL configurations.
4648
Simon Glassb2b92f52012-11-30 13:01:18 +00004649- CONFIG_DISPLAY_BOARDINFO
4650 Display information about the board that U-Boot is running on
4651 when U-Boot starts up. The board function checkboard() is called
4652 to do this.
4653
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004654- CONFIG_DISPLAY_BOARDINFO_LATE
4655 Similar to the previous option, but display this information
4656 later, once stdio is running and output goes to the LCD, if
4657 present.
4658
Sascha Silbefeb85802013-08-11 16:40:43 +02004659- CONFIG_BOARD_SIZE_LIMIT:
4660 Maximum size of the U-Boot image. When defined, the
4661 build system checks that the actual size does not
4662 exceed it.
4663
wdenkc6097192002-11-03 00:24:07 +00004664Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004665---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004667- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004668 Cache Line Size of the CPU.
4669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004670- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004671 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004672
wdenk42d1f032003-10-15 23:53:47 +00004673 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4674 and RPXsuper) to be able to adjust the position of
4675 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004676
Timur Tabie46fedf2011-08-04 18:03:41 -05004677- CONFIG_SYS_CCSRBAR_DEFAULT:
4678 Default (power-on reset) physical address of CCSR on Freescale
4679 PowerPC SOCs.
4680
4681- CONFIG_SYS_CCSRBAR:
4682 Virtual address of CCSR. On a 32-bit build, this is typically
4683 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4684
4685 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4686 for cross-platform code that uses that macro instead.
4687
4688- CONFIG_SYS_CCSRBAR_PHYS:
4689 Physical address of CCSR. CCSR can be relocated to a new
4690 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004691 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004692 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4693 is typically relocated on 36-bit builds. It is recommended
4694 that this macro be defined via the _HIGH and _LOW macros:
4695
4696 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4697 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4698
4699- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004700 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4701 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004702 used in assembly code, so it must not contain typecasts or
4703 integer size suffixes (e.g. "ULL").
4704
4705- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4706 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4707 used in assembly code, so it must not contain typecasts or
4708 integer size suffixes (e.g. "ULL").
4709
4710- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4711 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4712 forced to a value that ensures that CCSR is not relocated.
4713
wdenk7f6c2cb2002-11-10 22:06:23 +00004714- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004715 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004716
4717 the default drive number (default value 0)
4718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004720
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004721 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004722 (default value 1)
4723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004724 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004725
wdenk43d96162003-03-06 00:02:04 +00004726 defines the offset of register from address. It
4727 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004728 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004730 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4731 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004732 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004734 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004735 fdc_hw_init() is called at the beginning of the FDC
4736 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004737 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004738 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004739
Macpaul Lin0abddf82011-04-11 20:45:32 +00004740- CONFIG_IDE_AHB:
4741 Most IDE controllers were designed to be connected with PCI
4742 interface. Only few of them were designed for AHB interface.
4743 When software is doing ATA command and data transfer to
4744 IDE devices through IDE-AHB controller, some additional
4745 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004746 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004748- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004749 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004750 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004752- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk7152b1d2003-09-05 23:19:14 +00004754 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004755 initial data and stack; please note that this must be
4756 writable memory that is working WITHOUT special
4757 initialization, i. e. you CANNOT use normal RAM which
4758 will become available only after programming the
4759 memory controller and running certain initialization
4760 sequences.
4761
4762 U-Boot uses the following memory types:
4763 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4764 - MPC824X: data cache
4765 - PPC4xx: data cache
4766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004767- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004768
4769 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004770 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4771 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004772 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004773 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004774 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4775 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4776 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004777
4778 Note:
4779 On the MPC824X (or other systems that use the data
4780 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004781 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004782 point to an otherwise UNUSED address space between
4783 the top of RAM and the start of the PCI space.
4784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004785- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004787- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004789- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004791- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004793- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004795- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004797- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004798 SDRAM timing
4799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004800- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004801 periodic timer for refresh
4802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004803- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004805- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4806 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4807 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4808 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004809 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4810
4811- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004812 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4813 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004814 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004816- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4817 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004818 Machine Mode Register and Memory Periodic Timer
4819 Prescaler definitions (SDRAM timing)
4820
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004821- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004822 enable I2C microcode relocation patch (MPC8xx);
4823 define relocation offset in DPRAM [DSP2]
4824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004825- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004826 enable SMC microcode relocation patch (MPC8xx);
4827 define relocation offset in DPRAM [SMC1]
4828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004829- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004830 enable SPI microcode relocation patch (MPC8xx);
4831 define relocation offset in DPRAM [SCC4]
4832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004833- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004834 Use OSCM clock mode on MBX8xx board. Be careful,
4835 wrong setting might damage your board. Read
4836 doc/README.MBX before setting this variable!
4837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004838- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004839 Offset of the bootmode word in DPRAM used by post
4840 (Power On Self Tests). This definition overrides
4841 #define'd default value in commproc.h resp.
4842 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004844- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4845 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4846 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4847 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4848 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4849 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4850 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4851 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004852 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004853
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004854- CONFIG_PCI_DISABLE_PCIE:
4855 Disable PCI-Express on systems where it is supported but not
4856 required.
4857
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004858- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004859 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004860 Don't do any setup work, presumably because someone or
4861 something has already done it, and we don't need to do it
4862 a second time. Useful for platforms that are pre-booted
4863 by coreboot or similar.
4864
Gabor Juhos842033e2013-05-30 07:06:12 +00004865- CONFIG_PCI_INDIRECT_BRIDGE:
4866 Enable support for indirect PCI bridges.
4867
Kumar Galaa09b9b62010-12-30 12:09:53 -06004868- CONFIG_SYS_SRIO:
4869 Chip has SRIO or not
4870
4871- CONFIG_SRIO1:
4872 Board has SRIO 1 port available
4873
4874- CONFIG_SRIO2:
4875 Board has SRIO 2 port available
4876
Liu Gangc8b28152013-05-07 16:30:46 +08004877- CONFIG_SRIO_PCIE_BOOT_MASTER
4878 Board can support master function for Boot from SRIO and PCIE
4879
Kumar Galaa09b9b62010-12-30 12:09:53 -06004880- CONFIG_SYS_SRIOn_MEM_VIRT:
4881 Virtual Address of SRIO port 'n' memory region
4882
4883- CONFIG_SYS_SRIOn_MEM_PHYS:
4884 Physical Address of SRIO port 'n' memory region
4885
4886- CONFIG_SYS_SRIOn_MEM_SIZE:
4887 Size of SRIO port 'n' memory region
4888
Fabio Estevam66bd1842013-04-11 09:35:34 +00004889- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4890 Defined to tell the NAND controller that the NAND chip is using
4891 a 16 bit bus.
4892 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004893 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004894 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004895 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004896
4897- CONFIG_SYS_NDFC_EBC0_CFG
4898 Sets the EBC0_CFG register for the NDFC. If not defined
4899 a default value will be used.
4900
Ben Warrenbb99ad62006-09-07 16:50:54 -04004901- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004902 Get DDR timing information from an I2C EEPROM. Common
4903 with pluggable memory modules such as SODIMMs
4904
Ben Warrenbb99ad62006-09-07 16:50:54 -04004905 SPD_EEPROM_ADDRESS
4906 I2C address of the SPD EEPROM
4907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004908- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004909 If SPD EEPROM is on an I2C bus other than the first
4910 one, specify here. Note that the value must resolve
4911 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004912
York Sun1b3e3c42011-06-07 09:42:16 +08004913- CONFIG_SYS_DDR_RAW_TIMING
4914 Get DDR timing information from other than SPD. Common with
4915 soldered DDR chips onboard without SPD. DDR raw timing
4916 parameters are extracted from datasheet and hard-coded into
4917 header files or board specific files.
4918
York Sun6f5e1dc2011-09-16 13:21:35 -07004919- CONFIG_FSL_DDR_INTERACTIVE
4920 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004922- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004923 Only for 83xx systems. If specified, then DDR should
4924 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004925
wdenkc26e4542004-04-18 10:13:26 +00004926- CONFIG_ETHER_ON_FEC[12]
4927 Define to enable FEC[12] on a 8xx series processor.
4928
4929- CONFIG_FEC[12]_PHY
4930 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004931 to the given FEC; i. e.
4932 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004933 means that the PHY with address 4 is connected to FEC1
4934
4935 When set to -1, means to probe for first available.
4936
4937- CONFIG_FEC[12]_PHY_NORXERR
4938 The PHY does not have a RXERR line (RMII only).
4939 (so program the FEC to ignore it).
4940
4941- CONFIG_RMII
4942 Enable RMII mode for all FECs.
4943 Note that this is a global option, we can't
4944 have one FEC in standard MII mode and another in RMII mode.
4945
wdenk5cf91d62004-04-23 20:32:05 +00004946- CONFIG_CRC32_VERIFY
4947 Add a verify option to the crc32 command.
4948 The syntax is:
4949
4950 => crc32 -v <address> <count> <crc32>
4951
4952 Where address/count indicate a memory area
4953 and crc32 is the correct crc32 which the
4954 area should have.
4955
wdenk56523f12004-07-11 17:40:54 +00004956- CONFIG_LOOPW
4957 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004958 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004959
stroese7b466642004-12-16 18:46:55 +00004960- CONFIG_MX_CYCLIC
4961 Add the "mdc" and "mwc" memory commands. These are cyclic
4962 "md/mw" commands.
4963 Examples:
4964
wdenkefe2a4d2004-12-16 21:44:03 +00004965 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004966 This command will print 4 bytes (10,11,12,13) each 500 ms.
4967
wdenkefe2a4d2004-12-16 21:44:03 +00004968 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004969 This command will write 12345678 to address 100 all 10 ms.
4970
wdenkefe2a4d2004-12-16 21:44:03 +00004971 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004972 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004973
wdenk8aa1a2d2005-04-04 12:44:11 +00004974- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004975 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004976 low level initializations (like setting up the memory
4977 controller) are omitted and/or U-Boot does not
4978 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004979
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004980 Normally this variable MUST NOT be defined. The only
4981 exception is when U-Boot is loaded (to RAM) by some
4982 other boot loader or by a debugger which performs
4983 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004984
Aneesh V401bb302011-07-13 05:11:07 +00004985- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004986 Modifies the behaviour of start.S when compiling a loader
4987 that is executed before the actual U-Boot. E.g. when
4988 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004989
Ying Zhang3aa29de2013-08-16 15:16:15 +08004990- CONFIG_TPL_BUILD
4991 Modifies the behaviour of start.S when compiling a loader
4992 that is executed after the SPL and before the actual U-Boot.
4993 It is loaded by the SPL.
4994
Ying Zhang5df572f2013-05-20 14:07:23 +08004995- CONFIG_SYS_MPC85XX_NO_RESETVEC
4996 Only for 85xx systems. If this variable is specified, the section
4997 .resetvec is not kept and the section .bootpg is placed in the
4998 previous 4k of the .text section.
4999
Simon Glass4213fc22013-02-24 17:33:14 +00005000- CONFIG_ARCH_MAP_SYSMEM
5001 Generally U-Boot (and in particular the md command) uses
5002 effective address. It is therefore not necessary to regard
5003 U-Boot address as virtual addresses that need to be translated
5004 to physical addresses. However, sandbox requires this, since
5005 it maintains its own little RAM buffer which contains all
5006 addressable memory. This option causes some memory accesses
5007 to be mapped through map_sysmem() / unmap_sysmem().
5008
Matthias Weisserd8834a12011-03-10 21:36:32 +00005009- CONFIG_USE_ARCH_MEMCPY
5010 CONFIG_USE_ARCH_MEMSET
5011 If these options are used a optimized version of memcpy/memset will
5012 be used if available. These functions may be faster under some
5013 conditions but may increase the binary size.
5014
Simon Glass588a13f2013-02-14 04:18:54 +00005015- CONFIG_X86_RESET_VECTOR
5016 If defined, the x86 reset vector code is included. This is not
5017 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00005018
Mark Jacksonfc337052013-03-04 01:27:20 +00005019- CONFIG_SYS_MPUCLK
5020 Defines the MPU clock speed (in MHz).
5021
5022 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00005023
Heiko Schocher16678eb2013-11-04 14:05:00 +01005024- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5025 Enables the RTC32K OSC on AM33xx based plattforms
5026
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04005027- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5028 Option to disable subpage write in NAND driver
5029 driver that uses this:
5030 drivers/mtd/nand/davinci_nand.c
5031
Timur Tabif2717b42011-11-22 09:21:25 -06005032Freescale QE/FMAN Firmware Support:
5033-----------------------------------
5034
5035The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5036loading of "firmware", which is encoded in the QE firmware binary format.
5037This firmware often needs to be loaded during U-Boot booting, so macros
5038are used to identify the storage device (NOR flash, SPI, etc) and the address
5039within that device.
5040
Zhao Qiangdcf1d772014-03-21 16:21:44 +08005041- CONFIG_SYS_FMAN_FW_ADDR
5042 The address in the storage device where the FMAN microcode is located. The
5043 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5044 is also specified.
5045
5046- CONFIG_SYS_QE_FW_ADDR
5047 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06005048 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5049 is also specified.
5050
5051- CONFIG_SYS_QE_FMAN_FW_LENGTH
5052 The maximum possible size of the firmware. The firmware binary format
5053 has a field that specifies the actual size of the firmware, but it
5054 might not be possible to read any part of the firmware unless some
5055 local storage is allocated to hold the entire firmware first.
5056
5057- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5058 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5059 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5060 virtual address in NOR flash.
5061
5062- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5063 Specifies that QE/FMAN firmware is located in NAND flash.
5064 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5065
5066- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5067 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5068 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5069
5070- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5071 Specifies that QE/FMAN firmware is located on the primary SPI
5072 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5073
Liu Gang292dc6c2012-03-08 00:33:18 +00005074- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5075 Specifies that QE/FMAN firmware is located in the remote (master)
5076 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00005077 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5078 window->master inbound window->master LAW->the ucode address in
5079 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06005080
J. German Riverab940ca62014-06-23 15:15:55 -07005081Freescale Layerscape Management Complex Firmware Support:
5082---------------------------------------------------------
5083The Freescale Layerscape Management Complex (MC) supports the loading of
5084"firmware".
5085This firmware often needs to be loaded during U-Boot booting, so macros
5086are used to identify the storage device (NOR flash, SPI, etc) and the address
5087within that device.
5088
5089- CONFIG_FSL_MC_ENET
5090 Enable the MC driver for Layerscape SoCs.
5091
5092- CONFIG_SYS_LS_MC_FW_ADDR
5093 The address in the storage device where the firmware is located. The
5094 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5095 is also specified.
5096
5097- CONFIG_SYS_LS_MC_FW_LENGTH
5098 The maximum possible size of the firmware. The firmware binary format
5099 has a field that specifies the actual size of the firmware, but it
5100 might not be possible to read any part of the firmware unless some
5101 local storage is allocated to hold the entire firmware first.
5102
5103- CONFIG_SYS_LS_MC_FW_IN_NOR
5104 Specifies that MC firmware is located in NOR flash, mapped as
5105 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5106 virtual address in NOR flash.
5107
wdenkc6097192002-11-03 00:24:07 +00005108Building the Software:
5109======================
5110
Wolfgang Denk218ca722008-03-26 10:40:12 +01005111Building U-Boot has been tested in several native build environments
5112and in many different cross environments. Of course we cannot support
5113all possibly existing versions of cross development tools in all
5114(potentially obsolete) versions. In case of tool chain problems we
5115recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5116which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005117
Wolfgang Denk218ca722008-03-26 10:40:12 +01005118If you are not using a native environment, it is assumed that you
5119have GNU cross compiling tools available in your path. In this case,
5120you must set the environment variable CROSS_COMPILE in your shell.
5121Note that no changes to the Makefile or any other source files are
5122necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005123
Wolfgang Denk218ca722008-03-26 10:40:12 +01005124 $ CROSS_COMPILE=ppc_4xx-
5125 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005126
Peter Tyser2f8d3962009-03-13 18:54:51 -05005127Note: If you wish to generate Windows versions of the utilities in
5128 the tools directory you can use the MinGW toolchain
5129 (http://www.mingw.org). Set your HOST tools to the MinGW
5130 toolchain and execute 'make tools'. For example:
5131
5132 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5133
5134 Binaries such as tools/mkimage.exe will be created which can
5135 be executed on computers running Windows.
5136
Wolfgang Denk218ca722008-03-26 10:40:12 +01005137U-Boot is intended to be simple to build. After installing the
5138sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005139is done by typing:
5140
Holger Freytherab584d62014-08-04 09:26:05 +02005141 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005142
Holger Freytherab584d62014-08-04 09:26:05 +02005143where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005144rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005145
wdenk2729af92004-05-03 20:45:30 +00005146Note: for some board special configuration names may exist; check if
5147 additional information is available from the board vendor; for
5148 instance, the TQM823L systems are available without (standard)
5149 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005150 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005151
Holger Freytherab584d62014-08-04 09:26:05 +02005152 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005153 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005154
Holger Freytherab584d62014-08-04 09:26:05 +02005155 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005156 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk2729af92004-05-03 20:45:30 +00005158 etc.
wdenkc6097192002-11-03 00:24:07 +00005159
wdenkc6097192002-11-03 00:24:07 +00005160
wdenk2729af92004-05-03 20:45:30 +00005161Finally, type "make all", and you should get some working U-Boot
5162images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164- "u-boot.bin" is a raw binary image
5165- "u-boot" is an image in ELF binary format
5166- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005167
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005168By default the build is performed locally and the objects are saved
5169in the source directory. One of the two methods can be used to change
5170this behavior and build U-Boot to some external directory:
5171
51721. Add O= to the make command line invocations:
5173
5174 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005175 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005176 make O=/tmp/build all
5177
Timo Ketolaadbba992014-11-06 14:39:05 +020051782. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005179
Timo Ketolaadbba992014-11-06 14:39:05 +02005180 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005181 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005182 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005183 make all
5184
Timo Ketolaadbba992014-11-06 14:39:05 +02005185Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005186variable.
5187
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk2729af92004-05-03 20:45:30 +00005189Please be aware that the Makefiles assume you are using GNU make, so
5190for instance on NetBSD you might need to use "gmake" instead of
5191native "make".
wdenkc6097192002-11-03 00:24:07 +00005192
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk2729af92004-05-03 20:45:30 +00005194If the system board that you have is not listed, then you will need
5195to port U-Boot to your hardware platform. To do this, follow these
5196steps:
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +000051981. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005199 "boards.cfg" file, using the existing entries as examples.
5200 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000052012. Create a new directory to hold your board specific code. Add any
5202 files you need. In your board directory, you will need at least
5203 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
52043. Create a new configuration file "include/configs/<board>.h" for
5205 your board
52063. If you're porting U-Boot to a new CPU, then also create a new
5207 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020052084. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000052095. Type "make", and you should get a working "u-boot.srec" file
5210 to be installed on your target system.
52116. Debug and solve any problems that might arise.
5212 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005213
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk2729af92004-05-03 20:45:30 +00005215Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5216==============================================================
wdenkc6097192002-11-03 00:24:07 +00005217
Wolfgang Denk218ca722008-03-26 10:40:12 +01005218If you have modified U-Boot sources (for instance added a new board
5219or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005220provide feedback to the other developers. The feedback normally takes
5221the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005222official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005223
Wolfgang Denk218ca722008-03-26 10:40:12 +01005224But before you submit such a patch, please verify that your modifi-
5225cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005226the supported boards compile WITHOUT ANY compiler warnings. To do so,
5227just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005228for ALL supported system. Be warned, this will take a while. You can
5229select which (cross) compiler to use by passing a `CROSS_COMPILE'
5230environment variable to the script, i. e. to use the ELDK cross tools
5231you can type
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk2729af92004-05-03 20:45:30 +00005233 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk2729af92004-05-03 20:45:30 +00005235or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk2729af92004-05-03 20:45:30 +00005237 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005238
Wolfgang Denk218ca722008-03-26 10:40:12 +01005239When using the MAKEALL script, the default behaviour is to build
5240U-Boot in the source directory. This location can be changed by
5241setting the BUILD_DIR environment variable. Also, for each target
5242built, the MAKEALL script saves two log files (<target>.ERR and
5243<target>.MAKEALL) in the <source dir>/LOG directory. This default
5244location can be changed by setting the MAKEALL_LOGDIR environment
5245variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005246
5247 export BUILD_DIR=/tmp/build
5248 export MAKEALL_LOGDIR=/tmp/log
5249 CROSS_COMPILE=ppc_8xx- MAKEALL
5250
Wolfgang Denk218ca722008-03-26 10:40:12 +01005251With the above settings build objects are saved in the /tmp/build,
5252log files are saved in the /tmp/log and the source tree remains clean
5253during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005254
5255
wdenk2729af92004-05-03 20:45:30 +00005256See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005257
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk2729af92004-05-03 20:45:30 +00005259Monitor Commands - Overview:
5260============================
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262go - start application at address 'addr'
5263run - run commands in an environment variable
5264bootm - boot application image from memory
5265bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005266bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005267tftpboot- boot image via network using TFTP protocol
5268 and env variables "ipaddr" and "serverip"
5269 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005270tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005271rarpboot- boot image via network using RARP/TFTP protocol
5272diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5273loads - load S-Record file over serial line
5274loadb - load binary file over serial line (kermit mode)
5275md - memory display
5276mm - memory modify (auto-incrementing)
5277nm - memory modify (constant address)
5278mw - memory write (fill)
5279cp - memory copy
5280cmp - memory compare
5281crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005282i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005283sspi - SPI utility commands
5284base - print or set address offset
5285printenv- print environment variables
5286setenv - set environment variables
5287saveenv - save environment variables to persistent storage
5288protect - enable or disable FLASH write protection
5289erase - erase FLASH memory
5290flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005291nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005292bdinfo - print Board Info structure
5293iminfo - print header information for application image
5294coninfo - print console devices and informations
5295ide - IDE sub-system
5296loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005297loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005298mtest - simple RAM test
5299icache - enable or disable instruction cache
5300dcache - enable or disable data cache
5301reset - Perform RESET of the CPU
5302echo - echo args to console
5303version - print monitor version
5304help - print online help
5305? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005306
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308Monitor Commands - Detailed Description:
5309========================================
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk2729af92004-05-03 20:45:30 +00005311TODO.
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005314
5315
wdenk2729af92004-05-03 20:45:30 +00005316Environment Variables:
5317======================
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk2729af92004-05-03 20:45:30 +00005319U-Boot supports user configuration using Environment Variables which
5320can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk2729af92004-05-03 20:45:30 +00005322Environment Variables are set using "setenv", printed using
5323"printenv", and saved to Flash using "saveenv". Using "setenv"
5324without a value can be used to delete a variable from the
5325environment. As long as you don't save the environment you are
5326working with an in-memory copy. In case the Flash area containing the
5327environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005328
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005329Some configuration options can be set using Environment Variables.
5330
5331List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk2729af92004-05-03 20:45:30 +00005333 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk2729af92004-05-03 20:45:30 +00005335 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk2729af92004-05-03 20:45:30 +00005337 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk2729af92004-05-03 20:45:30 +00005339 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005342
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005343 bootm_low - Memory range available for image processing in the bootm
5344 command can be restricted. This variable is given as
5345 a hexadecimal number and defines lowest address allowed
5346 for use by the bootm command. See also "bootm_size"
5347 environment variable. Address defined by "bootm_low" is
5348 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005349 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5350 bootm_mapsize.
5351
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005352 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005353 This variable is given as a hexadecimal number and it
5354 defines the size of the memory region starting at base
5355 address bootm_low that is accessible by the Linux kernel
5356 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5357 as the default value if it is defined, and bootm_size is
5358 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005359
5360 bootm_size - Memory range available for image processing in the bootm
5361 command can be restricted. This variable is given as
5362 a hexadecimal number and defines the size of the region
5363 allowed for use by the bootm command. See also "bootm_low"
5364 environment variable.
5365
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005366 updatefile - Location of the software update file on a TFTP server, used
5367 by the automatic software update feature. Please refer to
5368 documentation in doc/README.update for more details.
5369
wdenk2729af92004-05-03 20:45:30 +00005370 autoload - if set to "no" (any string beginning with 'n'),
5371 "bootp" will just load perform a lookup of the
5372 configuration from the BOOTP server, but not try to
5373 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375 autostart - if set to "yes", an image loaded using the "bootp",
5376 "rarpboot", "tftpboot" or "diskboot" commands will
5377 be automatically started (by internally calling
5378 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380 If set to "no", a standalone image passed to the
5381 "bootm" command will be copied to the load address
5382 (and eventually uncompressed), but NOT be started.
5383 This can be used to load and uncompress arbitrary
5384 data.
wdenkc6097192002-11-03 00:24:07 +00005385
David A. Longa28afca2011-07-09 16:40:19 -04005386 fdt_high - if set this restricts the maximum address that the
5387 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005388 For example, if you have a system with 1 GB memory
5389 at physical address 0x10000000, while Linux kernel
5390 only recognizes the first 704 MB as low memory, you
5391 may need to set fdt_high as 0x3C000000 to have the
5392 device tree blob be copied to the maximum address
5393 of the 704 MB low memory, so that Linux kernel can
5394 access it during the boot procedure.
5395
David A. Longa28afca2011-07-09 16:40:19 -04005396 If this is set to the special value 0xFFFFFFFF then
5397 the fdt will not be copied at all on boot. For this
5398 to work it must reside in writable memory, have
5399 sufficient padding on the end of it for u-boot to
5400 add the information it needs into it, and the memory
5401 must be accessible by the kernel.
5402
Simon Glasseea63e02011-10-24 19:15:34 +00005403 fdtcontroladdr- if set this is the address of the control flattened
5404 device tree used by U-Boot when CONFIG_OF_CONTROL is
5405 defined.
5406
wdenk17ea1172004-06-06 21:51:03 +00005407 i2cfast - (PPC405GP|PPC405EP only)
5408 if set to 'y' configures Linux I2C driver for fast
5409 mode (400kHZ). This environment variable is used in
5410 initialization code. So, for changes to be effective
5411 it must be saved and board must be reset.
5412
wdenk2729af92004-05-03 20:45:30 +00005413 initrd_high - restrict positioning of initrd images:
5414 If this variable is not set, initrd images will be
5415 copied to the highest possible address in RAM; this
5416 is usually what you want since it allows for
5417 maximum initrd size. If for some reason you want to
5418 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005419 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005420 variable to a value of "no" or "off" or "0".
5421 Alternatively, you can set it to a maximum upper
5422 address to use (U-Boot will still check that it
5423 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005424
wdenk2729af92004-05-03 20:45:30 +00005425 For instance, when you have a system with 16 MB
5426 RAM, and want to reserve 4 MB from use by Linux,
5427 you can do this by adding "mem=12M" to the value of
5428 the "bootargs" variable. However, now you must make
5429 sure that the initrd image is placed in the first
5430 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk2729af92004-05-03 20:45:30 +00005432 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk2729af92004-05-03 20:45:30 +00005434 If you set initrd_high to 0xFFFFFFFF, this is an
5435 indication to U-Boot that all addresses are legal
5436 for the Linux kernel, including addresses in flash
5437 memory. In this case U-Boot will NOT COPY the
5438 ramdisk at all. This may be useful to reduce the
5439 boot time on your system, but requires that this
5440 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005441
wdenk2729af92004-05-03 20:45:30 +00005442 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk2729af92004-05-03 20:45:30 +00005444 loadaddr - Default load address for commands like "bootp",
5445 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005446
wdenk2729af92004-05-03 20:45:30 +00005447 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005448
wdenk2729af92004-05-03 20:45:30 +00005449 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005450
wdenk2729af92004-05-03 20:45:30 +00005451 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005452
wdenk2729af92004-05-03 20:45:30 +00005453 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk2729af92004-05-03 20:45:30 +00005455 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005456
Mike Frysingere2a53452011-10-02 10:01:27 +00005457 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005458
Mike Frysingere2a53452011-10-02 10:01:27 +00005459 ethact - controls which interface is currently active.
5460 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005461
Heiko Schocher48690d82010-07-20 17:45:02 +02005462 => setenv ethact FEC
5463 => ping 192.168.0.1 # traffic sent on FEC
5464 => setenv ethact SCC
5465 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005466
Matthias Fuchse1692572008-01-17 07:45:05 +01005467 ethrotate - When set to "no" U-Boot does not go through all
5468 available network interfaces.
5469 It just stays at the currently selected interface.
5470
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005471 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005472 either succeed or fail without retrying.
5473 When set to "once" the network operation will
5474 fail when all the available network interfaces
5475 are tried once without success.
5476 Useful on scripts which control the retry operation
5477 themselves.
wdenkc6097192002-11-03 00:24:07 +00005478
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005479 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005480
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005481 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005482 changing the console to be empty. If "yes" it will be
5483 made silent. If "no" it will not be made silent. If
5484 unset, then it will be made silent if the U-Boot console
5485 is silent.
5486
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005487 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005488 UDP source port.
5489
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005490 tftpdstport - If this is set, the value is used for TFTP's UDP
5491 destination port instead of the Well Know Port 69.
5492
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005493 tftpblocksize - Block size to use for TFTP transfers; if not set,
5494 we use the TFTP server's default block size
5495
5496 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5497 seconds, minimum value is 1000 = 1 second). Defines
5498 when a packet is considered to be lost so it has to
5499 be retransmitted. The default is 5000 = 5 seconds.
5500 Lowering this value may make downloads succeed
5501 faster in networks with high packet loss rates or
5502 with unreliable TFTP servers.
5503
5504 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005505 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005506 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005507
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005508The following image location variables contain the location of images
5509used in booting. The "Image" column gives the role of the image and is
5510not an environment variable name. The other columns are environment
5511variable names. "File Name" gives the name of the file on a TFTP
5512server, "RAM Address" gives the location in RAM the image will be
5513loaded to, and "Flash Location" gives the image's address in NOR
5514flash or offset in NAND flash.
5515
5516*Note* - these variables don't have to be defined for all boards, some
5517boards currenlty use other variables for these purposes, and some
5518boards use these variables for other purposes.
5519
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005520Image File Name RAM Address Flash Location
5521----- --------- ----------- --------------
5522u-boot u-boot u-boot_addr_r u-boot_addr
5523Linux kernel bootfile kernel_addr_r kernel_addr
5524device tree blob fdtfile fdt_addr_r fdt_addr
5525ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005526
wdenk2729af92004-05-03 20:45:30 +00005527The following environment variables may be used and automatically
5528updated by the network boot commands ("bootp" and "rarpboot"),
5529depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531 bootfile - see above
5532 dnsip - IP address of your Domain Name Server
5533 dnsip2 - IP address of your secondary Domain Name Server
5534 gatewayip - IP address of the Gateway (Router) to use
5535 hostname - Target hostname
5536 ipaddr - see above
5537 netmask - Subnet Mask
5538 rootpath - Pathname of the root filesystem on the NFS server
5539 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005540
wdenka3d991b2004-04-15 21:48:45 +00005541
wdenk2729af92004-05-03 20:45:30 +00005542There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544 serial# - contains hardware identification information such
5545 as type string and/or serial number
5546 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk2729af92004-05-03 20:45:30 +00005548These variables can be set only once (usually during manufacturing of
5549the board). U-Boot refuses to delete or overwrite these variables
5550once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005551
5552
wdenk2729af92004-05-03 20:45:30 +00005553Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk2729af92004-05-03 20:45:30 +00005555 ver - Contains the U-Boot version string as printed
5556 with the "version" command. This variable is
5557 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005558
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk2729af92004-05-03 20:45:30 +00005560Please note that changes to some configuration parameters may take
5561only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005562
stroesec1551ea2003-04-04 15:53:41 +00005563
Joe Hershberger170ab112012-12-11 22:16:24 -06005564Callback functions for environment variables:
5565---------------------------------------------
5566
5567For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005568when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005569be associated with arbitrary variables. On creation, overwrite, or
5570deletion, the callback will provide the opportunity for some side
5571effect to happen or for the change to be rejected.
5572
5573The callbacks are named and associated with a function using the
5574U_BOOT_ENV_CALLBACK macro in your board or driver code.
5575
5576These callbacks are associated with variables in one of two ways. The
5577static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5578in the board configuration to a string that defines a list of
5579associations. The list must be in the following format:
5580
5581 entry = variable_name[:callback_name]
5582 list = entry[,list]
5583
5584If the callback name is not specified, then the callback is deleted.
5585Spaces are also allowed anywhere in the list.
5586
5587Callbacks can also be associated by defining the ".callbacks" variable
5588with the same list format above. Any association in ".callbacks" will
5589override any association in the static list. You can define
5590CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005591".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005592
5593
wdenk2729af92004-05-03 20:45:30 +00005594Command Line Parsing:
5595=====================
stroesec1551ea2003-04-04 15:53:41 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597There are two different command line parsers available with U-Boot:
5598the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005599
wdenk2729af92004-05-03 20:45:30 +00005600Old, simple command line parser:
5601--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk2729af92004-05-03 20:45:30 +00005603- supports environment variables (through setenv / saveenv commands)
5604- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005605- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005606- special characters ('$', ';') can be escaped by prefixing with '\',
5607 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005608 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005609- You can also escape text by enclosing in single apostrophes, for example:
5610 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005611
wdenk2729af92004-05-03 20:45:30 +00005612Hush shell:
5613-----------
wdenkf07771c2003-05-28 08:06:31 +00005614
wdenk2729af92004-05-03 20:45:30 +00005615- similar to Bourne shell, with control structures like
5616 if...then...else...fi, for...do...done; while...do...done,
5617 until...do...done, ...
5618- supports environment ("global") variables (through setenv / saveenv
5619 commands) and local shell variables (through standard shell syntax
5620 "name=value"); only environment variables can be used with "run"
5621 command
wdenkf07771c2003-05-28 08:06:31 +00005622
wdenk2729af92004-05-03 20:45:30 +00005623General rules:
5624--------------
wdenkf07771c2003-05-28 08:06:31 +00005625
wdenk2729af92004-05-03 20:45:30 +00005626(1) If a command line (or an environment variable executed by a "run"
5627 command) contains several commands separated by semicolon, and
5628 one of these commands fails, then the remaining commands will be
5629 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005630
wdenk2729af92004-05-03 20:45:30 +00005631(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005632 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005633 command will cause "run" to terminate, i. e. the remaining
5634 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636Note for Redundant Ethernet Interfaces:
5637=======================================
wdenkf07771c2003-05-28 08:06:31 +00005638
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005639Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005640such configurations and is capable of automatic selection of a
5641"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005642
wdenk2729af92004-05-03 20:45:30 +00005643Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5644MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5645"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647If the network interface stores some valid MAC address (for instance
5648in SROM), this is used as default address if there is NO correspon-
5649ding setting in the environment; if the corresponding environment
5650variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652o If the SROM has a valid MAC address, and there is no address in the
5653 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655o If there is no valid address in the SROM, and a definition in the
5656 environment exists, then the value from the environment variable is
5657 used.
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk2729af92004-05-03 20:45:30 +00005659o If both the SROM and the environment contain a MAC address, and
5660 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk2729af92004-05-03 20:45:30 +00005662o If both the SROM and the environment contain a MAC address, and the
5663 addresses differ, the value from the environment is used and a
5664 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk2729af92004-05-03 20:45:30 +00005666o If neither SROM nor the environment contain a MAC address, an error
5667 is raised.
wdenkc6097192002-11-03 00:24:07 +00005668
Ben Warrenecee9322010-04-26 11:11:46 -07005669If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005670will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005671may be skipped by setting the appropriate 'ethmacskip' environment variable.
5672The naming convention is as follows:
5673"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk2729af92004-05-03 20:45:30 +00005675Image Formats:
5676==============
wdenkc6097192002-11-03 00:24:07 +00005677
Marian Balakowicz3310c542008-03-12 12:13:13 +01005678U-Boot is capable of booting (and performing other auxiliary operations on)
5679images in two formats:
5680
5681New uImage format (FIT)
5682-----------------------
5683
5684Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5685to Flattened Device Tree). It allows the use of images with multiple
5686components (several kernels, ramdisks, etc.), with contents protected by
5687SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5688
5689
5690Old uImage format
5691-----------------
5692
5693Old image format is based on binary files which can be basically anything,
5694preceded by a special header; see the definitions in include/image.h for
5695details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk2729af92004-05-03 20:45:30 +00005697* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5698 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005699 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5700 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5701 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005702* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005703 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5704 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005705* Compression Type (uncompressed, gzip, bzip2)
5706* Load Address
5707* Entry Point
5708* Image Name
5709* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711The header is marked by a special Magic Number, and both the header
5712and the data portions of the image are secured against corruption by
5713CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005714
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk2729af92004-05-03 20:45:30 +00005716Linux Support:
5717==============
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk2729af92004-05-03 20:45:30 +00005719Although U-Boot should support any OS or standalone application
5720easily, the main focus has always been on Linux during the design of
5721U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723U-Boot includes many features that so far have been part of some
5724special "boot loader" code within the Linux kernel. Also, any
5725"initrd" images to be used are no longer part of one big Linux image;
5726instead, kernel and "initrd" are separate images. This implementation
5727serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk2729af92004-05-03 20:45:30 +00005729- the same features can be used for other OS or standalone
5730 applications (for instance: using compressed images to reduce the
5731 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733- it becomes much easier to port new Linux kernel versions because
5734 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736- the same Linux kernel image can now be used with different "initrd"
5737 images; of course this also means that different kernel images can
5738 be run with the same "initrd". This makes testing easier (you don't
5739 have to build a new "zImage.initrd" Linux image when you just
5740 change a file in your "initrd"). Also, a field-upgrade of the
5741 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005742
wdenkc6097192002-11-03 00:24:07 +00005743
wdenk2729af92004-05-03 20:45:30 +00005744Linux HOWTO:
5745============
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747Porting Linux to U-Boot based systems:
5748---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk2729af92004-05-03 20:45:30 +00005750U-Boot cannot save you from doing all the necessary modifications to
5751configure the Linux device drivers for use with your target hardware
5752(no, we don't intend to provide a full virtual machine interface to
5753Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005754
Stefan Roesea47a12b2010-04-15 16:07:28 +02005755But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk2729af92004-05-03 20:45:30 +00005757Just make sure your machine specific header file (for instance
5758include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005759Information structure as we define in include/asm-<arch>/u-boot.h,
5760and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005761as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005762
Simon Glass2eb31b12014-06-11 23:29:46 -06005763Note that U-Boot now has a driver model, a unified model for drivers.
5764If you are adding a new driver, plumb it into driver model. If there
5765is no uclass available, you are encouraged to create one. See
5766doc/driver-model.
5767
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk2729af92004-05-03 20:45:30 +00005769Configuring the Linux kernel:
5770-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk2729af92004-05-03 20:45:30 +00005772No specific requirements for U-Boot. Make sure you have some root
5773device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005774
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk2729af92004-05-03 20:45:30 +00005776Building a Linux Image:
5777-----------------------
wdenkc6097192002-11-03 00:24:07 +00005778
wdenk2729af92004-05-03 20:45:30 +00005779With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5780not used. If you use recent kernel source, a new build target
5781"uImage" will exist which automatically builds an image usable by
5782U-Boot. Most older kernels also have support for a "pImage" target,
5783which was introduced for our predecessor project PPCBoot and uses a
5784100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005785
wdenk2729af92004-05-03 20:45:30 +00005786Example:
wdenkc6097192002-11-03 00:24:07 +00005787
Holger Freytherab584d62014-08-04 09:26:05 +02005788 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005789 make oldconfig
5790 make dep
5791 make uImage
wdenkc6097192002-11-03 00:24:07 +00005792
wdenk2729af92004-05-03 20:45:30 +00005793The "uImage" build target uses a special tool (in 'tools/mkimage') to
5794encapsulate a compressed Linux kernel image with header information,
5795CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk2729af92004-05-03 20:45:30 +00005797* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005798
wdenk2729af92004-05-03 20:45:30 +00005799* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk2729af92004-05-03 20:45:30 +00005801 ${CROSS_COMPILE}-objcopy -O binary \
5802 -R .note -R .comment \
5803 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk2729af92004-05-03 20:45:30 +00005807 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk2729af92004-05-03 20:45:30 +00005809* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811 mkimage -A ppc -O linux -T kernel -C gzip \
5812 -a 0 -e 0 -n "Linux Kernel Image" \
5813 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005814
wdenk24ee89b2002-11-03 17:56:27 +00005815
wdenk2729af92004-05-03 20:45:30 +00005816The "mkimage" tool can also be used to create ramdisk images for use
5817with U-Boot, either separated from the Linux kernel image, or
5818combined into one file. "mkimage" encapsulates the images with a 64
5819byte header containing information about target architecture,
5820operating system, image type, compression method, entry points, time
5821stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005822
wdenk2729af92004-05-03 20:45:30 +00005823"mkimage" can be called in two ways: to verify existing images and
5824print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005825
wdenk2729af92004-05-03 20:45:30 +00005826In the first form (with "-l" option) mkimage lists the information
5827contained in the header of an existing U-Boot image; this includes
5828checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005829
wdenk2729af92004-05-03 20:45:30 +00005830 tools/mkimage -l image
5831 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005832
wdenk2729af92004-05-03 20:45:30 +00005833The second form (with "-d" option) is used to build a U-Boot image
5834from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005835
wdenk2729af92004-05-03 20:45:30 +00005836 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5837 -n name -d data_file image
5838 -A ==> set architecture to 'arch'
5839 -O ==> set operating system to 'os'
5840 -T ==> set image type to 'type'
5841 -C ==> set compression type 'comp'
5842 -a ==> set load address to 'addr' (hex)
5843 -e ==> set entry point to 'ep' (hex)
5844 -n ==> set image name to 'name'
5845 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005846
wdenk69459792004-05-29 16:53:29 +00005847Right now, all Linux kernels for PowerPC systems use the same load
5848address (0x00000000), but the entry point address depends on the
5849kernel version:
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk2729af92004-05-03 20:45:30 +00005851- 2.2.x kernels have the entry point at 0x0000000C,
5852- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk2729af92004-05-03 20:45:30 +00005854So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk2729af92004-05-03 20:45:30 +00005856 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5857 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005858 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005859 > examples/uImage.TQM850L
5860 Image Name: 2.4.4 kernel for TQM850L
5861 Created: Wed Jul 19 02:34:59 2000
5862 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5863 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5864 Load Address: 0x00000000
5865 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk2729af92004-05-03 20:45:30 +00005867To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005868
wdenk2729af92004-05-03 20:45:30 +00005869 -> tools/mkimage -l examples/uImage.TQM850L
5870 Image Name: 2.4.4 kernel for TQM850L
5871 Created: Wed Jul 19 02:34:59 2000
5872 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5873 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5874 Load Address: 0x00000000
5875 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk2729af92004-05-03 20:45:30 +00005877NOTE: for embedded systems where boot time is critical you can trade
5878speed for memory and install an UNCOMPRESSED image instead: this
5879needs more space in Flash, but boots much faster since it does not
5880need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005881
Stefan Roesea47a12b2010-04-15 16:07:28 +02005882 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005883 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5884 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005885 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005886 > examples/uImage.TQM850L-uncompressed
5887 Image Name: 2.4.4 kernel for TQM850L
5888 Created: Wed Jul 19 02:34:59 2000
5889 Image Type: PowerPC Linux Kernel Image (uncompressed)
5890 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5891 Load Address: 0x00000000
5892 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005893
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk2729af92004-05-03 20:45:30 +00005895Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5896when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005897
wdenk2729af92004-05-03 20:45:30 +00005898 -> tools/mkimage -n 'Simple Ramdisk Image' \
5899 > -A ppc -O linux -T ramdisk -C gzip \
5900 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5901 Image Name: Simple Ramdisk Image
5902 Created: Wed Jan 12 14:01:50 2000
5903 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5904 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5905 Load Address: 0x00000000
5906 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005907
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005908The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5909option performs the converse operation of the mkimage's second form (the "-d"
5910option). Given an image built by mkimage, the dumpimage extracts a "data file"
5911from the image:
5912
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005913 tools/dumpimage -i image -T type -p position data_file
5914 -i ==> extract from the 'image' a specific 'data_file'
5915 -T ==> set image type to 'type'
5916 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005917
wdenkdb01a2e2004-04-15 23:14:49 +00005918
wdenk2729af92004-05-03 20:45:30 +00005919Installing a Linux Image:
5920-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005921
wdenk2729af92004-05-03 20:45:30 +00005922To downloading a U-Boot image over the serial (console) interface,
5923you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005924
wdenk2729af92004-05-03 20:45:30 +00005925 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005926
wdenk2729af92004-05-03 20:45:30 +00005927The 'objcopy' does not understand the information in the U-Boot
5928image header, so the resulting S-Record file will be relative to
5929address 0x00000000. To load it to a given address, you need to
5930specify the target address as 'offset' parameter with the 'loads'
5931command.
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk2729af92004-05-03 20:45:30 +00005933Example: install the image to address 0x40100000 (which on the
5934TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk2729af92004-05-03 20:45:30 +00005936 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005937
wdenk2729af92004-05-03 20:45:30 +00005938 .......... done
5939 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk2729af92004-05-03 20:45:30 +00005941 => loads 40100000
5942 ## Ready for S-Record download ...
5943 ~>examples/image.srec
5944 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5945 ...
5946 15989 15990 15991 15992
5947 [file transfer complete]
5948 [connected]
5949 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005950
5951
wdenk2729af92004-05-03 20:45:30 +00005952You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005953this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005954corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005955
wdenk2729af92004-05-03 20:45:30 +00005956 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005957
wdenk2729af92004-05-03 20:45:30 +00005958 ## Checking Image at 40100000 ...
5959 Image Name: 2.2.13 for initrd on TQM850L
5960 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5961 Data Size: 335725 Bytes = 327 kB = 0 MB
5962 Load Address: 00000000
5963 Entry Point: 0000000c
5964 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005965
5966
wdenk2729af92004-05-03 20:45:30 +00005967Boot Linux:
5968-----------
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk2729af92004-05-03 20:45:30 +00005970The "bootm" command is used to boot an application that is stored in
5971memory (RAM or Flash). In case of a Linux kernel image, the contents
5972of the "bootargs" environment variable is passed to the kernel as
5973parameters. You can check and modify this variable using the
5974"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005975
5976
wdenk2729af92004-05-03 20:45:30 +00005977 => printenv bootargs
5978 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005979
wdenk2729af92004-05-03 20:45:30 +00005980 => 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 +00005981
wdenk2729af92004-05-03 20:45:30 +00005982 => printenv bootargs
5983 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 +00005984
wdenk2729af92004-05-03 20:45:30 +00005985 => bootm 40020000
5986 ## Booting Linux kernel at 40020000 ...
5987 Image Name: 2.2.13 for NFS on TQM850L
5988 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5989 Data Size: 381681 Bytes = 372 kB = 0 MB
5990 Load Address: 00000000
5991 Entry Point: 0000000c
5992 Verifying Checksum ... OK
5993 Uncompressing Kernel Image ... OK
5994 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
5995 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5996 time_init: decrementer frequency = 187500000/60
5997 Calibrating delay loop... 49.77 BogoMIPS
5998 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5999 ...
wdenkc6097192002-11-03 00:24:07 +00006000
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006001If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00006002the memory addresses of both the kernel and the initrd image (PPBCOOT
6003format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00006004
wdenk2729af92004-05-03 20:45:30 +00006005 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk2729af92004-05-03 20:45:30 +00006007 ## Checking Image at 40100000 ...
6008 Image Name: 2.2.13 for initrd on TQM850L
6009 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6010 Data Size: 335725 Bytes = 327 kB = 0 MB
6011 Load Address: 00000000
6012 Entry Point: 0000000c
6013 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006014
wdenk2729af92004-05-03 20:45:30 +00006015 ## Checking Image at 40200000 ...
6016 Image Name: Simple Ramdisk Image
6017 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6018 Data Size: 566530 Bytes = 553 kB = 0 MB
6019 Load Address: 00000000
6020 Entry Point: 00000000
6021 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00006022
wdenk2729af92004-05-03 20:45:30 +00006023 => bootm 40100000 40200000
6024 ## Booting Linux kernel at 40100000 ...
6025 Image Name: 2.2.13 for initrd on TQM850L
6026 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6027 Data Size: 335725 Bytes = 327 kB = 0 MB
6028 Load Address: 00000000
6029 Entry Point: 0000000c
6030 Verifying Checksum ... OK
6031 Uncompressing Kernel Image ... OK
6032 ## Loading RAMDisk Image at 40200000 ...
6033 Image Name: Simple Ramdisk Image
6034 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6035 Data Size: 566530 Bytes = 553 kB = 0 MB
6036 Load Address: 00000000
6037 Entry Point: 00000000
6038 Verifying Checksum ... OK
6039 Loading Ramdisk ... OK
6040 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
6041 Boot arguments: root=/dev/ram
6042 time_init: decrementer frequency = 187500000/60
6043 Calibrating delay loop... 49.77 BogoMIPS
6044 ...
6045 RAMDISK: Compressed image found at block 0
6046 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk2729af92004-05-03 20:45:30 +00006048 bash#
wdenkc6097192002-11-03 00:24:07 +00006049
Matthew McClintock02677682006-06-28 10:41:37 -05006050Boot Linux and pass a flat device tree:
6051-----------
6052
6053First, U-Boot must be compiled with the appropriate defines. See the section
6054titled "Linux Kernel Interface" above for a more in depth explanation. The
6055following is an example of how to start a kernel and pass an updated
6056flat device tree:
6057
6058=> print oftaddr
6059oftaddr=0x300000
6060=> print oft
6061oft=oftrees/mpc8540ads.dtb
6062=> tftp $oftaddr $oft
6063Speed: 1000, full duplex
6064Using TSEC0 device
6065TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6066Filename 'oftrees/mpc8540ads.dtb'.
6067Load address: 0x300000
6068Loading: #
6069done
6070Bytes transferred = 4106 (100a hex)
6071=> tftp $loadaddr $bootfile
6072Speed: 1000, full duplex
6073Using TSEC0 device
6074TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6075Filename 'uImage'.
6076Load address: 0x200000
6077Loading:############
6078done
6079Bytes transferred = 1029407 (fb51f hex)
6080=> print loadaddr
6081loadaddr=200000
6082=> print oftaddr
6083oftaddr=0x300000
6084=> bootm $loadaddr - $oftaddr
6085## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006086 Image Name: Linux-2.6.17-dirty
6087 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6088 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006089 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006090 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006091 Verifying Checksum ... OK
6092 Uncompressing Kernel Image ... OK
6093Booting using flat device tree at 0x300000
6094Using MPC85xx ADS machine description
6095Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6096[snip]
6097
6098
wdenk2729af92004-05-03 20:45:30 +00006099More About U-Boot Image Types:
6100------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006101
wdenk2729af92004-05-03 20:45:30 +00006102U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006103
wdenk2729af92004-05-03 20:45:30 +00006104 "Standalone Programs" are directly runnable in the environment
6105 provided by U-Boot; it is expected that (if they behave
6106 well) you can continue to work in U-Boot after return from
6107 the Standalone Program.
6108 "OS Kernel Images" are usually images of some Embedded OS which
6109 will take over control completely. Usually these programs
6110 will install their own set of exception handlers, device
6111 drivers, set up the MMU, etc. - this means, that you cannot
6112 expect to re-enter U-Boot except by resetting the CPU.
6113 "RAMDisk Images" are more or less just data blocks, and their
6114 parameters (address, size) are passed to an OS kernel that is
6115 being started.
6116 "Multi-File Images" contain several images, typically an OS
6117 (Linux) kernel image and one or more data images like
6118 RAMDisks. This construct is useful for instance when you want
6119 to boot over the network using BOOTP etc., where the boot
6120 server provides just a single image file, but you want to get
6121 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006122
wdenk2729af92004-05-03 20:45:30 +00006123 "Multi-File Images" start with a list of image sizes, each
6124 image size (in bytes) specified by an "uint32_t" in network
6125 byte order. This list is terminated by an "(uint32_t)0".
6126 Immediately after the terminating 0 follow the images, one by
6127 one, all aligned on "uint32_t" boundaries (size rounded up to
6128 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006129
wdenk2729af92004-05-03 20:45:30 +00006130 "Firmware Images" are binary images containing firmware (like
6131 U-Boot or FPGA images) which usually will be programmed to
6132 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006133
wdenk2729af92004-05-03 20:45:30 +00006134 "Script files" are command sequences that will be executed by
6135 U-Boot's command interpreter; this feature is especially
6136 useful when you configure U-Boot to use a real shell (hush)
6137 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006138
Marek Vasut44f074c2012-03-14 21:52:45 +00006139Booting the Linux zImage:
6140-------------------------
6141
6142On some platforms, it's possible to boot Linux zImage. This is done
6143using the "bootz" command. The syntax of "bootz" command is the same
6144as the syntax of "bootm" command.
6145
Tom Rini8ac28562013-05-16 11:40:11 -04006146Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006147kernel with raw initrd images. The syntax is slightly different, the
6148address of the initrd must be augmented by it's size, in the following
6149format: "<initrd addres>:<initrd size>".
6150
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk2729af92004-05-03 20:45:30 +00006152Standalone HOWTO:
6153=================
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk2729af92004-05-03 20:45:30 +00006155One of the features of U-Boot is that you can dynamically load and
6156run "standalone" applications, which can use some resources of
6157U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk2729af92004-05-03 20:45:30 +00006159Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006160
wdenk2729af92004-05-03 20:45:30 +00006161"Hello World" Demo:
6162-------------------
wdenkc6097192002-11-03 00:24:07 +00006163
wdenk2729af92004-05-03 20:45:30 +00006164'examples/hello_world.c' contains a small "Hello World" Demo
6165application; it is automatically compiled when you build U-Boot.
6166It's configured to run at address 0x00040004, so you can play with it
6167like that:
wdenkc6097192002-11-03 00:24:07 +00006168
wdenk2729af92004-05-03 20:45:30 +00006169 => loads
6170 ## Ready for S-Record download ...
6171 ~>examples/hello_world.srec
6172 1 2 3 4 5 6 7 8 9 10 11 ...
6173 [file transfer complete]
6174 [connected]
6175 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006176
wdenk2729af92004-05-03 20:45:30 +00006177 => go 40004 Hello World! This is a test.
6178 ## Starting application at 0x00040004 ...
6179 Hello World
6180 argc = 7
6181 argv[0] = "40004"
6182 argv[1] = "Hello"
6183 argv[2] = "World!"
6184 argv[3] = "This"
6185 argv[4] = "is"
6186 argv[5] = "a"
6187 argv[6] = "test."
6188 argv[7] = "<NULL>"
6189 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006190
wdenk2729af92004-05-03 20:45:30 +00006191 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006192
wdenk2729af92004-05-03 20:45:30 +00006193Another example, which demonstrates how to register a CPM interrupt
6194handler with the U-Boot code, can be found in 'examples/timer.c'.
6195Here, a CPM timer is set up to generate an interrupt every second.
6196The interrupt service routine is trivial, just printing a '.'
6197character, but this is just a demo program. The application can be
6198controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006199
wdenk2729af92004-05-03 20:45:30 +00006200 ? - print current values og the CPM Timer registers
6201 b - enable interrupts and start timer
6202 e - stop timer and disable interrupts
6203 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk2729af92004-05-03 20:45:30 +00006205 => loads
6206 ## Ready for S-Record download ...
6207 ~>examples/timer.srec
6208 1 2 3 4 5 6 7 8 9 10 11 ...
6209 [file transfer complete]
6210 [connected]
6211 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006212
wdenk2729af92004-05-03 20:45:30 +00006213 => go 40004
6214 ## Starting application at 0x00040004 ...
6215 TIMERS=0xfff00980
6216 Using timer 1
6217 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006218
wdenk2729af92004-05-03 20:45:30 +00006219Hit 'b':
6220 [q, b, e, ?] Set interval 1000000 us
6221 Enabling timer
6222Hit '?':
6223 [q, b, e, ?] ........
6224 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6225Hit '?':
6226 [q, b, e, ?] .
6227 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6228Hit '?':
6229 [q, b, e, ?] .
6230 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6231Hit '?':
6232 [q, b, e, ?] .
6233 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6234Hit 'e':
6235 [q, b, e, ?] ...Stopping timer
6236Hit 'q':
6237 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006238
6239
wdenk2729af92004-05-03 20:45:30 +00006240Minicom warning:
6241================
wdenk85ec0bc2003-03-31 16:34:49 +00006242
wdenk2729af92004-05-03 20:45:30 +00006243Over time, many people have reported problems when trying to use the
6244"minicom" terminal emulation program for serial download. I (wd)
6245consider minicom to be broken, and recommend not to use it. Under
6246Unix, I recommend to use C-Kermit for general purpose use (and
6247especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006248use "cu" for S-Record download ("loads" command). See
6249http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6250for help with kermit.
6251
wdenk85ec0bc2003-03-31 16:34:49 +00006252
wdenk2729af92004-05-03 20:45:30 +00006253Nevertheless, if you absolutely want to use it try adding this
6254configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006255
wdenk2729af92004-05-03 20:45:30 +00006256 Name Program Name U/D FullScr IO-Red. Multi
6257 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6258 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006259
6260
wdenk2729af92004-05-03 20:45:30 +00006261NetBSD Notes:
6262=============
wdenkc6097192002-11-03 00:24:07 +00006263
wdenk2729af92004-05-03 20:45:30 +00006264Starting at version 0.9.2, U-Boot supports NetBSD both as host
6265(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006266
wdenk2729af92004-05-03 20:45:30 +00006267Building requires a cross environment; it is known to work on
6268NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6269need gmake since the Makefiles are not compatible with BSD make).
6270Note that the cross-powerpc package does not install include files;
6271attempting to build U-Boot will fail because <machine/ansi.h> is
6272missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006273
wdenk2729af92004-05-03 20:45:30 +00006274 # cd /usr/pkg/cross/powerpc-netbsd/include
6275 # mkdir powerpc
6276 # ln -s powerpc machine
6277 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6278 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk2729af92004-05-03 20:45:30 +00006280Native builds *don't* work due to incompatibilities between native
6281and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk2729af92004-05-03 20:45:30 +00006283Booting assumes that (the first part of) the image booted is a
6284stage-2 loader which in turn loads and then invokes the kernel
6285proper. Loader sources will eventually appear in the NetBSD source
6286tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006287meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006288
6289
wdenk2729af92004-05-03 20:45:30 +00006290Implementation Internals:
6291=========================
wdenkc6097192002-11-03 00:24:07 +00006292
wdenk2729af92004-05-03 20:45:30 +00006293The following is not intended to be a complete description of every
6294implementation detail. However, it should help to understand the
6295inner workings of U-Boot and make it easier to port it to custom
6296hardware.
wdenkc6097192002-11-03 00:24:07 +00006297
6298
wdenk2729af92004-05-03 20:45:30 +00006299Initial Stack, Global Data:
6300---------------------------
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk2729af92004-05-03 20:45:30 +00006302The implementation of U-Boot is complicated by the fact that U-Boot
6303starts running out of ROM (flash memory), usually without access to
6304system RAM (because the memory controller is not initialized yet).
6305This means that we don't have writable Data or BSS segments, and BSS
6306is not initialized as zero. To be able to get a C environment working
6307at all, we have to allocate at least a minimal stack. Implementation
6308options for this are defined and restricted by the CPU used: Some CPU
6309models provide on-chip memory (like the IMMR area on MPC8xx and
6310MPC826x processors), on others (parts of) the data cache can be
6311locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006312
Wolfgang Denk218ca722008-03-26 10:40:12 +01006313 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006314 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006315
wdenk2729af92004-05-03 20:45:30 +00006316 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6317 From: "Chris Hallinan" <clh@net1plus.com>
6318 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6319 ...
wdenk43d96162003-03-06 00:02:04 +00006320
wdenk2729af92004-05-03 20:45:30 +00006321 Correct me if I'm wrong, folks, but the way I understand it
6322 is this: Using DCACHE as initial RAM for Stack, etc, does not
6323 require any physical RAM backing up the cache. The cleverness
6324 is that the cache is being used as a temporary supply of
6325 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006326 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006327 can see how this works by studying the cache architecture and
6328 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006329
wdenk2729af92004-05-03 20:45:30 +00006330 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6331 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006332 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006333 option should work for you. Using CS 4 should be fine if your
6334 board designers haven't used it for something that would
6335 cause you grief during the initial boot! It is frequently not
6336 used.
wdenk43d96162003-03-06 00:02:04 +00006337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006338 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006339 with your processor/board/system design. The default value
6340 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006341 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006342 than your SDRAM module. If you have a 64MB SDRAM module, set
6343 it above 400_0000. Just make sure your board has no resources
6344 that are supposed to respond to that address! That code in
6345 start.S has been around a while and should work as is when
6346 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006347
wdenk2729af92004-05-03 20:45:30 +00006348 -Chris Hallinan
6349 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006350
wdenk2729af92004-05-03 20:45:30 +00006351It is essential to remember this, since it has some impact on the C
6352code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006353
wdenk2729af92004-05-03 20:45:30 +00006354* Initialized global data (data segment) is read-only. Do not attempt
6355 to write it.
wdenkc6097192002-11-03 00:24:07 +00006356
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006357* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006358 as zero data - BSS segment) at all - this is undefined, initiali-
6359 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk2729af92004-05-03 20:45:30 +00006361* Stack space is very limited. Avoid big data buffers or things like
6362 that.
wdenkc6097192002-11-03 00:24:07 +00006363
wdenk2729af92004-05-03 20:45:30 +00006364Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006365normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006366turned out that the implementation of U-Boot can be greatly
6367simplified by making a global data structure (gd_t) available to all
6368functions. We could pass a pointer to this data as argument to _all_
6369functions, but this would bloat the code. Instead we use a feature of
6370the GCC compiler (Global Register Variables) to share the data: we
6371place a pointer (gd) to the global data into a register which we
6372reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006373
wdenk2729af92004-05-03 20:45:30 +00006374When choosing a register for such a purpose we are restricted by the
6375relevant (E)ABI specifications for the current architecture, and by
6376GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006377
wdenk2729af92004-05-03 20:45:30 +00006378For PowerPC, the following registers have specific use:
6379 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006380 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006381 R3-R4: parameter passing and return values
6382 R5-R10: parameter passing
6383 R13: small data area pointer
6384 R30: GOT pointer
6385 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006386
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006387 (U-Boot also uses R12 as internal GOT pointer. r12
6388 is a volatile register so r12 needs to be reset when
6389 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006390
Wolfgang Denke7670f62008-02-14 22:43:22 +01006391 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006392
wdenk2729af92004-05-03 20:45:30 +00006393 Note: on PPC, we could use a static initializer (since the
6394 address of the global data structure is known at compile time),
6395 but it turned out that reserving a register results in somewhat
6396 smaller code - although the code savings are not that big (on
6397 average for all boards 752 bytes for the whole U-Boot image,
6398 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006399
Robin Getzc4db3352009-08-17 15:23:02 +00006400On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006401 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6402
Robin Getzc4db3352009-08-17 15:23:02 +00006403 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006404
wdenk2729af92004-05-03 20:45:30 +00006405On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006406
wdenk2729af92004-05-03 20:45:30 +00006407 R0: function argument word/integer result
6408 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006409 R9: platform specific
6410 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006411 R11: argument (frame) pointer
6412 R12: temporary workspace
6413 R13: stack pointer
6414 R14: link register
6415 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006416
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006417 ==> U-Boot will use R9 to hold a pointer to the global data
6418
6419 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006420
Thomas Chou0df01fd2010-05-21 11:08:03 +08006421On Nios II, the ABI is documented here:
6422 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6423
6424 ==> U-Boot will use gp to hold a pointer to the global data
6425
6426 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6427 to access small data sections, so gp is free.
6428
Macpaul Linafc1ce82011-10-19 20:41:11 +00006429On NDS32, the following registers are used:
6430
6431 R0-R1: argument/return
6432 R2-R5: argument
6433 R15: temporary register for assembler
6434 R16: trampoline register
6435 R28: frame pointer (FP)
6436 R29: global pointer (GP)
6437 R30: link register (LP)
6438 R31: stack pointer (SP)
6439 PC: program counter (PC)
6440
6441 ==> U-Boot will use R10 to hold a pointer to the global data
6442
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006443NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6444or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006445
wdenk2729af92004-05-03 20:45:30 +00006446Memory Management:
6447------------------
wdenkc6097192002-11-03 00:24:07 +00006448
wdenk2729af92004-05-03 20:45:30 +00006449U-Boot runs in system state and uses physical addresses, i.e. the
6450MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006451
wdenk2729af92004-05-03 20:45:30 +00006452The available memory is mapped to fixed addresses using the memory
6453controller. In this process, a contiguous block is formed for each
6454memory type (Flash, SDRAM, SRAM), even when it consists of several
6455physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006456
wdenk2729af92004-05-03 20:45:30 +00006457U-Boot is installed in the first 128 kB of the first Flash bank (on
6458TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6459booting and sizing and initializing DRAM, the code relocates itself
6460to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006461memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006462configuration setting]. Below that, a structure with global Board
6463Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006464
wdenk2729af92004-05-03 20:45:30 +00006465Additionally, some exception handler code is copied to the low 8 kB
6466of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006467
wdenk2729af92004-05-03 20:45:30 +00006468So a typical memory configuration with 16 MB of DRAM could look like
6469this:
wdenkc6097192002-11-03 00:24:07 +00006470
wdenk2729af92004-05-03 20:45:30 +00006471 0x0000 0000 Exception Vector code
6472 :
6473 0x0000 1FFF
6474 0x0000 2000 Free for Application Use
6475 :
6476 :
wdenkc6097192002-11-03 00:24:07 +00006477
wdenk2729af92004-05-03 20:45:30 +00006478 :
6479 :
6480 0x00FB FF20 Monitor Stack (Growing downward)
6481 0x00FB FFAC Board Info Data and permanent copy of global data
6482 0x00FC 0000 Malloc Arena
6483 :
6484 0x00FD FFFF
6485 0x00FE 0000 RAM Copy of Monitor Code
6486 ... eventually: LCD or video framebuffer
6487 ... eventually: pRAM (Protected RAM - unchanged by reset)
6488 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006489
6490
wdenk2729af92004-05-03 20:45:30 +00006491System Initialization:
6492----------------------
wdenkc6097192002-11-03 00:24:07 +00006493
wdenk2729af92004-05-03 20:45:30 +00006494In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006495(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006496configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006497To be able to re-map memory U-Boot then jumps to its link address.
6498To be able to implement the initialization code in C, a (small!)
6499initial stack is set up in the internal Dual Ported RAM (in case CPUs
6500which provide such a feature like MPC8xx or MPC8260), or in a locked
6501part of the data cache. After that, U-Boot initializes the CPU core,
6502the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006503
wdenk2729af92004-05-03 20:45:30 +00006504Next, all (potentially) available memory banks are mapped using a
6505preliminary mapping. For example, we put them on 512 MB boundaries
6506(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6507on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6508programmed for SDRAM access. Using the temporary configuration, a
6509simple memory test is run that determines the size of the SDRAM
6510banks.
wdenkc6097192002-11-03 00:24:07 +00006511
wdenk2729af92004-05-03 20:45:30 +00006512When there is more than one SDRAM bank, and the banks are of
6513different size, the largest is mapped first. For equal size, the first
6514bank (CS2#) is mapped first. The first mapping is always for address
65150x00000000, with any additional banks following immediately to create
6516contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006517
wdenk2729af92004-05-03 20:45:30 +00006518Then, the monitor installs itself at the upper end of the SDRAM area
6519and allocates memory for use by malloc() and for the global Board
6520Info data; also, the exception vector code is copied to the low RAM
6521pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006522
wdenk2729af92004-05-03 20:45:30 +00006523Only after this relocation will you have a "normal" C environment;
6524until that you are restricted in several ways, mostly because you are
6525running from ROM, and because the code will have to be relocated to a
6526new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006527
6528
wdenk2729af92004-05-03 20:45:30 +00006529U-Boot Porting Guide:
6530----------------------
wdenkc6097192002-11-03 00:24:07 +00006531
wdenk2729af92004-05-03 20:45:30 +00006532[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6533list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006534
6535
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006536int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006537{
6538 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006539
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006540 signal(SIGALRM, no_more_time);
6541 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006542
wdenk2729af92004-05-03 20:45:30 +00006543 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006544 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006545 return 0;
6546 }
6547
wdenk2729af92004-05-03 20:45:30 +00006548 Download latest U-Boot source;
6549
Wolfgang Denk06682362008-12-30 22:56:11 +01006550 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006551
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006552 if (clueless)
6553 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006554
wdenk2729af92004-05-03 20:45:30 +00006555 while (learning) {
6556 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006557 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6558 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006559 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006560 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006561 }
wdenkc6097192002-11-03 00:24:07 +00006562
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006563 if (available_money > toLocalCurrency ($2500))
6564 Buy a BDI3000;
6565 else
wdenk2729af92004-05-03 20:45:30 +00006566 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006567
6568 if (a similar board exists) { /* hopefully... */
6569 cp -a board/<similar> board/<myboard>
6570 cp include/configs/<similar>.h include/configs/<myboard>.h
6571 } else {
6572 Create your own board support subdirectory;
6573 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006574 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006575 Edit new board/<myboard> files
6576 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006577
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006578 while (!accepted) {
6579 while (!running) {
6580 do {
6581 Add / modify source code;
6582 } until (compiles);
6583 Debug;
6584 if (clueless)
6585 email("Hi, I am having problems...");
6586 }
6587 Send patch file to the U-Boot email list;
6588 if (reasonable critiques)
6589 Incorporate improvements from email list code review;
6590 else
6591 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006592 }
wdenkc6097192002-11-03 00:24:07 +00006593
wdenk2729af92004-05-03 20:45:30 +00006594 return 0;
6595}
6596
6597void no_more_time (int sig)
6598{
6599 hire_a_guru();
6600}
wdenkc6097192002-11-03 00:24:07 +00006601
6602
wdenk2729af92004-05-03 20:45:30 +00006603Coding Standards:
6604-----------------
wdenkc6097192002-11-03 00:24:07 +00006605
wdenk2729af92004-05-03 20:45:30 +00006606All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006607coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006608"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006609
Detlev Zundel2c051652006-09-01 15:39:02 +02006610Source files originating from a different project (for example the
6611MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006612reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006613sources.
6614
6615Please note that U-Boot is implemented in C (and to some small parts in
6616Assembler); no C++ is used, so please do not use C++ style comments (//)
6617in your code.
wdenk2729af92004-05-03 20:45:30 +00006618
6619Please also stick to the following formatting rules:
6620- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006621- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006622- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006623- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006624- do not add trailing empty lines to source files
6625
6626Submissions which do not conform to the standards may be returned
6627with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006628
6629
wdenk2729af92004-05-03 20:45:30 +00006630Submitting Patches:
6631-------------------
wdenkc6097192002-11-03 00:24:07 +00006632
wdenk2729af92004-05-03 20:45:30 +00006633Since the number of patches for U-Boot is growing, we need to
6634establish some rules. Submissions which do not conform to these rules
6635may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006636
Magnus Lilja0d28f342008-08-06 19:32:33 +02006637Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006638
Wolfgang Denk06682362008-12-30 22:56:11 +01006639Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6640see http://lists.denx.de/mailman/listinfo/u-boot
6641
wdenk2729af92004-05-03 20:45:30 +00006642When you send a patch, please include the following information with
6643it:
wdenkc6097192002-11-03 00:24:07 +00006644
wdenk2729af92004-05-03 20:45:30 +00006645* For bug fixes: a description of the bug and how your patch fixes
6646 this bug. Please try to include a way of demonstrating that the
6647 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006648
wdenk2729af92004-05-03 20:45:30 +00006649* For new features: a description of the feature and your
6650 implementation.
wdenkc6097192002-11-03 00:24:07 +00006651
wdenk2729af92004-05-03 20:45:30 +00006652* A CHANGELOG entry as plaintext (separate from the patch)
6653
6654* For major contributions, your entry to the CREDITS file
6655
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006656* When you add support for a new board, don't forget to add a
6657 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006658
6659* If your patch adds new configuration options, don't forget to
6660 document these in the README file.
6661
Wolfgang Denk218ca722008-03-26 10:40:12 +01006662* The patch itself. If you are using git (which is *strongly*
6663 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006664 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006665 the U-Boot mailing list, you will avoid most of the common problems
6666 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006667
Wolfgang Denk218ca722008-03-26 10:40:12 +01006668 If you cannot use git, use "diff -purN OLD NEW". If your version of
6669 diff does not support these options, then get the latest version of
6670 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006671
Wolfgang Denk218ca722008-03-26 10:40:12 +01006672 The current directory when running this command shall be the parent
6673 directory of the U-Boot source tree (i. e. please make sure that
6674 your patch includes sufficient directory information for the
6675 affected files).
6676
6677 We prefer patches as plain text. MIME attachments are discouraged,
6678 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006679
6680* If one logical set of modifications affects or creates several
6681 files, all these changes shall be submitted in a SINGLE patch file.
6682
6683* Changesets that contain different, unrelated modifications shall be
6684 submitted as SEPARATE patches, one patch per changeset.
6685
6686
6687Notes:
6688
6689* Before sending the patch, run the MAKEALL script on your patched
6690 source tree and make sure that no errors or warnings are reported
6691 for any of the boards.
6692
6693* Keep your modifications to the necessary minimum: A patch
6694 containing several unrelated changes or arbitrary reformats will be
6695 returned with a request to re-formatting / split it.
6696
6697* If you modify existing code, make sure that your new code does not
6698 add to the memory footprint of the code ;-) Small is beautiful!
6699 When adding new features, these should compile conditionally only
6700 (using #ifdef), and the resulting code with the new feature
6701 disabled must not need more memory than the old code without your
6702 modification.
wdenk90dc6702005-05-03 14:12:25 +00006703
Wolfgang Denk06682362008-12-30 22:56:11 +01006704* Remember that there is a size limit of 100 kB per message on the
6705 u-boot mailing list. Bigger patches will be moderated. If they are
6706 reasonable and not too big, they will be acknowledged. But patches
6707 bigger than the size limit should be avoided.