blob: cdccae995392afdd649f5dee338a1a23358f478c [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
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
255configurations available; just type "make <board_name>_config".
256
257Example: For a TQM823L module type:
258
259 cd u-boot
260 make TQM823L_config
261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000263e.g. "make cogent_mpc8xx_config". And also configure the cogent
264directory according to the instructions in cogent/README.
265
266
Simon Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
275See board/sandbox/sandbox/README.sandbox for more details.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk7f6c2cb2002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Gala66412c62011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala8f290842011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood33eee332012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood33eee332012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jain64501c62013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jain64501c62013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jainb1359912013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantianaade2002014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sun5614e712013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun34e026f2014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun9ac4ffb2013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sun5614e712013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700505
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun4e5b1bd2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun6b9e3092014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sun6b1e1252014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100541- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200542 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100543
544 Defines the Monahans run mode to oscillator
545 ratio. Valid values are 8, 16, 24, 31. The core
546 frequency is this value multiplied by 13 MHz.
547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200548 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200549
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100550 Defines the Monahans turbo mode to oscillator
551 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200552 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200554
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Rieschb67d8812012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
Aneesh V5356f542012-03-08 07:20:19 +0000593 CONFIG_SYS_THUMB_BUILD
594
595 Use this flag to build U-Boot using the Thumb instruction
596 set for ARM architectures. Thumb instruction set provides
597 better code density. For ARM architectures that support
598 Thumb2 this flag will result in Thumb2 code generated by
599 GCC.
600
Stephen Warrenc5d47522013-03-04 13:29:40 +0000601 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000602 CONFIG_ARM_ERRATA_742230
603 CONFIG_ARM_ERRATA_743622
604 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500605 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500606 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000607
608 If set, the workarounds for these ARM errata are applied early
609 during U-Boot startup. Note that these options force the
610 workarounds to be applied; no CPU-type/version detection
611 exists, unlike the similar options in the Linux kernel. Do not
612 set these options unless they apply!
613
Stephen Warren795659d2013-03-27 17:06:41 +0000614- CPU timer options:
615 CONFIG_SYS_HZ
616
617 The frequency of the timer returned by get_timer().
618 get_timer() must operate in milliseconds and this CONFIG
619 option must be set to 1000.
620
wdenk5da627a2003-10-09 20:09:04 +0000621- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000622 CONFIG_CLOCKS_IN_MHZ
623
624 U-Boot stores all clock information in Hz
625 internally. For binary compatibility with older Linux
626 kernels (which expect the clocks passed in the
627 bd_info data to be in MHz) the environment variable
628 "clocks_in_mhz" can be defined so that U-Boot
629 converts clock data to MHZ before passing it to the
630 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000631 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100632 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000633 default environment.
634
wdenk5da627a2003-10-09 20:09:04 +0000635 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
636
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200637 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000638 expect it to be in bytes, others in MB.
639 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
640
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400641 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200642
643 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400644 passed using flattened device trees (based on open firmware
645 concepts).
646
647 CONFIG_OF_LIBFDT
648 * New libfdt-based support
649 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500650 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400651
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200652 OF_CPU - The proper name of the cpus node (only required for
653 MPC512X and MPC5xxx based boards).
654 OF_SOC - The proper name of the soc node (only required for
655 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200656 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600657 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200658
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200659 boards with QUICC Engines require OF_QE to set UCC MAC
660 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500661
Kumar Gala4e253132006-01-11 13:54:17 -0600662 CONFIG_OF_BOARD_SETUP
663
664 Board code has addition modification that it wants to make
665 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000666
Matthew McClintock02677682006-06-28 10:41:37 -0500667 CONFIG_OF_BOOT_CPU
668
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200669 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500670 param header, the default value is zero if undefined.
671
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200672 CONFIG_OF_IDE_FIXUP
673
674 U-Boot can detect if an IDE device is present or not.
675 If not, and this new config option is activated, U-Boot
676 removes the ATA node from the DTS before booting Linux,
677 so the Linux IDE driver does not probe the device and
678 crash. This is needed for buggy hardware (uc101) where
679 no pull down resistor is connected to the signal IDE5V_DD7.
680
Igor Grinberg7eb29392011-07-14 05:45:07 +0000681 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
682
683 This setting is mandatory for all boards that have only one
684 machine type and must be used to specify the machine type
685 number as it appears in the ARM machine registry
686 (see http://www.arm.linux.org.uk/developer/machines/).
687 Only boards that have multiple machine types supported
688 in a single configuration file and the machine type is
689 runtime discoverable, do not have to use this setting.
690
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100691- vxWorks boot parameters:
692
693 bootvx constructs a valid bootline using the following
694 environments variables: bootfile, ipaddr, serverip, hostname.
695 It loads the vxWorks image pointed bootfile.
696
697 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
698 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
699 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
700 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
701
702 CONFIG_SYS_VXWORKS_ADD_PARAMS
703
704 Add it at the end of the bootline. E.g "u=username pw=secret"
705
706 Note: If a "bootargs" environment is defined, it will overwride
707 the defaults discussed just above.
708
Aneesh V2c451f72011-06-16 23:30:47 +0000709- Cache Configuration:
710 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
711 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
712 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
713
Aneesh V93bc2192011-06-16 23:30:51 +0000714- Cache Configuration for ARM:
715 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
716 controller
717 CONFIG_SYS_PL310_BASE - Physical base address of PL310
718 controller register space
719
wdenk6705d812004-08-02 23:22:59 +0000720- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200721 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000722
723 Define this if you want support for Amba PrimeCell PL010 UARTs.
724
Andreas Engel48d01922008-09-08 14:30:53 +0200725 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000726
727 Define this if you want support for Amba PrimeCell PL011 UARTs.
728
729 CONFIG_PL011_CLOCK
730
731 If you have Amba PrimeCell PL011 UARTs, set this variable to
732 the clock speed of the UARTs.
733
734 CONFIG_PL01x_PORTS
735
736 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
737 define this to a list of base addresses for each (supported)
738 port. See e.g. include/configs/versatile.h
739
John Rigby910f1ae2011-04-19 10:42:39 +0000740 CONFIG_PL011_SERIAL_RLCR
741
742 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743 have separate receive and transmit line control registers. Set
744 this variable to initialize the extra register.
745
746 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747
748 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749 boot loader that has already initialized the UART. Define this
750 variable to flush the UART at init time.
751
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400752 CONFIG_SERIAL_HW_FLOW_CONTROL
753
754 Define this variable to enable hw flow control in serial driver.
755 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000756
wdenkc6097192002-11-03 00:24:07 +0000757- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000758 Depending on board, define exactly one serial port
759 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000762
763 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764 port routines must be defined elsewhere
765 (i.e. serial_init(), serial_getc(), ...)
766
767 CONFIG_CFB_CONSOLE
768 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000769 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000770 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
771 (default big endian)
772 VIDEO_HW_RECTFILL graphic chip supports
773 rectangle fill
774 (cf. smiLynxEM)
775 VIDEO_HW_BITBLT graphic chip supports
776 bit-blit (cf. smiLynxEM)
777 VIDEO_VISIBLE_COLS visible pixel columns
778 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000779 VIDEO_VISIBLE_ROWS visible pixel rows
780 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_DATA_FORMAT graphic data format
782 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000783 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000784 VIDEO_KBD_INIT_FCT keyboard int fct
785 (i.e. i8042_kbd_init())
786 VIDEO_TSTC_FCT test char fct
787 (i.e. i8042_tstc)
788 VIDEO_GETC_FCT get char fct
789 (i.e. i8042_getc)
790 CONFIG_CONSOLE_CURSOR cursor drawing on/off
791 (requires blink timer
792 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000794 CONFIG_CONSOLE_TIME display time/date info in
795 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500796 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000797 CONFIG_VIDEO_LOGO display Linux logo in
798 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000799 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
800 linux_logo.h for logo.
801 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200803 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000804 the logo
805
Pali Rohár33a35bb2012-10-19 13:30:09 +0000806 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
807 a limited number of ANSI escape sequences (cursor control,
808 erase functions and limited graphics rendition control).
809
wdenk43d96162003-03-06 00:02:04 +0000810 When CONFIG_CFB_CONSOLE is defined, video console is
811 default i/o. Serial console can be forced with
812 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000813
wdenkd4ca31c2004-01-02 14:00:00 +0000814 When CONFIG_SILENT_CONSOLE is defined, all console
815 messages (by U-Boot and Linux!) can be silenced with
816 the "silent" environment variable. See
817 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000818
Heiko Schocher45ae2542013-10-22 11:06:06 +0200819 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
820 is 0x00.
821 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
822 is 0xa0.
823
wdenkc6097192002-11-03 00:24:07 +0000824- Console Baudrate:
825 CONFIG_BAUDRATE - in bps
826 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200827 CONFIG_SYS_BAUDRATE_TABLE, see below.
828 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000829
Heiko Schocherc92fac92009-01-30 12:55:38 +0100830- Console Rx buffer length
831 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100833 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100834 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835 must be defined, to setup the maximum idle timeout for
836 the SMC.
837
Graeme Russ9558b482011-09-01 00:48:27 +0000838- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200839 Prior to the console being initialised (i.e. serial UART
840 initialised etc) all console output is silently discarded.
841 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
842 buffer any console messages prior to the console being
843 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
844 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
845 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200846 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200847 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000848
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200849 'Sane' compilers will generate smaller code if
850 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000851
Sonny Rao046a37b2011-11-02 09:52:08 +0000852- Safe printf() functions
853 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854 the printf() functions. These are defined in
855 include/vsprintf.h and include snprintf(), vsnprintf() and
856 so on. Code size increase is approximately 300-500 bytes.
857 If this option is not given then these functions will
858 silently discard their buffer size argument - this means
859 you are not getting any overflow checking in this case.
860
wdenkc6097192002-11-03 00:24:07 +0000861- Boot Delay: CONFIG_BOOTDELAY - in seconds
862 Delay before automatically booting the default image;
863 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000864 set to -2 to autoboot with no delay and not check for abort
865 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000866
867 See doc/README.autoboot for these options that
868 work with CONFIG_BOOTDELAY. None are required.
869 CONFIG_BOOT_RETRY_TIME
870 CONFIG_BOOT_RETRY_MIN
871 CONFIG_AUTOBOOT_KEYED
872 CONFIG_AUTOBOOT_PROMPT
873 CONFIG_AUTOBOOT_DELAY_STR
874 CONFIG_AUTOBOOT_STOP_STR
875 CONFIG_AUTOBOOT_DELAY_STR2
876 CONFIG_AUTOBOOT_STOP_STR2
877 CONFIG_ZERO_BOOTDELAY_CHECK
878 CONFIG_RESET_TO_RETRY
879
880- Autoboot Command:
881 CONFIG_BOOTCOMMAND
882 Only needed when CONFIG_BOOTDELAY is enabled;
883 define a command string that is automatically executed
884 when no character is read on the console interface
885 within "Boot Delay" after reset.
886
887 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000888 This can be used to pass arguments to the bootm
889 command. The value of CONFIG_BOOTARGS goes into the
890 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000891
892 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000893 The value of these goes into the environment as
894 "ramboot" and "nfsboot" respectively, and can be used
895 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200896 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000897
Heiko Schochereda0ba32013-11-04 14:04:59 +0100898- Bootcount:
899 CONFIG_BOOTCOUNT_LIMIT
900 Implements a mechanism for detecting a repeating reboot
901 cycle, see:
902 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903
904 CONFIG_BOOTCOUNT_ENV
905 If no softreset save registers are found on the hardware
906 "bootcount" is stored in the environment. To prevent a
907 saveenv on all reboots, the environment variable
908 "upgrade_available" is used. If "upgrade_available" is
909 0, "bootcount" is always 0, if "upgrade_available" is
910 1 "bootcount" is incremented in the environment.
911 So the Userspace Applikation must set the "upgrade_available"
912 and "bootcount" variable to 0, if a boot was successfully.
913
wdenkc6097192002-11-03 00:24:07 +0000914- Pre-Boot Commands:
915 CONFIG_PREBOOT
916
917 When this option is #defined, the existence of the
918 environment variable "preboot" will be checked
919 immediately before starting the CONFIG_BOOTDELAY
920 countdown and/or running the auto-boot command resp.
921 entering interactive mode.
922
923 This feature is especially useful when "preboot" is
924 automatically generated or modified. For an example
925 see the LWMON board specific code: here "preboot" is
926 modified when the user holds down a certain
927 combination of keys on the (special) keyboard when
928 booting the systems
929
930- Serial Download Echo Mode:
931 CONFIG_LOADS_ECHO
932 If defined to 1, all characters received during a
933 serial download (using the "loads" command) are
934 echoed back. This might be needed by some terminal
935 emulations (like "cu"), but may as well just take
936 time on others. This setting #define's the initial
937 value of the "loads_echo" environment variable.
938
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500939- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000940 CONFIG_KGDB_BAUDRATE
941 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000943
944- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 Monitor commands can be included or excluded
946 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000947 <config_cmd_all.h> and #undef'ing unwanted
948 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500949 and augmenting with additional #define's
950 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000951
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952 The default command configuration includes all commands
953 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000954
Marek Vasutb401b732014-03-05 19:58:39 +0100955 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500956 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500957 CONFIG_CMD_BDI bdinfo
958 CONFIG_CMD_BEDBUG * Include BedBug Debugger
959 CONFIG_CMD_BMP * BMP support
960 CONFIG_CMD_BSP * Board specific commands
961 CONFIG_CMD_BOOTD bootd
962 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800963 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500964 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500965 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500966 CONFIG_CMD_DATE * support for RTC, date/time...
967 CONFIG_CMD_DHCP * DHCP support
968 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600969 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
970 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
971 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
972 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500973 CONFIG_CMD_DTT * Digital Therm and Thermostat
974 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500975 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500976 CONFIG_CMD_EEPROM * EEPROM read/write support
977 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600978 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600979 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500980 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500981 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000982 CONFIG_CMD_EXT2 * ext2 command support
983 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700984 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
985 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500986 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500987 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000988 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 CONFIG_CMD_FLASH flinfo, erase, protect
990 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200991 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000992 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500993 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000994 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000995 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
997 CONFIG_CMD_I2C * I2C serial bus support
998 CONFIG_CMD_IDE * IDE harddisk support
999 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001000 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001001 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001003 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001004 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001005 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001006 CONFIG_CMD_IRQ * irqinfo
1007 CONFIG_CMD_ITEST Integer/string test of 2 values
1008 CONFIG_CMD_JFFS2 * JFFS2 Support
1009 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001010 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001011 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1012 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_LOADB loadb
1014 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001015 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001016 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001017 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001018 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001019 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001020 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001021 CONFIG_CMD_MISC Misc functions like sleep etc
1022 CONFIG_CMD_MMC * MMC memory mapped support
1023 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001024 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001025 CONFIG_CMD_NAND * NAND support
1026 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001027 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001028 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001029 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001030 CONFIG_CMD_PCI * pciinfo
1031 CONFIG_CMD_PCMCIA * PCMCIA support
1032 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1033 host
1034 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001035 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001036 CONFIG_CMD_REGINFO * Register dump
1037 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001038 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001039 CONFIG_CMD_SAVES * save S record dump
1040 CONFIG_CMD_SCSI * SCSI Support
1041 CONFIG_CMD_SDRAM * print SDRAM configuration information
1042 (requires CONFIG_CMD_I2C)
1043 CONFIG_CMD_SETGETDCR Support for DCR Register access
1044 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001045 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001046 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001047 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001048 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001049 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001050 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001051 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001052 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001053 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1054 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001055 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001056 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001057 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001058 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001059 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001060
1061 EXAMPLE: If you want all functions except of network
1062 support you can write:
1063
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001064 #include "config_cmd_all.h"
1065 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001066
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001067 Other Commands:
1068 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001069
1070 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001071 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001072 what you (and your U-Boot users) are doing. Data
1073 cache cannot be enabled on systems like the 8xx or
1074 8260 (where accesses to the IMMR region must be
1075 uncached), and it cannot be disabled on all other
1076 systems where we (mis-) use the data cache to hold an
1077 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001078
1079
1080 XXX - this list needs to get updated!
1081
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001082- Regular expression support:
1083 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001084 If this variable is defined, U-Boot is linked against
1085 the SLRE (Super Light Regular Expression) library,
1086 which adds regex support to some commands, as for
1087 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001088
Simon Glass45ba8072011-10-15 05:48:20 +00001089- Device tree:
1090 CONFIG_OF_CONTROL
1091 If this variable is defined, U-Boot will use a device tree
1092 to configure its devices, instead of relying on statically
1093 compiled #defines in the board file. This option is
1094 experimental and only available on a few boards. The device
1095 tree is available in the global data as gd->fdt_blob.
1096
Simon Glass2c0f79e2011-10-24 19:15:31 +00001097 U-Boot needs to get its device tree from somewhere. This can
1098 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001099
1100 CONFIG_OF_EMBED
1101 If this variable is defined, U-Boot will embed a device tree
1102 binary in its image. This device tree file should be in the
1103 board directory and called <soc>-<board>.dts. The binary file
1104 is then picked up in board_init_f() and made available through
1105 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001106
Simon Glass2c0f79e2011-10-24 19:15:31 +00001107 CONFIG_OF_SEPARATE
1108 If this variable is defined, U-Boot will build a device tree
1109 binary. It will be called u-boot.dtb. Architecture-specific
1110 code will locate it at run-time. Generally this works by:
1111
1112 cat u-boot.bin u-boot.dtb >image.bin
1113
1114 and in fact, U-Boot does this for you, creating a file called
1115 u-boot-dtb.bin which is useful in the common case. You can
1116 still use the individual files if you need something more
1117 exotic.
1118
wdenkc6097192002-11-03 00:24:07 +00001119- Watchdog:
1120 CONFIG_WATCHDOG
1121 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001122 support for the SoC. There must be support in the SoC
1123 specific code for a watchdog. For the 8xx and 8260
1124 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1125 register. When supported for a specific SoC is
1126 available, then no further board specific code should
1127 be needed to use it.
1128
1129 CONFIG_HW_WATCHDOG
1130 When using a watchdog circuitry external to the used
1131 SoC, then define this variable and provide board
1132 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001133
stroesec1551ea2003-04-04 15:53:41 +00001134- U-Boot Version:
1135 CONFIG_VERSION_VARIABLE
1136 If this variable is defined, an environment variable
1137 named "ver" is created by U-Boot showing the U-Boot
1138 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001139 Any change to this variable will be reverted at the
1140 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001141
wdenkc6097192002-11-03 00:24:07 +00001142- Real-Time Clock:
1143
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001144 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001145 has to be selected, too. Define exactly one of the
1146 following options:
1147
1148 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1149 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001150 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001151 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001152 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001153 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001154 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001155 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001156 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001157 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001158 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001159 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1160 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001161
wdenkb37c7e52003-06-30 16:24:52 +00001162 Note that if the RTC uses I2C, then the I2C interface
1163 must also be configured. See I2C Support, below.
1164
Peter Tysere92739d2008-12-17 16:36:21 -06001165- GPIO Support:
1166 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001167
Chris Packham5dec49c2010-12-19 10:12:13 +00001168 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1169 chip-ngpio pairs that tell the PCA953X driver the number of
1170 pins supported by a particular chip.
1171
Peter Tysere92739d2008-12-17 16:36:21 -06001172 Note that if the GPIO device uses I2C, then the I2C interface
1173 must also be configured. See I2C Support, below.
1174
Simon Glassaa532332014-06-11 23:29:41 -06001175- I/O tracing:
1176 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1177 accesses and can checksum them or write a list of them out
1178 to memory. See the 'iotrace' command for details. This is
1179 useful for testing device drivers since it can confirm that
1180 the driver behaves the same way before and after a code
1181 change. Currently this is supported on sandbox and arm. To
1182 add support for your architecture, add '#include <iotrace.h>'
1183 to the bottom of arch/<arch>/include/asm/io.h and test.
1184
1185 Example output from the 'iotrace stats' command is below.
1186 Note that if the trace buffer is exhausted, the checksum will
1187 still continue to operate.
1188
1189 iotrace is enabled
1190 Start: 10000000 (buffer start address)
1191 Size: 00010000 (buffer size)
1192 Offset: 00000120 (current buffer offset)
1193 Output: 10000120 (start + offset)
1194 Count: 00000018 (number of trace records)
1195 CRC32: 9526fb66 (CRC32 of all trace records)
1196
wdenkc6097192002-11-03 00:24:07 +00001197- Timestamp Support:
1198
wdenk43d96162003-03-06 00:02:04 +00001199 When CONFIG_TIMESTAMP is selected, the timestamp
1200 (date and time) of an image is printed by image
1201 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001202 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001203
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001204- Partition Labels (disklabels) Supported:
1205 Zero or more of the following:
1206 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1207 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1208 Intel architecture, USB sticks, etc.
1209 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1210 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1211 bootloader. Note 2TB partition limit; see
1212 disk/part_efi.c
1213 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001214
Wolfgang Denk218ca722008-03-26 10:40:12 +01001215 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1216 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001217 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001218
1219- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001220 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1221 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001222
wdenk4d13cba2004-03-14 14:09:05 +00001223 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1224 be performed by calling the function
1225 ide_set_reset(int reset)
1226 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001227
1228- ATAPI Support:
1229 CONFIG_ATAPI
1230
1231 Set this to enable ATAPI support.
1232
wdenkc40b2952004-03-13 23:29:43 +00001233- LBA48 Support
1234 CONFIG_LBA48
1235
1236 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001237 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001238 Whithout these , LBA48 support uses 32bit variables and will 'only'
1239 support disks up to 2.1TB.
1240
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001242 When enabled, makes the IDE subsystem use 64bit sector addresses.
1243 Default is 32bit.
1244
wdenkc6097192002-11-03 00:24:07 +00001245- SCSI Support:
1246 At the moment only there is only support for the
1247 SYM53C8XX SCSI controller; define
1248 CONFIG_SCSI_SYM53C8XX to enable it.
1249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001250 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1251 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1252 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001253 maximum numbers of LUNs, SCSI ID's and target
1254 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001255 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001256
Wolfgang Denk93e14592013-10-04 17:43:24 +02001257 The environment variable 'scsidevs' is set to the number of
1258 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001259
wdenkc6097192002-11-03 00:24:07 +00001260- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001261 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001262 Support for Intel 8254x/8257x gigabit chips.
1263
1264 CONFIG_E1000_SPI
1265 Utility code for direct access to the SPI bus on Intel 8257x.
1266 This does not do anything useful unless you set at least one
1267 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1268
1269 CONFIG_E1000_SPI_GENERIC
1270 Allow generic access to the SPI bus on the Intel 8257x, for
1271 example with the "sspi" command.
1272
1273 CONFIG_CMD_E1000
1274 Management command for E1000 devices. When used on devices
1275 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001276
Andre Schwarzac3315c2008-03-06 16:45:44 +01001277 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001278 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001279
wdenkc6097192002-11-03 00:24:07 +00001280 CONFIG_EEPRO100
1281 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001282 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001283 write routine for first time initialisation.
1284
1285 CONFIG_TULIP
1286 Support for Digital 2114x chips.
1287 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1288 modem chip initialisation (KS8761/QS6611).
1289
1290 CONFIG_NATSEMI
1291 Support for National dp83815 chips.
1292
1293 CONFIG_NS8382X
1294 Support for National dp8382[01] gigabit chips.
1295
wdenk45219c42003-05-12 21:50:16 +00001296- NETWORK Support (other):
1297
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001298 CONFIG_DRIVER_AT91EMAC
1299 Support for AT91RM9200 EMAC.
1300
1301 CONFIG_RMII
1302 Define this to use reduced MII inteface
1303
1304 CONFIG_DRIVER_AT91EMAC_QUIET
1305 If this defined, the driver is quiet.
1306 The driver doen't show link status messages.
1307
Rob Herringefdd7312011-12-15 11:15:49 +00001308 CONFIG_CALXEDA_XGMAC
1309 Support for the Calxeda XGMAC device
1310
Ashok3bb46d22012-10-15 06:20:47 +00001311 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001312 Support for SMSC's LAN91C96 chips.
1313
1314 CONFIG_LAN91C96_BASE
1315 Define this to hold the physical address
1316 of the LAN91C96's I/O space
1317
1318 CONFIG_LAN91C96_USE_32_BIT
1319 Define this to enable 32 bit addressing
1320
Ashok3bb46d22012-10-15 06:20:47 +00001321 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001322 Support for SMSC's LAN91C111 chip
1323
1324 CONFIG_SMC91111_BASE
1325 Define this to hold the physical address
1326 of the device (I/O space)
1327
1328 CONFIG_SMC_USE_32_BIT
1329 Define this if data bus is 32 bits
1330
1331 CONFIG_SMC_USE_IOFUNCS
1332 Define this to use i/o functions instead of macros
1333 (some hardware wont work with macros)
1334
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001335 CONFIG_DRIVER_TI_EMAC
1336 Support for davinci emac
1337
1338 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1339 Define this if you have more then 3 PHYs.
1340
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001341 CONFIG_FTGMAC100
1342 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1343
1344 CONFIG_FTGMAC100_EGIGA
1345 Define this to use GE link update with gigabit PHY.
1346 Define this if FTGMAC100 is connected to gigabit PHY.
1347 If your system has 10/100 PHY only, it might not occur
1348 wrong behavior. Because PHY usually return timeout or
1349 useless data when polling gigabit status and gigabit
1350 control registers. This behavior won't affect the
1351 correctnessof 10/100 link speed update.
1352
Mike Rapoportc2fff332009-11-11 10:03:03 +02001353 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001354 Support for SMSC's LAN911x and LAN921x chips
1355
Mike Rapoportc2fff332009-11-11 10:03:03 +02001356 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001357 Define this to hold the physical address
1358 of the device (I/O space)
1359
Mike Rapoportc2fff332009-11-11 10:03:03 +02001360 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001361 Define this if data bus is 32 bits
1362
Mike Rapoportc2fff332009-11-11 10:03:03 +02001363 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001364 Define this if data bus is 16 bits. If your processor
1365 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001366 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001367
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001368 CONFIG_SH_ETHER
1369 Support for Renesas on-chip Ethernet controller
1370
1371 CONFIG_SH_ETHER_USE_PORT
1372 Define the number of ports to be used
1373
1374 CONFIG_SH_ETHER_PHY_ADDR
1375 Define the ETH PHY's address
1376
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001377 CONFIG_SH_ETHER_CACHE_WRITEBACK
1378 If this option is set, the driver enables cache flush.
1379
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001380- PWM Support:
1381 CONFIG_PWM_IMX
1382 Support for PWM modul on the imx6.
1383
Vadim Bendebury5e124722011-10-17 08:36:14 +00001384- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001385 CONFIG_TPM
1386 Support TPM devices.
1387
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001388 CONFIG_TPM_TIS_I2C
1389 Support for i2c bus TPM devices. Only one device
1390 per system is supported at this time.
1391
1392 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1393 Define the the i2c bus number for the TPM device
1394
1395 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1396 Define the TPM's address on the i2c bus
1397
1398 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1399 Define the burst count bytes upper limit
1400
Dirk Eibachc01939c2013-06-26 15:55:15 +02001401 CONFIG_TPM_ATMEL_TWI
1402 Support for Atmel TWI TPM device. Requires I2C support.
1403
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001404 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001405 Support for generic parallel port TPM devices. Only one device
1406 per system is supported at this time.
1407
1408 CONFIG_TPM_TIS_BASE_ADDRESS
1409 Base address where the generic TPM device is mapped
1410 to. Contemporary x86 systems usually map it at
1411 0xfed40000.
1412
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001413 CONFIG_CMD_TPM
1414 Add tpm monitor functions.
1415 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1416 provides monitor access to authorized functions.
1417
1418 CONFIG_TPM
1419 Define this to enable the TPM support library which provides
1420 functional interfaces to some TPM commands.
1421 Requires support for a TPM device.
1422
1423 CONFIG_TPM_AUTH_SESSIONS
1424 Define this to enable authorized functions in the TPM library.
1425 Requires CONFIG_TPM and CONFIG_SHA1.
1426
wdenkc6097192002-11-03 00:24:07 +00001427- USB Support:
1428 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001429 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001430 CONFIG_USB_UHCI to enable it.
1431 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001432 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001433 storage devices.
1434 Note:
1435 Supported are USB Keyboards and USB Floppy drives
1436 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001437 MPC5200 USB requires additional defines:
1438 CONFIG_USB_CLOCK
1439 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001440 CONFIG_PSC3_USB
1441 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001442 CONFIG_USB_CONFIG
1443 for differential drivers: 0x00001000
1444 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001445 for differential drivers on PSC3: 0x00000100
1446 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001447 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001448 May be defined to allow interrupt polling
1449 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001450
Simon Glass9ab4ce22012-02-27 10:52:47 +00001451 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1452 txfilltuning field in the EHCI controller on reset.
1453
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001454- USB Device:
1455 Define the below if you wish to use the USB console.
1456 Once firmware is rebuilt from a serial console issue the
1457 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001458 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001459 it has found a new device. The environment variable usbtty
1460 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001461 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001462 Common Device Class Abstract Control Model serial device.
1463 If you select usbtty = gserial you should be able to enumerate
1464 a Linux host by
1465 # modprobe usbserial vendor=0xVendorID product=0xProductID
1466 else if using cdc_acm, simply setting the environment
1467 variable usbtty to be cdc_acm should suffice. The following
1468 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001469
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001470 CONFIG_USB_DEVICE
1471 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001472
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001473 CONFIG_USB_TTY
1474 Define this to have a tty type of device available to
1475 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001476
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301477 CONFIG_USBD_HS
1478 Define this to enable the high speed support for usb
1479 device and usbtty. If this feature is enabled, a routine
1480 int is_usbd_high_speed(void)
1481 also needs to be defined by the driver to dynamically poll
1482 whether the enumeration has succeded at high speed or full
1483 speed.
1484
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001485 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001486 Define this if you want stdin, stdout &/or stderr to
1487 be set to usbtty.
1488
1489 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001490 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001491 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001492 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001494 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001495 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001496 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001497
Wolfgang Denk386eda02006-06-14 18:14:56 +02001498 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001499 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001500 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001501 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1502 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1503 should pretend to be a Linux device to it's target host.
1504
1505 CONFIG_USBD_MANUFACTURER
1506 Define this string as the name of your company for
1507 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001508
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001509 CONFIG_USBD_PRODUCT_NAME
1510 Define this string as the name of your product
1511 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1512
1513 CONFIG_USBD_VENDORID
1514 Define this as your assigned Vendor ID from the USB
1515 Implementors Forum. This *must* be a genuine Vendor ID
1516 to avoid polluting the USB namespace.
1517 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001518
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001519 CONFIG_USBD_PRODUCTID
1520 Define this as the unique Product ID
1521 for your device
1522 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001523
Igor Grinbergd70a5602011-12-12 12:08:35 +02001524- ULPI Layer Support:
1525 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1526 the generic ULPI layer. The generic layer accesses the ULPI PHY
1527 via the platform viewport, so you need both the genric layer and
1528 the viewport enabled. Currently only Chipidea/ARC based
1529 viewport is supported.
1530 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1531 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001532 If your ULPI phy needs a different reference clock than the
1533 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1534 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001535
1536- MMC Support:
1537 The MMC controller on the Intel PXA is supported. To
1538 enable this define CONFIG_MMC. The MMC can be
1539 accessed from the boot prompt by mapping the device
1540 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001541 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1542 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001543
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001544 CONFIG_SH_MMCIF
1545 Support for Renesas on-chip MMCIF controller
1546
1547 CONFIG_SH_MMCIF_ADDR
1548 Define the base address of MMCIF registers
1549
1550 CONFIG_SH_MMCIF_CLK
1551 Define the clock frequency for MMCIF
1552
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001553 CONFIG_GENERIC_MMC
1554 Enable the generic MMC driver
1555
1556 CONFIG_SUPPORT_EMMC_BOOT
1557 Enable some additional features of the eMMC boot partitions.
1558
1559 CONFIG_SUPPORT_EMMC_RPMB
1560 Enable the commands for reading, writing and programming the
1561 key for the Replay Protection Memory Block partition in eMMC.
1562
Tom Rinib3ba6e92013-03-14 05:32:47 +00001563- USB Device Firmware Update (DFU) class support:
1564 CONFIG_DFU_FUNCTION
1565 This enables the USB portion of the DFU USB class
1566
1567 CONFIG_CMD_DFU
1568 This enables the command "dfu" which is used to have
1569 U-Boot create a DFU class device via USB. This command
1570 requires that the "dfu_alt_info" environment variable be
1571 set and define the alt settings to expose to the host.
1572
1573 CONFIG_DFU_MMC
1574 This enables support for exposing (e)MMC devices via DFU.
1575
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001576 CONFIG_DFU_NAND
1577 This enables support for exposing NAND devices via DFU.
1578
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301579 CONFIG_DFU_RAM
1580 This enables support for exposing RAM via DFU.
1581 Note: DFU spec refer to non-volatile memory usage, but
1582 allow usages beyond the scope of spec - here RAM usage,
1583 one that would help mostly the developer.
1584
Heiko Schochere7e75c72013-06-12 06:05:51 +02001585 CONFIG_SYS_DFU_DATA_BUF_SIZE
1586 Dfu transfer uses a buffer before writing data to the
1587 raw storage device. Make the size (in bytes) of this buffer
1588 configurable. The size of this buffer is also configurable
1589 through the "dfu_bufsiz" environment variable.
1590
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001591 CONFIG_SYS_DFU_MAX_FILE_SIZE
1592 When updating files rather than the raw storage device,
1593 we use a static buffer to copy the file into and then write
1594 the buffer once we've been given the whole file. Define
1595 this to the maximum filesize (in bytes) for the buffer.
1596 Default is 4 MiB if undefined.
1597
Heiko Schocher001a8312014-03-18 08:09:56 +01001598 DFU_DEFAULT_POLL_TIMEOUT
1599 Poll timeout [ms], is the timeout a device can send to the
1600 host. The host must wait for this timeout before sending
1601 a subsequent DFU_GET_STATUS request to the device.
1602
1603 DFU_MANIFEST_POLL_TIMEOUT
1604 Poll timeout [ms], which the device sends to the host when
1605 entering dfuMANIFEST state. Host waits this timeout, before
1606 sending again an USB request to the device.
1607
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001608- USB Device Android Fastboot support:
1609 CONFIG_CMD_FASTBOOT
1610 This enables the command "fastboot" which enables the Android
1611 fastboot mode for the platform's USB device. Fastboot is a USB
1612 protocol for downloading images, flashing and device control
1613 used on Android devices.
1614 See doc/README.android-fastboot for more information.
1615
1616 CONFIG_ANDROID_BOOT_IMAGE
1617 This enables support for booting images which use the Android
1618 image format header.
1619
1620 CONFIG_USB_FASTBOOT_BUF_ADDR
1621 The fastboot protocol requires a large memory buffer for
1622 downloads. Define this to the starting RAM address to use for
1623 downloaded images.
1624
1625 CONFIG_USB_FASTBOOT_BUF_SIZE
1626 The fastboot protocol requires a large memory buffer for
1627 downloads. This buffer should be as large as possible for a
1628 platform. Define this to the size available RAM for fastboot.
1629
wdenk6705d812004-08-02 23:22:59 +00001630- Journaling Flash filesystem support:
1631 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1632 CONFIG_JFFS2_NAND_DEV
1633 Define these for a default partition on a NAND device
1634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001635 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1636 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001637 Define these for a default partition on a NOR device
1638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001639 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001640 Define this to create an own partition. You have to provide a
1641 function struct part_info* jffs2_part_info(int part_num)
1642
1643 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001644 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001645 to disable the command chpart. This is the default when you
1646 have not defined a custom partition
1647
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001648- FAT(File Allocation Table) filesystem write function support:
1649 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001650
1651 Define this to enable support for saving memory data as a
1652 file in FAT formatted partition.
1653
1654 This will also enable the command "fatwrite" enabling the
1655 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001656
Gabe Black84cd9322012-10-12 14:26:11 +00001657CBFS (Coreboot Filesystem) support
1658 CONFIG_CMD_CBFS
1659
1660 Define this to enable support for reading from a Coreboot
1661 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1662 and cbfsload.
1663
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301664- FAT(File Allocation Table) filesystem cluster size:
1665 CONFIG_FS_FAT_MAX_CLUSTSIZE
1666
1667 Define the max cluster size for fat operations else
1668 a default value of 65536 will be defined.
1669
wdenkc6097192002-11-03 00:24:07 +00001670- Keyboard Support:
1671 CONFIG_ISA_KEYBOARD
1672
1673 Define this to enable standard (PC-Style) keyboard
1674 support
1675
1676 CONFIG_I8042_KBD
1677 Standard PC keyboard driver with US (is default) and
1678 GERMAN key layout (switch via environment 'keymap=de') support.
1679 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1680 for cfb_console. Supports cursor blinking.
1681
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001682 CONFIG_CROS_EC_KEYB
1683 Enables a Chrome OS keyboard using the CROS_EC interface.
1684 This uses CROS_EC to communicate with a second microcontroller
1685 which provides key scans on request.
1686
wdenkc6097192002-11-03 00:24:07 +00001687- Video support:
1688 CONFIG_VIDEO
1689
1690 Define this to enable video support (for output to
1691 video).
1692
1693 CONFIG_VIDEO_CT69000
1694
1695 Enable Chips & Technologies 69000 Video chip
1696
1697 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001698 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001699 video output is selected via environment 'videoout'
1700 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1701 assumed.
wdenkc6097192002-11-03 00:24:07 +00001702
wdenkb79a11c2004-03-25 15:14:43 +00001703 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001704 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001705 are possible:
1706 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001707 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001708
1709 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1710 -------------+---------------------------------------------
1711 8 bits | 0x301* 0x303 0x305 0x161 0x307
1712 15 bits | 0x310 0x313 0x316 0x162 0x319
1713 16 bits | 0x311 0x314 0x317 0x163 0x31A
1714 24 bits | 0x312 0x315 0x318 ? 0x31B
1715 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001716 (i.e. setenv videomode 317; saveenv; reset;)
1717
wdenkb79a11c2004-03-25 15:14:43 +00001718 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001719 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001720
1721
stroesec1551ea2003-04-04 15:53:41 +00001722 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001723 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001724 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1725 or CONFIG_VIDEO_SED13806_16BPP
1726
Timur Tabi7d3053f2011-02-15 17:09:19 -06001727 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001728 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001729 SOCs that have a DIU should define this macro to enable DIU
1730 support, and should also define these other macros:
1731
1732 CONFIG_SYS_DIU_ADDR
1733 CONFIG_VIDEO
1734 CONFIG_CMD_BMP
1735 CONFIG_CFB_CONSOLE
1736 CONFIG_VIDEO_SW_CURSOR
1737 CONFIG_VGA_AS_SINGLE_DEVICE
1738 CONFIG_VIDEO_LOGO
1739 CONFIG_VIDEO_BMP_LOGO
1740
Timur Tabiba8e76b2011-04-11 14:18:22 -05001741 The DIU driver will look for the 'video-mode' environment
1742 variable, and if defined, enable the DIU as a console during
1743 boot. See the documentation file README.video for a
1744 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001745
Simon Glass058d59b2012-12-03 13:59:47 +00001746 CONFIG_VIDEO_VGA
1747
1748 Enable the VGA video / BIOS for x86. The alternative if you
1749 are using coreboot is to use the coreboot frame buffer
1750 driver.
1751
1752
wdenk682011f2003-06-03 23:54:09 +00001753- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001754 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001755
wdenk8bde7f72003-06-27 21:31:46 +00001756 Define this to enable a custom keyboard support.
1757 This simply calls drv_keyboard_init() which must be
1758 defined in your board-specific files.
1759 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001760
wdenkc6097192002-11-03 00:24:07 +00001761- LCD Support: CONFIG_LCD
1762
1763 Define this to enable LCD support (for output to LCD
1764 display); also select one of the supported displays
1765 by defining one of these:
1766
Stelian Pop39cf4802008-05-09 21:57:18 +02001767 CONFIG_ATMEL_LCD:
1768
1769 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1770
wdenkfd3103b2003-11-25 16:55:19 +00001771 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001772
wdenkfd3103b2003-11-25 16:55:19 +00001773 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001774
wdenkfd3103b2003-11-25 16:55:19 +00001775 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001776
wdenkfd3103b2003-11-25 16:55:19 +00001777 NEC NL6448BC20-08. 6.5", 640x480.
1778 Active, color, single scan.
1779
1780 CONFIG_NEC_NL6448BC33_54
1781
1782 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001783 Active, color, single scan.
1784
1785 CONFIG_SHARP_16x9
1786
1787 Sharp 320x240. Active, color, single scan.
1788 It isn't 16x9, and I am not sure what it is.
1789
1790 CONFIG_SHARP_LQ64D341
1791
1792 Sharp LQ64D341 display, 640x480.
1793 Active, color, single scan.
1794
1795 CONFIG_HLD1045
1796
1797 HLD1045 display, 640x480.
1798 Active, color, single scan.
1799
1800 CONFIG_OPTREX_BW
1801
1802 Optrex CBL50840-2 NF-FW 99 22 M5
1803 or
1804 Hitachi LMG6912RPFC-00T
1805 or
1806 Hitachi SP14Q002
1807
1808 320x240. Black & white.
1809
1810 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001811 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001812
Simon Glass676d3192012-10-17 13:24:54 +00001813 CONFIG_LCD_ALIGNMENT
1814
1815 Normally the LCD is page-aligned (tyically 4KB). If this is
1816 defined then the LCD will be aligned to this value instead.
1817 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1818 here, since it is cheaper to change data cache settings on
1819 a per-section basis.
1820
Simon Glass0d89efe2012-10-17 13:24:59 +00001821 CONFIG_CONSOLE_SCROLL_LINES
1822
1823 When the console need to be scrolled, this is the number of
1824 lines to scroll by. It defaults to 1. Increasing this makes
1825 the console jump but can help speed up operation when scrolling
1826 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001827
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001828 CONFIG_LCD_BMP_RLE8
1829
1830 Support drawing of RLE8-compressed bitmaps on the LCD.
1831
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001832 CONFIG_I2C_EDID
1833
1834 Enables an 'i2c edid' command which can read EDID
1835 information over I2C from an attached LCD display.
1836
wdenk7152b1d2003-09-05 23:19:14 +00001837- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001838
wdenk8bde7f72003-06-27 21:31:46 +00001839 If this option is set, the environment is checked for
1840 a variable "splashimage". If found, the usual display
1841 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001842 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001843 specified in "splashimage" is loaded instead. The
1844 console is redirected to the "nulldev", too. This
1845 allows for a "silent" boot where a splash screen is
1846 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001847
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001848 CONFIG_SPLASHIMAGE_GUARD
1849
1850 If this option is set, then U-Boot will prevent the environment
1851 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001852 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001853 This option is useful for targets where, due to alignment
1854 restrictions, an improperly aligned BMP image will cause a data
1855 abort. If you think you will not have problems with unaligned
1856 accesses (for example because your toolchain prevents them)
1857 there is no need to set this option.
1858
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001859 CONFIG_SPLASH_SCREEN_ALIGN
1860
1861 If this option is set the splash image can be freely positioned
1862 on the screen. Environment variable "splashpos" specifies the
1863 position as "x,y". If a positive number is given it is used as
1864 number of pixel from left/top. If a negative number is given it
1865 is used as number of pixel from right/bottom. You can also
1866 specify 'm' for centering the image.
1867
1868 Example:
1869 setenv splashpos m,m
1870 => image at center of screen
1871
1872 setenv splashpos 30,20
1873 => image at x = 30 and y = 20
1874
1875 setenv splashpos -10,m
1876 => vertically centered image
1877 at x = dspWidth - bmpWidth - 9
1878
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001879- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1880
1881 If this option is set, additionally to standard BMP
1882 images, gzipped BMP images can be displayed via the
1883 splashscreen support or the bmp command.
1884
Anatolij Gustschind5011762010-03-15 14:50:25 +01001885- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1886
1887 If this option is set, 8-bit RLE compressed BMP images
1888 can be displayed via the splashscreen support or the
1889 bmp command.
1890
Lei Wenf2b96df2012-09-28 04:26:47 +00001891- Do compresssing for memory range:
1892 CONFIG_CMD_ZIP
1893
1894 If this option is set, it would use zlib deflate method
1895 to compress the specified memory at its best effort.
1896
wdenkc29fdfc2003-08-29 20:57:53 +00001897- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001898 CONFIG_GZIP
1899
1900 Enabled by default to support gzip compressed images.
1901
wdenkc29fdfc2003-08-29 20:57:53 +00001902 CONFIG_BZIP2
1903
1904 If this option is set, support for bzip2 compressed
1905 images is included. If not, only uncompressed and gzip
1906 compressed images are supported.
1907
wdenk42d1f032003-10-15 23:53:47 +00001908 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001909 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001910 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001911
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001912 CONFIG_LZMA
1913
1914 If this option is set, support for lzma compressed
1915 images is included.
1916
1917 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1918 requires an amount of dynamic memory that is given by the
1919 formula:
1920
1921 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1922
1923 Where lc and lp stand for, respectively, Literal context bits
1924 and Literal pos bits.
1925
1926 This value is upper-bounded by 14MB in the worst case. Anyway,
1927 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1928 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1929 a very small buffer.
1930
1931 Use the lzmainfo tool to determinate the lc and lp values and
1932 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001933 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001934
Kees Cook8ef70472013-08-16 07:59:12 -07001935 CONFIG_LZO
1936
1937 If this option is set, support for LZO compressed images
1938 is included.
1939
wdenk17ea1172004-06-06 21:51:03 +00001940- MII/PHY support:
1941 CONFIG_PHY_ADDR
1942
1943 The address of PHY on MII bus.
1944
1945 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1946
1947 The clock frequency of the MII bus
1948
1949 CONFIG_PHY_GIGE
1950
1951 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001952 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001953
1954 CONFIG_PHY_RESET_DELAY
1955
1956 Some PHY like Intel LXT971A need extra delay after
1957 reset before any MII register access is possible.
1958 For such PHY, set this option to the usec delay
1959 required. (minimum 300usec for LXT971A)
1960
1961 CONFIG_PHY_CMD_DELAY (ppc4xx)
1962
1963 Some PHY like Intel LXT971A need extra delay after
1964 command issued before MII status register can be read
1965
wdenkc6097192002-11-03 00:24:07 +00001966- Ethernet address:
1967 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001968 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001969 CONFIG_ETH2ADDR
1970 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001971 CONFIG_ETH4ADDR
1972 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001973
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001974 Define a default value for Ethernet address to use
1975 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001976 is not determined automatically.
1977
1978- IP address:
1979 CONFIG_IPADDR
1980
1981 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001982 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001983 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001984 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001985
1986- Server IP address:
1987 CONFIG_SERVERIP
1988
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001989 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001990 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001991 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001992
Robin Getz97cfe862009-07-21 12:15:28 -04001993 CONFIG_KEEP_SERVERADDR
1994
1995 Keeps the server's MAC address, in the env 'serveraddr'
1996 for passing to bootargs (like Linux's netconsole option)
1997
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001998- Gateway IP address:
1999 CONFIG_GATEWAYIP
2000
2001 Defines a default value for the IP address of the
2002 default router where packets to other networks are
2003 sent to.
2004 (Environment variable "gatewayip")
2005
2006- Subnet mask:
2007 CONFIG_NETMASK
2008
2009 Defines a default value for the subnet mask (or
2010 routing prefix) which is used to determine if an IP
2011 address belongs to the local subnet or needs to be
2012 forwarded through a router.
2013 (Environment variable "netmask")
2014
David Updegraff53a5c422007-06-11 10:41:07 -05002015- Multicast TFTP Mode:
2016 CONFIG_MCAST_TFTP
2017
2018 Defines whether you want to support multicast TFTP as per
2019 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002020 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002021 driver in use must provide a function: mcast() to join/leave a
2022 multicast group.
2023
wdenkc6097192002-11-03 00:24:07 +00002024- BOOTP Recovery Mode:
2025 CONFIG_BOOTP_RANDOM_DELAY
2026
2027 If you have many targets in a network that try to
2028 boot using BOOTP, you may want to avoid that all
2029 systems send out BOOTP requests at precisely the same
2030 moment (which would happen for instance at recovery
2031 from a power failure, when all systems will try to
2032 boot, thus flooding the BOOTP server. Defining
2033 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2034 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002035 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002036
2037 1st BOOTP request: delay 0 ... 1 sec
2038 2nd BOOTP request: delay 0 ... 2 sec
2039 3rd BOOTP request: delay 0 ... 4 sec
2040 4th and following
2041 BOOTP requests: delay 0 ... 8 sec
2042
stroesefe389a82003-08-28 14:17:32 +00002043- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002044 You can fine tune the DHCP functionality by defining
2045 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002046
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002047 CONFIG_BOOTP_SUBNETMASK
2048 CONFIG_BOOTP_GATEWAY
2049 CONFIG_BOOTP_HOSTNAME
2050 CONFIG_BOOTP_NISDOMAIN
2051 CONFIG_BOOTP_BOOTPATH
2052 CONFIG_BOOTP_BOOTFILESIZE
2053 CONFIG_BOOTP_DNS
2054 CONFIG_BOOTP_DNS2
2055 CONFIG_BOOTP_SEND_HOSTNAME
2056 CONFIG_BOOTP_NTPSERVER
2057 CONFIG_BOOTP_TIMEOFFSET
2058 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002059 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002060
Wilson Callan5d110f02007-07-28 10:56:13 -04002061 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2062 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002063
Joe Hershberger2c00e092012-05-23 07:59:19 +00002064 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2065 after the configured retry count, the call will fail
2066 instead of starting over. This can be used to fail over
2067 to Link-local IP address configuration if the DHCP server
2068 is not available.
2069
stroesefe389a82003-08-28 14:17:32 +00002070 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2071 serverip from a DHCP server, it is possible that more
2072 than one DNS serverip is offered to the client.
2073 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2074 serverip will be stored in the additional environment
2075 variable "dnsip2". The first DNS serverip is always
2076 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002077 is defined.
stroesefe389a82003-08-28 14:17:32 +00002078
2079 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2080 to do a dynamic update of a DNS server. To do this, they
2081 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002082 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002083 of the "hostname" environment variable is passed as
2084 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002085
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002086 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2087
2088 A 32bit value in microseconds for a delay between
2089 receiving a "DHCP Offer" and sending the "DHCP Request".
2090 This fixes a problem with certain DHCP servers that don't
2091 respond 100% of the time to a "DHCP request". E.g. On an
2092 AT91RM9200 processor running at 180MHz, this delay needed
2093 to be *at least* 15,000 usec before a Windows Server 2003
2094 DHCP server would reply 100% of the time. I recommend at
2095 least 50,000 usec to be safe. The alternative is to hope
2096 that one of the retries will be successful but note that
2097 the DHCP timeout and retry process takes a longer than
2098 this delay.
2099
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002100 - Link-local IP address negotiation:
2101 Negotiate with other link-local clients on the local network
2102 for an address that doesn't require explicit configuration.
2103 This is especially useful if a DHCP server cannot be guaranteed
2104 to exist in all environments that the device must operate.
2105
2106 See doc/README.link-local for more information.
2107
wdenka3d991b2004-04-15 21:48:45 +00002108 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002109 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002110
2111 The device id used in CDP trigger frames.
2112
2113 CONFIG_CDP_DEVICE_ID_PREFIX
2114
2115 A two character string which is prefixed to the MAC address
2116 of the device.
2117
2118 CONFIG_CDP_PORT_ID
2119
2120 A printf format string which contains the ascii name of
2121 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002122 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002123
2124 CONFIG_CDP_CAPABILITIES
2125
2126 A 32bit integer which indicates the device capabilities;
2127 0x00000010 for a normal host which does not forwards.
2128
2129 CONFIG_CDP_VERSION
2130
2131 An ascii string containing the version of the software.
2132
2133 CONFIG_CDP_PLATFORM
2134
2135 An ascii string containing the name of the platform.
2136
2137 CONFIG_CDP_TRIGGER
2138
2139 A 32bit integer sent on the trigger.
2140
2141 CONFIG_CDP_POWER_CONSUMPTION
2142
2143 A 16bit integer containing the power consumption of the
2144 device in .1 of milliwatts.
2145
2146 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2147
2148 A byte containing the id of the VLAN.
2149
wdenkc6097192002-11-03 00:24:07 +00002150- Status LED: CONFIG_STATUS_LED
2151
2152 Several configurations allow to display the current
2153 status using a LED. For instance, the LED will blink
2154 fast while running U-Boot code, stop blinking as
2155 soon as a reply to a BOOTP request was received, and
2156 start blinking slow once the Linux kernel is running
2157 (supported by a status LED driver in the Linux
2158 kernel). Defining CONFIG_STATUS_LED enables this
2159 feature in U-Boot.
2160
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002161 Additional options:
2162
2163 CONFIG_GPIO_LED
2164 The status LED can be connected to a GPIO pin.
2165 In such cases, the gpio_led driver can be used as a
2166 status LED backend implementation. Define CONFIG_GPIO_LED
2167 to include the gpio_led driver in the U-Boot binary.
2168
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002169 CONFIG_GPIO_LED_INVERTED_TABLE
2170 Some GPIO connected LEDs may have inverted polarity in which
2171 case the GPIO high value corresponds to LED off state and
2172 GPIO low value corresponds to LED on state.
2173 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2174 with a list of GPIO LEDs that have inverted polarity.
2175
wdenkc6097192002-11-03 00:24:07 +00002176- CAN Support: CONFIG_CAN_DRIVER
2177
2178 Defining CONFIG_CAN_DRIVER enables CAN driver support
2179 on those systems that support this (optional)
2180 feature, like the TQM8xxL modules.
2181
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002182- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002183
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002184 This enable the NEW i2c subsystem, and will allow you to use
2185 i2c commands at the u-boot command line (as long as you set
2186 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2187 based realtime clock chips or other i2c devices. See
2188 common/cmd_i2c.c for a description of the command line
2189 interface.
2190
2191 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002192 - drivers/i2c/soft_i2c.c:
2193 - activate first bus with CONFIG_SYS_I2C_SOFT define
2194 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2195 for defining speed and slave address
2196 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2197 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2198 for defining speed and slave address
2199 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2200 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2201 for defining speed and slave address
2202 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2203 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2204 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002205
Heiko Schocher00f792e2012-10-24 13:48:22 +02002206 - drivers/i2c/fsl_i2c.c:
2207 - activate i2c driver with CONFIG_SYS_I2C_FSL
2208 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2209 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2210 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2211 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002212 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002213 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2214 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2215 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2216 second bus.
2217
Simon Glass1f2ba722012-10-30 07:28:53 +00002218 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002219 - activate this driver with CONFIG_SYS_I2C_TEGRA
2220 - This driver adds 4 i2c buses with a fix speed from
2221 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002222
Dirk Eibach880540d2013-04-25 02:40:01 +00002223 - drivers/i2c/ppc4xx_i2c.c
2224 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2225 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2226 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2227
tremfac96402013-09-21 18:13:35 +02002228 - drivers/i2c/i2c_mxc.c
2229 - activate this driver with CONFIG_SYS_I2C_MXC
2230 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2231 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2232 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2233 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2234 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2235 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2236 If thoses defines are not set, default value is 100000
2237 for speed, and 0 for slave.
2238
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002239 - drivers/i2c/rcar_i2c.c:
2240 - activate this driver with CONFIG_SYS_I2C_RCAR
2241 - This driver adds 4 i2c buses
2242
2243 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2244 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2245 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2246 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2247 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2248 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2249 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2250 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2251 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2252
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002253 - drivers/i2c/sh_i2c.c:
2254 - activate this driver with CONFIG_SYS_I2C_SH
2255 - This driver adds from 2 to 5 i2c buses
2256
2257 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2258 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2259 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2260 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2261 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2262 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2263 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2264 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2265 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2266 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2267 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2268 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2269 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2270
Heiko Schocher6789e842013-10-22 11:03:18 +02002271 - drivers/i2c/omap24xx_i2c.c
2272 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2273 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2274 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2275 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2276 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2277 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2278 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2279 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2280 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2281 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2282 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2283
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002284 - drivers/i2c/zynq_i2c.c
2285 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2286 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2287 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2288
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302289 - drivers/i2c/s3c24x0_i2c.c:
2290 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2291 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2292 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2293 with a fix speed from 100000 and the slave addr 0!
2294
Dirk Eibachb46226b2014-07-03 09:28:18 +02002295 - drivers/i2c/ihs_i2c.c
2296 - activate this driver with CONFIG_SYS_I2C_IHS
2297 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2298 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2299 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2300 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2301 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2302 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2303 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2304 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2305 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2306 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2307 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2308 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2309
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002310 additional defines:
2311
2312 CONFIG_SYS_NUM_I2C_BUSES
2313 Hold the number of i2c busses you want to use. If you
2314 don't use/have i2c muxes on your i2c bus, this
2315 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2316 omit this define.
2317
2318 CONFIG_SYS_I2C_DIRECT_BUS
2319 define this, if you don't use i2c muxes on your hardware.
2320 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2321 omit this define.
2322
2323 CONFIG_SYS_I2C_MAX_HOPS
2324 define how many muxes are maximal consecutively connected
2325 on one i2c bus. If you not use i2c muxes, omit this
2326 define.
2327
2328 CONFIG_SYS_I2C_BUSES
2329 hold a list of busses you want to use, only used if
2330 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2331 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2332 CONFIG_SYS_NUM_I2C_BUSES = 9:
2333
2334 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2335 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2336 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2337 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2338 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2339 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2340 {1, {I2C_NULL_HOP}}, \
2341 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2342 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2343 }
2344
2345 which defines
2346 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002347 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2348 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2349 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2350 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2351 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002352 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002353 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2354 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002355
2356 If you do not have i2c muxes on your board, omit this define.
2357
Heiko Schocherea818db2013-01-29 08:53:15 +01002358- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002359
2360 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2361 provides the following compelling advantages:
2362
2363 - more than one i2c adapter is usable
2364 - approved multibus support
2365 - better i2c mux support
2366
2367 ** Please consider updating your I2C driver now. **
2368
Heiko Schocherea818db2013-01-29 08:53:15 +01002369 These enable legacy I2C serial bus commands. Defining
2370 CONFIG_HARD_I2C will include the appropriate I2C driver
2371 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002372
wdenk945af8d2003-07-16 21:53:01 +00002373 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002374 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002375 CONFIG_COMMANDS) and communicate with i2c based realtime
2376 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002377 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002378
Ben Warrenbb99ad62006-09-07 16:50:54 -04002379 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002380
wdenk945af8d2003-07-16 21:53:01 +00002381 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002382 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002384 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002385 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002386 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002387 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002388
Peter Tyser8d321b82010-04-12 22:28:21 -05002389 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002390 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002391 and so its address should therefore be cleared to 0 (See,
2392 eg, MPC823e User's Manual p.16-473). So, set
2393 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002394
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002395 CONFIG_SYS_I2C_INIT_MPC5XXX
2396
2397 When a board is reset during an i2c bus transfer
2398 chips might think that the current transfer is still
2399 in progress. Reset the slave devices by sending start
2400 commands until the slave device responds.
2401
wdenk945af8d2003-07-16 21:53:01 +00002402 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002403
Heiko Schocherea818db2013-01-29 08:53:15 +01002404 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002405 then the following macros need to be defined (examples are
2406 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002407
2408 I2C_INIT
2409
wdenkb37c7e52003-06-30 16:24:52 +00002410 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002411 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002412
wdenkba56f622004-02-06 23:19:44 +00002413 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002414
wdenkc6097192002-11-03 00:24:07 +00002415 I2C_PORT
2416
wdenk43d96162003-03-06 00:02:04 +00002417 (Only for MPC8260 CPU). The I/O port to use (the code
2418 assumes both bits are on the same port). Valid values
2419 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002420
2421 I2C_ACTIVE
2422
2423 The code necessary to make the I2C data line active
2424 (driven). If the data line is open collector, this
2425 define can be null.
2426
wdenkb37c7e52003-06-30 16:24:52 +00002427 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2428
wdenkc6097192002-11-03 00:24:07 +00002429 I2C_TRISTATE
2430
2431 The code necessary to make the I2C data line tri-stated
2432 (inactive). If the data line is open collector, this
2433 define can be null.
2434
wdenkb37c7e52003-06-30 16:24:52 +00002435 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2436
wdenkc6097192002-11-03 00:24:07 +00002437 I2C_READ
2438
York Sun472d5462013-04-01 11:29:11 -07002439 Code that returns true if the I2C data line is high,
2440 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002441
wdenkb37c7e52003-06-30 16:24:52 +00002442 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2443
wdenkc6097192002-11-03 00:24:07 +00002444 I2C_SDA(bit)
2445
York Sun472d5462013-04-01 11:29:11 -07002446 If <bit> is true, sets the I2C data line high. If it
2447 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002448
wdenkb37c7e52003-06-30 16:24:52 +00002449 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002450 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002451 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002452
wdenkc6097192002-11-03 00:24:07 +00002453 I2C_SCL(bit)
2454
York Sun472d5462013-04-01 11:29:11 -07002455 If <bit> is true, sets the I2C clock line high. If it
2456 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002457
wdenkb37c7e52003-06-30 16:24:52 +00002458 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002459 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002460 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002461
wdenkc6097192002-11-03 00:24:07 +00002462 I2C_DELAY
2463
2464 This delay is invoked four times per clock cycle so this
2465 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002466 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002467 like:
2468
wdenkb37c7e52003-06-30 16:24:52 +00002469 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002470
Mike Frysinger793b5722010-07-21 13:38:02 -04002471 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2472
2473 If your arch supports the generic GPIO framework (asm/gpio.h),
2474 then you may alternatively define the two GPIOs that are to be
2475 used as SCL / SDA. Any of the previous I2C_xxx macros will
2476 have GPIO-based defaults assigned to them as appropriate.
2477
2478 You should define these to the GPIO value as given directly to
2479 the generic GPIO functions.
2480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002482
wdenk8bde7f72003-06-27 21:31:46 +00002483 When a board is reset during an i2c bus transfer
2484 chips might think that the current transfer is still
2485 in progress. On some boards it is possible to access
2486 the i2c SCLK line directly, either by using the
2487 processor pin as a GPIO or by having a second pin
2488 connected to the bus. If this option is defined a
2489 custom i2c_init_board() routine in boards/xxx/board.c
2490 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002491
Richard Retanubun26a33502010-04-12 15:08:17 -04002492 CONFIG_SYS_I2C_BOARD_LATE_INIT
2493
2494 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2495 defined a custom i2c_board_late_init() routine in
2496 boards/xxx/board.c is run AFTER the operations in i2c_init()
2497 is completed. This callpoint can be used to unreset i2c bus
2498 using CPU i2c controller register accesses for CPUs whose i2c
2499 controller provide such a method. It is called at the end of
2500 i2c_init() to allow i2c_init operations to setup the i2c bus
2501 controller on the CPU (e.g. setting bus speed & slave address).
2502
wdenk17ea1172004-06-06 21:51:03 +00002503 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2504
2505 This option enables configuration of bi_iic_fast[] flags
2506 in u-boot bd_info structure based on u-boot environment
2507 variable "i2cfast". (see also i2cfast)
2508
Ben Warrenbb99ad62006-09-07 16:50:54 -04002509 CONFIG_I2C_MULTI_BUS
2510
2511 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002512 must have a controller. At any point in time, only one bus is
2513 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002514 Note that bus numbering is zero-based.
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002517
2518 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002519 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002520 is set, specify a list of bus-device pairs. Otherwise, specify
2521 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002522
2523 e.g.
2524 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002525 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002526
2527 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2528
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002529 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002530 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002531
2532 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002534 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002535
2536 If defined, then this indicates the I2C bus number for DDR SPD.
2537 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002539 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002540
2541 If defined, then this indicates the I2C bus number for the RTC.
2542 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2543
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002544 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002545
2546 If defined, then this indicates the I2C bus number for the DTT.
2547 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002549 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002550
2551 If defined, specifies the I2C address of the DTT device.
2552 If not defined, then U-Boot uses predefined value for
2553 specified DTT device.
2554
Andrew Dyer2ac69852008-12-29 17:36:01 -06002555 CONFIG_SOFT_I2C_READ_REPEATED_START
2556
2557 defining this will force the i2c_read() function in
2558 the soft_i2c driver to perform an I2C repeated start
2559 between writing the address pointer and reading the
2560 data. If this define is omitted the default behaviour
2561 of doing a stop-start sequence will be used. Most I2C
2562 devices can use either method, but some require one or
2563 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002564
wdenkc6097192002-11-03 00:24:07 +00002565- SPI Support: CONFIG_SPI
2566
2567 Enables SPI driver (so far only tested with
2568 SPI EEPROM, also an instance works with Crystal A/D and
2569 D/As on the SACSng board)
2570
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002571 CONFIG_SH_SPI
2572
2573 Enables the driver for SPI controller on SuperH. Currently
2574 only SH7757 is supported.
2575
wdenkc6097192002-11-03 00:24:07 +00002576 CONFIG_SPI_X
2577
2578 Enables extended (16-bit) SPI EEPROM addressing.
2579 (symmetrical to CONFIG_I2C_X)
2580
2581 CONFIG_SOFT_SPI
2582
wdenk43d96162003-03-06 00:02:04 +00002583 Enables a software (bit-bang) SPI driver rather than
2584 using hardware support. This is a general purpose
2585 driver that only requires three general I/O port pins
2586 (two outputs, one input) to function. If this is
2587 defined, the board configuration must define several
2588 SPI configuration items (port pins to use, etc). For
2589 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002590
Ben Warren04a9e112008-01-16 22:37:35 -05002591 CONFIG_HARD_SPI
2592
2593 Enables a hardware SPI driver for general-purpose reads
2594 and writes. As with CONFIG_SOFT_SPI, the board configuration
2595 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002596 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002597 example, see include/configs/mpc8349emds.h.
2598
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002599 CONFIG_MXC_SPI
2600
2601 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002602 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002603
Matthias Fuchs01335022007-12-27 17:12:34 +01002604- FPGA Support: CONFIG_FPGA
2605
2606 Enables FPGA subsystem.
2607
2608 CONFIG_FPGA_<vendor>
2609
2610 Enables support for specific chip vendors.
2611 (ALTERA, XILINX)
2612
2613 CONFIG_FPGA_<family>
2614
2615 Enables support for FPGA family.
2616 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2617
2618 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002619
wdenk43d96162003-03-06 00:02:04 +00002620 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002621
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302622 CONFIG_CMD_FPGA_LOADMK
2623
2624 Enable support for fpga loadmk command
2625
Michal Simek67193862014-05-02 13:43:39 +02002626 CONFIG_CMD_FPGA_LOADP
2627
2628 Enable support for fpga loadp command - load partial bitstream
2629
2630 CONFIG_CMD_FPGA_LOADBP
2631
2632 Enable support for fpga loadbp command - load partial bitstream
2633 (Xilinx only)
2634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002635 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002636
wdenk8bde7f72003-06-27 21:31:46 +00002637 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002639 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002640
wdenk43d96162003-03-06 00:02:04 +00002641 Enable checks on FPGA configuration interface busy
2642 status by the configuration function. This option
2643 will require a board or device specific function to
2644 be written.
wdenkc6097192002-11-03 00:24:07 +00002645
2646 CONFIG_FPGA_DELAY
2647
2648 If defined, a function that provides delays in the FPGA
2649 configuration driver.
2650
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002651 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002652 Allow Control-C to interrupt FPGA configuration
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002655
wdenk43d96162003-03-06 00:02:04 +00002656 Check for configuration errors during FPGA bitfile
2657 loading. For example, abort during Virtex II
2658 configuration if the INIT_B line goes low (which
2659 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002661 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002662
wdenk43d96162003-03-06 00:02:04 +00002663 Maximum time to wait for the INIT_B line to deassert
2664 after PROB_B has been deasserted during a Virtex II
2665 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002666 ms.
wdenkc6097192002-11-03 00:24:07 +00002667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002668 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002669
wdenk43d96162003-03-06 00:02:04 +00002670 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002671 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002673 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002674
wdenk43d96162003-03-06 00:02:04 +00002675 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002676 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002677
2678- Configuration Management:
2679 CONFIG_IDENT_STRING
2680
wdenk43d96162003-03-06 00:02:04 +00002681 If defined, this string will be added to the U-Boot
2682 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002683
2684- Vendor Parameter Protection:
2685
wdenk43d96162003-03-06 00:02:04 +00002686 U-Boot considers the values of the environment
2687 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002688 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002689 are set once by the board vendor / manufacturer, and
2690 protects these variables from casual modification by
2691 the user. Once set, these variables are read-only,
2692 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002693 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002694
2695 If CONFIG_ENV_OVERWRITE is #defined in your config
2696 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002697 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002698 these parameters.
2699
2700 Alternatively, if you #define _both_ CONFIG_ETHADDR
2701 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002702 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002703 which can be changed exactly ONCE by the user. [The
2704 serial# is unaffected by this, i. e. it remains
2705 read-only.]
2706
Joe Hershberger25980902012-12-11 22:16:31 -06002707 The same can be accomplished in a more flexible way
2708 for any variable by configuring the type of access
2709 to allow for those variables in the ".flags" variable
2710 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2711
wdenkc6097192002-11-03 00:24:07 +00002712- Protected RAM:
2713 CONFIG_PRAM
2714
2715 Define this variable to enable the reservation of
2716 "protected RAM", i. e. RAM which is not overwritten
2717 by U-Boot. Define CONFIG_PRAM to hold the number of
2718 kB you want to reserve for pRAM. You can overwrite
2719 this default value by defining an environment
2720 variable "pram" to the number of kB you want to
2721 reserve. Note that the board info structure will
2722 still show the full amount of RAM. If pRAM is
2723 reserved, a new environment variable "mem" will
2724 automatically be defined to hold the amount of
2725 remaining RAM in a form that can be passed as boot
2726 argument to Linux, for instance like that:
2727
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002728 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002729 saveenv
2730
2731 This way you can tell Linux not to use this memory,
2732 either, which results in a memory region that will
2733 not be affected by reboots.
2734
2735 *WARNING* If your board configuration uses automatic
2736 detection of the RAM size, you must make sure that
2737 this memory test is non-destructive. So far, the
2738 following board configurations are known to be
2739 "pRAM-clean":
2740
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002741 IVMS8, IVML24, SPD8xx, TQM8xxL,
2742 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002743 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002744
Gabe Black40fef042012-12-02 04:55:18 +00002745- Access to physical memory region (> 4GB)
2746 Some basic support is provided for operations on memory not
2747 normally accessible to U-Boot - e.g. some architectures
2748 support access to more than 4GB of memory on 32-bit
2749 machines using physical address extension or similar.
2750 Define CONFIG_PHYSMEM to access this basic support, which
2751 currently only supports clearing the memory.
2752
wdenkc6097192002-11-03 00:24:07 +00002753- Error Recovery:
2754 CONFIG_PANIC_HANG
2755
2756 Define this variable to stop the system in case of a
2757 fatal error, so that you have to reset it manually.
2758 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002759 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002760 automatically as fast as possible, but it may be
2761 useful during development since you can try to debug
2762 the conditions that lead to the situation.
2763
2764 CONFIG_NET_RETRY_COUNT
2765
wdenk43d96162003-03-06 00:02:04 +00002766 This variable defines the number of retries for
2767 network operations like ARP, RARP, TFTP, or BOOTP
2768 before giving up the operation. If not defined, a
2769 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002770
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002771 CONFIG_ARP_TIMEOUT
2772
2773 Timeout waiting for an ARP reply in milliseconds.
2774
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002775 CONFIG_NFS_TIMEOUT
2776
2777 Timeout in milliseconds used in NFS protocol.
2778 If you encounter "ERROR: Cannot umount" in nfs command,
2779 try longer timeout such as
2780 #define CONFIG_NFS_TIMEOUT 10000UL
2781
wdenkc6097192002-11-03 00:24:07 +00002782- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002783 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002784
2785 Enable auto completion of commands using TAB.
2786
Wolfgang Denka9398e02006-11-27 15:32:42 +01002787 Note that this feature has NOT been implemented yet
2788 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002789
2790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002792
2793 Define this variable to enable the "hush" shell (from
2794 Busybox) as command line interpreter, thus enabling
2795 powerful command line syntax like
2796 if...then...else...fi conditionals or `&&' and '||'
2797 constructs ("shell scripts").
2798
2799 If undefined, you get the old, much simpler behaviour
2800 with a somewhat smaller memory footprint.
2801
2802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002804
2805 This defines the secondary prompt string, which is
2806 printed when the command interpreter needs more input
2807 to complete a command. Usually "> ".
2808
2809 Note:
2810
wdenk8bde7f72003-06-27 21:31:46 +00002811 In the current implementation, the local variables
2812 space and global environment variables space are
2813 separated. Local variables are those you define by
2814 simply typing `name=value'. To access a local
2815 variable later on, you have write `$name' or
2816 `${name}'; to execute the contents of a variable
2817 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002818
wdenk43d96162003-03-06 00:02:04 +00002819 Global environment variables are those you use
2820 setenv/printenv to work with. To run a command stored
2821 in such a variable, you need to use the run command,
2822 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002823
2824 To store commands and special characters in a
2825 variable, please use double quotation marks
2826 surrounding the whole text of the variable, instead
2827 of the backslashes before semicolons and special
2828 symbols.
2829
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002830- Commandline Editing and History:
2831 CONFIG_CMDLINE_EDITING
2832
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002833 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002834 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002835
wdenka8c7c702003-12-06 19:49:23 +00002836- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002837 CONFIG_EXTRA_ENV_SETTINGS
2838
wdenk43d96162003-03-06 00:02:04 +00002839 Define this to contain any number of null terminated
2840 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002841 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002842
wdenk43d96162003-03-06 00:02:04 +00002843 For example, place something like this in your
2844 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002845
2846 #define CONFIG_EXTRA_ENV_SETTINGS \
2847 "myvar1=value1\0" \
2848 "myvar2=value2\0"
2849
wdenk43d96162003-03-06 00:02:04 +00002850 Warning: This method is based on knowledge about the
2851 internal format how the environment is stored by the
2852 U-Boot code. This is NOT an official, exported
2853 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002854 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002855 You better know what you are doing here.
2856
wdenk43d96162003-03-06 00:02:04 +00002857 Note: overly (ab)use of the default environment is
2858 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002859 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002860 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002861
Stephen Warren5e724ca2012-05-22 09:21:54 +00002862 CONFIG_ENV_VARS_UBOOT_CONFIG
2863
2864 Define this in order to add variables describing the
2865 U-Boot build configuration to the default environment.
2866 These will be named arch, cpu, board, vendor, and soc.
2867
2868 Enabling this option will cause the following to be defined:
2869
2870 - CONFIG_SYS_ARCH
2871 - CONFIG_SYS_CPU
2872 - CONFIG_SYS_BOARD
2873 - CONFIG_SYS_VENDOR
2874 - CONFIG_SYS_SOC
2875
Tom Rini7e27f892012-10-24 07:28:16 +00002876 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2877
2878 Define this in order to add variables describing certain
2879 run-time determined information about the hardware to the
2880 environment. These will be named board_name, board_rev.
2881
Simon Glass06fd8532012-11-30 13:01:17 +00002882 CONFIG_DELAY_ENVIRONMENT
2883
2884 Normally the environment is loaded when the board is
2885 intialised so that it is available to U-Boot. This inhibits
2886 that so that the environment is not available until
2887 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2888 this is instead controlled by the value of
2889 /config/load-environment.
2890
wdenka8c7c702003-12-06 19:49:23 +00002891- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002892 CONFIG_HAS_DATAFLASH
2893
wdenk8bde7f72003-06-27 21:31:46 +00002894 Defining this option enables DataFlash features and
2895 allows to read/write in Dataflash via the standard
2896 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002897
Eric Nelsonf61ec452012-01-31 10:52:08 -07002898- Serial Flash support
2899 CONFIG_CMD_SF
2900
2901 Defining this option enables SPI flash commands
2902 'sf probe/read/write/erase/update'.
2903
2904 Usage requires an initial 'probe' to define the serial
2905 flash parameters, followed by read/write/erase/update
2906 commands.
2907
2908 The following defaults may be provided by the platform
2909 to handle the common case when only a single serial
2910 flash is present on the system.
2911
2912 CONFIG_SF_DEFAULT_BUS Bus identifier
2913 CONFIG_SF_DEFAULT_CS Chip-select
2914 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2915 CONFIG_SF_DEFAULT_SPEED in Hz
2916
Simon Glass24007272012-10-08 13:16:02 +00002917 CONFIG_CMD_SF_TEST
2918
2919 Define this option to include a destructive SPI flash
2920 test ('sf test').
2921
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302922 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2923
2924 Define this option to use the Bank addr/Extended addr
2925 support on SPI flashes which has size > 16Mbytes.
2926
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302927 CONFIG_SF_DUAL_FLASH Dual flash memories
2928
2929 Define this option to use dual flash support where two flash
2930 memories can be connected with a given cs line.
2931 currently Xilinx Zynq qspi support these type of connections.
2932
Heiko Schocher562f8df2014-07-18 06:07:21 +02002933 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2934 enable the W#/Vpp signal to disable writing to the status
2935 register on ST MICRON flashes like the N25Q128.
2936 The status register write enable/disable bit, combined with
2937 the W#/VPP signal provides hardware data protection for the
2938 device as follows: When the enable/disable bit is set to 1,
2939 and the W#/VPP signal is driven LOW, the status register
2940 nonvolatile bits become read-only and the WRITE STATUS REGISTER
2941 operation will not execute. The only way to exit this
2942 hardware-protected mode is to drive W#/VPP HIGH.
2943
wdenk3f85ce22004-02-23 16:11:30 +00002944- SystemACE Support:
2945 CONFIG_SYSTEMACE
2946
2947 Adding this option adds support for Xilinx SystemACE
2948 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002949 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002950 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002951
2952 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002954
2955 When SystemACE support is added, the "ace" device type
2956 becomes available to the fat commands, i.e. fatls.
2957
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002958- TFTP Fixed UDP Port:
2959 CONFIG_TFTP_PORT
2960
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002961 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002962 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002963 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002964 number generator is used.
2965
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002966 Also, the environment variable tftpdstp is used to supply
2967 the TFTP UDP destination port value. If tftpdstp isn't
2968 defined, the normal port 69 is used.
2969
2970 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002971 blindly start the TFTP transfer using the pre-configured
2972 target IP address and UDP port. This has the effect of
2973 "punching through" the (Windows XP) firewall, allowing
2974 the remainder of the TFTP transfer to proceed normally.
2975 A better solution is to properly configure the firewall,
2976 but sometimes that is not allowed.
2977
Simon Glassbf36c5d2012-12-05 14:46:38 +00002978- Hashing support:
2979 CONFIG_CMD_HASH
2980
2981 This enables a generic 'hash' command which can produce
2982 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2983
2984 CONFIG_HASH_VERIFY
2985
2986 Enable the hash verify command (hash -v). This adds to code
2987 size a little.
2988
2989 CONFIG_SHA1 - support SHA1 hashing
2990 CONFIG_SHA256 - support SHA256 hashing
2991
2992 Note: There is also a sha1sum command, which should perhaps
2993 be deprecated in favour of 'hash sha1'.
2994
Robert Winklera11f1872013-07-24 17:57:06 -07002995- Freescale i.MX specific commands:
2996 CONFIG_CMD_HDMIDETECT
2997 This enables 'hdmidet' command which returns true if an
2998 HDMI monitor is detected. This command is i.MX 6 specific.
2999
3000 CONFIG_CMD_BMODE
3001 This enables the 'bmode' (bootmode) command for forcing
3002 a boot from specific media.
3003
3004 This is useful for forcing the ROM's usb downloader to
3005 activate upon a watchdog reset which is nice when iterating
3006 on U-Boot. Using the reset button or running bmode normal
3007 will set it back to normal. This command currently
3008 supports i.MX53 and i.MX6.
3009
Simon Glass19c402a2013-06-13 15:10:02 -07003010- Signing support:
3011 CONFIG_RSA
3012
3013 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003014 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003015
3016 The signing part is build into mkimage regardless of this
3017 option.
3018
Heiko Schocher9e50c402014-01-25 07:27:13 +01003019- bootcount support:
3020 CONFIG_BOOTCOUNT_LIMIT
3021
3022 This enables the bootcounter support, see:
3023 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3024
3025 CONFIG_AT91SAM9XE
3026 enable special bootcounter support on at91sam9xe based boards.
3027 CONFIG_BLACKFIN
3028 enable special bootcounter support on blackfin based boards.
3029 CONFIG_SOC_DA8XX
3030 enable special bootcounter support on da850 based boards.
3031 CONFIG_BOOTCOUNT_RAM
3032 enable support for the bootcounter in RAM
3033 CONFIG_BOOTCOUNT_I2C
3034 enable support for the bootcounter on an i2c (like RTC) device.
3035 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3036 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3037 the bootcounter.
3038 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003039
wdenka8c7c702003-12-06 19:49:23 +00003040- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003041 CONFIG_SHOW_BOOT_PROGRESS
3042
wdenk43d96162003-03-06 00:02:04 +00003043 Defining this option allows to add some board-
3044 specific code (calling a user-provided function
3045 "show_boot_progress(int)") that enables you to show
3046 the system's boot progress on some display (for
3047 example, some LED's) on your board. At the moment,
3048 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003049
Simon Glass3a608ca2012-02-13 13:51:19 +00003050- Detailed boot stage timing
3051 CONFIG_BOOTSTAGE
3052 Define this option to get detailed timing of each stage
3053 of the boot process.
3054
3055 CONFIG_BOOTSTAGE_USER_COUNT
3056 This is the number of available user bootstage records.
3057 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3058 a new ID will be allocated from this stash. If you exceed
3059 the limit, recording will stop.
3060
3061 CONFIG_BOOTSTAGE_REPORT
3062 Define this to print a report before boot, similar to this:
3063
3064 Timer summary in microseconds:
3065 Mark Elapsed Stage
3066 0 0 reset
3067 3,575,678 3,575,678 board_init_f start
3068 3,575,695 17 arch_cpu_init A9
3069 3,575,777 82 arch_cpu_init done
3070 3,659,598 83,821 board_init_r start
3071 3,910,375 250,777 main_loop
3072 29,916,167 26,005,792 bootm_start
3073 30,361,327 445,160 start_kernel
3074
Simon Glass2eba38c2012-09-28 08:56:39 +00003075 CONFIG_CMD_BOOTSTAGE
3076 Add a 'bootstage' command which supports printing a report
3077 and un/stashing of bootstage data.
3078
Simon Glass94fd1312012-09-28 08:56:37 +00003079 CONFIG_BOOTSTAGE_FDT
3080 Stash the bootstage information in the FDT. A root 'bootstage'
3081 node is created with each bootstage id as a child. Each child
3082 has a 'name' property and either 'mark' containing the
3083 mark time in microsecond, or 'accum' containing the
3084 accumulated time for that bootstage id in microseconds.
3085 For example:
3086
3087 bootstage {
3088 154 {
3089 name = "board_init_f";
3090 mark = <3575678>;
3091 };
3092 170 {
3093 name = "lcd";
3094 accum = <33482>;
3095 };
3096 };
3097
3098 Code in the Linux kernel can find this in /proc/devicetree.
3099
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003100Legacy uImage format:
3101
wdenkc6097192002-11-03 00:24:07 +00003102 Arg Where When
3103 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003104 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003105 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003106 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003107 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003108 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003109 4 common/cmd_bootm.c Image data has correct checksum
3110 -4 common/cmd_bootm.c Image is for unsupported architecture
3111 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003112 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003113 6 common/cmd_bootm.c Image Type check OK
3114 -6 common/cmd_bootm.c gunzip uncompression error
3115 -7 common/cmd_bootm.c Unimplemented compression type
3116 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003117 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003118 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003119
3120 9 common/image.c Start initial ramdisk verification
3121 -10 common/image.c Ramdisk header has bad magic number
3122 -11 common/image.c Ramdisk header has bad checksum
3123 10 common/image.c Ramdisk header is OK
3124 -12 common/image.c Ramdisk data has bad checksum
3125 11 common/image.c Ramdisk data has correct checksum
3126 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003127 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003128 13 common/image.c Start multifile image verification
3129 14 common/image.c No initial ramdisk, no multifile, continue.
3130
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003131 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003132
Stefan Roesea47a12b2010-04-15 16:07:28 +02003133 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003134 -31 post/post.c POST test failed, detected by post_output_backlog()
3135 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003136
Heiko Schocher566a4942007-06-22 19:11:54 +02003137 34 common/cmd_doc.c before loading a Image from a DOC device
3138 -35 common/cmd_doc.c Bad usage of "doc" command
3139 35 common/cmd_doc.c correct usage of "doc" command
3140 -36 common/cmd_doc.c No boot device
3141 36 common/cmd_doc.c correct boot device
3142 -37 common/cmd_doc.c Unknown Chip ID on boot device
3143 37 common/cmd_doc.c correct chip ID found, device available
3144 -38 common/cmd_doc.c Read Error on boot device
3145 38 common/cmd_doc.c reading Image header from DOC device OK
3146 -39 common/cmd_doc.c Image header has bad magic number
3147 39 common/cmd_doc.c Image header has correct magic number
3148 -40 common/cmd_doc.c Error reading Image from DOC device
3149 40 common/cmd_doc.c Image header has correct magic number
3150 41 common/cmd_ide.c before loading a Image from a IDE device
3151 -42 common/cmd_ide.c Bad usage of "ide" command
3152 42 common/cmd_ide.c correct usage of "ide" command
3153 -43 common/cmd_ide.c No boot device
3154 43 common/cmd_ide.c boot device found
3155 -44 common/cmd_ide.c Device not available
3156 44 common/cmd_ide.c Device available
3157 -45 common/cmd_ide.c wrong partition selected
3158 45 common/cmd_ide.c partition selected
3159 -46 common/cmd_ide.c Unknown partition table
3160 46 common/cmd_ide.c valid partition table found
3161 -47 common/cmd_ide.c Invalid partition type
3162 47 common/cmd_ide.c correct partition type
3163 -48 common/cmd_ide.c Error reading Image Header on boot device
3164 48 common/cmd_ide.c reading Image Header from IDE device OK
3165 -49 common/cmd_ide.c Image header has bad magic number
3166 49 common/cmd_ide.c Image header has correct magic number
3167 -50 common/cmd_ide.c Image header has bad checksum
3168 50 common/cmd_ide.c Image header has correct checksum
3169 -51 common/cmd_ide.c Error reading Image from IDE device
3170 51 common/cmd_ide.c reading Image from IDE device OK
3171 52 common/cmd_nand.c before loading a Image from a NAND device
3172 -53 common/cmd_nand.c Bad usage of "nand" command
3173 53 common/cmd_nand.c correct usage of "nand" command
3174 -54 common/cmd_nand.c No boot device
3175 54 common/cmd_nand.c boot device found
3176 -55 common/cmd_nand.c Unknown Chip ID on boot device
3177 55 common/cmd_nand.c correct chip ID found, device available
3178 -56 common/cmd_nand.c Error reading Image Header on boot device
3179 56 common/cmd_nand.c reading Image Header from NAND device OK
3180 -57 common/cmd_nand.c Image header has bad magic number
3181 57 common/cmd_nand.c Image header has correct magic number
3182 -58 common/cmd_nand.c Error reading Image from NAND device
3183 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003184
Heiko Schocher566a4942007-06-22 19:11:54 +02003185 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003186
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003187 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003188 -64 net/eth.c no Ethernet found.
3189 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003190
Heiko Schocher566a4942007-06-22 19:11:54 +02003191 -80 common/cmd_net.c usage wrong
3192 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003193 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02003194 81 common/cmd_net.c NetLoop() back without error
3195 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3196 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003197 83 common/cmd_net.c running "source" command
3198 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003199 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003200
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003201FIT uImage format:
3202
3203 Arg Where When
3204 100 common/cmd_bootm.c Kernel FIT Image has correct format
3205 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3206 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3207 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3208 102 common/cmd_bootm.c Kernel unit name specified
3209 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003210 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003211 104 common/cmd_bootm.c Got kernel subimage node offset
3212 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3213 105 common/cmd_bootm.c Kernel subimage hash verification OK
3214 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3215 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003216 -106 common/cmd_bootm.c Kernel subimage has wrong type
3217 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003218 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3219 108 common/cmd_bootm.c Got kernel subimage data/size
3220 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3221 -109 common/cmd_bootm.c Can't get kernel subimage type
3222 -110 common/cmd_bootm.c Can't get kernel subimage comp
3223 -111 common/cmd_bootm.c Can't get kernel subimage os
3224 -112 common/cmd_bootm.c Can't get kernel subimage load address
3225 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3226
3227 120 common/image.c Start initial ramdisk verification
3228 -120 common/image.c Ramdisk FIT image has incorrect format
3229 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003230 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003231 -122 common/image.c Can't get configuration for ramdisk subimage
3232 123 common/image.c Ramdisk unit name specified
3233 -124 common/image.c Can't get ramdisk subimage node offset
3234 125 common/image.c Got ramdisk subimage node offset
3235 -125 common/image.c Ramdisk subimage hash verification failed
3236 126 common/image.c Ramdisk subimage hash verification OK
3237 -126 common/image.c Ramdisk subimage for unsupported architecture
3238 127 common/image.c Architecture check OK
3239 -127 common/image.c Can't get ramdisk subimage data/size
3240 128 common/image.c Got ramdisk subimage data/size
3241 129 common/image.c Can't get ramdisk load address
3242 -129 common/image.c Got ramdisk load address
3243
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003244 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003245 131 common/cmd_doc.c FIT image format OK
3246
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003247 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003248 141 common/cmd_ide.c FIT image format OK
3249
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003250 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003251 151 common/cmd_nand.c FIT image format OK
3252
Heiko Schocher21d29f72014-05-28 11:33:33 +02003253- legacy image format:
3254 CONFIG_IMAGE_FORMAT_LEGACY
3255 enables the legacy image format support in U-Boot.
3256
3257 Default:
3258 enabled if CONFIG_FIT_SIGNATURE is not defined.
3259
3260 CONFIG_DISABLE_IMAGE_LEGACY
3261 disable the legacy image format
3262
3263 This define is introduced, as the legacy image format is
3264 enabled per default for backward compatibility.
3265
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003266- FIT image support:
3267 CONFIG_FIT
3268 Enable support for the FIT uImage format.
3269
3270 CONFIG_FIT_BEST_MATCH
3271 When no configuration is explicitly selected, default to the
3272 one whose fdt's compatibility field best matches that of
3273 U-Boot itself. A match is considered "best" if it matches the
3274 most specific compatibility entry of U-Boot's fdt's root node.
3275 The order of entries in the configuration's fdt is ignored.
3276
Simon Glass3e569a62013-06-13 15:10:00 -07003277 CONFIG_FIT_SIGNATURE
3278 This option enables signature verification of FIT uImages,
3279 using a hash signed and verified using RSA. See
3280 doc/uImage.FIT/signature.txt for more details.
3281
Heiko Schocher21d29f72014-05-28 11:33:33 +02003282 WARNING: When relying on signed FIT images with required
3283 signature check the legacy image format is default
3284 disabled. If a board need legacy image format support
3285 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3286
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003287 CONFIG_FIT_DISABLE_SHA256
3288 Supporting SHA256 hashes has quite an impact on binary size.
3289 For constrained systems sha256 hash support can be disabled
3290 with this option.
3291
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003292- Standalone program support:
3293 CONFIG_STANDALONE_LOAD_ADDR
3294
Wolfgang Denk6feff892011-10-09 21:06:34 +02003295 This option defines a board specific value for the
3296 address where standalone program gets loaded, thus
3297 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003298 settings.
3299
3300- Frame Buffer Address:
3301 CONFIG_FB_ADDR
3302
3303 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003304 address for frame buffer. This is typically the case
3305 when using a graphics controller has separate video
3306 memory. U-Boot will then place the frame buffer at
3307 the given address instead of dynamically reserving it
3308 in system RAM by calling lcd_setmem(), which grabs
3309 the memory for the frame buffer depending on the
3310 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003311
3312 Please see board_init_f function.
3313
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003314- Automatic software updates via TFTP server
3315 CONFIG_UPDATE_TFTP
3316 CONFIG_UPDATE_TFTP_CNT_MAX
3317 CONFIG_UPDATE_TFTP_MSEC_MAX
3318
3319 These options enable and control the auto-update feature;
3320 for a more detailed description refer to doc/README.update.
3321
3322- MTD Support (mtdparts command, UBI support)
3323 CONFIG_MTD_DEVICE
3324
3325 Adds the MTD device infrastructure from the Linux kernel.
3326 Needed for mtdparts command support.
3327
3328 CONFIG_MTD_PARTITIONS
3329
3330 Adds the MTD partitioning infrastructure from the Linux
3331 kernel. Needed for UBI support.
3332
Joe Hershberger70c219c2013-04-08 10:32:48 +00003333- UBI support
3334 CONFIG_CMD_UBI
3335
3336 Adds commands for interacting with MTD partitions formatted
3337 with the UBI flash translation layer
3338
3339 Requires also defining CONFIG_RBTREE
3340
Joe Hershberger147162d2013-04-08 10:32:49 +00003341 CONFIG_UBI_SILENCE_MSG
3342
3343 Make the verbose messages from UBI stop printing. This leaves
3344 warnings and errors enabled.
3345
Joe Hershberger70c219c2013-04-08 10:32:48 +00003346- UBIFS support
3347 CONFIG_CMD_UBIFS
3348
3349 Adds commands for interacting with UBI volumes formatted as
3350 UBIFS. UBIFS is read-only in u-boot.
3351
3352 Requires UBI support as well as CONFIG_LZO
3353
Joe Hershberger147162d2013-04-08 10:32:49 +00003354 CONFIG_UBIFS_SILENCE_MSG
3355
3356 Make the verbose messages from UBIFS stop printing. This leaves
3357 warnings and errors enabled.
3358
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003359- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003360 CONFIG_SPL
3361 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003362
Tom Rini95579792012-02-14 07:29:40 +00003363 CONFIG_SPL_LDSCRIPT
3364 LDSCRIPT for linking the SPL binary.
3365
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003366 CONFIG_SPL_MAX_FOOTPRINT
3367 Maximum size in memory allocated to the SPL, BSS included.
3368 When defined, the linker checks that the actual memory
3369 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003370 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003371 must not be both defined at the same time.
3372
Tom Rini95579792012-02-14 07:29:40 +00003373 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003374 Maximum size of the SPL image (text, data, rodata, and
3375 linker lists sections), BSS excluded.
3376 When defined, the linker checks that the actual size does
3377 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003378
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003379 CONFIG_SPL_TEXT_BASE
3380 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003381
Scott Wood94a45bb2012-09-20 19:05:12 -05003382 CONFIG_SPL_RELOC_TEXT_BASE
3383 Address to relocate to. If unspecified, this is equal to
3384 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3385
Tom Rini95579792012-02-14 07:29:40 +00003386 CONFIG_SPL_BSS_START_ADDR
3387 Link address for the BSS within the SPL binary.
3388
3389 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003390 Maximum size in memory allocated to the SPL BSS.
3391 When defined, the linker checks that the actual memory used
3392 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003393 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003394 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003395
3396 CONFIG_SPL_STACK
3397 Adress of the start of the stack SPL will use
3398
Scott Wood94a45bb2012-09-20 19:05:12 -05003399 CONFIG_SPL_RELOC_STACK
3400 Adress of the start of the stack SPL will use after
3401 relocation. If unspecified, this is equal to
3402 CONFIG_SPL_STACK.
3403
Tom Rini95579792012-02-14 07:29:40 +00003404 CONFIG_SYS_SPL_MALLOC_START
3405 Starting address of the malloc pool used in SPL.
3406
3407 CONFIG_SYS_SPL_MALLOC_SIZE
3408 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003409
Tom Rini47f7bca2012-08-13 12:03:19 -07003410 CONFIG_SPL_FRAMEWORK
3411 Enable the SPL framework under common/. This framework
3412 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3413 NAND loading of the Linux Kernel.
3414
Tom Rini9607faf2014-03-28 12:03:39 -04003415 CONFIG_SPL_OS_BOOT
3416 Enable booting directly to an OS from SPL.
3417 See also: doc/README.falcon
3418
Tom Rini861a86f2012-08-13 11:37:56 -07003419 CONFIG_SPL_DISPLAY_PRINT
3420 For ARM, enable an optional function to print more information
3421 about the running system.
3422
Scott Wood4b919722012-09-20 16:35:21 -05003423 CONFIG_SPL_INIT_MINIMAL
3424 Arch init code should be built for a very small image
3425
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003426 CONFIG_SPL_LIBCOMMON_SUPPORT
3427 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003428
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003429 CONFIG_SPL_LIBDISK_SUPPORT
3430 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003431
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003432 CONFIG_SPL_I2C_SUPPORT
3433 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003434
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003435 CONFIG_SPL_GPIO_SUPPORT
3436 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003437
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003438 CONFIG_SPL_MMC_SUPPORT
3439 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003440
Tom Rini95579792012-02-14 07:29:40 +00003441 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3442 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3443 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3444 Address, size and partition on the MMC to load U-Boot from
3445 when the MMC is being used in raw mode.
3446
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003447 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3448 Sector to load kernel uImage from when MMC is being
3449 used in raw mode (for Falcon mode)
3450
3451 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3452 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3453 Sector and number of sectors to load kernel argument
3454 parameters from when MMC is being used in raw mode
3455 (for falcon mode)
3456
Tom Rini95579792012-02-14 07:29:40 +00003457 CONFIG_SPL_FAT_SUPPORT
3458 Support for fs/fat/libfat.o in SPL binary
3459
3460 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3461 Filename to read to load U-Boot when reading from FAT
3462
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003463 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3464 Filename to read to load kernel uImage when reading
3465 from FAT (for Falcon mode)
3466
3467 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3468 Filename to read to load kernel argument parameters
3469 when reading from FAT (for Falcon mode)
3470
Scott Wood06f60ae2012-12-06 13:33:17 +00003471 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3472 Set this for NAND SPL on PPC mpc83xx targets, so that
3473 start.S waits for the rest of the SPL to load before
3474 continuing (the hardware starts execution after just
3475 loading the first page rather than the full 4K).
3476
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303477 CONFIG_SPL_SKIP_RELOCATE
3478 Avoid SPL relocation
3479
Scott Wood6f2f01b2012-09-20 19:09:07 -05003480 CONFIG_SPL_NAND_BASE
3481 Include nand_base.c in the SPL. Requires
3482 CONFIG_SPL_NAND_DRIVERS.
3483
3484 CONFIG_SPL_NAND_DRIVERS
3485 SPL uses normal NAND drivers, not minimal drivers.
3486
3487 CONFIG_SPL_NAND_ECC
3488 Include standard software ECC in the SPL
3489
Tom Rini95579792012-02-14 07:29:40 +00003490 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003491 Support for NAND boot using simple NAND drivers that
3492 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003493
Tom Rini6dd3b562014-03-28 12:03:36 -04003494 CONFIG_SPL_MTD_SUPPORT
3495 Support for the MTD subsystem within SPL. Useful for
3496 environment on NAND support within SPL.
3497
Ying Zhangbb0dc102013-08-16 15:16:11 +08003498 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3499 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003500 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003501
Ying Zhang7c8eea52013-08-16 15:16:12 +08003502 CONFIG_SPL_COMMON_INIT_DDR
3503 Set for common ddr init with serial presence detect in
3504 SPL binary.
3505
Tom Rini95579792012-02-14 07:29:40 +00003506 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3507 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3508 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3509 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3510 CONFIG_SYS_NAND_ECCBYTES
3511 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003512 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003513
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303514 CONFIG_SPL_NAND_BOOT
3515 Add support NAND boot
3516
Tom Rini95579792012-02-14 07:29:40 +00003517 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003518 Location in NAND to read U-Boot from
3519
3520 CONFIG_SYS_NAND_U_BOOT_DST
3521 Location in memory to load U-Boot to
3522
3523 CONFIG_SYS_NAND_U_BOOT_SIZE
3524 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003525
3526 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003527 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003528
3529 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3530 Define this if you need to first read the OOB and then the
3531 data. This is used for example on davinci plattforms.
3532
3533 CONFIG_SPL_OMAP3_ID_NAND
3534 Support for an OMAP3-specific set of functions to return the
3535 ID and MFR of the first attached NAND chip, if present.
3536
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003537 CONFIG_SPL_SERIAL_SUPPORT
3538 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003539
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003540 CONFIG_SPL_SPI_FLASH_SUPPORT
3541 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003542
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003543 CONFIG_SPL_SPI_SUPPORT
3544 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003545
Pavel Machekc57b9532012-08-30 22:42:11 +02003546 CONFIG_SPL_RAM_DEVICE
3547 Support for running image already present in ram, in SPL binary
3548
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003549 CONFIG_SPL_LIBGENERIC_SUPPORT
3550 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003551
Ying Zhangba1bee42013-05-20 14:07:25 +08003552 CONFIG_SPL_ENV_SUPPORT
3553 Support for the environment operating in SPL binary
3554
3555 CONFIG_SPL_NET_SUPPORT
3556 Support for the net/libnet.o in SPL binary.
3557 It conflicts with SPL env from storage medium specified by
3558 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3559
Scott Wood74752ba2012-12-06 13:33:16 +00003560 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003561 Image offset to which the SPL should be padded before appending
3562 the SPL payload. By default, this is defined as
3563 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3564 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3565 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003566
Scott Woodca2fca22012-09-21 16:27:32 -05003567 CONFIG_SPL_TARGET
3568 Final target image containing SPL and payload. Some SPLs
3569 use an arch-specific makefile fragment instead, for
3570 example if more than one image needs to be produced.
3571
Simon Glass87ebee32013-05-08 08:05:59 +00003572 CONFIG_FIT_SPL_PRINT
3573 Printing information about a FIT image adds quite a bit of
3574 code to SPL. So this is normally disabled in SPL. Use this
3575 option to re-enable it. This will affect the output of the
3576 bootm command when booting a FIT image.
3577
Ying Zhang3aa29de2013-08-16 15:16:15 +08003578- TPL framework
3579 CONFIG_TPL
3580 Enable building of TPL globally.
3581
3582 CONFIG_TPL_PAD_TO
3583 Image offset to which the TPL should be padded before appending
3584 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003585 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3586 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3587 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003588
wdenkc6097192002-11-03 00:24:07 +00003589Modem Support:
3590--------------
3591
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003592[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003593
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003594- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003595 CONFIG_MODEM_SUPPORT
3596
3597- RTS/CTS Flow control enable:
3598 CONFIG_HWFLOW
3599
3600- Modem debug support:
3601 CONFIG_MODEM_SUPPORT_DEBUG
3602
wdenk43d96162003-03-06 00:02:04 +00003603 Enables debugging stuff (char screen[1024], dbg())
3604 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003605
wdenka8c7c702003-12-06 19:49:23 +00003606- Interrupt support (PPC):
3607
wdenkd4ca31c2004-01-02 14:00:00 +00003608 There are common interrupt_init() and timer_interrupt()
3609 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003610 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003611 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003612 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003613 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003614 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003615 specific handling. If board has watchdog / status_led
3616 / other_activity_monitor it works automatically from
3617 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003618
wdenkc6097192002-11-03 00:24:07 +00003619- General:
3620
wdenk43d96162003-03-06 00:02:04 +00003621 In the target system modem support is enabled when a
3622 specific key (key combination) is pressed during
3623 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003624 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003625 board_init(). Currently key_pressed() is a dummy
3626 function, returning 1 and thus enabling modem
3627 initialization.
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk43d96162003-03-06 00:02:04 +00003629 If there are no modem init strings in the
3630 environment, U-Boot proceed to autoboot; the
3631 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003632 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003633
3634 See also: doc/README.Modem
3635
Helmut Raiger9660e442011-10-20 04:19:47 +00003636Board initialization settings:
3637------------------------------
3638
3639During Initialization u-boot calls a number of board specific functions
3640to allow the preparation of board specific prerequisites, e.g. pin setup
3641before drivers are initialized. To enable these callbacks the
3642following configuration macros have to be defined. Currently this is
3643architecture specific, so please check arch/your_architecture/lib/board.c
3644typically in board_init_f() and board_init_r().
3645
3646- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3647- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3648- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3649- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003650
wdenkc6097192002-11-03 00:24:07 +00003651Configuration Settings:
3652-----------------------
3653
York Sun4d1fd7f2014-02-26 17:03:19 -08003654- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3655 Optionally it can be defined to support 64-bit memory commands.
3656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003657- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003658 undefine this when you're short of memory.
3659
Peter Tyser2fb26042009-01-27 18:03:12 -06003660- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3661 width of the commands listed in the 'help' command output.
3662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003663- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003664 prompt for user input.
3665
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003666- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003668- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003670- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003672- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003673 the application (usually a Linux kernel) when it is
3674 booted
3675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003676- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003677 List of legal baudrate settings for this board.
3678
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003679- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003680 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003681
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003682- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003683 If the board specific function
3684 extern int overwrite_console (void);
3685 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003686 serial port, else the settings in the environment are used.
3687
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003688- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003689 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003691- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003692 Enable overwrite of previous console environment settings.
3693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003694- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003695 Begin and End addresses of the area used by the
3696 simple memory test.
3697
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003698- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003699 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003701- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003702 Scratch address used by the alternate memory test
3703 You only need to set this if address zero isn't writeable
3704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003705- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3706 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003707 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003708 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003709 fixing up gd->ram_size the Linux kernel should gets passed
3710 the now "corrected" memory size and won't touch it either.
3711 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003712 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003713 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003714 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003715
3716 This option can be used as a workaround for the 440EPx/GRx
3717 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3718 be touched.
3719
3720 WARNING: Please make sure that this value is a multiple of
3721 the Linux page size (normally 4k). If this is not the case,
3722 then the end address of the Linux memory will be located at a
3723 non page size aligned address and this could cause major
3724 problems.
3725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003726- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003727 Enable temporary baudrate change while serial download
3728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003729- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003730 Physical start address of SDRAM. _Must_ be 0 here.
3731
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003732- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003733 Physical start address of Motherboard I/O (if using a
3734 Cogent motherboard)
3735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003736- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003737 Physical start address of Flash memory.
3738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003739- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003740 Physical start address of boot monitor code (set by
3741 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003742 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003743 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003744
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003745- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003746 Size of memory reserved for monitor code, used to
3747 determine _at_compile_time_ (!) if the environment is
3748 embedded within the U-Boot image, or in a separate
3749 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003751- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003752 Size of DRAM reserved for malloc() use.
3753
Simon Glassd59476b2014-07-10 22:23:28 -06003754- CONFIG_SYS_MALLOC_F_LEN
3755 Size of the malloc() pool for use before relocation. If
3756 this is defined, then a very simple malloc() implementation
3757 will become available before relocation. The address is just
3758 below the global data, and the stack is moved down to make
3759 space.
3760
3761 This feature allocates regions with increasing addresses
3762 within the region. calloc() is supported, but realloc()
3763 is not available. free() is supported but does nothing.
3764 The memory will be freed (or in fact just forgotton) when
3765 U-Boot relocates itself.
3766
Simon Glass29afe9e2014-07-10 22:23:31 -06003767 Pre-relocation malloc() is only supported on sandbox
3768 at present but is fairly easy to enable for other archs.
3769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003770- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003771 Normally compressed uImages are limited to an
3772 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003773 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003774 to adjust this setting to your needs.
3775
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003776- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003777 Maximum size of memory mapped by the startup code of
3778 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003779 the Linux kernel (bd_info, boot arguments, FDT blob if
3780 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003781 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003782 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003783 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003784 variable "bootm_mapsize" will override the value of
3785 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3786 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003787
John Rigbyfca43cc2010-10-13 13:57:35 -06003788- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3789 Enable initrd_high functionality. If defined then the
3790 initrd_high feature is enabled and the bootm ramdisk subcommand
3791 is enabled.
3792
3793- CONFIG_SYS_BOOT_GET_CMDLINE:
3794 Enables allocating and saving kernel cmdline in space between
3795 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3796
3797- CONFIG_SYS_BOOT_GET_KBD:
3798 Enables allocating and saving a kernel copy of the bd_info in
3799 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003801- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003802 Max number of Flash memory banks
3803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003804- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003805 Max number of sectors on a Flash chip
3806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003807- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003808 Timeout for Flash erase operations (in ms)
3809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003811 Timeout for Flash write operations (in ms)
3812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003813- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003814 Timeout for Flash set sector lock bit operation (in ms)
3815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003816- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003817 Timeout for Flash clear lock bits operation (in ms)
3818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003819- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003820 If defined, hardware flash sectors protection is used
3821 instead of U-Boot software protection.
3822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003823- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003824
3825 Enable TFTP transfers directly to flash memory;
3826 without this option such a download has to be
3827 performed in two steps: (1) download to RAM, and (2)
3828 copy from RAM to flash.
3829
3830 The two-step approach is usually more reliable, since
3831 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003832 the flash, but in some situations (when system RAM is
3833 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003834 downloaded image) this option may be very useful.
3835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003836- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003837 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003838 common flash structure for storing flash geometry.
3839
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003840- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003841 This option also enables the building of the cfi_flash driver
3842 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003843
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003844- CONFIG_FLASH_CFI_MTD
3845 This option enables the building of the cfi_mtd driver
3846 in the drivers directory. The driver exports CFI flash
3847 to the MTD layer.
3848
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003849- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003850 Use buffered writes to flash.
3851
3852- CONFIG_FLASH_SPANSION_S29WS_N
3853 s29ws-n MirrorBit flash has non-standard addresses for buffered
3854 write commands.
3855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003856- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003857 If this option is defined, the common CFI flash doesn't
3858 print it's warning upon not recognized FLASH banks. This
3859 is useful, if some of the configured banks are only
3860 optionally available.
3861
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003862- CONFIG_FLASH_SHOW_PROGRESS
3863 If defined (must be an integer), print out countdown
3864 digits and dots. Recommended value: 45 (9..1) for 80
3865 column displays, 15 (3..1) for 40 column displays.
3866
Stefan Roese352ef3f2013-04-04 15:53:14 +02003867- CONFIG_FLASH_VERIFY
3868 If defined, the content of the flash (destination) is compared
3869 against the source after the write operation. An error message
3870 will be printed when the contents are not identical.
3871 Please note that this option is useless in nearly all cases,
3872 since such flash programming errors usually are detected earlier
3873 while unprotecting/erasing/programming. Please only enable
3874 this option if you really know what you are doing.
3875
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003876- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003877 Defines the number of Ethernet receive buffers. On some
3878 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003879 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3880 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003881 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003882 Defaults to 4 if not defined.
3883
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003884- CONFIG_ENV_MAX_ENTRIES
3885
Wolfgang Denk071bc922010-10-27 22:48:30 +02003886 Maximum number of entries in the hash table that is used
3887 internally to store the environment settings. The default
3888 setting is supposed to be generous and should work in most
3889 cases. This setting can be used to tune behaviour; see
3890 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003891
Joe Hershberger25980902012-12-11 22:16:31 -06003892- CONFIG_ENV_FLAGS_LIST_DEFAULT
3893- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003894 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003895 calling env set. Variables can be restricted to only decimal,
3896 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3897 the variables can also be restricted to IP address or MAC address.
3898
3899 The format of the list is:
3900 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003901 access_atribute = [a|r|o|c]
3902 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003903 entry = variable_name[:attributes]
3904 list = entry[,list]
3905
3906 The type attributes are:
3907 s - String (default)
3908 d - Decimal
3909 x - Hexadecimal
3910 b - Boolean ([1yYtT|0nNfF])
3911 i - IP address
3912 m - MAC address
3913
Joe Hershberger267541f2012-12-11 22:16:34 -06003914 The access attributes are:
3915 a - Any (default)
3916 r - Read-only
3917 o - Write-once
3918 c - Change-default
3919
Joe Hershberger25980902012-12-11 22:16:31 -06003920 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3921 Define this to a list (string) to define the ".flags"
3922 envirnoment variable in the default or embedded environment.
3923
3924 - CONFIG_ENV_FLAGS_LIST_STATIC
3925 Define this to a list (string) to define validation that
3926 should be done if an entry is not found in the ".flags"
3927 environment variable. To override a setting in the static
3928 list, simply add an entry for the same variable name to the
3929 ".flags" variable.
3930
Joe Hershberger267541f2012-12-11 22:16:34 -06003931- CONFIG_ENV_ACCESS_IGNORE_FORCE
3932 If defined, don't allow the -f switch to env set override variable
3933 access flags.
3934
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003935- CONFIG_SYS_GENERIC_BOARD
3936 This selects the architecture-generic board system instead of the
3937 architecture-specific board files. It is intended to move boards
3938 to this new framework over time. Defining this will disable the
3939 arch/foo/lib/board.c file and use common/board_f.c and
3940 common/board_r.c instead. To use this option your architecture
3941 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3942 its config.mk file). If you find problems enabling this option on
3943 your board please report the problem and send patches!
3944
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003945- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3946 This is set by OMAP boards for the max time that reset should
3947 be asserted. See doc/README.omap-reset-time for details on how
3948 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003949
wdenkc6097192002-11-03 00:24:07 +00003950The following definitions that deal with the placement and management
3951of environment data (variable area); in general, we support the
3952following configurations:
3953
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003954- CONFIG_BUILD_ENVCRC:
3955
3956 Builds up envcrc with the target environment so that external utils
3957 may easily extract it and embed it in final U-Boot images.
3958
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003959- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003960
3961 Define this if the environment is in flash memory.
3962
3963 a) The environment occupies one whole flash sector, which is
3964 "embedded" in the text segment with the U-Boot code. This
3965 happens usually with "bottom boot sector" or "top boot
3966 sector" type flash chips, which have several smaller
3967 sectors at the start or the end. For instance, such a
3968 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3969 such a case you would place the environment in one of the
3970 4 kB sectors - with U-Boot code before and after it. With
3971 "top boot sector" type flash chips, you would put the
3972 environment in one of the last sectors, leaving a gap
3973 between U-Boot and the environment.
3974
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003975 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003976
3977 Offset of environment data (variable area) to the
3978 beginning of flash memory; for instance, with bottom boot
3979 type flash chips the second sector can be used: the offset
3980 for this sector is given here.
3981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003982 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003983
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003984 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003985
3986 This is just another way to specify the start address of
3987 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003988 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003989
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003990 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003991
3992 Size of the sector containing the environment.
3993
3994
3995 b) Sometimes flash chips have few, equal sized, BIG sectors.
3996 In such a case you don't want to spend a whole sector for
3997 the environment.
3998
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003999 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004000
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004001 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004002 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004003 of this flash sector for the environment. This saves
4004 memory for the RAM copy of the environment.
4005
4006 It may also save flash memory if you decide to use this
4007 when your environment is "embedded" within U-Boot code,
4008 since then the remainder of the flash sector could be used
4009 for U-Boot code. It should be pointed out that this is
4010 STRONGLY DISCOURAGED from a robustness point of view:
4011 updating the environment in flash makes it always
4012 necessary to erase the WHOLE sector. If something goes
4013 wrong before the contents has been restored from a copy in
4014 RAM, your target system will be dead.
4015
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004016 - CONFIG_ENV_ADDR_REDUND
4017 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk43d96162003-03-06 00:02:04 +00004019 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004020 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004021 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004022 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004023
4024BE CAREFUL! Any changes to the flash layout, and some changes to the
4025source code will make it necessary to adapt <board>/u-boot.lds*
4026accordingly!
4027
4028
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004029- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004030
4031 Define this if you have some non-volatile memory device
4032 (NVRAM, battery buffered SRAM) which you want to use for the
4033 environment.
4034
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004035 - CONFIG_ENV_ADDR:
4036 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004037
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004038 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004039 want to use for environment. It is assumed that this memory
4040 can just be read and written to, without any special
4041 provision.
4042
4043BE CAREFUL! The first access to the environment happens quite early
4044in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004045console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004046U-Boot will hang.
4047
4048Please note that even with NVRAM we still use a copy of the
4049environment in RAM: we could work on NVRAM directly, but we want to
4050keep settings there always unmodified except somebody uses "saveenv"
4051to save the current settings.
4052
4053
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004054- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004055
4056 Use this if you have an EEPROM or similar serial access
4057 device and a driver for it.
4058
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004059 - CONFIG_ENV_OFFSET:
4060 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004061
4062 These two #defines specify the offset and size of the
4063 environment area within the total memory of your EEPROM.
4064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004065 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004066 If defined, specified the chip address of the EEPROM device.
4067 The default address is zero.
4068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004069 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004070 If defined, the number of bits used to address bytes in a
4071 single page in the EEPROM device. A 64 byte page, for example
4072 would require six bits.
4073
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004074 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004075 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004076 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004078 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004079 The length in bytes of the EEPROM memory array address. Note
4080 that this is NOT the chip address length!
4081
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004082 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004083 EEPROM chips that implement "address overflow" are ones
4084 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4085 address and the extra bits end up in the "chip address" bit
4086 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4087 byte chips.
4088
4089 Note that we consider the length of the address field to
4090 still be one byte because the extra address bits are hidden
4091 in the chip address.
4092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004093 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004094 The size in bytes of the EEPROM device.
4095
Heiko Schocher548738b2010-01-07 08:55:40 +01004096 - CONFIG_ENV_EEPROM_IS_ON_I2C
4097 define this, if you have I2C and SPI activated, and your
4098 EEPROM, which holds the environment, is on the I2C bus.
4099
4100 - CONFIG_I2C_ENV_EEPROM_BUS
4101 if you have an Environment on an EEPROM reached over
4102 I2C muxes, you can define here, how to reach this
4103 EEPROM. For example:
4104
Heiko Schocherea818db2013-01-29 08:53:15 +01004105 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004106
4107 EEPROM which holds the environment, is reached over
4108 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004109
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004110- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004111
wdenkd4ca31c2004-01-02 14:00:00 +00004112 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004113 want to use for the environment.
4114
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004115 - CONFIG_ENV_OFFSET:
4116 - CONFIG_ENV_ADDR:
4117 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004118
4119 These three #defines specify the offset and size of the
4120 environment area within the total memory of your DataFlash placed
4121 at the specified address.
4122
Wu, Joshbd83b592014-07-01 19:30:13 +08004123- CONFIG_ENV_IS_IN_SPI_FLASH:
4124
4125 Define this if you have a SPI Flash memory device which you
4126 want to use for the environment.
4127
4128 - CONFIG_ENV_OFFSET:
4129 - CONFIG_ENV_SIZE:
4130
4131 These two #defines specify the offset and size of the
4132 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4133 aligned to an erase sector boundary.
4134
4135 - CONFIG_ENV_SECT_SIZE:
4136
4137 Define the SPI flash's sector size.
4138
4139 - CONFIG_ENV_OFFSET_REDUND (optional):
4140
4141 This setting describes a second storage area of CONFIG_ENV_SIZE
4142 size used to hold a redundant copy of the environment data, so
4143 that there is a valid backup copy in case there is a power failure
4144 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4145 aligned to an erase sector boundary.
4146
4147 - CONFIG_ENV_SPI_BUS (optional):
4148 - CONFIG_ENV_SPI_CS (optional):
4149
4150 Define the SPI bus and chip select. If not defined they will be 0.
4151
4152 - CONFIG_ENV_SPI_MAX_HZ (optional):
4153
4154 Define the SPI max work clock. If not defined then use 1MHz.
4155
4156 - CONFIG_ENV_SPI_MODE (optional):
4157
4158 Define the SPI work mode. If not defined then use SPI_MODE_3.
4159
Liu Gang0a85a9e2012-03-08 00:33:20 +00004160- CONFIG_ENV_IS_IN_REMOTE:
4161
4162 Define this if you have a remote memory space which you
4163 want to use for the local device's environment.
4164
4165 - CONFIG_ENV_ADDR:
4166 - CONFIG_ENV_SIZE:
4167
4168 These two #defines specify the address and size of the
4169 environment area within the remote memory space. The
4170 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004171 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004172
4173BE CAREFUL! For some special cases, the local device can not use
4174"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004175environment stored in a remote NOR flash by SRIO or PCIE link,
4176but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004177
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004178- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004179
4180 Define this if you have a NAND device which you want to use
4181 for the environment.
4182
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004183 - CONFIG_ENV_OFFSET:
4184 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004185
4186 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004187 area within the first NAND device. CONFIG_ENV_OFFSET must be
4188 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004189
Scott Woodfdd813d2010-09-17 14:38:37 -05004190 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004191
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004192 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004193 size used to hold a redundant copy of the environment data, so
4194 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004195 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004196 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004197
Scott Woodfdd813d2010-09-17 14:38:37 -05004198 - CONFIG_ENV_RANGE (optional):
4199
4200 Specifies the length of the region in which the environment
4201 can be written. This should be a multiple of the NAND device's
4202 block size. Specifying a range with more erase blocks than
4203 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4204 the range to be avoided.
4205
4206 - CONFIG_ENV_OFFSET_OOB (optional):
4207
4208 Enables support for dynamically retrieving the offset of the
4209 environment from block zero's out-of-band data. The
4210 "nand env.oob" command can be used to record this offset.
4211 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4212 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004213
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004214- CONFIG_NAND_ENV_DST
4215
4216 Defines address in RAM to which the nand_spl code should copy the
4217 environment. If redundant environment is used, it will be copied to
4218 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4219
Joe Hershberger2b744332013-04-08 10:32:51 +00004220- CONFIG_ENV_IS_IN_UBI:
4221
4222 Define this if you have an UBI volume that you want to use for the
4223 environment. This has the benefit of wear-leveling the environment
4224 accesses, which is important on NAND.
4225
4226 - CONFIG_ENV_UBI_PART:
4227
4228 Define this to a string that is the mtd partition containing the UBI.
4229
4230 - CONFIG_ENV_UBI_VOLUME:
4231
4232 Define this to the name of the volume that you want to store the
4233 environment in.
4234
Joe Hershberger785881f2013-04-08 10:32:52 +00004235 - CONFIG_ENV_UBI_VOLUME_REDUND:
4236
4237 Define this to the name of another volume to store a second copy of
4238 the environment in. This will enable redundant environments in UBI.
4239 It is assumed that both volumes are in the same MTD partition.
4240
Joe Hershberger2b744332013-04-08 10:32:51 +00004241 - CONFIG_UBI_SILENCE_MSG
4242 - CONFIG_UBIFS_SILENCE_MSG
4243
4244 You will probably want to define these to avoid a really noisy system
4245 when storing the env in UBI.
4246
Wu, Joshd1db76f2014-06-24 17:31:03 +08004247- CONFIG_ENV_IS_IN_FAT:
4248 Define this if you want to use the FAT file system for the environment.
4249
4250 - FAT_ENV_INTERFACE:
4251
4252 Define this to a string that is the name of the block device.
4253
4254 - FAT_ENV_DEV_AND_PART:
4255
4256 Define this to a string to specify the partition of the device. It can
4257 be as following:
4258
4259 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4260 - "D:P": device D partition P. Error occurs if device D has no
4261 partition table.
4262 - "D:0": device D.
4263 - "D" or "D:": device D partition 1 if device D has partition
4264 table, or the whole device D if has no partition
4265 table.
4266 - "D:auto": first partition in device D with bootable flag set.
4267 If none, first valid paratition in device D. If no
4268 partition table then means device D.
4269
4270 - FAT_ENV_FILE:
4271
4272 It's a string of the FAT file name. This file use to store the
4273 envrionment.
4274
4275 - CONFIG_FAT_WRITE:
4276 This should be defined. Otherwise it cannot save the envrionment file.
4277
Stephen Warren06e4ae52013-06-11 15:14:00 -06004278- CONFIG_ENV_IS_IN_MMC:
4279
4280 Define this if you have an MMC device which you want to use for the
4281 environment.
4282
4283 - CONFIG_SYS_MMC_ENV_DEV:
4284
4285 Specifies which MMC device the environment is stored in.
4286
4287 - CONFIG_SYS_MMC_ENV_PART (optional):
4288
4289 Specifies which MMC partition the environment is stored in. If not
4290 set, defaults to partition 0, the user area. Common values might be
4291 1 (first MMC boot partition), 2 (second MMC boot partition).
4292
4293 - CONFIG_ENV_OFFSET:
4294 - CONFIG_ENV_SIZE:
4295
4296 These two #defines specify the offset and size of the environment
4297 area within the specified MMC device.
4298
Stephen Warren5c088ee2013-06-11 15:14:02 -06004299 If offset is positive (the usual case), it is treated as relative to
4300 the start of the MMC partition. If offset is negative, it is treated
4301 as relative to the end of the MMC partition. This can be useful if
4302 your board may be fitted with different MMC devices, which have
4303 different sizes for the MMC partitions, and you always want the
4304 environment placed at the very end of the partition, to leave the
4305 maximum possible space before it, to store other data.
4306
Stephen Warren06e4ae52013-06-11 15:14:00 -06004307 These two values are in units of bytes, but must be aligned to an
4308 MMC sector boundary.
4309
4310 - CONFIG_ENV_OFFSET_REDUND (optional):
4311
4312 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4313 hold a redundant copy of the environment data. This provides a
4314 valid backup copy in case the other copy is corrupted, e.g. due
4315 to a power failure during a "saveenv" operation.
4316
Stephen Warren5c088ee2013-06-11 15:14:02 -06004317 This value may also be positive or negative; this is handled in the
4318 same way as CONFIG_ENV_OFFSET.
4319
Stephen Warren06e4ae52013-06-11 15:14:00 -06004320 This value is also in units of bytes, but must also be aligned to
4321 an MMC sector boundary.
4322
4323 - CONFIG_ENV_SIZE_REDUND (optional):
4324
4325 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4326 set. If this value is set, it must be set to the same value as
4327 CONFIG_ENV_SIZE.
4328
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004329- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004330
4331 Defines offset to the initial SPI buffer area in DPRAM. The
4332 area is used at an early stage (ROM part) if the environment
4333 is configured to reside in the SPI EEPROM: We need a 520 byte
4334 scratch DPRAM area. It is used between the two initialization
4335 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4336 to be a good choice since it makes it far enough from the
4337 start of the data area as well as from the stack pointer.
4338
Bruce Adlere881cb52007-11-02 13:15:42 -07004339Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004340has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004341created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004342until then to read environment variables.
4343
wdenk85ec0bc2003-03-31 16:34:49 +00004344The environment is protected by a CRC32 checksum. Before the monitor
4345is relocated into RAM, as a result of a bad CRC you will be working
4346with the compiled-in default environment - *silently*!!! [This is
4347necessary, because the first environment variable we need is the
4348"baudrate" setting for the console - if we have a bad CRC, we don't
4349have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004350
4351Note: once the monitor has been relocated, then it will complain if
4352the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004353use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004355- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004356 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004357
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004358 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004359 also needs to be defined.
4360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004361- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004362 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004363
Ron Madridf5675aa2009-02-18 14:30:44 -08004364- CONFIG_NS16550_MIN_FUNCTIONS:
4365 Define this if you desire to only have use of the NS16550_init
4366 and NS16550_putc functions for the serial driver located at
4367 drivers/serial/ns16550.c. This option is useful for saving
4368 space for already greatly restricted images, including but not
4369 limited to NAND_SPL configurations.
4370
Simon Glassb2b92f52012-11-30 13:01:18 +00004371- CONFIG_DISPLAY_BOARDINFO
4372 Display information about the board that U-Boot is running on
4373 when U-Boot starts up. The board function checkboard() is called
4374 to do this.
4375
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004376- CONFIG_DISPLAY_BOARDINFO_LATE
4377 Similar to the previous option, but display this information
4378 later, once stdio is running and output goes to the LCD, if
4379 present.
4380
wdenkc6097192002-11-03 00:24:07 +00004381Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004382---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004384- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004385 Cache Line Size of the CPU.
4386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004387- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004388 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004389
wdenk42d1f032003-10-15 23:53:47 +00004390 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4391 and RPXsuper) to be able to adjust the position of
4392 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004393
Timur Tabie46fedf2011-08-04 18:03:41 -05004394- CONFIG_SYS_CCSRBAR_DEFAULT:
4395 Default (power-on reset) physical address of CCSR on Freescale
4396 PowerPC SOCs.
4397
4398- CONFIG_SYS_CCSRBAR:
4399 Virtual address of CCSR. On a 32-bit build, this is typically
4400 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4401
4402 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4403 for cross-platform code that uses that macro instead.
4404
4405- CONFIG_SYS_CCSRBAR_PHYS:
4406 Physical address of CCSR. CCSR can be relocated to a new
4407 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004408 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004409 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4410 is typically relocated on 36-bit builds. It is recommended
4411 that this macro be defined via the _HIGH and _LOW macros:
4412
4413 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4414 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4415
4416- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004417 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4418 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004419 used in assembly code, so it must not contain typecasts or
4420 integer size suffixes (e.g. "ULL").
4421
4422- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4423 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4424 used in assembly code, so it must not contain typecasts or
4425 integer size suffixes (e.g. "ULL").
4426
4427- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4428 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4429 forced to a value that ensures that CCSR is not relocated.
4430
wdenk7f6c2cb2002-11-10 22:06:23 +00004431- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004432 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004433
4434 the default drive number (default value 0)
4435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004436 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004437
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004438 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004439 (default value 1)
4440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004441 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004442
wdenk43d96162003-03-06 00:02:04 +00004443 defines the offset of register from address. It
4444 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004445 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004447 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4448 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004449 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004450
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004451 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004452 fdc_hw_init() is called at the beginning of the FDC
4453 setup. fdc_hw_init() must be provided by the board
4454 source code. It is used to make hardware dependant
4455 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004456
Macpaul Lin0abddf82011-04-11 20:45:32 +00004457- CONFIG_IDE_AHB:
4458 Most IDE controllers were designed to be connected with PCI
4459 interface. Only few of them were designed for AHB interface.
4460 When software is doing ATA command and data transfer to
4461 IDE devices through IDE-AHB controller, some additional
4462 registers accessing to these kind of IDE-AHB controller
4463 is requierd.
4464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004465- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004466 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004467 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004469- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk7152b1d2003-09-05 23:19:14 +00004471 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004472 initial data and stack; please note that this must be
4473 writable memory that is working WITHOUT special
4474 initialization, i. e. you CANNOT use normal RAM which
4475 will become available only after programming the
4476 memory controller and running certain initialization
4477 sequences.
4478
4479 U-Boot uses the following memory types:
4480 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4481 - MPC824X: data cache
4482 - PPC4xx: data cache
4483
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004484- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004485
4486 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004487 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4488 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004489 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004490 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004491 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4492 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4493 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004494
4495 Note:
4496 On the MPC824X (or other systems that use the data
4497 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004498 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004499 point to an otherwise UNUSED address space between
4500 the top of RAM and the start of the PCI space.
4501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004502- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004504- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004505
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004506- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004508- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004510- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004512- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004513
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004514- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004515 SDRAM timing
4516
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004517- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004518 periodic timer for refresh
4519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004520- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004522- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4523 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4524 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4525 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004526 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4527
4528- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004529 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4530 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004531 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004533- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4534 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004535 Machine Mode Register and Memory Periodic Timer
4536 Prescaler definitions (SDRAM timing)
4537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004538- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004539 enable I2C microcode relocation patch (MPC8xx);
4540 define relocation offset in DPRAM [DSP2]
4541
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004542- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004543 enable SMC microcode relocation patch (MPC8xx);
4544 define relocation offset in DPRAM [SMC1]
4545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004546- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004547 enable SPI microcode relocation patch (MPC8xx);
4548 define relocation offset in DPRAM [SCC4]
4549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004550- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004551 Use OSCM clock mode on MBX8xx board. Be careful,
4552 wrong setting might damage your board. Read
4553 doc/README.MBX before setting this variable!
4554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004555- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004556 Offset of the bootmode word in DPRAM used by post
4557 (Power On Self Tests). This definition overrides
4558 #define'd default value in commproc.h resp.
4559 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004560
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004561- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4562 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4563 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4564 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4565 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4566 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4567 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4568 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004569 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004570
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004571- CONFIG_PCI_DISABLE_PCIE:
4572 Disable PCI-Express on systems where it is supported but not
4573 required.
4574
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004575- CONFIG_PCI_ENUM_ONLY
4576 Only scan through and get the devices on the busses.
4577 Don't do any setup work, presumably because someone or
4578 something has already done it, and we don't need to do it
4579 a second time. Useful for platforms that are pre-booted
4580 by coreboot or similar.
4581
Gabor Juhos842033e2013-05-30 07:06:12 +00004582- CONFIG_PCI_INDIRECT_BRIDGE:
4583 Enable support for indirect PCI bridges.
4584
Kumar Galaa09b9b62010-12-30 12:09:53 -06004585- CONFIG_SYS_SRIO:
4586 Chip has SRIO or not
4587
4588- CONFIG_SRIO1:
4589 Board has SRIO 1 port available
4590
4591- CONFIG_SRIO2:
4592 Board has SRIO 2 port available
4593
Liu Gangc8b28152013-05-07 16:30:46 +08004594- CONFIG_SRIO_PCIE_BOOT_MASTER
4595 Board can support master function for Boot from SRIO and PCIE
4596
Kumar Galaa09b9b62010-12-30 12:09:53 -06004597- CONFIG_SYS_SRIOn_MEM_VIRT:
4598 Virtual Address of SRIO port 'n' memory region
4599
4600- CONFIG_SYS_SRIOn_MEM_PHYS:
4601 Physical Address of SRIO port 'n' memory region
4602
4603- CONFIG_SYS_SRIOn_MEM_SIZE:
4604 Size of SRIO port 'n' memory region
4605
Fabio Estevam66bd1842013-04-11 09:35:34 +00004606- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4607 Defined to tell the NAND controller that the NAND chip is using
4608 a 16 bit bus.
4609 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004610 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004611 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004612 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004613
4614- CONFIG_SYS_NDFC_EBC0_CFG
4615 Sets the EBC0_CFG register for the NDFC. If not defined
4616 a default value will be used.
4617
Ben Warrenbb99ad62006-09-07 16:50:54 -04004618- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004619 Get DDR timing information from an I2C EEPROM. Common
4620 with pluggable memory modules such as SODIMMs
4621
Ben Warrenbb99ad62006-09-07 16:50:54 -04004622 SPD_EEPROM_ADDRESS
4623 I2C address of the SPD EEPROM
4624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004625- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004626 If SPD EEPROM is on an I2C bus other than the first
4627 one, specify here. Note that the value must resolve
4628 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004629
York Sun1b3e3c42011-06-07 09:42:16 +08004630- CONFIG_SYS_DDR_RAW_TIMING
4631 Get DDR timing information from other than SPD. Common with
4632 soldered DDR chips onboard without SPD. DDR raw timing
4633 parameters are extracted from datasheet and hard-coded into
4634 header files or board specific files.
4635
York Sun6f5e1dc2011-09-16 13:21:35 -07004636- CONFIG_FSL_DDR_INTERACTIVE
4637 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004639- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004640 Only for 83xx systems. If specified, then DDR should
4641 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004642
wdenkc26e4542004-04-18 10:13:26 +00004643- CONFIG_ETHER_ON_FEC[12]
4644 Define to enable FEC[12] on a 8xx series processor.
4645
4646- CONFIG_FEC[12]_PHY
4647 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004648 to the given FEC; i. e.
4649 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004650 means that the PHY with address 4 is connected to FEC1
4651
4652 When set to -1, means to probe for first available.
4653
4654- CONFIG_FEC[12]_PHY_NORXERR
4655 The PHY does not have a RXERR line (RMII only).
4656 (so program the FEC to ignore it).
4657
4658- CONFIG_RMII
4659 Enable RMII mode for all FECs.
4660 Note that this is a global option, we can't
4661 have one FEC in standard MII mode and another in RMII mode.
4662
wdenk5cf91d62004-04-23 20:32:05 +00004663- CONFIG_CRC32_VERIFY
4664 Add a verify option to the crc32 command.
4665 The syntax is:
4666
4667 => crc32 -v <address> <count> <crc32>
4668
4669 Where address/count indicate a memory area
4670 and crc32 is the correct crc32 which the
4671 area should have.
4672
wdenk56523f12004-07-11 17:40:54 +00004673- CONFIG_LOOPW
4674 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004675 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004676
stroese7b466642004-12-16 18:46:55 +00004677- CONFIG_MX_CYCLIC
4678 Add the "mdc" and "mwc" memory commands. These are cyclic
4679 "md/mw" commands.
4680 Examples:
4681
wdenkefe2a4d2004-12-16 21:44:03 +00004682 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004683 This command will print 4 bytes (10,11,12,13) each 500 ms.
4684
wdenkefe2a4d2004-12-16 21:44:03 +00004685 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004686 This command will write 12345678 to address 100 all 10 ms.
4687
wdenkefe2a4d2004-12-16 21:44:03 +00004688 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004689 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004690
wdenk8aa1a2d2005-04-04 12:44:11 +00004691- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004692 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004693 low level initializations (like setting up the memory
4694 controller) are omitted and/or U-Boot does not
4695 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004696
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004697 Normally this variable MUST NOT be defined. The only
4698 exception is when U-Boot is loaded (to RAM) by some
4699 other boot loader or by a debugger which performs
4700 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004701
Aneesh V401bb302011-07-13 05:11:07 +00004702- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004703 Modifies the behaviour of start.S when compiling a loader
4704 that is executed before the actual U-Boot. E.g. when
4705 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004706
Ying Zhang3aa29de2013-08-16 15:16:15 +08004707- CONFIG_TPL_BUILD
4708 Modifies the behaviour of start.S when compiling a loader
4709 that is executed after the SPL and before the actual U-Boot.
4710 It is loaded by the SPL.
4711
Ying Zhang5df572f2013-05-20 14:07:23 +08004712- CONFIG_SYS_MPC85XX_NO_RESETVEC
4713 Only for 85xx systems. If this variable is specified, the section
4714 .resetvec is not kept and the section .bootpg is placed in the
4715 previous 4k of the .text section.
4716
Simon Glass4213fc22013-02-24 17:33:14 +00004717- CONFIG_ARCH_MAP_SYSMEM
4718 Generally U-Boot (and in particular the md command) uses
4719 effective address. It is therefore not necessary to regard
4720 U-Boot address as virtual addresses that need to be translated
4721 to physical addresses. However, sandbox requires this, since
4722 it maintains its own little RAM buffer which contains all
4723 addressable memory. This option causes some memory accesses
4724 to be mapped through map_sysmem() / unmap_sysmem().
4725
Matthias Weisserd8834a12011-03-10 21:36:32 +00004726- CONFIG_USE_ARCH_MEMCPY
4727 CONFIG_USE_ARCH_MEMSET
4728 If these options are used a optimized version of memcpy/memset will
4729 be used if available. These functions may be faster under some
4730 conditions but may increase the binary size.
4731
Simon Glass588a13f2013-02-14 04:18:54 +00004732- CONFIG_X86_RESET_VECTOR
4733 If defined, the x86 reset vector code is included. This is not
4734 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004735
Mark Jacksonfc337052013-03-04 01:27:20 +00004736- CONFIG_SYS_MPUCLK
4737 Defines the MPU clock speed (in MHz).
4738
4739 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004740
Heiko Schocher16678eb2013-11-04 14:05:00 +01004741- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4742 Enables the RTC32K OSC on AM33xx based plattforms
4743
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004744- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4745 Option to disable subpage write in NAND driver
4746 driver that uses this:
4747 drivers/mtd/nand/davinci_nand.c
4748
Timur Tabif2717b42011-11-22 09:21:25 -06004749Freescale QE/FMAN Firmware Support:
4750-----------------------------------
4751
4752The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4753loading of "firmware", which is encoded in the QE firmware binary format.
4754This firmware often needs to be loaded during U-Boot booting, so macros
4755are used to identify the storage device (NOR flash, SPI, etc) and the address
4756within that device.
4757
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004758- CONFIG_SYS_FMAN_FW_ADDR
4759 The address in the storage device where the FMAN microcode is located. The
4760 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4761 is also specified.
4762
4763- CONFIG_SYS_QE_FW_ADDR
4764 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004765 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4766 is also specified.
4767
4768- CONFIG_SYS_QE_FMAN_FW_LENGTH
4769 The maximum possible size of the firmware. The firmware binary format
4770 has a field that specifies the actual size of the firmware, but it
4771 might not be possible to read any part of the firmware unless some
4772 local storage is allocated to hold the entire firmware first.
4773
4774- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4775 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4776 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4777 virtual address in NOR flash.
4778
4779- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4780 Specifies that QE/FMAN firmware is located in NAND flash.
4781 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4782
4783- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4784 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4785 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4786
4787- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4788 Specifies that QE/FMAN firmware is located on the primary SPI
4789 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4790
Liu Gang292dc6c2012-03-08 00:33:18 +00004791- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4792 Specifies that QE/FMAN firmware is located in the remote (master)
4793 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004794 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4795 window->master inbound window->master LAW->the ucode address in
4796 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004797
J. German Riverab940ca62014-06-23 15:15:55 -07004798Freescale Layerscape Management Complex Firmware Support:
4799---------------------------------------------------------
4800The Freescale Layerscape Management Complex (MC) supports the loading of
4801"firmware".
4802This firmware often needs to be loaded during U-Boot booting, so macros
4803are used to identify the storage device (NOR flash, SPI, etc) and the address
4804within that device.
4805
4806- CONFIG_FSL_MC_ENET
4807 Enable the MC driver for Layerscape SoCs.
4808
4809- CONFIG_SYS_LS_MC_FW_ADDR
4810 The address in the storage device where the firmware is located. The
4811 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4812 is also specified.
4813
4814- CONFIG_SYS_LS_MC_FW_LENGTH
4815 The maximum possible size of the firmware. The firmware binary format
4816 has a field that specifies the actual size of the firmware, but it
4817 might not be possible to read any part of the firmware unless some
4818 local storage is allocated to hold the entire firmware first.
4819
4820- CONFIG_SYS_LS_MC_FW_IN_NOR
4821 Specifies that MC firmware is located in NOR flash, mapped as
4822 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4823 virtual address in NOR flash.
4824
wdenkc6097192002-11-03 00:24:07 +00004825Building the Software:
4826======================
4827
Wolfgang Denk218ca722008-03-26 10:40:12 +01004828Building U-Boot has been tested in several native build environments
4829and in many different cross environments. Of course we cannot support
4830all possibly existing versions of cross development tools in all
4831(potentially obsolete) versions. In case of tool chain problems we
4832recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4833which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004834
Wolfgang Denk218ca722008-03-26 10:40:12 +01004835If you are not using a native environment, it is assumed that you
4836have GNU cross compiling tools available in your path. In this case,
4837you must set the environment variable CROSS_COMPILE in your shell.
4838Note that no changes to the Makefile or any other source files are
4839necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004840
Wolfgang Denk218ca722008-03-26 10:40:12 +01004841 $ CROSS_COMPILE=ppc_4xx-
4842 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004843
Peter Tyser2f8d3962009-03-13 18:54:51 -05004844Note: If you wish to generate Windows versions of the utilities in
4845 the tools directory you can use the MinGW toolchain
4846 (http://www.mingw.org). Set your HOST tools to the MinGW
4847 toolchain and execute 'make tools'. For example:
4848
4849 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4850
4851 Binaries such as tools/mkimage.exe will be created which can
4852 be executed on computers running Windows.
4853
Wolfgang Denk218ca722008-03-26 10:40:12 +01004854U-Boot is intended to be simple to build. After installing the
4855sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004856is done by typing:
4857
4858 make NAME_config
4859
Wolfgang Denk218ca722008-03-26 10:40:12 +01004860where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004861rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863Note: for some board special configuration names may exist; check if
4864 additional information is available from the board vendor; for
4865 instance, the TQM823L systems are available without (standard)
4866 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004867 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869 make TQM823L_config
4870 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872 make TQM823L_LCD_config
4873 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk2729af92004-05-03 20:45:30 +00004875 etc.
wdenkc6097192002-11-03 00:24:07 +00004876
wdenkc6097192002-11-03 00:24:07 +00004877
wdenk2729af92004-05-03 20:45:30 +00004878Finally, type "make all", and you should get some working U-Boot
4879images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk2729af92004-05-03 20:45:30 +00004881- "u-boot.bin" is a raw binary image
4882- "u-boot" is an image in ELF binary format
4883- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004884
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004885By default the build is performed locally and the objects are saved
4886in the source directory. One of the two methods can be used to change
4887this behavior and build U-Boot to some external directory:
4888
48891. Add O= to the make command line invocations:
4890
4891 make O=/tmp/build distclean
4892 make O=/tmp/build NAME_config
4893 make O=/tmp/build all
4894
48952. Set environment variable BUILD_DIR to point to the desired location:
4896
4897 export BUILD_DIR=/tmp/build
4898 make distclean
4899 make NAME_config
4900 make all
4901
4902Note that the command line "O=" setting overrides the BUILD_DIR environment
4903variable.
4904
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906Please be aware that the Makefiles assume you are using GNU make, so
4907for instance on NetBSD you might need to use "gmake" instead of
4908native "make".
wdenkc6097192002-11-03 00:24:07 +00004909
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk2729af92004-05-03 20:45:30 +00004911If the system board that you have is not listed, then you will need
4912to port U-Boot to your hardware platform. To do this, follow these
4913steps:
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk2729af92004-05-03 20:45:30 +000049151. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004916 "boards.cfg" file, using the existing entries as examples.
4917 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000049182. Create a new directory to hold your board specific code. Add any
4919 files you need. In your board directory, you will need at least
4920 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
49213. Create a new configuration file "include/configs/<board>.h" for
4922 your board
49233. If you're porting U-Boot to a new CPU, then also create a new
4924 directory to hold your CPU specific code. Add any files you need.
49254. Run "make <board>_config" with your new name.
49265. Type "make", and you should get a working "u-boot.srec" file
4927 to be installed on your target system.
49286. Debug and solve any problems that might arise.
4929 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004930
wdenkc6097192002-11-03 00:24:07 +00004931
wdenk2729af92004-05-03 20:45:30 +00004932Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4933==============================================================
wdenkc6097192002-11-03 00:24:07 +00004934
Wolfgang Denk218ca722008-03-26 10:40:12 +01004935If you have modified U-Boot sources (for instance added a new board
4936or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004937provide feedback to the other developers. The feedback normally takes
4938the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004939official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004940
Wolfgang Denk218ca722008-03-26 10:40:12 +01004941But before you submit such a patch, please verify that your modifi-
4942cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004943the supported boards compile WITHOUT ANY compiler warnings. To do so,
4944just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004945for ALL supported system. Be warned, this will take a while. You can
4946select which (cross) compiler to use by passing a `CROSS_COMPILE'
4947environment variable to the script, i. e. to use the ELDK cross tools
4948you can type
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk2729af92004-05-03 20:45:30 +00004950 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk2729af92004-05-03 20:45:30 +00004952or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004953
wdenk2729af92004-05-03 20:45:30 +00004954 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004955
Wolfgang Denk218ca722008-03-26 10:40:12 +01004956When using the MAKEALL script, the default behaviour is to build
4957U-Boot in the source directory. This location can be changed by
4958setting the BUILD_DIR environment variable. Also, for each target
4959built, the MAKEALL script saves two log files (<target>.ERR and
4960<target>.MAKEALL) in the <source dir>/LOG directory. This default
4961location can be changed by setting the MAKEALL_LOGDIR environment
4962variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004963
4964 export BUILD_DIR=/tmp/build
4965 export MAKEALL_LOGDIR=/tmp/log
4966 CROSS_COMPILE=ppc_8xx- MAKEALL
4967
Wolfgang Denk218ca722008-03-26 10:40:12 +01004968With the above settings build objects are saved in the /tmp/build,
4969log files are saved in the /tmp/log and the source tree remains clean
4970during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004971
4972
wdenk2729af92004-05-03 20:45:30 +00004973See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004974
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk2729af92004-05-03 20:45:30 +00004976Monitor Commands - Overview:
4977============================
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979go - start application at address 'addr'
4980run - run commands in an environment variable
4981bootm - boot application image from memory
4982bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004983bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004984tftpboot- boot image via network using TFTP protocol
4985 and env variables "ipaddr" and "serverip"
4986 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004987tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004988rarpboot- boot image via network using RARP/TFTP protocol
4989diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4990loads - load S-Record file over serial line
4991loadb - load binary file over serial line (kermit mode)
4992md - memory display
4993mm - memory modify (auto-incrementing)
4994nm - memory modify (constant address)
4995mw - memory write (fill)
4996cp - memory copy
4997cmp - memory compare
4998crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004999i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005000sspi - SPI utility commands
5001base - print or set address offset
5002printenv- print environment variables
5003setenv - set environment variables
5004saveenv - save environment variables to persistent storage
5005protect - enable or disable FLASH write protection
5006erase - erase FLASH memory
5007flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005008nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005009bdinfo - print Board Info structure
5010iminfo - print header information for application image
5011coninfo - print console devices and informations
5012ide - IDE sub-system
5013loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005014loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005015mtest - simple RAM test
5016icache - enable or disable instruction cache
5017dcache - enable or disable data cache
5018reset - Perform RESET of the CPU
5019echo - echo args to console
5020version - print monitor version
5021help - print online help
5022? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005023
wdenkc6097192002-11-03 00:24:07 +00005024
wdenk2729af92004-05-03 20:45:30 +00005025Monitor Commands - Detailed Description:
5026========================================
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028TODO.
wdenkc6097192002-11-03 00:24:07 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005031
5032
wdenk2729af92004-05-03 20:45:30 +00005033Environment Variables:
5034======================
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036U-Boot supports user configuration using Environment Variables which
5037can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005038
wdenk2729af92004-05-03 20:45:30 +00005039Environment Variables are set using "setenv", printed using
5040"printenv", and saved to Flash using "saveenv". Using "setenv"
5041without a value can be used to delete a variable from the
5042environment. As long as you don't save the environment you are
5043working with an in-memory copy. In case the Flash area containing the
5044environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005045
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005046Some configuration options can be set using Environment Variables.
5047
5048List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005049
wdenk2729af92004-05-03 20:45:30 +00005050 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk2729af92004-05-03 20:45:30 +00005052 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk2729af92004-05-03 20:45:30 +00005054 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk2729af92004-05-03 20:45:30 +00005056 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005057
wdenk2729af92004-05-03 20:45:30 +00005058 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005059
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005060 bootm_low - Memory range available for image processing in the bootm
5061 command can be restricted. This variable is given as
5062 a hexadecimal number and defines lowest address allowed
5063 for use by the bootm command. See also "bootm_size"
5064 environment variable. Address defined by "bootm_low" is
5065 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005066 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5067 bootm_mapsize.
5068
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005069 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005070 This variable is given as a hexadecimal number and it
5071 defines the size of the memory region starting at base
5072 address bootm_low that is accessible by the Linux kernel
5073 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5074 as the default value if it is defined, and bootm_size is
5075 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005076
5077 bootm_size - Memory range available for image processing in the bootm
5078 command can be restricted. This variable is given as
5079 a hexadecimal number and defines the size of the region
5080 allowed for use by the bootm command. See also "bootm_low"
5081 environment variable.
5082
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005083 updatefile - Location of the software update file on a TFTP server, used
5084 by the automatic software update feature. Please refer to
5085 documentation in doc/README.update for more details.
5086
wdenk2729af92004-05-03 20:45:30 +00005087 autoload - if set to "no" (any string beginning with 'n'),
5088 "bootp" will just load perform a lookup of the
5089 configuration from the BOOTP server, but not try to
5090 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092 autostart - if set to "yes", an image loaded using the "bootp",
5093 "rarpboot", "tftpboot" or "diskboot" commands will
5094 be automatically started (by internally calling
5095 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk2729af92004-05-03 20:45:30 +00005097 If set to "no", a standalone image passed to the
5098 "bootm" command will be copied to the load address
5099 (and eventually uncompressed), but NOT be started.
5100 This can be used to load and uncompress arbitrary
5101 data.
wdenkc6097192002-11-03 00:24:07 +00005102
David A. Longa28afca2011-07-09 16:40:19 -04005103 fdt_high - if set this restricts the maximum address that the
5104 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005105 For example, if you have a system with 1 GB memory
5106 at physical address 0x10000000, while Linux kernel
5107 only recognizes the first 704 MB as low memory, you
5108 may need to set fdt_high as 0x3C000000 to have the
5109 device tree blob be copied to the maximum address
5110 of the 704 MB low memory, so that Linux kernel can
5111 access it during the boot procedure.
5112
David A. Longa28afca2011-07-09 16:40:19 -04005113 If this is set to the special value 0xFFFFFFFF then
5114 the fdt will not be copied at all on boot. For this
5115 to work it must reside in writable memory, have
5116 sufficient padding on the end of it for u-boot to
5117 add the information it needs into it, and the memory
5118 must be accessible by the kernel.
5119
Simon Glasseea63e02011-10-24 19:15:34 +00005120 fdtcontroladdr- if set this is the address of the control flattened
5121 device tree used by U-Boot when CONFIG_OF_CONTROL is
5122 defined.
5123
wdenk17ea1172004-06-06 21:51:03 +00005124 i2cfast - (PPC405GP|PPC405EP only)
5125 if set to 'y' configures Linux I2C driver for fast
5126 mode (400kHZ). This environment variable is used in
5127 initialization code. So, for changes to be effective
5128 it must be saved and board must be reset.
5129
wdenk2729af92004-05-03 20:45:30 +00005130 initrd_high - restrict positioning of initrd images:
5131 If this variable is not set, initrd images will be
5132 copied to the highest possible address in RAM; this
5133 is usually what you want since it allows for
5134 maximum initrd size. If for some reason you want to
5135 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005136 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005137 variable to a value of "no" or "off" or "0".
5138 Alternatively, you can set it to a maximum upper
5139 address to use (U-Boot will still check that it
5140 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk2729af92004-05-03 20:45:30 +00005142 For instance, when you have a system with 16 MB
5143 RAM, and want to reserve 4 MB from use by Linux,
5144 you can do this by adding "mem=12M" to the value of
5145 the "bootargs" variable. However, now you must make
5146 sure that the initrd image is placed in the first
5147 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151 If you set initrd_high to 0xFFFFFFFF, this is an
5152 indication to U-Boot that all addresses are legal
5153 for the Linux kernel, including addresses in flash
5154 memory. In this case U-Boot will NOT COPY the
5155 ramdisk at all. This may be useful to reduce the
5156 boot time on your system, but requires that this
5157 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005158
wdenk2729af92004-05-03 20:45:30 +00005159 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005160
wdenk2729af92004-05-03 20:45:30 +00005161 loadaddr - Default load address for commands like "bootp",
5162 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk2729af92004-05-03 20:45:30 +00005166 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005167
wdenk2729af92004-05-03 20:45:30 +00005168 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk2729af92004-05-03 20:45:30 +00005170 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk2729af92004-05-03 20:45:30 +00005172 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005173
Mike Frysingere2a53452011-10-02 10:01:27 +00005174 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005175
Mike Frysingere2a53452011-10-02 10:01:27 +00005176 ethact - controls which interface is currently active.
5177 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005178
Heiko Schocher48690d82010-07-20 17:45:02 +02005179 => setenv ethact FEC
5180 => ping 192.168.0.1 # traffic sent on FEC
5181 => setenv ethact SCC
5182 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005183
Matthias Fuchse1692572008-01-17 07:45:05 +01005184 ethrotate - When set to "no" U-Boot does not go through all
5185 available network interfaces.
5186 It just stays at the currently selected interface.
5187
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005188 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005189 either succeed or fail without retrying.
5190 When set to "once" the network operation will
5191 fail when all the available network interfaces
5192 are tried once without success.
5193 Useful on scripts which control the retry operation
5194 themselves.
wdenkc6097192002-11-03 00:24:07 +00005195
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005196 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005197
Simon Glass8d51aac2013-07-16 20:10:00 -07005198 silent_linux - If set then linux will be told to boot silently, by
5199 changing the console to be empty. If "yes" it will be
5200 made silent. If "no" it will not be made silent. If
5201 unset, then it will be made silent if the U-Boot console
5202 is silent.
5203
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005204 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005205 UDP source port.
5206
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005207 tftpdstport - If this is set, the value is used for TFTP's UDP
5208 destination port instead of the Well Know Port 69.
5209
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005210 tftpblocksize - Block size to use for TFTP transfers; if not set,
5211 we use the TFTP server's default block size
5212
5213 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5214 seconds, minimum value is 1000 = 1 second). Defines
5215 when a packet is considered to be lost so it has to
5216 be retransmitted. The default is 5000 = 5 seconds.
5217 Lowering this value may make downloads succeed
5218 faster in networks with high packet loss rates or
5219 with unreliable TFTP servers.
5220
5221 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005222 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005223 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005224
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005225The following image location variables contain the location of images
5226used in booting. The "Image" column gives the role of the image and is
5227not an environment variable name. The other columns are environment
5228variable names. "File Name" gives the name of the file on a TFTP
5229server, "RAM Address" gives the location in RAM the image will be
5230loaded to, and "Flash Location" gives the image's address in NOR
5231flash or offset in NAND flash.
5232
5233*Note* - these variables don't have to be defined for all boards, some
5234boards currenlty use other variables for these purposes, and some
5235boards use these variables for other purposes.
5236
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005237Image File Name RAM Address Flash Location
5238----- --------- ----------- --------------
5239u-boot u-boot u-boot_addr_r u-boot_addr
5240Linux kernel bootfile kernel_addr_r kernel_addr
5241device tree blob fdtfile fdt_addr_r fdt_addr
5242ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005243
wdenk2729af92004-05-03 20:45:30 +00005244The following environment variables may be used and automatically
5245updated by the network boot commands ("bootp" and "rarpboot"),
5246depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005247
wdenk2729af92004-05-03 20:45:30 +00005248 bootfile - see above
5249 dnsip - IP address of your Domain Name Server
5250 dnsip2 - IP address of your secondary Domain Name Server
5251 gatewayip - IP address of the Gateway (Router) to use
5252 hostname - Target hostname
5253 ipaddr - see above
5254 netmask - Subnet Mask
5255 rootpath - Pathname of the root filesystem on the NFS server
5256 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005257
wdenka3d991b2004-04-15 21:48:45 +00005258
wdenk2729af92004-05-03 20:45:30 +00005259There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261 serial# - contains hardware identification information such
5262 as type string and/or serial number
5263 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk2729af92004-05-03 20:45:30 +00005265These variables can be set only once (usually during manufacturing of
5266the board). U-Boot refuses to delete or overwrite these variables
5267once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005268
5269
wdenk2729af92004-05-03 20:45:30 +00005270Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005271
wdenk2729af92004-05-03 20:45:30 +00005272 ver - Contains the U-Boot version string as printed
5273 with the "version" command. This variable is
5274 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005275
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk2729af92004-05-03 20:45:30 +00005277Please note that changes to some configuration parameters may take
5278only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005279
stroesec1551ea2003-04-04 15:53:41 +00005280
Joe Hershberger170ab112012-12-11 22:16:24 -06005281Callback functions for environment variables:
5282---------------------------------------------
5283
5284For some environment variables, the behavior of u-boot needs to change
5285when their values are changed. This functionailty allows functions to
5286be associated with arbitrary variables. On creation, overwrite, or
5287deletion, the callback will provide the opportunity for some side
5288effect to happen or for the change to be rejected.
5289
5290The callbacks are named and associated with a function using the
5291U_BOOT_ENV_CALLBACK macro in your board or driver code.
5292
5293These callbacks are associated with variables in one of two ways. The
5294static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5295in the board configuration to a string that defines a list of
5296associations. The list must be in the following format:
5297
5298 entry = variable_name[:callback_name]
5299 list = entry[,list]
5300
5301If the callback name is not specified, then the callback is deleted.
5302Spaces are also allowed anywhere in the list.
5303
5304Callbacks can also be associated by defining the ".callbacks" variable
5305with the same list format above. Any association in ".callbacks" will
5306override any association in the static list. You can define
5307CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5308".callbacks" envirnoment variable in the default or embedded environment.
5309
5310
wdenk2729af92004-05-03 20:45:30 +00005311Command Line Parsing:
5312=====================
stroesec1551ea2003-04-04 15:53:41 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314There are two different command line parsers available with U-Boot:
5315the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005316
wdenk2729af92004-05-03 20:45:30 +00005317Old, simple command line parser:
5318--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk2729af92004-05-03 20:45:30 +00005320- supports environment variables (through setenv / saveenv commands)
5321- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005322- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005323- special characters ('$', ';') can be escaped by prefixing with '\',
5324 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005325 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005326- You can also escape text by enclosing in single apostrophes, for example:
5327 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005328
wdenk2729af92004-05-03 20:45:30 +00005329Hush shell:
5330-----------
wdenkf07771c2003-05-28 08:06:31 +00005331
wdenk2729af92004-05-03 20:45:30 +00005332- similar to Bourne shell, with control structures like
5333 if...then...else...fi, for...do...done; while...do...done,
5334 until...do...done, ...
5335- supports environment ("global") variables (through setenv / saveenv
5336 commands) and local shell variables (through standard shell syntax
5337 "name=value"); only environment variables can be used with "run"
5338 command
wdenkf07771c2003-05-28 08:06:31 +00005339
wdenk2729af92004-05-03 20:45:30 +00005340General rules:
5341--------------
wdenkf07771c2003-05-28 08:06:31 +00005342
wdenk2729af92004-05-03 20:45:30 +00005343(1) If a command line (or an environment variable executed by a "run"
5344 command) contains several commands separated by semicolon, and
5345 one of these commands fails, then the remaining commands will be
5346 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005349 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005350 command will cause "run" to terminate, i. e. the remaining
5351 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005352
wdenk2729af92004-05-03 20:45:30 +00005353Note for Redundant Ethernet Interfaces:
5354=======================================
wdenkf07771c2003-05-28 08:06:31 +00005355
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005356Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005357such configurations and is capable of automatic selection of a
5358"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005359
wdenk2729af92004-05-03 20:45:30 +00005360Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5361MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5362"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364If the network interface stores some valid MAC address (for instance
5365in SROM), this is used as default address if there is NO correspon-
5366ding setting in the environment; if the corresponding environment
5367variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369o If the SROM has a valid MAC address, and there is no address in the
5370 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372o If there is no valid address in the SROM, and a definition in the
5373 environment exists, then the value from the environment variable is
5374 used.
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376o If both the SROM and the environment contain a MAC address, and
5377 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005378
wdenk2729af92004-05-03 20:45:30 +00005379o If both the SROM and the environment contain a MAC address, and the
5380 addresses differ, the value from the environment is used and a
5381 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk2729af92004-05-03 20:45:30 +00005383o If neither SROM nor the environment contain a MAC address, an error
5384 is raised.
wdenkc6097192002-11-03 00:24:07 +00005385
Ben Warrenecee9322010-04-26 11:11:46 -07005386If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005387will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005388may be skipped by setting the appropriate 'ethmacskip' environment variable.
5389The naming convention is as follows:
5390"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk2729af92004-05-03 20:45:30 +00005392Image Formats:
5393==============
wdenkc6097192002-11-03 00:24:07 +00005394
Marian Balakowicz3310c542008-03-12 12:13:13 +01005395U-Boot is capable of booting (and performing other auxiliary operations on)
5396images in two formats:
5397
5398New uImage format (FIT)
5399-----------------------
5400
5401Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5402to Flattened Device Tree). It allows the use of images with multiple
5403components (several kernels, ramdisks, etc.), with contents protected by
5404SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5405
5406
5407Old uImage format
5408-----------------
5409
5410Old image format is based on binary files which can be basically anything,
5411preceded by a special header; see the definitions in include/image.h for
5412details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5415 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005416 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5417 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5418 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005419* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005420 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5421 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005422* Compression Type (uncompressed, gzip, bzip2)
5423* Load Address
5424* Entry Point
5425* Image Name
5426* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk2729af92004-05-03 20:45:30 +00005428The header is marked by a special Magic Number, and both the header
5429and the data portions of the image are secured against corruption by
5430CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005431
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433Linux Support:
5434==============
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk2729af92004-05-03 20:45:30 +00005436Although U-Boot should support any OS or standalone application
5437easily, the main focus has always been on Linux during the design of
5438U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005439
wdenk2729af92004-05-03 20:45:30 +00005440U-Boot includes many features that so far have been part of some
5441special "boot loader" code within the Linux kernel. Also, any
5442"initrd" images to be used are no longer part of one big Linux image;
5443instead, kernel and "initrd" are separate images. This implementation
5444serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446- the same features can be used for other OS or standalone
5447 applications (for instance: using compressed images to reduce the
5448 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk2729af92004-05-03 20:45:30 +00005450- it becomes much easier to port new Linux kernel versions because
5451 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005452
wdenk2729af92004-05-03 20:45:30 +00005453- the same Linux kernel image can now be used with different "initrd"
5454 images; of course this also means that different kernel images can
5455 be run with the same "initrd". This makes testing easier (you don't
5456 have to build a new "zImage.initrd" Linux image when you just
5457 change a file in your "initrd"). Also, a field-upgrade of the
5458 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005459
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk2729af92004-05-03 20:45:30 +00005461Linux HOWTO:
5462============
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk2729af92004-05-03 20:45:30 +00005464Porting Linux to U-Boot based systems:
5465---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005466
wdenk2729af92004-05-03 20:45:30 +00005467U-Boot cannot save you from doing all the necessary modifications to
5468configure the Linux device drivers for use with your target hardware
5469(no, we don't intend to provide a full virtual machine interface to
5470Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005471
Stefan Roesea47a12b2010-04-15 16:07:28 +02005472But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474Just make sure your machine specific header file (for instance
5475include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005476Information structure as we define in include/asm-<arch>/u-boot.h,
5477and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005478as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005479
Simon Glass2eb31b12014-06-11 23:29:46 -06005480Note that U-Boot now has a driver model, a unified model for drivers.
5481If you are adding a new driver, plumb it into driver model. If there
5482is no uclass available, you are encouraged to create one. See
5483doc/driver-model.
5484
wdenkc6097192002-11-03 00:24:07 +00005485
wdenk2729af92004-05-03 20:45:30 +00005486Configuring the Linux kernel:
5487-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk2729af92004-05-03 20:45:30 +00005489No specific requirements for U-Boot. Make sure you have some root
5490device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005491
wdenkc6097192002-11-03 00:24:07 +00005492
wdenk2729af92004-05-03 20:45:30 +00005493Building a Linux Image:
5494-----------------------
wdenkc6097192002-11-03 00:24:07 +00005495
wdenk2729af92004-05-03 20:45:30 +00005496With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5497not used. If you use recent kernel source, a new build target
5498"uImage" will exist which automatically builds an image usable by
5499U-Boot. Most older kernels also have support for a "pImage" target,
5500which was introduced for our predecessor project PPCBoot and uses a
5501100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503Example:
wdenkc6097192002-11-03 00:24:07 +00005504
wdenk2729af92004-05-03 20:45:30 +00005505 make TQM850L_config
5506 make oldconfig
5507 make dep
5508 make uImage
wdenkc6097192002-11-03 00:24:07 +00005509
wdenk2729af92004-05-03 20:45:30 +00005510The "uImage" build target uses a special tool (in 'tools/mkimage') to
5511encapsulate a compressed Linux kernel image with header information,
5512CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk2729af92004-05-03 20:45:30 +00005514* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005515
wdenk2729af92004-05-03 20:45:30 +00005516* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk2729af92004-05-03 20:45:30 +00005518 ${CROSS_COMPILE}-objcopy -O binary \
5519 -R .note -R .comment \
5520 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005521
wdenk2729af92004-05-03 20:45:30 +00005522* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005523
wdenk2729af92004-05-03 20:45:30 +00005524 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk2729af92004-05-03 20:45:30 +00005526* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005527
wdenk2729af92004-05-03 20:45:30 +00005528 mkimage -A ppc -O linux -T kernel -C gzip \
5529 -a 0 -e 0 -n "Linux Kernel Image" \
5530 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005531
wdenk24ee89b2002-11-03 17:56:27 +00005532
wdenk2729af92004-05-03 20:45:30 +00005533The "mkimage" tool can also be used to create ramdisk images for use
5534with U-Boot, either separated from the Linux kernel image, or
5535combined into one file. "mkimage" encapsulates the images with a 64
5536byte header containing information about target architecture,
5537operating system, image type, compression method, entry points, time
5538stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005539
wdenk2729af92004-05-03 20:45:30 +00005540"mkimage" can be called in two ways: to verify existing images and
5541print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005542
wdenk2729af92004-05-03 20:45:30 +00005543In the first form (with "-l" option) mkimage lists the information
5544contained in the header of an existing U-Boot image; this includes
5545checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005546
wdenk2729af92004-05-03 20:45:30 +00005547 tools/mkimage -l image
5548 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550The second form (with "-d" option) is used to build a U-Boot image
5551from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005552
wdenk2729af92004-05-03 20:45:30 +00005553 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5554 -n name -d data_file image
5555 -A ==> set architecture to 'arch'
5556 -O ==> set operating system to 'os'
5557 -T ==> set image type to 'type'
5558 -C ==> set compression type 'comp'
5559 -a ==> set load address to 'addr' (hex)
5560 -e ==> set entry point to 'ep' (hex)
5561 -n ==> set image name to 'name'
5562 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005563
wdenk69459792004-05-29 16:53:29 +00005564Right now, all Linux kernels for PowerPC systems use the same load
5565address (0x00000000), but the entry point address depends on the
5566kernel version:
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk2729af92004-05-03 20:45:30 +00005568- 2.2.x kernels have the entry point at 0x0000000C,
5569- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005572
wdenk2729af92004-05-03 20:45:30 +00005573 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5574 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005575 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005576 > examples/uImage.TQM850L
5577 Image Name: 2.4.4 kernel for TQM850L
5578 Created: Wed Jul 19 02:34:59 2000
5579 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5580 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5581 Load Address: 0x00000000
5582 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk2729af92004-05-03 20:45:30 +00005584To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk2729af92004-05-03 20:45:30 +00005586 -> tools/mkimage -l examples/uImage.TQM850L
5587 Image Name: 2.4.4 kernel for TQM850L
5588 Created: Wed Jul 19 02:34:59 2000
5589 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5590 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5591 Load Address: 0x00000000
5592 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594NOTE: for embedded systems where boot time is critical you can trade
5595speed for memory and install an UNCOMPRESSED image instead: this
5596needs more space in Flash, but boots much faster since it does not
5597need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005598
Stefan Roesea47a12b2010-04-15 16:07:28 +02005599 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005600 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5601 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005602 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005603 > examples/uImage.TQM850L-uncompressed
5604 Image Name: 2.4.4 kernel for TQM850L
5605 Created: Wed Jul 19 02:34:59 2000
5606 Image Type: PowerPC Linux Kernel Image (uncompressed)
5607 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5608 Load Address: 0x00000000
5609 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005610
wdenkc6097192002-11-03 00:24:07 +00005611
wdenk2729af92004-05-03 20:45:30 +00005612Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5613when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005614
wdenk2729af92004-05-03 20:45:30 +00005615 -> tools/mkimage -n 'Simple Ramdisk Image' \
5616 > -A ppc -O linux -T ramdisk -C gzip \
5617 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5618 Image Name: Simple Ramdisk Image
5619 Created: Wed Jan 12 14:01:50 2000
5620 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5621 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5622 Load Address: 0x00000000
5623 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005624
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005625The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5626option performs the converse operation of the mkimage's second form (the "-d"
5627option). Given an image built by mkimage, the dumpimage extracts a "data file"
5628from the image:
5629
5630 tools/dumpimage -i image -p position data_file
5631 -i ==> extract from the 'image' a specific 'data_file', \
5632 indexed by 'position'
5633
wdenkdb01a2e2004-04-15 23:14:49 +00005634
wdenk2729af92004-05-03 20:45:30 +00005635Installing a Linux Image:
5636-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005637
wdenk2729af92004-05-03 20:45:30 +00005638To downloading a U-Boot image over the serial (console) interface,
5639you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005640
wdenk2729af92004-05-03 20:45:30 +00005641 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005642
wdenk2729af92004-05-03 20:45:30 +00005643The 'objcopy' does not understand the information in the U-Boot
5644image header, so the resulting S-Record file will be relative to
5645address 0x00000000. To load it to a given address, you need to
5646specify the target address as 'offset' parameter with the 'loads'
5647command.
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649Example: install the image to address 0x40100000 (which on the
5650TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk2729af92004-05-03 20:45:30 +00005654 .......... done
5655 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk2729af92004-05-03 20:45:30 +00005657 => loads 40100000
5658 ## Ready for S-Record download ...
5659 ~>examples/image.srec
5660 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5661 ...
5662 15989 15990 15991 15992
5663 [file transfer complete]
5664 [connected]
5665 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005666
5667
wdenk2729af92004-05-03 20:45:30 +00005668You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005669this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005670corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk2729af92004-05-03 20:45:30 +00005672 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk2729af92004-05-03 20:45:30 +00005674 ## Checking Image at 40100000 ...
5675 Image Name: 2.2.13 for initrd on TQM850L
5676 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5677 Data Size: 335725 Bytes = 327 kB = 0 MB
5678 Load Address: 00000000
5679 Entry Point: 0000000c
5680 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005681
5682
wdenk2729af92004-05-03 20:45:30 +00005683Boot Linux:
5684-----------
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686The "bootm" command is used to boot an application that is stored in
5687memory (RAM or Flash). In case of a Linux kernel image, the contents
5688of the "bootargs" environment variable is passed to the kernel as
5689parameters. You can check and modify this variable using the
5690"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005691
5692
wdenk2729af92004-05-03 20:45:30 +00005693 => printenv bootargs
5694 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk2729af92004-05-03 20:45:30 +00005696 => 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 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698 => printenv bootargs
5699 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 +00005700
wdenk2729af92004-05-03 20:45:30 +00005701 => bootm 40020000
5702 ## Booting Linux kernel at 40020000 ...
5703 Image Name: 2.2.13 for NFS on TQM850L
5704 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5705 Data Size: 381681 Bytes = 372 kB = 0 MB
5706 Load Address: 00000000
5707 Entry Point: 0000000c
5708 Verifying Checksum ... OK
5709 Uncompressing Kernel Image ... OK
5710 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
5711 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5712 time_init: decrementer frequency = 187500000/60
5713 Calibrating delay loop... 49.77 BogoMIPS
5714 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5715 ...
wdenkc6097192002-11-03 00:24:07 +00005716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005717If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005718the memory addresses of both the kernel and the initrd image (PPBCOOT
5719format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005720
wdenk2729af92004-05-03 20:45:30 +00005721 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005722
wdenk2729af92004-05-03 20:45:30 +00005723 ## Checking Image at 40100000 ...
5724 Image Name: 2.2.13 for initrd on TQM850L
5725 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5726 Data Size: 335725 Bytes = 327 kB = 0 MB
5727 Load Address: 00000000
5728 Entry Point: 0000000c
5729 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk2729af92004-05-03 20:45:30 +00005731 ## Checking Image at 40200000 ...
5732 Image Name: Simple Ramdisk Image
5733 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5734 Data Size: 566530 Bytes = 553 kB = 0 MB
5735 Load Address: 00000000
5736 Entry Point: 00000000
5737 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk2729af92004-05-03 20:45:30 +00005739 => bootm 40100000 40200000
5740 ## Booting Linux kernel at 40100000 ...
5741 Image Name: 2.2.13 for initrd on TQM850L
5742 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5743 Data Size: 335725 Bytes = 327 kB = 0 MB
5744 Load Address: 00000000
5745 Entry Point: 0000000c
5746 Verifying Checksum ... OK
5747 Uncompressing Kernel Image ... OK
5748 ## Loading RAMDisk Image at 40200000 ...
5749 Image Name: Simple Ramdisk Image
5750 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5751 Data Size: 566530 Bytes = 553 kB = 0 MB
5752 Load Address: 00000000
5753 Entry Point: 00000000
5754 Verifying Checksum ... OK
5755 Loading Ramdisk ... OK
5756 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
5757 Boot arguments: root=/dev/ram
5758 time_init: decrementer frequency = 187500000/60
5759 Calibrating delay loop... 49.77 BogoMIPS
5760 ...
5761 RAMDISK: Compressed image found at block 0
5762 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk2729af92004-05-03 20:45:30 +00005764 bash#
wdenkc6097192002-11-03 00:24:07 +00005765
Matthew McClintock02677682006-06-28 10:41:37 -05005766Boot Linux and pass a flat device tree:
5767-----------
5768
5769First, U-Boot must be compiled with the appropriate defines. See the section
5770titled "Linux Kernel Interface" above for a more in depth explanation. The
5771following is an example of how to start a kernel and pass an updated
5772flat device tree:
5773
5774=> print oftaddr
5775oftaddr=0x300000
5776=> print oft
5777oft=oftrees/mpc8540ads.dtb
5778=> tftp $oftaddr $oft
5779Speed: 1000, full duplex
5780Using TSEC0 device
5781TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5782Filename 'oftrees/mpc8540ads.dtb'.
5783Load address: 0x300000
5784Loading: #
5785done
5786Bytes transferred = 4106 (100a hex)
5787=> tftp $loadaddr $bootfile
5788Speed: 1000, full duplex
5789Using TSEC0 device
5790TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5791Filename 'uImage'.
5792Load address: 0x200000
5793Loading:############
5794done
5795Bytes transferred = 1029407 (fb51f hex)
5796=> print loadaddr
5797loadaddr=200000
5798=> print oftaddr
5799oftaddr=0x300000
5800=> bootm $loadaddr - $oftaddr
5801## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005802 Image Name: Linux-2.6.17-dirty
5803 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5804 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005805 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005806 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005807 Verifying Checksum ... OK
5808 Uncompressing Kernel Image ... OK
5809Booting using flat device tree at 0x300000
5810Using MPC85xx ADS machine description
5811Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5812[snip]
5813
5814
wdenk2729af92004-05-03 20:45:30 +00005815More About U-Boot Image Types:
5816------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005817
wdenk2729af92004-05-03 20:45:30 +00005818U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005819
wdenk2729af92004-05-03 20:45:30 +00005820 "Standalone Programs" are directly runnable in the environment
5821 provided by U-Boot; it is expected that (if they behave
5822 well) you can continue to work in U-Boot after return from
5823 the Standalone Program.
5824 "OS Kernel Images" are usually images of some Embedded OS which
5825 will take over control completely. Usually these programs
5826 will install their own set of exception handlers, device
5827 drivers, set up the MMU, etc. - this means, that you cannot
5828 expect to re-enter U-Boot except by resetting the CPU.
5829 "RAMDisk Images" are more or less just data blocks, and their
5830 parameters (address, size) are passed to an OS kernel that is
5831 being started.
5832 "Multi-File Images" contain several images, typically an OS
5833 (Linux) kernel image and one or more data images like
5834 RAMDisks. This construct is useful for instance when you want
5835 to boot over the network using BOOTP etc., where the boot
5836 server provides just a single image file, but you want to get
5837 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005838
wdenk2729af92004-05-03 20:45:30 +00005839 "Multi-File Images" start with a list of image sizes, each
5840 image size (in bytes) specified by an "uint32_t" in network
5841 byte order. This list is terminated by an "(uint32_t)0".
5842 Immediately after the terminating 0 follow the images, one by
5843 one, all aligned on "uint32_t" boundaries (size rounded up to
5844 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005845
wdenk2729af92004-05-03 20:45:30 +00005846 "Firmware Images" are binary images containing firmware (like
5847 U-Boot or FPGA images) which usually will be programmed to
5848 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005849
wdenk2729af92004-05-03 20:45:30 +00005850 "Script files" are command sequences that will be executed by
5851 U-Boot's command interpreter; this feature is especially
5852 useful when you configure U-Boot to use a real shell (hush)
5853 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005854
Marek Vasut44f074c2012-03-14 21:52:45 +00005855Booting the Linux zImage:
5856-------------------------
5857
5858On some platforms, it's possible to boot Linux zImage. This is done
5859using the "bootz" command. The syntax of "bootz" command is the same
5860as the syntax of "bootm" command.
5861
Tom Rini8ac28562013-05-16 11:40:11 -04005862Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005863kernel with raw initrd images. The syntax is slightly different, the
5864address of the initrd must be augmented by it's size, in the following
5865format: "<initrd addres>:<initrd size>".
5866
wdenkc6097192002-11-03 00:24:07 +00005867
wdenk2729af92004-05-03 20:45:30 +00005868Standalone HOWTO:
5869=================
wdenkc6097192002-11-03 00:24:07 +00005870
wdenk2729af92004-05-03 20:45:30 +00005871One of the features of U-Boot is that you can dynamically load and
5872run "standalone" applications, which can use some resources of
5873U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005874
wdenk2729af92004-05-03 20:45:30 +00005875Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk2729af92004-05-03 20:45:30 +00005877"Hello World" Demo:
5878-------------------
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk2729af92004-05-03 20:45:30 +00005880'examples/hello_world.c' contains a small "Hello World" Demo
5881application; it is automatically compiled when you build U-Boot.
5882It's configured to run at address 0x00040004, so you can play with it
5883like that:
wdenkc6097192002-11-03 00:24:07 +00005884
wdenk2729af92004-05-03 20:45:30 +00005885 => loads
5886 ## Ready for S-Record download ...
5887 ~>examples/hello_world.srec
5888 1 2 3 4 5 6 7 8 9 10 11 ...
5889 [file transfer complete]
5890 [connected]
5891 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893 => go 40004 Hello World! This is a test.
5894 ## Starting application at 0x00040004 ...
5895 Hello World
5896 argc = 7
5897 argv[0] = "40004"
5898 argv[1] = "Hello"
5899 argv[2] = "World!"
5900 argv[3] = "This"
5901 argv[4] = "is"
5902 argv[5] = "a"
5903 argv[6] = "test."
5904 argv[7] = "<NULL>"
5905 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk2729af92004-05-03 20:45:30 +00005907 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005908
wdenk2729af92004-05-03 20:45:30 +00005909Another example, which demonstrates how to register a CPM interrupt
5910handler with the U-Boot code, can be found in 'examples/timer.c'.
5911Here, a CPM timer is set up to generate an interrupt every second.
5912The interrupt service routine is trivial, just printing a '.'
5913character, but this is just a demo program. The application can be
5914controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk2729af92004-05-03 20:45:30 +00005916 ? - print current values og the CPM Timer registers
5917 b - enable interrupts and start timer
5918 e - stop timer and disable interrupts
5919 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk2729af92004-05-03 20:45:30 +00005921 => loads
5922 ## Ready for S-Record download ...
5923 ~>examples/timer.srec
5924 1 2 3 4 5 6 7 8 9 10 11 ...
5925 [file transfer complete]
5926 [connected]
5927 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005928
wdenk2729af92004-05-03 20:45:30 +00005929 => go 40004
5930 ## Starting application at 0x00040004 ...
5931 TIMERS=0xfff00980
5932 Using timer 1
5933 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk2729af92004-05-03 20:45:30 +00005935Hit 'b':
5936 [q, b, e, ?] Set interval 1000000 us
5937 Enabling timer
5938Hit '?':
5939 [q, b, e, ?] ........
5940 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5941Hit '?':
5942 [q, b, e, ?] .
5943 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5944Hit '?':
5945 [q, b, e, ?] .
5946 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5947Hit '?':
5948 [q, b, e, ?] .
5949 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5950Hit 'e':
5951 [q, b, e, ?] ...Stopping timer
5952Hit 'q':
5953 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005954
5955
wdenk2729af92004-05-03 20:45:30 +00005956Minicom warning:
5957================
wdenk85ec0bc2003-03-31 16:34:49 +00005958
wdenk2729af92004-05-03 20:45:30 +00005959Over time, many people have reported problems when trying to use the
5960"minicom" terminal emulation program for serial download. I (wd)
5961consider minicom to be broken, and recommend not to use it. Under
5962Unix, I recommend to use C-Kermit for general purpose use (and
5963especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005964use "cu" for S-Record download ("loads" command). See
5965http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5966for help with kermit.
5967
wdenk85ec0bc2003-03-31 16:34:49 +00005968
wdenk2729af92004-05-03 20:45:30 +00005969Nevertheless, if you absolutely want to use it try adding this
5970configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005971
wdenk2729af92004-05-03 20:45:30 +00005972 Name Program Name U/D FullScr IO-Red. Multi
5973 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5974 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005975
5976
wdenk2729af92004-05-03 20:45:30 +00005977NetBSD Notes:
5978=============
wdenkc6097192002-11-03 00:24:07 +00005979
wdenk2729af92004-05-03 20:45:30 +00005980Starting at version 0.9.2, U-Boot supports NetBSD both as host
5981(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005982
wdenk2729af92004-05-03 20:45:30 +00005983Building requires a cross environment; it is known to work on
5984NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5985need gmake since the Makefiles are not compatible with BSD make).
5986Note that the cross-powerpc package does not install include files;
5987attempting to build U-Boot will fail because <machine/ansi.h> is
5988missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005989
wdenk2729af92004-05-03 20:45:30 +00005990 # cd /usr/pkg/cross/powerpc-netbsd/include
5991 # mkdir powerpc
5992 # ln -s powerpc machine
5993 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5994 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk2729af92004-05-03 20:45:30 +00005996Native builds *don't* work due to incompatibilities between native
5997and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk2729af92004-05-03 20:45:30 +00005999Booting assumes that (the first part of) the image booted is a
6000stage-2 loader which in turn loads and then invokes the kernel
6001proper. Loader sources will eventually appear in the NetBSD source
6002tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006003meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006004
6005
wdenk2729af92004-05-03 20:45:30 +00006006Implementation Internals:
6007=========================
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk2729af92004-05-03 20:45:30 +00006009The following is not intended to be a complete description of every
6010implementation detail. However, it should help to understand the
6011inner workings of U-Boot and make it easier to port it to custom
6012hardware.
wdenkc6097192002-11-03 00:24:07 +00006013
6014
wdenk2729af92004-05-03 20:45:30 +00006015Initial Stack, Global Data:
6016---------------------------
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk2729af92004-05-03 20:45:30 +00006018The implementation of U-Boot is complicated by the fact that U-Boot
6019starts running out of ROM (flash memory), usually without access to
6020system RAM (because the memory controller is not initialized yet).
6021This means that we don't have writable Data or BSS segments, and BSS
6022is not initialized as zero. To be able to get a C environment working
6023at all, we have to allocate at least a minimal stack. Implementation
6024options for this are defined and restricted by the CPU used: Some CPU
6025models provide on-chip memory (like the IMMR area on MPC8xx and
6026MPC826x processors), on others (parts of) the data cache can be
6027locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006028
Wolfgang Denk218ca722008-03-26 10:40:12 +01006029 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006030 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006031
wdenk2729af92004-05-03 20:45:30 +00006032 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6033 From: "Chris Hallinan" <clh@net1plus.com>
6034 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6035 ...
wdenk43d96162003-03-06 00:02:04 +00006036
wdenk2729af92004-05-03 20:45:30 +00006037 Correct me if I'm wrong, folks, but the way I understand it
6038 is this: Using DCACHE as initial RAM for Stack, etc, does not
6039 require any physical RAM backing up the cache. The cleverness
6040 is that the cache is being used as a temporary supply of
6041 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006042 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006043 can see how this works by studying the cache architecture and
6044 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006045
wdenk2729af92004-05-03 20:45:30 +00006046 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6047 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006048 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006049 option should work for you. Using CS 4 should be fine if your
6050 board designers haven't used it for something that would
6051 cause you grief during the initial boot! It is frequently not
6052 used.
wdenk43d96162003-03-06 00:02:04 +00006053
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006054 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006055 with your processor/board/system design. The default value
6056 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006057 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006058 than your SDRAM module. If you have a 64MB SDRAM module, set
6059 it above 400_0000. Just make sure your board has no resources
6060 that are supposed to respond to that address! That code in
6061 start.S has been around a while and should work as is when
6062 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006063
wdenk2729af92004-05-03 20:45:30 +00006064 -Chris Hallinan
6065 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006066
wdenk2729af92004-05-03 20:45:30 +00006067It is essential to remember this, since it has some impact on the C
6068code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006069
wdenk2729af92004-05-03 20:45:30 +00006070* Initialized global data (data segment) is read-only. Do not attempt
6071 to write it.
wdenkc6097192002-11-03 00:24:07 +00006072
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006073* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00006074 as zero data - BSS segment) at all - this is undefined, initiali-
6075 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006076
wdenk2729af92004-05-03 20:45:30 +00006077* Stack space is very limited. Avoid big data buffers or things like
6078 that.
wdenkc6097192002-11-03 00:24:07 +00006079
wdenk2729af92004-05-03 20:45:30 +00006080Having only the stack as writable memory limits means we cannot use
6081normal global data to share information beween the code. But it
6082turned out that the implementation of U-Boot can be greatly
6083simplified by making a global data structure (gd_t) available to all
6084functions. We could pass a pointer to this data as argument to _all_
6085functions, but this would bloat the code. Instead we use a feature of
6086the GCC compiler (Global Register Variables) to share the data: we
6087place a pointer (gd) to the global data into a register which we
6088reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006089
wdenk2729af92004-05-03 20:45:30 +00006090When choosing a register for such a purpose we are restricted by the
6091relevant (E)ABI specifications for the current architecture, and by
6092GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006093
wdenk2729af92004-05-03 20:45:30 +00006094For PowerPC, the following registers have specific use:
6095 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006096 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006097 R3-R4: parameter passing and return values
6098 R5-R10: parameter passing
6099 R13: small data area pointer
6100 R30: GOT pointer
6101 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006102
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006103 (U-Boot also uses R12 as internal GOT pointer. r12
6104 is a volatile register so r12 needs to be reset when
6105 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006106
Wolfgang Denke7670f62008-02-14 22:43:22 +01006107 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006108
wdenk2729af92004-05-03 20:45:30 +00006109 Note: on PPC, we could use a static initializer (since the
6110 address of the global data structure is known at compile time),
6111 but it turned out that reserving a register results in somewhat
6112 smaller code - although the code savings are not that big (on
6113 average for all boards 752 bytes for the whole U-Boot image,
6114 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006115
Robin Getzc4db3352009-08-17 15:23:02 +00006116On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006117 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6118
Robin Getzc4db3352009-08-17 15:23:02 +00006119 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006120
wdenk2729af92004-05-03 20:45:30 +00006121On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006122
wdenk2729af92004-05-03 20:45:30 +00006123 R0: function argument word/integer result
6124 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006125 R9: platform specific
6126 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006127 R11: argument (frame) pointer
6128 R12: temporary workspace
6129 R13: stack pointer
6130 R14: link register
6131 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006132
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006133 ==> U-Boot will use R9 to hold a pointer to the global data
6134
6135 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006136
Thomas Chou0df01fd2010-05-21 11:08:03 +08006137On Nios II, the ABI is documented here:
6138 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6139
6140 ==> U-Boot will use gp to hold a pointer to the global data
6141
6142 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6143 to access small data sections, so gp is free.
6144
Macpaul Linafc1ce82011-10-19 20:41:11 +00006145On NDS32, the following registers are used:
6146
6147 R0-R1: argument/return
6148 R2-R5: argument
6149 R15: temporary register for assembler
6150 R16: trampoline register
6151 R28: frame pointer (FP)
6152 R29: global pointer (GP)
6153 R30: link register (LP)
6154 R31: stack pointer (SP)
6155 PC: program counter (PC)
6156
6157 ==> U-Boot will use R10 to hold a pointer to the global data
6158
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006159NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6160or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006161
wdenk2729af92004-05-03 20:45:30 +00006162Memory Management:
6163------------------
wdenkc6097192002-11-03 00:24:07 +00006164
wdenk2729af92004-05-03 20:45:30 +00006165U-Boot runs in system state and uses physical addresses, i.e. the
6166MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006167
wdenk2729af92004-05-03 20:45:30 +00006168The available memory is mapped to fixed addresses using the memory
6169controller. In this process, a contiguous block is formed for each
6170memory type (Flash, SDRAM, SRAM), even when it consists of several
6171physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006172
wdenk2729af92004-05-03 20:45:30 +00006173U-Boot is installed in the first 128 kB of the first Flash bank (on
6174TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6175booting and sizing and initializing DRAM, the code relocates itself
6176to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006177memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006178configuration setting]. Below that, a structure with global Board
6179Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk2729af92004-05-03 20:45:30 +00006181Additionally, some exception handler code is copied to the low 8 kB
6182of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006183
wdenk2729af92004-05-03 20:45:30 +00006184So a typical memory configuration with 16 MB of DRAM could look like
6185this:
wdenkc6097192002-11-03 00:24:07 +00006186
wdenk2729af92004-05-03 20:45:30 +00006187 0x0000 0000 Exception Vector code
6188 :
6189 0x0000 1FFF
6190 0x0000 2000 Free for Application Use
6191 :
6192 :
wdenkc6097192002-11-03 00:24:07 +00006193
wdenk2729af92004-05-03 20:45:30 +00006194 :
6195 :
6196 0x00FB FF20 Monitor Stack (Growing downward)
6197 0x00FB FFAC Board Info Data and permanent copy of global data
6198 0x00FC 0000 Malloc Arena
6199 :
6200 0x00FD FFFF
6201 0x00FE 0000 RAM Copy of Monitor Code
6202 ... eventually: LCD or video framebuffer
6203 ... eventually: pRAM (Protected RAM - unchanged by reset)
6204 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006205
6206
wdenk2729af92004-05-03 20:45:30 +00006207System Initialization:
6208----------------------
wdenkc6097192002-11-03 00:24:07 +00006209
wdenk2729af92004-05-03 20:45:30 +00006210In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006211(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00006212configuration for CS0# this is a mirror of the onboard Flash memory.
6213To be able to re-map memory U-Boot then jumps to its link address.
6214To be able to implement the initialization code in C, a (small!)
6215initial stack is set up in the internal Dual Ported RAM (in case CPUs
6216which provide such a feature like MPC8xx or MPC8260), or in a locked
6217part of the data cache. After that, U-Boot initializes the CPU core,
6218the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006219
wdenk2729af92004-05-03 20:45:30 +00006220Next, all (potentially) available memory banks are mapped using a
6221preliminary mapping. For example, we put them on 512 MB boundaries
6222(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6223on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6224programmed for SDRAM access. Using the temporary configuration, a
6225simple memory test is run that determines the size of the SDRAM
6226banks.
wdenkc6097192002-11-03 00:24:07 +00006227
wdenk2729af92004-05-03 20:45:30 +00006228When there is more than one SDRAM bank, and the banks are of
6229different size, the largest is mapped first. For equal size, the first
6230bank (CS2#) is mapped first. The first mapping is always for address
62310x00000000, with any additional banks following immediately to create
6232contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006233
wdenk2729af92004-05-03 20:45:30 +00006234Then, the monitor installs itself at the upper end of the SDRAM area
6235and allocates memory for use by malloc() and for the global Board
6236Info data; also, the exception vector code is copied to the low RAM
6237pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk2729af92004-05-03 20:45:30 +00006239Only after this relocation will you have a "normal" C environment;
6240until that you are restricted in several ways, mostly because you are
6241running from ROM, and because the code will have to be relocated to a
6242new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006243
6244
wdenk2729af92004-05-03 20:45:30 +00006245U-Boot Porting Guide:
6246----------------------
wdenkc6097192002-11-03 00:24:07 +00006247
wdenk2729af92004-05-03 20:45:30 +00006248[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6249list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006250
6251
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006252int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006253{
6254 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006255
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006256 signal(SIGALRM, no_more_time);
6257 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006258
wdenk2729af92004-05-03 20:45:30 +00006259 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006260 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006261 return 0;
6262 }
6263
wdenk2729af92004-05-03 20:45:30 +00006264 Download latest U-Boot source;
6265
Wolfgang Denk06682362008-12-30 22:56:11 +01006266 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006267
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006268 if (clueless)
6269 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk2729af92004-05-03 20:45:30 +00006271 while (learning) {
6272 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006273 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6274 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006275 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006276 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006277 }
wdenkc6097192002-11-03 00:24:07 +00006278
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006279 if (available_money > toLocalCurrency ($2500))
6280 Buy a BDI3000;
6281 else
wdenk2729af92004-05-03 20:45:30 +00006282 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006283
6284 if (a similar board exists) { /* hopefully... */
6285 cp -a board/<similar> board/<myboard>
6286 cp include/configs/<similar>.h include/configs/<myboard>.h
6287 } else {
6288 Create your own board support subdirectory;
6289 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006290 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006291 Edit new board/<myboard> files
6292 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006293
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006294 while (!accepted) {
6295 while (!running) {
6296 do {
6297 Add / modify source code;
6298 } until (compiles);
6299 Debug;
6300 if (clueless)
6301 email("Hi, I am having problems...");
6302 }
6303 Send patch file to the U-Boot email list;
6304 if (reasonable critiques)
6305 Incorporate improvements from email list code review;
6306 else
6307 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006308 }
wdenkc6097192002-11-03 00:24:07 +00006309
wdenk2729af92004-05-03 20:45:30 +00006310 return 0;
6311}
6312
6313void no_more_time (int sig)
6314{
6315 hire_a_guru();
6316}
wdenkc6097192002-11-03 00:24:07 +00006317
6318
wdenk2729af92004-05-03 20:45:30 +00006319Coding Standards:
6320-----------------
wdenkc6097192002-11-03 00:24:07 +00006321
wdenk2729af92004-05-03 20:45:30 +00006322All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006323coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006324"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006325
Detlev Zundel2c051652006-09-01 15:39:02 +02006326Source files originating from a different project (for example the
6327MTD subsystem) are generally exempt from these guidelines and are not
6328reformated to ease subsequent migration to newer versions of those
6329sources.
6330
6331Please note that U-Boot is implemented in C (and to some small parts in
6332Assembler); no C++ is used, so please do not use C++ style comments (//)
6333in your code.
wdenk2729af92004-05-03 20:45:30 +00006334
6335Please also stick to the following formatting rules:
6336- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006337- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006338- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006339- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006340- do not add trailing empty lines to source files
6341
6342Submissions which do not conform to the standards may be returned
6343with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006344
6345
wdenk2729af92004-05-03 20:45:30 +00006346Submitting Patches:
6347-------------------
wdenkc6097192002-11-03 00:24:07 +00006348
wdenk2729af92004-05-03 20:45:30 +00006349Since the number of patches for U-Boot is growing, we need to
6350establish some rules. Submissions which do not conform to these rules
6351may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006352
Magnus Lilja0d28f342008-08-06 19:32:33 +02006353Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006354
Wolfgang Denk06682362008-12-30 22:56:11 +01006355Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6356see http://lists.denx.de/mailman/listinfo/u-boot
6357
wdenk2729af92004-05-03 20:45:30 +00006358When you send a patch, please include the following information with
6359it:
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk2729af92004-05-03 20:45:30 +00006361* For bug fixes: a description of the bug and how your patch fixes
6362 this bug. Please try to include a way of demonstrating that the
6363 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006364
wdenk2729af92004-05-03 20:45:30 +00006365* For new features: a description of the feature and your
6366 implementation.
wdenkc6097192002-11-03 00:24:07 +00006367
wdenk2729af92004-05-03 20:45:30 +00006368* A CHANGELOG entry as plaintext (separate from the patch)
6369
6370* For major contributions, your entry to the CREDITS file
6371
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006372* When you add support for a new board, don't forget to add a
6373 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006374
6375* If your patch adds new configuration options, don't forget to
6376 document these in the README file.
6377
Wolfgang Denk218ca722008-03-26 10:40:12 +01006378* The patch itself. If you are using git (which is *strongly*
6379 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006380 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006381 the U-Boot mailing list, you will avoid most of the common problems
6382 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006383
Wolfgang Denk218ca722008-03-26 10:40:12 +01006384 If you cannot use git, use "diff -purN OLD NEW". If your version of
6385 diff does not support these options, then get the latest version of
6386 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006387
Wolfgang Denk218ca722008-03-26 10:40:12 +01006388 The current directory when running this command shall be the parent
6389 directory of the U-Boot source tree (i. e. please make sure that
6390 your patch includes sufficient directory information for the
6391 affected files).
6392
6393 We prefer patches as plain text. MIME attachments are discouraged,
6394 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006395
6396* If one logical set of modifications affects or creates several
6397 files, all these changes shall be submitted in a SINGLE patch file.
6398
6399* Changesets that contain different, unrelated modifications shall be
6400 submitted as SEPARATE patches, one patch per changeset.
6401
6402
6403Notes:
6404
6405* Before sending the patch, run the MAKEALL script on your patched
6406 source tree and make sure that no errors or warnings are reported
6407 for any of the boards.
6408
6409* Keep your modifications to the necessary minimum: A patch
6410 containing several unrelated changes or arbitrary reformats will be
6411 returned with a request to re-formatting / split it.
6412
6413* If you modify existing code, make sure that your new code does not
6414 add to the memory footprint of the code ;-) Small is beautiful!
6415 When adding new features, these should compile conditionally only
6416 (using #ifdef), and the resulting code with the new feature
6417 disabled must not need more memory than the old code without your
6418 modification.
wdenk90dc6702005-05-03 14:12:25 +00006419
Wolfgang Denk06682362008-12-30 22:56:11 +01006420* Remember that there is a size limit of 100 kB per message on the
6421 u-boot mailing list. Bigger patches will be moderated. If they are
6422 reasonable and not too big, they will be acknowledged. But patches
6423 bigger than the size limit should be avoided.