blob: 4f0dbd4fca6ddc94aa26e874be54231089fc79a0 [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
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800154/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500155/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500156/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157/disk Code for disk drive partition handling
158/doc Documentation (don't expect too much)
159/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400160/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500161/examples Example code for standalone applications, etc.
162/fs Filesystem code (cramfs, ext2, jffs2, etc.)
163/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500164/lib Library routines generic to all architectures
165/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500166/net Networking code
167/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500168/scripts Various build scripts and Makefiles
169/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500170/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000171
wdenkc6097192002-11-03 00:24:07 +0000172Software Configuration:
173=======================
174
175Configuration is usually done using C preprocessor defines; the
176rationale behind that is to avoid dead code whenever possible.
177
178There are two classes of configuration variables:
179
180* Configuration _OPTIONS_:
181 These are selectable by the user and have names beginning with
182 "CONFIG_".
183
184* Configuration _SETTINGS_:
185 These depend on the hardware etc. and should not be meddled with if
186 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200187 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000188
Robert P. J. Day7207b362015-12-19 07:16:10 -0500189Previously, all configuration was done by hand, which involved creating
190symbolic links and editing configuration files manually. More recently,
191U-Boot has added the Kbuild infrastructure used by the Linux kernel,
192allowing you to use the "make menuconfig" command to configure your
193build.
wdenkc6097192002-11-03 00:24:07 +0000194
195
196Selection of Processor Architecture and Board Type:
197---------------------------------------------------
198
199For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200200configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000201
202Example: For a TQM823L module type:
203
204 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200205 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000206
Robert P. J. Day7207b362015-12-19 07:16:10 -0500207Note: If you're looking for the default configuration file for a board
208you're sure used to be there but is now missing, check the file
209doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000210
Simon Glass75b3c3a2014-03-22 17:12:59 -0600211Sandbox Environment:
212--------------------
213
214U-Boot can be built natively to run on a Linux host using the 'sandbox'
215board. This allows feature development which is not board- or architecture-
216specific to be undertaken on a native platform. The sandbox is also used to
217run some of U-Boot's tests.
218
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530219See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600220
221
Simon Glassdb910352015-03-03 08:03:00 -0700222Board Initialisation Flow:
223--------------------------
224
225This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500226SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700227
Robert P. J. Day7207b362015-12-19 07:16:10 -0500228Note: "SPL" stands for "Secondary Program Loader," which is explained in
229more detail later in this file.
230
231At present, SPL mostly uses a separate code path, but the function names
232and roles of each function are the same. Some boards or architectures
233may not conform to this. At least most ARM boards which use
234CONFIG_SPL_FRAMEWORK conform to this.
235
236Execution typically starts with an architecture-specific (and possibly
237CPU-specific) start.S file, such as:
238
239 - arch/arm/cpu/armv7/start.S
240 - arch/powerpc/cpu/mpc83xx/start.S
241 - arch/mips/cpu/start.S
242
243and so on. From there, three functions are called; the purpose and
244limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700245
246lowlevel_init():
247 - purpose: essential init to permit execution to reach board_init_f()
248 - no global_data or BSS
249 - there is no stack (ARMv7 may have one but it will soon be removed)
250 - must not set up SDRAM or use console
251 - must only do the bare minimum to allow execution to continue to
252 board_init_f()
253 - this is almost never needed
254 - return normally from this function
255
256board_init_f():
257 - purpose: set up the machine ready for running board_init_r():
258 i.e. SDRAM and serial UART
259 - global_data is available
260 - stack is in SRAM
261 - BSS is not available, so you cannot use global/static variables,
262 only stack variables and global_data
263
264 Non-SPL-specific notes:
265 - dram_init() is called to set up DRAM. If already done in SPL this
266 can do nothing
267
268 SPL-specific notes:
269 - you can override the entire board_init_f() function with your own
270 version as needed.
271 - preloader_console_init() can be called here in extremis
272 - should set up SDRAM, and anything needed to make the UART work
273 - these is no need to clear BSS, it will be done by crt0.S
274 - must return normally from this function (don't call board_init_r()
275 directly)
276
277Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278this point the stack and global_data are relocated to below
279CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280memory.
281
282board_init_r():
283 - purpose: main execution, common code
284 - global_data is available
285 - SDRAM is available
286 - BSS is available, all static/global variables can be used
287 - execution eventually continues to main_loop()
288
289 Non-SPL-specific notes:
290 - U-Boot is relocated to the top of memory and is now running from
291 there.
292
293 SPL-specific notes:
294 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295 CONFIG_SPL_STACK_R_ADDR points into SDRAM
296 - preloader_console_init() can be called here - typically this is
297 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298 spl_board_init() function containing this call
299 - loads U-Boot or (in falcon mode) Linux
300
301
302
wdenkc6097192002-11-03 00:24:07 +0000303Configuration Options:
304----------------------
305
306Configuration depends on the combination of board and CPU type; all
307such information is kept in a configuration file
308"include/configs/<board_name>.h".
309
310Example: For a TQM823L module, all configuration settings are in
311"include/configs/TQM823L.h".
312
313
wdenk7f6c2cb2002-11-10 22:06:23 +0000314Many of the options are named exactly as the corresponding Linux
315kernel configuration options. The intention is to make it easier to
316build a config tool - later.
317
318
wdenkc6097192002-11-03 00:24:07 +0000319The following options need to be configured:
320
Kim Phillips26281142007-08-10 13:28:25 -0500321- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000322
Kim Phillips26281142007-08-10 13:28:25 -0500323- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200324
325- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100326 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
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
Scott Wood33eee332012-08-14 10:14:53 +0000379 CONFIG_SYS_FSL_ERRATUM_A004510
380
381 Enables a workaround for erratum A004510. If set,
382 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
383 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
384
385 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
386 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
387
388 Defines one or two SoC revisions (low 8 bits of SVR)
389 for which the A004510 workaround should be applied.
390
391 The rest of SVR is either not relevant to the decision
392 of whether the erratum is present (e.g. p2040 versus
393 p2041) or is implied by the build target, which controls
394 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
395
396 See Freescale App Note 4493 for more information about
397 this erratum.
398
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530399 CONFIG_A003399_NOR_WORKAROUND
400 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800401 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530402
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530403 CONFIG_A008044_WORKAROUND
404 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800405 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530406
Scott Wood33eee332012-08-14 10:14:53 +0000407 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
408
409 This is the value to write into CCSR offset 0x18600
410 according to the A004510 workaround.
411
Priyanka Jain64501c62013-07-02 09:21:04 +0530412 CONFIG_SYS_FSL_DSP_DDR_ADDR
413 This value denotes start offset of DDR memory which is
414 connected exclusively to the DSP cores.
415
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530416 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
417 This value denotes start offset of M2 memory
418 which is directly connected to the DSP core.
419
Priyanka Jain64501c62013-07-02 09:21:04 +0530420 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
421 This value denotes start offset of M3 memory which is directly
422 connected to the DSP core.
423
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530424 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
425 This value denotes start offset of DSP CCSR space.
426
Priyanka Jainb1359912013-12-17 14:25:52 +0530427 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
428 Single Source Clock is clocking mode present in some of FSL SoC's.
429 In this mode, a single differential clock is used to supply
430 clocks to the sysclock, ddrclock and usbclock.
431
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530432 CONFIG_SYS_CPC_REINIT_F
433 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800434 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530435
Tang Yuantianaade2002014-04-17 15:33:46 +0800436 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800437 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800438 supported, core will start to execute uboot when wakes up.
439
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000440- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700441 CONFIG_SYS_GENERIC_GLOBAL_DATA
442 Defines global data is initialized in generic board board_init_f().
443 If this macro is defined, global data is created and cleared in
444 generic board board_init_f(). Without this macro, architecture/board
445 should initialize global data before calling board_init_f().
446
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000447 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
448
449 Defines the endianess of the CPU. Implementation of those
450 values is arch specific.
451
York Sun5614e712013-09-30 09:22:09 -0700452 CONFIG_SYS_FSL_DDR
453 Freescale DDR driver in use. This type of DDR controller is
454 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
455 SoCs.
456
457 CONFIG_SYS_FSL_DDR_ADDR
458 Freescale DDR memory-mapped register base.
459
460 CONFIG_SYS_FSL_DDR_EMU
461 Specify emulator support for DDR. Some DDR features such as
462 deskew training are not available.
463
464 CONFIG_SYS_FSL_DDRC_GEN1
465 Freescale DDR1 controller.
466
467 CONFIG_SYS_FSL_DDRC_GEN2
468 Freescale DDR2 controller.
469
470 CONFIG_SYS_FSL_DDRC_GEN3
471 Freescale DDR3 controller.
472
York Sun34e026f2014-03-27 17:54:47 -0700473 CONFIG_SYS_FSL_DDRC_GEN4
474 Freescale DDR4 controller.
475
York Sun9ac4ffb2013-09-30 14:20:51 -0700476 CONFIG_SYS_FSL_DDRC_ARM_GEN3
477 Freescale DDR3 controller for ARM-based SoCs.
478
York Sun5614e712013-09-30 09:22:09 -0700479 CONFIG_SYS_FSL_DDR1
480 Board config to use DDR1. It can be enabled for SoCs with
481 Freescale DDR1 or DDR2 controllers, depending on the board
482 implemetation.
483
484 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400485 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700486 Freescale DDR2 or DDR3 controllers, depending on the board
487 implementation.
488
489 CONFIG_SYS_FSL_DDR3
490 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700491 Freescale DDR3 or DDR3L controllers.
492
493 CONFIG_SYS_FSL_DDR3L
494 Board config to use DDR3L. It can be enabled for SoCs with
495 DDR3L controllers.
496
497 CONFIG_SYS_FSL_DDR4
498 Board config to use DDR4. It can be enabled for SoCs with
499 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700500
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530501 CONFIG_SYS_FSL_IFC_BE
502 Defines the IFC controller register space as Big Endian
503
504 CONFIG_SYS_FSL_IFC_LE
505 Defines the IFC controller register space as Little Endian
506
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530507 CONFIG_SYS_FSL_IFC_CLK_DIV
508 Defines divider of platform clock(clock input to IFC controller).
509
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530510 CONFIG_SYS_FSL_LBC_CLK_DIV
511 Defines divider of platform clock(clock input to eLBC controller).
512
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530513 CONFIG_SYS_FSL_PBL_PBI
514 It enables addition of RCW (Power on reset configuration) in built image.
515 Please refer doc/README.pblimage for more details
516
517 CONFIG_SYS_FSL_PBL_RCW
518 It adds PBI(pre-boot instructions) commands in u-boot build image.
519 PBI commands can be used to configure SoC before it starts the execution.
520 Please refer doc/README.pblimage for more details
521
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530522 CONFIG_SPL_FSL_PBL
523 It adds a target to create boot binary having SPL binary in PBI format
524 concatenated with u-boot binary.
525
York Sun4e5b1bd2014-02-10 13:59:42 -0800526 CONFIG_SYS_FSL_DDR_BE
527 Defines the DDR controller register space as Big Endian
528
529 CONFIG_SYS_FSL_DDR_LE
530 Defines the DDR controller register space as Little Endian
531
York Sun6b9e3092014-02-10 13:59:43 -0800532 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
533 Physical address from the view of DDR controllers. It is the
534 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
535 it could be different for ARM SoCs.
536
York Sun6b1e1252014-02-10 13:59:44 -0800537 CONFIG_SYS_FSL_DDR_INTLV_256B
538 DDR controller interleaving on 256-byte. This is a special
539 interleaving mode, handled by Dickens for Freescale layerscape
540 SoCs with ARM core.
541
York Sun1d71efb2014-08-01 15:51:00 -0700542 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
543 Number of controllers used as main memory.
544
545 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
546 Number of controllers used for other than main memory.
547
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530548 CONFIG_SYS_FSL_HAS_DP_DDR
549 Defines the SoC has DP-DDR used for DPAA.
550
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530551 CONFIG_SYS_FSL_SEC_BE
552 Defines the SEC controller register space as Big Endian
553
554 CONFIG_SYS_FSL_SEC_LE
555 Defines the SEC controller register space as Little Endian
556
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200557- MIPS CPU options:
558 CONFIG_SYS_INIT_SP_OFFSET
559
560 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
561 pointer. This is needed for the temporary stack before
562 relocation.
563
564 CONFIG_SYS_MIPS_CACHE_MODE
565
566 Cache operation mode for the MIPS CPU.
567 See also arch/mips/include/asm/mipsregs.h.
568 Possible values are:
569 CONF_CM_CACHABLE_NO_WA
570 CONF_CM_CACHABLE_WA
571 CONF_CM_UNCACHED
572 CONF_CM_CACHABLE_NONCOHERENT
573 CONF_CM_CACHABLE_CE
574 CONF_CM_CACHABLE_COW
575 CONF_CM_CACHABLE_CUW
576 CONF_CM_CACHABLE_ACCELERATED
577
578 CONFIG_SYS_XWAY_EBU_BOOTCFG
579
580 Special option for Lantiq XWAY SoCs for booting from NOR flash.
581 See also arch/mips/cpu/mips32/start.S.
582
583 CONFIG_XWAY_SWAP_BYTES
584
585 Enable compilation of tools/xway-swap-bytes needed for Lantiq
586 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
587 be swapped if a flash programmer is used.
588
Christian Rieschb67d8812012-02-02 00:44:39 +0000589- ARM options:
590 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
591
592 Select high exception vectors of the ARM core, e.g., do not
593 clear the V bit of the c1 register of CP15.
594
Aneesh V5356f542012-03-08 07:20:19 +0000595 CONFIG_SYS_THUMB_BUILD
596
597 Use this flag to build U-Boot using the Thumb instruction
598 set for ARM architectures. Thumb instruction set provides
599 better code density. For ARM architectures that support
600 Thumb2 this flag will result in Thumb2 code generated by
601 GCC.
602
Stephen Warrenc5d47522013-03-04 13:29:40 +0000603 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000604 CONFIG_ARM_ERRATA_742230
605 CONFIG_ARM_ERRATA_743622
606 CONFIG_ARM_ERRATA_751472
Nitin Gargb7588e32014-04-02 08:55:02 -0500607 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100608 CONFIG_ARM_ERRATA_773022
609 CONFIG_ARM_ERRATA_774769
610 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-02-26 12:28:27 +0000611
612 If set, the workarounds for these ARM errata are applied early
613 during U-Boot startup. Note that these options force the
614 workarounds to be applied; no CPU-type/version detection
615 exists, unlike the similar options in the Linux kernel. Do not
616 set these options unless they apply!
617
York Sun207774b2015-03-20 19:28:08 -0700618 COUNTER_FREQUENCY
619 Generic timer clock source frequency.
620
621 COUNTER_FREQUENCY_REAL
622 Generic timer clock source frequency if the real clock is
623 different from COUNTER_FREQUENCY, and can only be determined
624 at run time.
625
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500626 NOTE: The following can be machine specific errata. These
627 do have ability to provide rudimentary version and machine
628 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500629 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500630 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500631 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500632 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500633 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500634
Stephen Warren73c38932015-01-19 16:25:52 -0700635- Tegra SoC options:
636 CONFIG_TEGRA_SUPPORT_NON_SECURE
637
638 Support executing U-Boot in non-secure (NS) mode. Certain
639 impossible actions will be skipped if the CPU is in NS mode,
640 such as ARM architectural timer initialization.
641
wdenk5da627a2003-10-09 20:09:04 +0000642- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000643 CONFIG_CLOCKS_IN_MHZ
644
645 U-Boot stores all clock information in Hz
646 internally. For binary compatibility with older Linux
647 kernels (which expect the clocks passed in the
648 bd_info data to be in MHz) the environment variable
649 "clocks_in_mhz" can be defined so that U-Boot
650 converts clock data to MHZ before passing it to the
651 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000652 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100653 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000654 default environment.
655
wdenk5da627a2003-10-09 20:09:04 +0000656 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
657
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800658 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000659 expect it to be in bytes, others in MB.
660 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
661
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400662 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200663
664 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400665 passed using flattened device trees (based on open firmware
666 concepts).
667
668 CONFIG_OF_LIBFDT
669 * New libfdt-based support
670 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500671 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400672
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200673 OF_CPU - The proper name of the cpus node (only required for
674 MPC512X and MPC5xxx based boards).
675 OF_SOC - The proper name of the soc node (only required for
676 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200677 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600678 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200679
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200680 boards with QUICC Engines require OF_QE to set UCC MAC
681 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500682
Kumar Gala4e253132006-01-11 13:54:17 -0600683 CONFIG_OF_BOARD_SETUP
684
685 Board code has addition modification that it wants to make
686 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000687
Simon Glassc654b512014-10-23 18:58:54 -0600688 CONFIG_OF_SYSTEM_SETUP
689
690 Other code has addition modification that it wants to make
691 to the flat device tree before handing it off to the kernel.
692 This causes ft_system_setup() to be called before booting
693 the kernel.
694
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200695 CONFIG_OF_IDE_FIXUP
696
697 U-Boot can detect if an IDE device is present or not.
698 If not, and this new config option is activated, U-Boot
699 removes the ATA node from the DTS before booting Linux,
700 so the Linux IDE driver does not probe the device and
701 crash. This is needed for buggy hardware (uc101) where
702 no pull down resistor is connected to the signal IDE5V_DD7.
703
Igor Grinberg7eb29392011-07-14 05:45:07 +0000704 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
705
706 This setting is mandatory for all boards that have only one
707 machine type and must be used to specify the machine type
708 number as it appears in the ARM machine registry
709 (see http://www.arm.linux.org.uk/developer/machines/).
710 Only boards that have multiple machine types supported
711 in a single configuration file and the machine type is
712 runtime discoverable, do not have to use this setting.
713
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100714- vxWorks boot parameters:
715
716 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700717 environments variables: bootdev, bootfile, ipaddr, netmask,
718 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100719 It loads the vxWorks image pointed bootfile.
720
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100721 Note: If a "bootargs" environment is defined, it will overwride
722 the defaults discussed just above.
723
Aneesh V2c451f72011-06-16 23:30:47 +0000724- Cache Configuration:
725 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
726 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
727 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
728
Aneesh V93bc2192011-06-16 23:30:51 +0000729- Cache Configuration for ARM:
730 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
731 controller
732 CONFIG_SYS_PL310_BASE - Physical base address of PL310
733 controller register space
734
wdenk6705d812004-08-02 23:22:59 +0000735- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200736 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000737
738 Define this if you want support for Amba PrimeCell PL010 UARTs.
739
Andreas Engel48d01922008-09-08 14:30:53 +0200740 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000741
742 Define this if you want support for Amba PrimeCell PL011 UARTs.
743
744 CONFIG_PL011_CLOCK
745
746 If you have Amba PrimeCell PL011 UARTs, set this variable to
747 the clock speed of the UARTs.
748
749 CONFIG_PL01x_PORTS
750
751 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
752 define this to a list of base addresses for each (supported)
753 port. See e.g. include/configs/versatile.h
754
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400755 CONFIG_SERIAL_HW_FLOW_CONTROL
756
757 Define this variable to enable hw flow control in serial driver.
758 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000759
wdenkc6097192002-11-03 00:24:07 +0000760- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000761 Depending on board, define exactly one serial port
762 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
763 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
764 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000765
766 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
767 port routines must be defined elsewhere
768 (i.e. serial_init(), serial_getc(), ...)
769
wdenkc6097192002-11-03 00:24:07 +0000770- Console Baudrate:
771 CONFIG_BAUDRATE - in bps
772 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200773 CONFIG_SYS_BAUDRATE_TABLE, see below.
774 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000775
Heiko Schocherc92fac92009-01-30 12:55:38 +0100776- Console Rx buffer length
777 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
778 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100779 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100780 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
781 must be defined, to setup the maximum idle timeout for
782 the SMC.
783
wdenkc6097192002-11-03 00:24:07 +0000784- Autoboot Command:
785 CONFIG_BOOTCOMMAND
786 Only needed when CONFIG_BOOTDELAY is enabled;
787 define a command string that is automatically executed
788 when no character is read on the console interface
789 within "Boot Delay" after reset.
790
791 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000792 This can be used to pass arguments to the bootm
793 command. The value of CONFIG_BOOTARGS goes into the
794 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000795
796 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000797 The value of these goes into the environment as
798 "ramboot" and "nfsboot" respectively, and can be used
799 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200800 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000801
Heiko Schochereda0ba32013-11-04 14:04:59 +0100802- Bootcount:
803 CONFIG_BOOTCOUNT_LIMIT
804 Implements a mechanism for detecting a repeating reboot
805 cycle, see:
806 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
807
808 CONFIG_BOOTCOUNT_ENV
809 If no softreset save registers are found on the hardware
810 "bootcount" is stored in the environment. To prevent a
811 saveenv on all reboots, the environment variable
812 "upgrade_available" is used. If "upgrade_available" is
813 0, "bootcount" is always 0, if "upgrade_available" is
814 1 "bootcount" is incremented in the environment.
815 So the Userspace Applikation must set the "upgrade_available"
816 and "bootcount" variable to 0, if a boot was successfully.
817
wdenkc6097192002-11-03 00:24:07 +0000818- Pre-Boot Commands:
819 CONFIG_PREBOOT
820
821 When this option is #defined, the existence of the
822 environment variable "preboot" will be checked
823 immediately before starting the CONFIG_BOOTDELAY
824 countdown and/or running the auto-boot command resp.
825 entering interactive mode.
826
827 This feature is especially useful when "preboot" is
828 automatically generated or modified. For an example
829 see the LWMON board specific code: here "preboot" is
830 modified when the user holds down a certain
831 combination of keys on the (special) keyboard when
832 booting the systems
833
834- Serial Download Echo Mode:
835 CONFIG_LOADS_ECHO
836 If defined to 1, all characters received during a
837 serial download (using the "loads" command) are
838 echoed back. This might be needed by some terminal
839 emulations (like "cu"), but may as well just take
840 time on others. This setting #define's the initial
841 value of the "loads_echo" environment variable.
842
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500843- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_KGDB_BAUDRATE
845 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200846 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000847
848- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500849 Monitor commands can be included or excluded
850 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000851 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500852 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000853
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500854 The default command configuration includes all commands
855 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000856
Marek Vasutb401b732014-03-05 19:58:39 +0100857 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500858 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500859 CONFIG_CMD_BDI bdinfo
860 CONFIG_CMD_BEDBUG * Include BedBug Debugger
861 CONFIG_CMD_BMP * BMP support
862 CONFIG_CMD_BSP * Board specific commands
863 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400864 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500865 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800866 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500868 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500869 CONFIG_CMD_DATE * support for RTC, date/time...
870 CONFIG_CMD_DHCP * DHCP support
871 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600872 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
873 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
874 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
875 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500876 CONFIG_CMD_DTT * Digital Therm and Thermostat
877 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500878 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500879 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanovaa9e6042016-04-16 17:55:03 +0300880 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600882 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600883 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500884 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500885 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000886 CONFIG_CMD_EXT2 * ext2 command support
887 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700888 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
889 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100890 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500891 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000893 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500894 CONFIG_CMD_FLASH flinfo, erase, protect
895 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200896 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000897 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500898 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000899 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000900 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500901 CONFIG_CMD_I2C * I2C serial bus support
902 CONFIG_CMD_IDE * IDE harddisk support
903 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000904 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200905 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500906 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -0600907 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500908 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000909 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500910 CONFIG_CMD_IRQ * irqinfo
911 CONFIG_CMD_ITEST Integer/string test of 2 values
912 CONFIG_CMD_JFFS2 * JFFS2 Support
913 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200914 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000915 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
916 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500917 CONFIG_CMD_LOADB loadb
918 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200919 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400920 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000921 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500922 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000923 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200924 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500925 CONFIG_CMD_MISC Misc functions like sleep etc
926 CONFIG_CMD_MMC * MMC memory mapped support
927 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100928 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500929 CONFIG_CMD_NAND * NAND support
930 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200931 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600932 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000933 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500934 CONFIG_CMD_PCI * pciinfo
935 CONFIG_CMD_PCMCIA * PCMCIA support
936 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
937 host
938 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000939 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500940 CONFIG_CMD_REGINFO * Register dump
941 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000942 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500943 CONFIG_CMD_SAVES * save S record dump
Simon Glassc649e3c2016-05-01 11:36:02 -0600944 CONFIG_SCSI * SCSI Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 CONFIG_CMD_SDRAM * print SDRAM configuration information
946 (requires CONFIG_CMD_I2C)
947 CONFIG_CMD_SETGETDCR Support for DCR Register access
948 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700949 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200950 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400951 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800952 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200953 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500954 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000955 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000956 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000957 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
958 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500959 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500960 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000961 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200962 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +0200963 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000964
965 EXAMPLE: If you want all functions except of network
966 support you can write:
967
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500968 #include "config_cmd_all.h"
969 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000970
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400971 Other Commands:
972 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000973
974 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500975 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000976 what you (and your U-Boot users) are doing. Data
977 cache cannot be enabled on systems like the 8xx or
978 8260 (where accesses to the IMMR region must be
979 uncached), and it cannot be disabled on all other
980 systems where we (mis-) use the data cache to hold an
981 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000982
983
984 XXX - this list needs to get updated!
985
Simon Glass302a6482016-03-13 19:07:28 -0600986- Removal of commands
987 If no commands are needed to boot, you can disable
988 CONFIG_CMDLINE to remove them. In this case, the command line
989 will not be available, and when U-Boot wants to execute the
990 boot command (on start-up) it will call board_run_command()
991 instead. This can reduce image size significantly for very
992 simple boot procedures.
993
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000994- Regular expression support:
995 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200996 If this variable is defined, U-Boot is linked against
997 the SLRE (Super Light Regular Expression) library,
998 which adds regex support to some commands, as for
999 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001000
Simon Glass45ba8072011-10-15 05:48:20 +00001001- Device tree:
1002 CONFIG_OF_CONTROL
1003 If this variable is defined, U-Boot will use a device tree
1004 to configure its devices, instead of relying on statically
1005 compiled #defines in the board file. This option is
1006 experimental and only available on a few boards. The device
1007 tree is available in the global data as gd->fdt_blob.
1008
Simon Glass2c0f79e2011-10-24 19:15:31 +00001009 U-Boot needs to get its device tree from somewhere. This can
1010 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001011
1012 CONFIG_OF_EMBED
1013 If this variable is defined, U-Boot will embed a device tree
1014 binary in its image. This device tree file should be in the
1015 board directory and called <soc>-<board>.dts. The binary file
1016 is then picked up in board_init_f() and made available through
1017 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001018
Simon Glass2c0f79e2011-10-24 19:15:31 +00001019 CONFIG_OF_SEPARATE
1020 If this variable is defined, U-Boot will build a device tree
1021 binary. It will be called u-boot.dtb. Architecture-specific
1022 code will locate it at run-time. Generally this works by:
1023
1024 cat u-boot.bin u-boot.dtb >image.bin
1025
1026 and in fact, U-Boot does this for you, creating a file called
1027 u-boot-dtb.bin which is useful in the common case. You can
1028 still use the individual files if you need something more
1029 exotic.
1030
wdenkc6097192002-11-03 00:24:07 +00001031- Watchdog:
1032 CONFIG_WATCHDOG
1033 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001034 support for the SoC. There must be support in the SoC
1035 specific code for a watchdog. For the 8xx and 8260
1036 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1037 register. When supported for a specific SoC is
1038 available, then no further board specific code should
1039 be needed to use it.
1040
1041 CONFIG_HW_WATCHDOG
1042 When using a watchdog circuitry external to the used
1043 SoC, then define this variable and provide board
1044 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001045
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001046 CONFIG_AT91_HW_WDT_TIMEOUT
1047 specify the timeout in seconds. default 2 seconds.
1048
stroesec1551ea2003-04-04 15:53:41 +00001049- U-Boot Version:
1050 CONFIG_VERSION_VARIABLE
1051 If this variable is defined, an environment variable
1052 named "ver" is created by U-Boot showing the U-Boot
1053 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001054 Any change to this variable will be reverted at the
1055 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001056
wdenkc6097192002-11-03 00:24:07 +00001057- Real-Time Clock:
1058
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001059 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001060 has to be selected, too. Define exactly one of the
1061 following options:
1062
1063 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1064 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001065 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001066 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001067 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001068 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001069 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001070 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001071 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001072 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001073 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001074 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001075 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1076 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001077
wdenkb37c7e52003-06-30 16:24:52 +00001078 Note that if the RTC uses I2C, then the I2C interface
1079 must also be configured. See I2C Support, below.
1080
Peter Tysere92739d2008-12-17 16:36:21 -06001081- GPIO Support:
1082 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001083
Chris Packham5dec49c2010-12-19 10:12:13 +00001084 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1085 chip-ngpio pairs that tell the PCA953X driver the number of
1086 pins supported by a particular chip.
1087
Peter Tysere92739d2008-12-17 16:36:21 -06001088 Note that if the GPIO device uses I2C, then the I2C interface
1089 must also be configured. See I2C Support, below.
1090
Simon Glassaa532332014-06-11 23:29:41 -06001091- I/O tracing:
1092 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1093 accesses and can checksum them or write a list of them out
1094 to memory. See the 'iotrace' command for details. This is
1095 useful for testing device drivers since it can confirm that
1096 the driver behaves the same way before and after a code
1097 change. Currently this is supported on sandbox and arm. To
1098 add support for your architecture, add '#include <iotrace.h>'
1099 to the bottom of arch/<arch>/include/asm/io.h and test.
1100
1101 Example output from the 'iotrace stats' command is below.
1102 Note that if the trace buffer is exhausted, the checksum will
1103 still continue to operate.
1104
1105 iotrace is enabled
1106 Start: 10000000 (buffer start address)
1107 Size: 00010000 (buffer size)
1108 Offset: 00000120 (current buffer offset)
1109 Output: 10000120 (start + offset)
1110 Count: 00000018 (number of trace records)
1111 CRC32: 9526fb66 (CRC32 of all trace records)
1112
wdenkc6097192002-11-03 00:24:07 +00001113- Timestamp Support:
1114
wdenk43d96162003-03-06 00:02:04 +00001115 When CONFIG_TIMESTAMP is selected, the timestamp
1116 (date and time) of an image is printed by image
1117 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001118 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001119
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001120- Partition Labels (disklabels) Supported:
1121 Zero or more of the following:
1122 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1123 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1124 Intel architecture, USB sticks, etc.
1125 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1126 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1127 bootloader. Note 2TB partition limit; see
1128 disk/part_efi.c
1129 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001130
Wolfgang Denk218ca722008-03-26 10:40:12 +01001131 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001132 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001133 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001134
1135- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001136 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1137 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001138
wdenk4d13cba2004-03-14 14:09:05 +00001139 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1140 be performed by calling the function
1141 ide_set_reset(int reset)
1142 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001143
1144- ATAPI Support:
1145 CONFIG_ATAPI
1146
1147 Set this to enable ATAPI support.
1148
wdenkc40b2952004-03-13 23:29:43 +00001149- LBA48 Support
1150 CONFIG_LBA48
1151
1152 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001153 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001154 Whithout these , LBA48 support uses 32bit variables and will 'only'
1155 support disks up to 2.1TB.
1156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001157 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001158 When enabled, makes the IDE subsystem use 64bit sector addresses.
1159 Default is 32bit.
1160
wdenkc6097192002-11-03 00:24:07 +00001161- SCSI Support:
1162 At the moment only there is only support for the
1163 SYM53C8XX SCSI controller; define
1164 CONFIG_SCSI_SYM53C8XX to enable it.
1165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001166 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1167 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1168 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001169 maximum numbers of LUNs, SCSI ID's and target
1170 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001171 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001172
Wolfgang Denk93e14592013-10-04 17:43:24 +02001173 The environment variable 'scsidevs' is set to the number of
1174 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001175
wdenkc6097192002-11-03 00:24:07 +00001176- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001177 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001178 Support for Intel 8254x/8257x gigabit chips.
1179
1180 CONFIG_E1000_SPI
1181 Utility code for direct access to the SPI bus on Intel 8257x.
1182 This does not do anything useful unless you set at least one
1183 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1184
1185 CONFIG_E1000_SPI_GENERIC
1186 Allow generic access to the SPI bus on the Intel 8257x, for
1187 example with the "sspi" command.
1188
1189 CONFIG_CMD_E1000
1190 Management command for E1000 devices. When used on devices
1191 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001192
wdenkc6097192002-11-03 00:24:07 +00001193 CONFIG_EEPRO100
1194 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001195 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001196 write routine for first time initialisation.
1197
1198 CONFIG_TULIP
1199 Support for Digital 2114x chips.
1200 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1201 modem chip initialisation (KS8761/QS6611).
1202
1203 CONFIG_NATSEMI
1204 Support for National dp83815 chips.
1205
1206 CONFIG_NS8382X
1207 Support for National dp8382[01] gigabit chips.
1208
wdenk45219c42003-05-12 21:50:16 +00001209- NETWORK Support (other):
1210
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001211 CONFIG_DRIVER_AT91EMAC
1212 Support for AT91RM9200 EMAC.
1213
1214 CONFIG_RMII
1215 Define this to use reduced MII inteface
1216
1217 CONFIG_DRIVER_AT91EMAC_QUIET
1218 If this defined, the driver is quiet.
1219 The driver doen't show link status messages.
1220
Rob Herringefdd7312011-12-15 11:15:49 +00001221 CONFIG_CALXEDA_XGMAC
1222 Support for the Calxeda XGMAC device
1223
Ashok3bb46d22012-10-15 06:20:47 +00001224 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001225 Support for SMSC's LAN91C96 chips.
1226
wdenk45219c42003-05-12 21:50:16 +00001227 CONFIG_LAN91C96_USE_32_BIT
1228 Define this to enable 32 bit addressing
1229
Ashok3bb46d22012-10-15 06:20:47 +00001230 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001231 Support for SMSC's LAN91C111 chip
1232
1233 CONFIG_SMC91111_BASE
1234 Define this to hold the physical address
1235 of the device (I/O space)
1236
1237 CONFIG_SMC_USE_32_BIT
1238 Define this if data bus is 32 bits
1239
1240 CONFIG_SMC_USE_IOFUNCS
1241 Define this to use i/o functions instead of macros
1242 (some hardware wont work with macros)
1243
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001244 CONFIG_DRIVER_TI_EMAC
1245 Support for davinci emac
1246
1247 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1248 Define this if you have more then 3 PHYs.
1249
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001250 CONFIG_FTGMAC100
1251 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1252
1253 CONFIG_FTGMAC100_EGIGA
1254 Define this to use GE link update with gigabit PHY.
1255 Define this if FTGMAC100 is connected to gigabit PHY.
1256 If your system has 10/100 PHY only, it might not occur
1257 wrong behavior. Because PHY usually return timeout or
1258 useless data when polling gigabit status and gigabit
1259 control registers. This behavior won't affect the
1260 correctnessof 10/100 link speed update.
1261
Mike Rapoportc2fff332009-11-11 10:03:03 +02001262 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001263 Support for SMSC's LAN911x and LAN921x chips
1264
Mike Rapoportc2fff332009-11-11 10:03:03 +02001265 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001266 Define this to hold the physical address
1267 of the device (I/O space)
1268
Mike Rapoportc2fff332009-11-11 10:03:03 +02001269 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001270 Define this if data bus is 32 bits
1271
Mike Rapoportc2fff332009-11-11 10:03:03 +02001272 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001273 Define this if data bus is 16 bits. If your processor
1274 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001275 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001276
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001277 CONFIG_SH_ETHER
1278 Support for Renesas on-chip Ethernet controller
1279
1280 CONFIG_SH_ETHER_USE_PORT
1281 Define the number of ports to be used
1282
1283 CONFIG_SH_ETHER_PHY_ADDR
1284 Define the ETH PHY's address
1285
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001286 CONFIG_SH_ETHER_CACHE_WRITEBACK
1287 If this option is set, the driver enables cache flush.
1288
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001289- PWM Support:
1290 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001291 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001292
Vadim Bendebury5e124722011-10-17 08:36:14 +00001293- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001294 CONFIG_TPM
1295 Support TPM devices.
1296
Christophe Ricard0766ad22015-10-06 22:54:41 +02001297 CONFIG_TPM_TIS_INFINEON
1298 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001299 per system is supported at this time.
1300
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001301 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1302 Define the burst count bytes upper limit
1303
Christophe Ricard3aa74082016-01-21 23:27:13 +01001304 CONFIG_TPM_ST33ZP24
1305 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1306
1307 CONFIG_TPM_ST33ZP24_I2C
1308 Support for STMicroelectronics ST33ZP24 I2C devices.
1309 Requires TPM_ST33ZP24 and I2C.
1310
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001311 CONFIG_TPM_ST33ZP24_SPI
1312 Support for STMicroelectronics ST33ZP24 SPI devices.
1313 Requires TPM_ST33ZP24 and SPI.
1314
Dirk Eibachc01939c2013-06-26 15:55:15 +02001315 CONFIG_TPM_ATMEL_TWI
1316 Support for Atmel TWI TPM device. Requires I2C support.
1317
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001318 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001319 Support for generic parallel port TPM devices. Only one device
1320 per system is supported at this time.
1321
1322 CONFIG_TPM_TIS_BASE_ADDRESS
1323 Base address where the generic TPM device is mapped
1324 to. Contemporary x86 systems usually map it at
1325 0xfed40000.
1326
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001327 CONFIG_CMD_TPM
1328 Add tpm monitor functions.
1329 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1330 provides monitor access to authorized functions.
1331
1332 CONFIG_TPM
1333 Define this to enable the TPM support library which provides
1334 functional interfaces to some TPM commands.
1335 Requires support for a TPM device.
1336
1337 CONFIG_TPM_AUTH_SESSIONS
1338 Define this to enable authorized functions in the TPM library.
1339 Requires CONFIG_TPM and CONFIG_SHA1.
1340
wdenkc6097192002-11-03 00:24:07 +00001341- USB Support:
1342 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001343 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001344 CONFIG_USB_UHCI to enable it.
1345 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001346 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001347 storage devices.
1348 Note:
1349 Supported are USB Keyboards and USB Floppy drives
1350 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001351 MPC5200 USB requires additional defines:
1352 CONFIG_USB_CLOCK
1353 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001354 CONFIG_PSC3_USB
1355 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001356 CONFIG_USB_CONFIG
1357 for differential drivers: 0x00001000
1358 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001359 for differential drivers on PSC3: 0x00000100
1360 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001361 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001362 May be defined to allow interrupt polling
1363 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001364
Simon Glass9ab4ce22012-02-27 10:52:47 +00001365 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1366 txfilltuning field in the EHCI controller on reset.
1367
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001368 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1369 HW module registers.
1370
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001371- USB Device:
1372 Define the below if you wish to use the USB console.
1373 Once firmware is rebuilt from a serial console issue the
1374 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001375 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001376 it has found a new device. The environment variable usbtty
1377 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001378 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001379 Common Device Class Abstract Control Model serial device.
1380 If you select usbtty = gserial you should be able to enumerate
1381 a Linux host by
1382 # modprobe usbserial vendor=0xVendorID product=0xProductID
1383 else if using cdc_acm, simply setting the environment
1384 variable usbtty to be cdc_acm should suffice. The following
1385 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001386
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001387 CONFIG_USB_DEVICE
1388 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001389
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001390 CONFIG_USB_TTY
1391 Define this to have a tty type of device available to
1392 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001393
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301394 CONFIG_USBD_HS
1395 Define this to enable the high speed support for usb
1396 device and usbtty. If this feature is enabled, a routine
1397 int is_usbd_high_speed(void)
1398 also needs to be defined by the driver to dynamically poll
1399 whether the enumeration has succeded at high speed or full
1400 speed.
1401
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001402 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001403 Define this if you want stdin, stdout &/or stderr to
1404 be set to usbtty.
1405
1406 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001407 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001408 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001409 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001410
Wolfgang Denk386eda02006-06-14 18:14:56 +02001411 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001412 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001413 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001414 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1415 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1416 should pretend to be a Linux device to it's target host.
1417
1418 CONFIG_USBD_MANUFACTURER
1419 Define this string as the name of your company for
1420 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001421
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001422 CONFIG_USBD_PRODUCT_NAME
1423 Define this string as the name of your product
1424 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1425
1426 CONFIG_USBD_VENDORID
1427 Define this as your assigned Vendor ID from the USB
1428 Implementors Forum. This *must* be a genuine Vendor ID
1429 to avoid polluting the USB namespace.
1430 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001431
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001432 CONFIG_USBD_PRODUCTID
1433 Define this as the unique Product ID
1434 for your device
1435 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001436
Igor Grinbergd70a5602011-12-12 12:08:35 +02001437- ULPI Layer Support:
1438 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1439 the generic ULPI layer. The generic layer accesses the ULPI PHY
1440 via the platform viewport, so you need both the genric layer and
1441 the viewport enabled. Currently only Chipidea/ARC based
1442 viewport is supported.
1443 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1444 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001445 If your ULPI phy needs a different reference clock than the
1446 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1447 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001448
1449- MMC Support:
1450 The MMC controller on the Intel PXA is supported. To
1451 enable this define CONFIG_MMC. The MMC can be
1452 accessed from the boot prompt by mapping the device
1453 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001454 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1455 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001456
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001457 CONFIG_SH_MMCIF
1458 Support for Renesas on-chip MMCIF controller
1459
1460 CONFIG_SH_MMCIF_ADDR
1461 Define the base address of MMCIF registers
1462
1463 CONFIG_SH_MMCIF_CLK
1464 Define the clock frequency for MMCIF
1465
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001466 CONFIG_SUPPORT_EMMC_BOOT
1467 Enable some additional features of the eMMC boot partitions.
1468
1469 CONFIG_SUPPORT_EMMC_RPMB
1470 Enable the commands for reading, writing and programming the
1471 key for the Replay Protection Memory Block partition in eMMC.
1472
Tom Rinib3ba6e92013-03-14 05:32:47 +00001473- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001474 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001475 This enables the USB portion of the DFU USB class
1476
1477 CONFIG_CMD_DFU
1478 This enables the command "dfu" which is used to have
1479 U-Boot create a DFU class device via USB. This command
1480 requires that the "dfu_alt_info" environment variable be
1481 set and define the alt settings to expose to the host.
1482
1483 CONFIG_DFU_MMC
1484 This enables support for exposing (e)MMC devices via DFU.
1485
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001486 CONFIG_DFU_NAND
1487 This enables support for exposing NAND devices via DFU.
1488
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301489 CONFIG_DFU_RAM
1490 This enables support for exposing RAM via DFU.
1491 Note: DFU spec refer to non-volatile memory usage, but
1492 allow usages beyond the scope of spec - here RAM usage,
1493 one that would help mostly the developer.
1494
Heiko Schochere7e75c72013-06-12 06:05:51 +02001495 CONFIG_SYS_DFU_DATA_BUF_SIZE
1496 Dfu transfer uses a buffer before writing data to the
1497 raw storage device. Make the size (in bytes) of this buffer
1498 configurable. The size of this buffer is also configurable
1499 through the "dfu_bufsiz" environment variable.
1500
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001501 CONFIG_SYS_DFU_MAX_FILE_SIZE
1502 When updating files rather than the raw storage device,
1503 we use a static buffer to copy the file into and then write
1504 the buffer once we've been given the whole file. Define
1505 this to the maximum filesize (in bytes) for the buffer.
1506 Default is 4 MiB if undefined.
1507
Heiko Schocher001a8312014-03-18 08:09:56 +01001508 DFU_DEFAULT_POLL_TIMEOUT
1509 Poll timeout [ms], is the timeout a device can send to the
1510 host. The host must wait for this timeout before sending
1511 a subsequent DFU_GET_STATUS request to the device.
1512
1513 DFU_MANIFEST_POLL_TIMEOUT
1514 Poll timeout [ms], which the device sends to the host when
1515 entering dfuMANIFEST state. Host waits this timeout, before
1516 sending again an USB request to the device.
1517
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001518- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001519 CONFIG_USB_FUNCTION_FASTBOOT
1520 This enables the USB part of the fastboot gadget
1521
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001522 CONFIG_CMD_FASTBOOT
1523 This enables the command "fastboot" which enables the Android
1524 fastboot mode for the platform's USB device. Fastboot is a USB
1525 protocol for downloading images, flashing and device control
1526 used on Android devices.
1527 See doc/README.android-fastboot for more information.
1528
1529 CONFIG_ANDROID_BOOT_IMAGE
1530 This enables support for booting images which use the Android
1531 image format header.
1532
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001533 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001534 The fastboot protocol requires a large memory buffer for
1535 downloads. Define this to the starting RAM address to use for
1536 downloaded images.
1537
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001538 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001539 The fastboot protocol requires a large memory buffer for
1540 downloads. This buffer should be as large as possible for a
1541 platform. Define this to the size available RAM for fastboot.
1542
Steve Raed1b5ed02014-08-26 11:47:28 -07001543 CONFIG_FASTBOOT_FLASH
1544 The fastboot protocol includes a "flash" command for writing
1545 the downloaded image to a non-volatile storage device. Define
1546 this to enable the "fastboot flash" command.
1547
1548 CONFIG_FASTBOOT_FLASH_MMC_DEV
1549 The fastboot "flash" command requires additional information
1550 regarding the non-volatile storage device. Define this to
1551 the eMMC device that fastboot should use to store the image.
1552
Steve Rae0ff7e582014-12-12 15:51:54 -08001553 CONFIG_FASTBOOT_GPT_NAME
1554 The fastboot "flash" command supports writing the downloaded
1555 image to the Protective MBR and the Primary GUID Partition
1556 Table. (Additionally, this downloaded image is post-processed
1557 to generate and write the Backup GUID Partition Table.)
1558 This occurs when the specified "partition name" on the
1559 "fastboot flash" command line matches this value.
Petr Kulhavy6f6c8632016-09-09 10:27:18 +02001560 The default is "gpt" if undefined.
Steve Rae0ff7e582014-12-12 15:51:54 -08001561
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +02001562 CONFIG_FASTBOOT_MBR_NAME
1563 The fastboot "flash" command supports writing the downloaded
1564 image to DOS MBR.
1565 This occurs when the "partition name" specified on the
1566 "fastboot flash" command line matches this value.
1567 If not defined the default value "mbr" is used.
1568
wdenk6705d812004-08-02 23:22:59 +00001569- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001570 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001571 Define these for a default partition on a NAND device
1572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001573 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1574 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001575 Define these for a default partition on a NOR device
1576
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001577- FAT(File Allocation Table) filesystem write function support:
1578 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001579
1580 Define this to enable support for saving memory data as a
1581 file in FAT formatted partition.
1582
1583 This will also enable the command "fatwrite" enabling the
1584 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001585
Alexander von Gernleredb42db2016-10-07 19:44:14 +02001586- CBFS (Coreboot Filesystem) support:
Gabe Black84cd9322012-10-12 14:26:11 +00001587 CONFIG_CMD_CBFS
1588
1589 Define this to enable support for reading from a Coreboot
1590 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1591 and cbfsload.
1592
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301593- FAT(File Allocation Table) filesystem cluster size:
1594 CONFIG_FS_FAT_MAX_CLUSTSIZE
1595
1596 Define the max cluster size for fat operations else
1597 a default value of 65536 will be defined.
1598
wdenkc6097192002-11-03 00:24:07 +00001599- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001600 See Kconfig help for available keyboard drivers.
1601
1602 CONFIG_KEYBOARD
1603
1604 Define this to enable a custom keyboard support.
1605 This simply calls drv_keyboard_init() which must be
1606 defined in your board-specific files. This option is deprecated
1607 and is only used by novena. For new boards, use driver model
1608 instead.
wdenkc6097192002-11-03 00:24:07 +00001609
1610- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001611 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001612 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001613 SOCs that have a DIU should define this macro to enable DIU
1614 support, and should also define these other macros:
1615
1616 CONFIG_SYS_DIU_ADDR
1617 CONFIG_VIDEO
1618 CONFIG_CMD_BMP
1619 CONFIG_CFB_CONSOLE
1620 CONFIG_VIDEO_SW_CURSOR
1621 CONFIG_VGA_AS_SINGLE_DEVICE
1622 CONFIG_VIDEO_LOGO
1623 CONFIG_VIDEO_BMP_LOGO
1624
Timur Tabiba8e76b2011-04-11 14:18:22 -05001625 The DIU driver will look for the 'video-mode' environment
1626 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001627 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001628 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001629
wdenkc6097192002-11-03 00:24:07 +00001630- LCD Support: CONFIG_LCD
1631
1632 Define this to enable LCD support (for output to LCD
1633 display); also select one of the supported displays
1634 by defining one of these:
1635
Stelian Pop39cf4802008-05-09 21:57:18 +02001636 CONFIG_ATMEL_LCD:
1637
1638 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1639
wdenkfd3103b2003-11-25 16:55:19 +00001640 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001641
wdenkfd3103b2003-11-25 16:55:19 +00001642 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001643
wdenkfd3103b2003-11-25 16:55:19 +00001644 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001645
wdenkfd3103b2003-11-25 16:55:19 +00001646 NEC NL6448BC20-08. 6.5", 640x480.
1647 Active, color, single scan.
1648
1649 CONFIG_NEC_NL6448BC33_54
1650
1651 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001652 Active, color, single scan.
1653
1654 CONFIG_SHARP_16x9
1655
1656 Sharp 320x240. Active, color, single scan.
1657 It isn't 16x9, and I am not sure what it is.
1658
1659 CONFIG_SHARP_LQ64D341
1660
1661 Sharp LQ64D341 display, 640x480.
1662 Active, color, single scan.
1663
1664 CONFIG_HLD1045
1665
1666 HLD1045 display, 640x480.
1667 Active, color, single scan.
1668
1669 CONFIG_OPTREX_BW
1670
1671 Optrex CBL50840-2 NF-FW 99 22 M5
1672 or
1673 Hitachi LMG6912RPFC-00T
1674 or
1675 Hitachi SP14Q002
1676
1677 320x240. Black & white.
1678
1679 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001680 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001681
Simon Glass676d3192012-10-17 13:24:54 +00001682 CONFIG_LCD_ALIGNMENT
1683
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001684 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001685 defined then the LCD will be aligned to this value instead.
1686 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1687 here, since it is cheaper to change data cache settings on
1688 a per-section basis.
1689
1690
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001691 CONFIG_LCD_ROTATION
1692
1693 Sometimes, for example if the display is mounted in portrait
1694 mode or even if it's mounted landscape but rotated by 180degree,
1695 we need to rotate our content of the display relative to the
1696 framebuffer, so that user can read the messages which are
1697 printed out.
1698 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1699 initialized with a given rotation from "vl_rot" out of
1700 "vidinfo_t" which is provided by the board specific code.
1701 The value for vl_rot is coded as following (matching to
1702 fbcon=rotate:<n> linux-kernel commandline):
1703 0 = no rotation respectively 0 degree
1704 1 = 90 degree rotation
1705 2 = 180 degree rotation
1706 3 = 270 degree rotation
1707
1708 If CONFIG_LCD_ROTATION is not defined, the console will be
1709 initialized with 0degree rotation.
1710
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001711 CONFIG_LCD_BMP_RLE8
1712
1713 Support drawing of RLE8-compressed bitmaps on the LCD.
1714
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001715 CONFIG_I2C_EDID
1716
1717 Enables an 'i2c edid' command which can read EDID
1718 information over I2C from an attached LCD display.
1719
wdenk7152b1d2003-09-05 23:19:14 +00001720- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001721
wdenk8bde7f72003-06-27 21:31:46 +00001722 If this option is set, the environment is checked for
1723 a variable "splashimage". If found, the usual display
1724 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001725 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001726 specified in "splashimage" is loaded instead. The
1727 console is redirected to the "nulldev", too. This
1728 allows for a "silent" boot where a splash screen is
1729 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001730
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001731 CONFIG_SPLASHIMAGE_GUARD
1732
1733 If this option is set, then U-Boot will prevent the environment
1734 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001735 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001736 This option is useful for targets where, due to alignment
1737 restrictions, an improperly aligned BMP image will cause a data
1738 abort. If you think you will not have problems with unaligned
1739 accesses (for example because your toolchain prevents them)
1740 there is no need to set this option.
1741
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001742 CONFIG_SPLASH_SCREEN_ALIGN
1743
1744 If this option is set the splash image can be freely positioned
1745 on the screen. Environment variable "splashpos" specifies the
1746 position as "x,y". If a positive number is given it is used as
1747 number of pixel from left/top. If a negative number is given it
1748 is used as number of pixel from right/bottom. You can also
1749 specify 'm' for centering the image.
1750
1751 Example:
1752 setenv splashpos m,m
1753 => image at center of screen
1754
1755 setenv splashpos 30,20
1756 => image at x = 30 and y = 20
1757
1758 setenv splashpos -10,m
1759 => vertically centered image
1760 at x = dspWidth - bmpWidth - 9
1761
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001762- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1763
1764 If this option is set, additionally to standard BMP
1765 images, gzipped BMP images can be displayed via the
1766 splashscreen support or the bmp command.
1767
Anatolij Gustschind5011762010-03-15 14:50:25 +01001768- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1769
1770 If this option is set, 8-bit RLE compressed BMP images
1771 can be displayed via the splashscreen support or the
1772 bmp command.
1773
wdenkc29fdfc2003-08-29 20:57:53 +00001774- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001775 CONFIG_GZIP
1776
1777 Enabled by default to support gzip compressed images.
1778
wdenkc29fdfc2003-08-29 20:57:53 +00001779 CONFIG_BZIP2
1780
1781 If this option is set, support for bzip2 compressed
1782 images is included. If not, only uncompressed and gzip
1783 compressed images are supported.
1784
wdenk42d1f032003-10-15 23:53:47 +00001785 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001786 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001787 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001788
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001789 CONFIG_LZMA
1790
1791 If this option is set, support for lzma compressed
1792 images is included.
1793
1794 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1795 requires an amount of dynamic memory that is given by the
1796 formula:
1797
1798 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1799
1800 Where lc and lp stand for, respectively, Literal context bits
1801 and Literal pos bits.
1802
1803 This value is upper-bounded by 14MB in the worst case. Anyway,
1804 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1805 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1806 a very small buffer.
1807
1808 Use the lzmainfo tool to determinate the lc and lp values and
1809 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001810 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001811
Kees Cook8ef70472013-08-16 07:59:12 -07001812 CONFIG_LZO
1813
1814 If this option is set, support for LZO compressed images
1815 is included.
1816
wdenk17ea1172004-06-06 21:51:03 +00001817- MII/PHY support:
1818 CONFIG_PHY_ADDR
1819
1820 The address of PHY on MII bus.
1821
1822 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1823
1824 The clock frequency of the MII bus
1825
1826 CONFIG_PHY_GIGE
1827
1828 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001829 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001830
1831 CONFIG_PHY_RESET_DELAY
1832
1833 Some PHY like Intel LXT971A need extra delay after
1834 reset before any MII register access is possible.
1835 For such PHY, set this option to the usec delay
1836 required. (minimum 300usec for LXT971A)
1837
1838 CONFIG_PHY_CMD_DELAY (ppc4xx)
1839
1840 Some PHY like Intel LXT971A need extra delay after
1841 command issued before MII status register can be read
1842
wdenkc6097192002-11-03 00:24:07 +00001843- IP address:
1844 CONFIG_IPADDR
1845
1846 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001847 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001848 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001849 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001850
1851- Server IP address:
1852 CONFIG_SERVERIP
1853
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001854 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001855 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001856 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001857
Robin Getz97cfe862009-07-21 12:15:28 -04001858 CONFIG_KEEP_SERVERADDR
1859
1860 Keeps the server's MAC address, in the env 'serveraddr'
1861 for passing to bootargs (like Linux's netconsole option)
1862
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001863- Gateway IP address:
1864 CONFIG_GATEWAYIP
1865
1866 Defines a default value for the IP address of the
1867 default router where packets to other networks are
1868 sent to.
1869 (Environment variable "gatewayip")
1870
1871- Subnet mask:
1872 CONFIG_NETMASK
1873
1874 Defines a default value for the subnet mask (or
1875 routing prefix) which is used to determine if an IP
1876 address belongs to the local subnet or needs to be
1877 forwarded through a router.
1878 (Environment variable "netmask")
1879
David Updegraff53a5c422007-06-11 10:41:07 -05001880- Multicast TFTP Mode:
1881 CONFIG_MCAST_TFTP
1882
1883 Defines whether you want to support multicast TFTP as per
1884 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001885 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001886 driver in use must provide a function: mcast() to join/leave a
1887 multicast group.
1888
wdenkc6097192002-11-03 00:24:07 +00001889- BOOTP Recovery Mode:
1890 CONFIG_BOOTP_RANDOM_DELAY
1891
1892 If you have many targets in a network that try to
1893 boot using BOOTP, you may want to avoid that all
1894 systems send out BOOTP requests at precisely the same
1895 moment (which would happen for instance at recovery
1896 from a power failure, when all systems will try to
1897 boot, thus flooding the BOOTP server. Defining
1898 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1899 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001900 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001901
1902 1st BOOTP request: delay 0 ... 1 sec
1903 2nd BOOTP request: delay 0 ... 2 sec
1904 3rd BOOTP request: delay 0 ... 4 sec
1905 4th and following
1906 BOOTP requests: delay 0 ... 8 sec
1907
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001908 CONFIG_BOOTP_ID_CACHE_SIZE
1909
1910 BOOTP packets are uniquely identified using a 32-bit ID. The
1911 server will copy the ID from client requests to responses and
1912 U-Boot will use this to determine if it is the destination of
1913 an incoming response. Some servers will check that addresses
1914 aren't in use before handing them out (usually using an ARP
1915 ping) and therefore take up to a few hundred milliseconds to
1916 respond. Network congestion may also influence the time it
1917 takes for a response to make it back to the client. If that
1918 time is too long, U-Boot will retransmit requests. In order
1919 to allow earlier responses to still be accepted after these
1920 retransmissions, U-Boot's BOOTP client keeps a small cache of
1921 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1922 cache. The default is to keep IDs for up to four outstanding
1923 requests. Increasing this will allow U-Boot to accept offers
1924 from a BOOTP client in networks with unusually high latency.
1925
stroesefe389a82003-08-28 14:17:32 +00001926- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001927 You can fine tune the DHCP functionality by defining
1928 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001929
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001930 CONFIG_BOOTP_SUBNETMASK
1931 CONFIG_BOOTP_GATEWAY
1932 CONFIG_BOOTP_HOSTNAME
1933 CONFIG_BOOTP_NISDOMAIN
1934 CONFIG_BOOTP_BOOTPATH
1935 CONFIG_BOOTP_BOOTFILESIZE
1936 CONFIG_BOOTP_DNS
1937 CONFIG_BOOTP_DNS2
1938 CONFIG_BOOTP_SEND_HOSTNAME
1939 CONFIG_BOOTP_NTPSERVER
1940 CONFIG_BOOTP_TIMEOFFSET
1941 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001942 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001943
Wilson Callan5d110f02007-07-28 10:56:13 -04001944 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1945 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001946
Joe Hershberger2c00e092012-05-23 07:59:19 +00001947 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1948 after the configured retry count, the call will fail
1949 instead of starting over. This can be used to fail over
1950 to Link-local IP address configuration if the DHCP server
1951 is not available.
1952
stroesefe389a82003-08-28 14:17:32 +00001953 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1954 serverip from a DHCP server, it is possible that more
1955 than one DNS serverip is offered to the client.
1956 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1957 serverip will be stored in the additional environment
1958 variable "dnsip2". The first DNS serverip is always
1959 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001960 is defined.
stroesefe389a82003-08-28 14:17:32 +00001961
1962 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1963 to do a dynamic update of a DNS server. To do this, they
1964 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001965 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001966 of the "hostname" environment variable is passed as
1967 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001968
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001969 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1970
1971 A 32bit value in microseconds for a delay between
1972 receiving a "DHCP Offer" and sending the "DHCP Request".
1973 This fixes a problem with certain DHCP servers that don't
1974 respond 100% of the time to a "DHCP request". E.g. On an
1975 AT91RM9200 processor running at 180MHz, this delay needed
1976 to be *at least* 15,000 usec before a Windows Server 2003
1977 DHCP server would reply 100% of the time. I recommend at
1978 least 50,000 usec to be safe. The alternative is to hope
1979 that one of the retries will be successful but note that
1980 the DHCP timeout and retry process takes a longer than
1981 this delay.
1982
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001983 - Link-local IP address negotiation:
1984 Negotiate with other link-local clients on the local network
1985 for an address that doesn't require explicit configuration.
1986 This is especially useful if a DHCP server cannot be guaranteed
1987 to exist in all environments that the device must operate.
1988
1989 See doc/README.link-local for more information.
1990
wdenka3d991b2004-04-15 21:48:45 +00001991 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001992 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001993
1994 The device id used in CDP trigger frames.
1995
1996 CONFIG_CDP_DEVICE_ID_PREFIX
1997
1998 A two character string which is prefixed to the MAC address
1999 of the device.
2000
2001 CONFIG_CDP_PORT_ID
2002
2003 A printf format string which contains the ascii name of
2004 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002005 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002006
2007 CONFIG_CDP_CAPABILITIES
2008
2009 A 32bit integer which indicates the device capabilities;
2010 0x00000010 for a normal host which does not forwards.
2011
2012 CONFIG_CDP_VERSION
2013
2014 An ascii string containing the version of the software.
2015
2016 CONFIG_CDP_PLATFORM
2017
2018 An ascii string containing the name of the platform.
2019
2020 CONFIG_CDP_TRIGGER
2021
2022 A 32bit integer sent on the trigger.
2023
2024 CONFIG_CDP_POWER_CONSUMPTION
2025
2026 A 16bit integer containing the power consumption of the
2027 device in .1 of milliwatts.
2028
2029 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2030
2031 A byte containing the id of the VLAN.
2032
Uri Mashiach79267ed2017-01-19 10:51:05 +02002033- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00002034
2035 Several configurations allow to display the current
2036 status using a LED. For instance, the LED will blink
2037 fast while running U-Boot code, stop blinking as
2038 soon as a reply to a BOOTP request was received, and
2039 start blinking slow once the Linux kernel is running
2040 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02002041 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00002042 feature in U-Boot.
2043
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002044 Additional options:
2045
Uri Mashiach79267ed2017-01-19 10:51:05 +02002046 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002047 The status LED can be connected to a GPIO pin.
2048 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02002049 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002050 to include the gpio_led driver in the U-Boot binary.
2051
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002052 CONFIG_GPIO_LED_INVERTED_TABLE
2053 Some GPIO connected LEDs may have inverted polarity in which
2054 case the GPIO high value corresponds to LED off state and
2055 GPIO low value corresponds to LED on state.
2056 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2057 with a list of GPIO LEDs that have inverted polarity.
2058
wdenkc6097192002-11-03 00:24:07 +00002059- CAN Support: CONFIG_CAN_DRIVER
2060
2061 Defining CONFIG_CAN_DRIVER enables CAN driver support
2062 on those systems that support this (optional)
2063 feature, like the TQM8xxL modules.
2064
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002065- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002066
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002067 This enable the NEW i2c subsystem, and will allow you to use
2068 i2c commands at the u-boot command line (as long as you set
2069 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2070 based realtime clock chips or other i2c devices. See
2071 common/cmd_i2c.c for a description of the command line
2072 interface.
2073
2074 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002075 - drivers/i2c/soft_i2c.c:
2076 - activate first bus with CONFIG_SYS_I2C_SOFT define
2077 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2078 for defining speed and slave address
2079 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2080 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2081 for defining speed and slave address
2082 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2083 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2084 for defining speed and slave address
2085 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2086 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2087 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002088
Heiko Schocher00f792e2012-10-24 13:48:22 +02002089 - drivers/i2c/fsl_i2c.c:
2090 - activate i2c driver with CONFIG_SYS_I2C_FSL
2091 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2092 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2093 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2094 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002095 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002096 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2097 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2098 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2099 second bus.
2100
Simon Glass1f2ba722012-10-30 07:28:53 +00002101 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002102 - activate this driver with CONFIG_SYS_I2C_TEGRA
2103 - This driver adds 4 i2c buses with a fix speed from
2104 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002105
Dirk Eibach880540d2013-04-25 02:40:01 +00002106 - drivers/i2c/ppc4xx_i2c.c
2107 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2108 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2109 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2110
tremfac96402013-09-21 18:13:35 +02002111 - drivers/i2c/i2c_mxc.c
2112 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002113 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2114 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2115 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2116 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002117 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2118 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2119 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2120 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2121 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2122 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002123 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2124 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002125 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002126 for speed, and 0 for slave.
2127
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002128 - drivers/i2c/rcar_i2c.c:
2129 - activate this driver with CONFIG_SYS_I2C_RCAR
2130 - This driver adds 4 i2c buses
2131
2132 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2133 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2134 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2135 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2136 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2137 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2138 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2139 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2140 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2141
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002142 - drivers/i2c/sh_i2c.c:
2143 - activate this driver with CONFIG_SYS_I2C_SH
2144 - This driver adds from 2 to 5 i2c buses
2145
2146 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2147 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2148 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2149 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2150 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2151 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2152 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2153 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2154 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2155 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002156 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002157
Heiko Schocher6789e842013-10-22 11:03:18 +02002158 - drivers/i2c/omap24xx_i2c.c
2159 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2160 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2161 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2162 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2163 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2164 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2165 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2166 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2167 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2168 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2169 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2170
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002171 - drivers/i2c/zynq_i2c.c
2172 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2173 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2174 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2175
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302176 - drivers/i2c/s3c24x0_i2c.c:
2177 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2178 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2179 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2180 with a fix speed from 100000 and the slave addr 0!
2181
Dirk Eibachb46226b2014-07-03 09:28:18 +02002182 - drivers/i2c/ihs_i2c.c
2183 - activate this driver with CONFIG_SYS_I2C_IHS
2184 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2185 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2186 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2187 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2188 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2189 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2190 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2191 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2192 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2193 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2194 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2195 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002196 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2197 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2198 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2199 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2200 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2201 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2202 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2203 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2204 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002205
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002206 additional defines:
2207
2208 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06002209 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002210
2211 CONFIG_SYS_I2C_DIRECT_BUS
2212 define this, if you don't use i2c muxes on your hardware.
2213 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2214 omit this define.
2215
2216 CONFIG_SYS_I2C_MAX_HOPS
2217 define how many muxes are maximal consecutively connected
2218 on one i2c bus. If you not use i2c muxes, omit this
2219 define.
2220
2221 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002222 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002223 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2224 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2225 CONFIG_SYS_NUM_I2C_BUSES = 9:
2226
2227 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2228 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2229 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2230 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2231 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2232 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2233 {1, {I2C_NULL_HOP}}, \
2234 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2235 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2236 }
2237
2238 which defines
2239 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002240 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2241 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2242 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2243 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2244 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002245 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002246 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2247 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002248
2249 If you do not have i2c muxes on your board, omit this define.
2250
Heiko Schocherea818db2013-01-29 08:53:15 +01002251- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002252
2253 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2254 provides the following compelling advantages:
2255
2256 - more than one i2c adapter is usable
2257 - approved multibus support
2258 - better i2c mux support
2259
2260 ** Please consider updating your I2C driver now. **
2261
Heiko Schocherea818db2013-01-29 08:53:15 +01002262 These enable legacy I2C serial bus commands. Defining
2263 CONFIG_HARD_I2C will include the appropriate I2C driver
2264 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002265
wdenk945af8d2003-07-16 21:53:01 +00002266 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002267 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002268 CONFIG_COMMANDS) and communicate with i2c based realtime
2269 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002270 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002271
Ben Warrenbb99ad62006-09-07 16:50:54 -04002272 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002273
wdenk945af8d2003-07-16 21:53:01 +00002274 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002275 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002277 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002278 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002279 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002280 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002281
Peter Tyser8d321b82010-04-12 22:28:21 -05002282 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002283 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002284 and so its address should therefore be cleared to 0 (See,
2285 eg, MPC823e User's Manual p.16-473). So, set
2286 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002287
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002288 CONFIG_SYS_I2C_INIT_MPC5XXX
2289
2290 When a board is reset during an i2c bus transfer
2291 chips might think that the current transfer is still
2292 in progress. Reset the slave devices by sending start
2293 commands until the slave device responds.
2294
wdenk945af8d2003-07-16 21:53:01 +00002295 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002296
Heiko Schocherea818db2013-01-29 08:53:15 +01002297 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002298 then the following macros need to be defined (examples are
2299 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002300
2301 I2C_INIT
2302
wdenkb37c7e52003-06-30 16:24:52 +00002303 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002304 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002305
wdenkba56f622004-02-06 23:19:44 +00002306 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002307
wdenkc6097192002-11-03 00:24:07 +00002308 I2C_PORT
2309
wdenk43d96162003-03-06 00:02:04 +00002310 (Only for MPC8260 CPU). The I/O port to use (the code
2311 assumes both bits are on the same port). Valid values
2312 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002313
2314 I2C_ACTIVE
2315
2316 The code necessary to make the I2C data line active
2317 (driven). If the data line is open collector, this
2318 define can be null.
2319
wdenkb37c7e52003-06-30 16:24:52 +00002320 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2321
wdenkc6097192002-11-03 00:24:07 +00002322 I2C_TRISTATE
2323
2324 The code necessary to make the I2C data line tri-stated
2325 (inactive). If the data line is open collector, this
2326 define can be null.
2327
wdenkb37c7e52003-06-30 16:24:52 +00002328 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2329
wdenkc6097192002-11-03 00:24:07 +00002330 I2C_READ
2331
York Sun472d5462013-04-01 11:29:11 -07002332 Code that returns true if the I2C data line is high,
2333 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002334
wdenkb37c7e52003-06-30 16:24:52 +00002335 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2336
wdenkc6097192002-11-03 00:24:07 +00002337 I2C_SDA(bit)
2338
York Sun472d5462013-04-01 11:29:11 -07002339 If <bit> is true, sets the I2C data line high. If it
2340 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002341
wdenkb37c7e52003-06-30 16:24:52 +00002342 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002343 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002344 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002345
wdenkc6097192002-11-03 00:24:07 +00002346 I2C_SCL(bit)
2347
York Sun472d5462013-04-01 11:29:11 -07002348 If <bit> is true, sets the I2C clock line high. If it
2349 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002350
wdenkb37c7e52003-06-30 16:24:52 +00002351 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002352 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002353 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002354
wdenkc6097192002-11-03 00:24:07 +00002355 I2C_DELAY
2356
2357 This delay is invoked four times per clock cycle so this
2358 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002359 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002360 like:
2361
wdenkb37c7e52003-06-30 16:24:52 +00002362 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002363
Mike Frysinger793b5722010-07-21 13:38:02 -04002364 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2365
2366 If your arch supports the generic GPIO framework (asm/gpio.h),
2367 then you may alternatively define the two GPIOs that are to be
2368 used as SCL / SDA. Any of the previous I2C_xxx macros will
2369 have GPIO-based defaults assigned to them as appropriate.
2370
2371 You should define these to the GPIO value as given directly to
2372 the generic GPIO functions.
2373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002374 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002375
wdenk8bde7f72003-06-27 21:31:46 +00002376 When a board is reset during an i2c bus transfer
2377 chips might think that the current transfer is still
2378 in progress. On some boards it is possible to access
2379 the i2c SCLK line directly, either by using the
2380 processor pin as a GPIO or by having a second pin
2381 connected to the bus. If this option is defined a
2382 custom i2c_init_board() routine in boards/xxx/board.c
2383 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002384
Richard Retanubun26a33502010-04-12 15:08:17 -04002385 CONFIG_SYS_I2C_BOARD_LATE_INIT
2386
2387 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2388 defined a custom i2c_board_late_init() routine in
2389 boards/xxx/board.c is run AFTER the operations in i2c_init()
2390 is completed. This callpoint can be used to unreset i2c bus
2391 using CPU i2c controller register accesses for CPUs whose i2c
2392 controller provide such a method. It is called at the end of
2393 i2c_init() to allow i2c_init operations to setup the i2c bus
2394 controller on the CPU (e.g. setting bus speed & slave address).
2395
wdenk17ea1172004-06-06 21:51:03 +00002396 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2397
2398 This option enables configuration of bi_iic_fast[] flags
2399 in u-boot bd_info structure based on u-boot environment
2400 variable "i2cfast". (see also i2cfast)
2401
Ben Warrenbb99ad62006-09-07 16:50:54 -04002402 CONFIG_I2C_MULTI_BUS
2403
2404 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002405 must have a controller. At any point in time, only one bus is
2406 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002407 Note that bus numbering is zero-based.
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002410
2411 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002412 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002413 is set, specify a list of bus-device pairs. Otherwise, specify
2414 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002415
2416 e.g.
2417 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002418 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002419
2420 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2421
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002422 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06002423 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002424
2425 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2426
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002427 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002428
2429 If defined, then this indicates the I2C bus number for DDR SPD.
2430 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002432 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002433
2434 If defined, then this indicates the I2C bus number for the RTC.
2435 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2436
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002437 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002438
2439 If defined, then this indicates the I2C bus number for the DTT.
2440 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002442 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002443
2444 If defined, specifies the I2C address of the DTT device.
2445 If not defined, then U-Boot uses predefined value for
2446 specified DTT device.
2447
Andrew Dyer2ac69852008-12-29 17:36:01 -06002448 CONFIG_SOFT_I2C_READ_REPEATED_START
2449
2450 defining this will force the i2c_read() function in
2451 the soft_i2c driver to perform an I2C repeated start
2452 between writing the address pointer and reading the
2453 data. If this define is omitted the default behaviour
2454 of doing a stop-start sequence will be used. Most I2C
2455 devices can use either method, but some require one or
2456 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002457
wdenkc6097192002-11-03 00:24:07 +00002458- SPI Support: CONFIG_SPI
2459
2460 Enables SPI driver (so far only tested with
2461 SPI EEPROM, also an instance works with Crystal A/D and
2462 D/As on the SACSng board)
2463
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002464 CONFIG_SH_SPI
2465
2466 Enables the driver for SPI controller on SuperH. Currently
2467 only SH7757 is supported.
2468
wdenkc6097192002-11-03 00:24:07 +00002469 CONFIG_SOFT_SPI
2470
wdenk43d96162003-03-06 00:02:04 +00002471 Enables a software (bit-bang) SPI driver rather than
2472 using hardware support. This is a general purpose
2473 driver that only requires three general I/O port pins
2474 (two outputs, one input) to function. If this is
2475 defined, the board configuration must define several
2476 SPI configuration items (port pins to use, etc). For
2477 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002478
Ben Warren04a9e112008-01-16 22:37:35 -05002479 CONFIG_HARD_SPI
2480
2481 Enables a hardware SPI driver for general-purpose reads
2482 and writes. As with CONFIG_SOFT_SPI, the board configuration
2483 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002484 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002485 example, see include/configs/mpc8349emds.h.
2486
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002487 CONFIG_MXC_SPI
2488
2489 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002490 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002491
Heiko Schocherf659b572014-07-14 10:22:11 +02002492 CONFIG_SYS_SPI_MXC_WAIT
2493 Timeout for waiting until spi transfer completed.
2494 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2495
Matthias Fuchs01335022007-12-27 17:12:34 +01002496- FPGA Support: CONFIG_FPGA
2497
2498 Enables FPGA subsystem.
2499
2500 CONFIG_FPGA_<vendor>
2501
2502 Enables support for specific chip vendors.
2503 (ALTERA, XILINX)
2504
2505 CONFIG_FPGA_<family>
2506
2507 Enables support for FPGA family.
2508 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2509
2510 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002511
wdenk43d96162003-03-06 00:02:04 +00002512 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002513
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302514 CONFIG_CMD_FPGA_LOADMK
2515
2516 Enable support for fpga loadmk command
2517
Michal Simek67193862014-05-02 13:43:39 +02002518 CONFIG_CMD_FPGA_LOADP
2519
2520 Enable support for fpga loadp command - load partial bitstream
2521
2522 CONFIG_CMD_FPGA_LOADBP
2523
2524 Enable support for fpga loadbp command - load partial bitstream
2525 (Xilinx only)
2526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk8bde7f72003-06-27 21:31:46 +00002529 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk43d96162003-03-06 00:02:04 +00002533 Enable checks on FPGA configuration interface busy
2534 status by the configuration function. This option
2535 will require a board or device specific function to
2536 be written.
wdenkc6097192002-11-03 00:24:07 +00002537
2538 CONFIG_FPGA_DELAY
2539
2540 If defined, a function that provides delays in the FPGA
2541 configuration driver.
2542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002544 Allow Control-C to interrupt FPGA configuration
2545
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002546 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk43d96162003-03-06 00:02:04 +00002548 Check for configuration errors during FPGA bitfile
2549 loading. For example, abort during Virtex II
2550 configuration if the INIT_B line goes low (which
2551 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002554
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002555 Maximum time to wait for the INIT_B line to de-assert
2556 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002557 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002558 ms.
wdenkc6097192002-11-03 00:24:07 +00002559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002561
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002562 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002563 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002565 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002566
wdenk43d96162003-03-06 00:02:04 +00002567 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002568 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002569
2570- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002571 CONFIG_BUILD_TARGET
2572
2573 Some SoCs need special image types (e.g. U-Boot binary
2574 with a special header) as build targets. By defining
2575 CONFIG_BUILD_TARGET in the SoC / board header, this
2576 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002577 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002578
wdenkc6097192002-11-03 00:24:07 +00002579 CONFIG_IDENT_STRING
2580
wdenk43d96162003-03-06 00:02:04 +00002581 If defined, this string will be added to the U-Boot
2582 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002583
2584- Vendor Parameter Protection:
2585
wdenk43d96162003-03-06 00:02:04 +00002586 U-Boot considers the values of the environment
2587 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002588 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002589 are set once by the board vendor / manufacturer, and
2590 protects these variables from casual modification by
2591 the user. Once set, these variables are read-only,
2592 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002593 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002594
2595 If CONFIG_ENV_OVERWRITE is #defined in your config
2596 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002597 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002598 these parameters.
2599
Joe Hershberger92ac5202015-05-04 14:55:14 -05002600 Alternatively, if you define _both_ an ethaddr in the
2601 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002602 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002603 which can be changed exactly ONCE by the user. [The
2604 serial# is unaffected by this, i. e. it remains
2605 read-only.]
2606
Joe Hershberger25980902012-12-11 22:16:31 -06002607 The same can be accomplished in a more flexible way
2608 for any variable by configuring the type of access
2609 to allow for those variables in the ".flags" variable
2610 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2611
wdenkc6097192002-11-03 00:24:07 +00002612- Protected RAM:
2613 CONFIG_PRAM
2614
2615 Define this variable to enable the reservation of
2616 "protected RAM", i. e. RAM which is not overwritten
2617 by U-Boot. Define CONFIG_PRAM to hold the number of
2618 kB you want to reserve for pRAM. You can overwrite
2619 this default value by defining an environment
2620 variable "pram" to the number of kB you want to
2621 reserve. Note that the board info structure will
2622 still show the full amount of RAM. If pRAM is
2623 reserved, a new environment variable "mem" will
2624 automatically be defined to hold the amount of
2625 remaining RAM in a form that can be passed as boot
2626 argument to Linux, for instance like that:
2627
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002628 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002629 saveenv
2630
2631 This way you can tell Linux not to use this memory,
2632 either, which results in a memory region that will
2633 not be affected by reboots.
2634
2635 *WARNING* If your board configuration uses automatic
2636 detection of the RAM size, you must make sure that
2637 this memory test is non-destructive. So far, the
2638 following board configurations are known to be
2639 "pRAM-clean":
2640
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002641 IVMS8, IVML24, SPD8xx, TQM8xxL,
2642 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002643 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002644
Gabe Black40fef042012-12-02 04:55:18 +00002645- Access to physical memory region (> 4GB)
2646 Some basic support is provided for operations on memory not
2647 normally accessible to U-Boot - e.g. some architectures
2648 support access to more than 4GB of memory on 32-bit
2649 machines using physical address extension or similar.
2650 Define CONFIG_PHYSMEM to access this basic support, which
2651 currently only supports clearing the memory.
2652
wdenkc6097192002-11-03 00:24:07 +00002653- Error Recovery:
2654 CONFIG_PANIC_HANG
2655
2656 Define this variable to stop the system in case of a
2657 fatal error, so that you have to reset it manually.
2658 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002659 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002660 automatically as fast as possible, but it may be
2661 useful during development since you can try to debug
2662 the conditions that lead to the situation.
2663
2664 CONFIG_NET_RETRY_COUNT
2665
wdenk43d96162003-03-06 00:02:04 +00002666 This variable defines the number of retries for
2667 network operations like ARP, RARP, TFTP, or BOOTP
2668 before giving up the operation. If not defined, a
2669 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002670
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002671 CONFIG_ARP_TIMEOUT
2672
2673 Timeout waiting for an ARP reply in milliseconds.
2674
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002675 CONFIG_NFS_TIMEOUT
2676
2677 Timeout in milliseconds used in NFS protocol.
2678 If you encounter "ERROR: Cannot umount" in nfs command,
2679 try longer timeout such as
2680 #define CONFIG_NFS_TIMEOUT 10000UL
2681
wdenkc6097192002-11-03 00:24:07 +00002682- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002683 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002684
2685 Enable auto completion of commands using TAB.
2686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002687 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002688
2689 This defines the secondary prompt string, which is
2690 printed when the command interpreter needs more input
2691 to complete a command. Usually "> ".
2692
2693 Note:
2694
wdenk8bde7f72003-06-27 21:31:46 +00002695 In the current implementation, the local variables
2696 space and global environment variables space are
2697 separated. Local variables are those you define by
2698 simply typing `name=value'. To access a local
2699 variable later on, you have write `$name' or
2700 `${name}'; to execute the contents of a variable
2701 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002702
wdenk43d96162003-03-06 00:02:04 +00002703 Global environment variables are those you use
2704 setenv/printenv to work with. To run a command stored
2705 in such a variable, you need to use the run command,
2706 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002707
2708 To store commands and special characters in a
2709 variable, please use double quotation marks
2710 surrounding the whole text of the variable, instead
2711 of the backslashes before semicolons and special
2712 symbols.
2713
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002714- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002715 CONFIG_CMDLINE_EDITING
2716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002717 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002718 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002719
Marek Vasutf3b267b2016-01-27 04:47:55 +01002720- Command Line PS1/PS2 support:
2721 CONFIG_CMDLINE_PS_SUPPORT
2722
2723 Enable support for changing the command prompt string
2724 at run-time. Only static string is supported so far.
2725 The string is obtained from environment variables PS1
2726 and PS2.
2727
wdenka8c7c702003-12-06 19:49:23 +00002728- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002729 CONFIG_EXTRA_ENV_SETTINGS
2730
wdenk43d96162003-03-06 00:02:04 +00002731 Define this to contain any number of null terminated
2732 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002733 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002734
wdenk43d96162003-03-06 00:02:04 +00002735 For example, place something like this in your
2736 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002737
2738 #define CONFIG_EXTRA_ENV_SETTINGS \
2739 "myvar1=value1\0" \
2740 "myvar2=value2\0"
2741
wdenk43d96162003-03-06 00:02:04 +00002742 Warning: This method is based on knowledge about the
2743 internal format how the environment is stored by the
2744 U-Boot code. This is NOT an official, exported
2745 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002746 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002747 You better know what you are doing here.
2748
wdenk43d96162003-03-06 00:02:04 +00002749 Note: overly (ab)use of the default environment is
2750 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002751 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002752 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002753
Stephen Warren5e724ca2012-05-22 09:21:54 +00002754 CONFIG_ENV_VARS_UBOOT_CONFIG
2755
2756 Define this in order to add variables describing the
2757 U-Boot build configuration to the default environment.
2758 These will be named arch, cpu, board, vendor, and soc.
2759
2760 Enabling this option will cause the following to be defined:
2761
2762 - CONFIG_SYS_ARCH
2763 - CONFIG_SYS_CPU
2764 - CONFIG_SYS_BOARD
2765 - CONFIG_SYS_VENDOR
2766 - CONFIG_SYS_SOC
2767
Tom Rini7e27f892012-10-24 07:28:16 +00002768 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2769
2770 Define this in order to add variables describing certain
2771 run-time determined information about the hardware to the
2772 environment. These will be named board_name, board_rev.
2773
Simon Glass06fd8532012-11-30 13:01:17 +00002774 CONFIG_DELAY_ENVIRONMENT
2775
2776 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002777 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002778 that so that the environment is not available until
2779 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2780 this is instead controlled by the value of
2781 /config/load-environment.
2782
wdenka8c7c702003-12-06 19:49:23 +00002783- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002784 CONFIG_HAS_DATAFLASH
2785
wdenk8bde7f72003-06-27 21:31:46 +00002786 Defining this option enables DataFlash features and
2787 allows to read/write in Dataflash via the standard
2788 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002789
Eric Nelsonf61ec452012-01-31 10:52:08 -07002790- Serial Flash support
2791 CONFIG_CMD_SF
2792
2793 Defining this option enables SPI flash commands
2794 'sf probe/read/write/erase/update'.
2795
2796 Usage requires an initial 'probe' to define the serial
2797 flash parameters, followed by read/write/erase/update
2798 commands.
2799
2800 The following defaults may be provided by the platform
2801 to handle the common case when only a single serial
2802 flash is present on the system.
2803
2804 CONFIG_SF_DEFAULT_BUS Bus identifier
2805 CONFIG_SF_DEFAULT_CS Chip-select
2806 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2807 CONFIG_SF_DEFAULT_SPEED in Hz
2808
Simon Glass24007272012-10-08 13:16:02 +00002809 CONFIG_CMD_SF_TEST
2810
2811 Define this option to include a destructive SPI flash
2812 test ('sf test').
2813
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302814 CONFIG_SF_DUAL_FLASH Dual flash memories
2815
2816 Define this option to use dual flash support where two flash
2817 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002818 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05302819
wdenk3f85ce22004-02-23 16:11:30 +00002820- SystemACE Support:
2821 CONFIG_SYSTEMACE
2822
2823 Adding this option adds support for Xilinx SystemACE
2824 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002825 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002826 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002827
2828 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002830
2831 When SystemACE support is added, the "ace" device type
2832 becomes available to the fat commands, i.e. fatls.
2833
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002834- TFTP Fixed UDP Port:
2835 CONFIG_TFTP_PORT
2836
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002837 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002838 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002839 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002840 number generator is used.
2841
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002842 Also, the environment variable tftpdstp is used to supply
2843 the TFTP UDP destination port value. If tftpdstp isn't
2844 defined, the normal port 69 is used.
2845
2846 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002847 blindly start the TFTP transfer using the pre-configured
2848 target IP address and UDP port. This has the effect of
2849 "punching through" the (Windows XP) firewall, allowing
2850 the remainder of the TFTP transfer to proceed normally.
2851 A better solution is to properly configure the firewall,
2852 but sometimes that is not allowed.
2853
Simon Glassbf36c5d2012-12-05 14:46:38 +00002854- Hashing support:
2855 CONFIG_CMD_HASH
2856
2857 This enables a generic 'hash' command which can produce
2858 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2859
2860 CONFIG_HASH_VERIFY
2861
2862 Enable the hash verify command (hash -v). This adds to code
2863 size a little.
2864
gaurav rana94e3c8c2015-02-20 12:51:46 +05302865 CONFIG_SHA1 - This option enables support of hashing using SHA1
2866 algorithm. The hash is calculated in software.
2867 CONFIG_SHA256 - This option enables support of hashing using
2868 SHA256 algorithm. The hash is calculated in software.
2869 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2870 for SHA1/SHA256 hashing.
2871 This affects the 'hash' command and also the
2872 hash_lookup_algo() function.
2873 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2874 hardware-acceleration for SHA1/SHA256 progressive hashing.
2875 Data can be streamed in a block at a time and the hashing
2876 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00002877
2878 Note: There is also a sha1sum command, which should perhaps
2879 be deprecated in favour of 'hash sha1'.
2880
Robert Winklera11f1872013-07-24 17:57:06 -07002881- Freescale i.MX specific commands:
2882 CONFIG_CMD_HDMIDETECT
2883 This enables 'hdmidet' command which returns true if an
2884 HDMI monitor is detected. This command is i.MX 6 specific.
2885
2886 CONFIG_CMD_BMODE
2887 This enables the 'bmode' (bootmode) command for forcing
2888 a boot from specific media.
2889
2890 This is useful for forcing the ROM's usb downloader to
2891 activate upon a watchdog reset which is nice when iterating
2892 on U-Boot. Using the reset button or running bmode normal
2893 will set it back to normal. This command currently
2894 supports i.MX53 and i.MX6.
2895
Heiko Schocher9e50c402014-01-25 07:27:13 +01002896- bootcount support:
2897 CONFIG_BOOTCOUNT_LIMIT
2898
2899 This enables the bootcounter support, see:
2900 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2901
2902 CONFIG_AT91SAM9XE
2903 enable special bootcounter support on at91sam9xe based boards.
2904 CONFIG_BLACKFIN
2905 enable special bootcounter support on blackfin based boards.
2906 CONFIG_SOC_DA8XX
2907 enable special bootcounter support on da850 based boards.
2908 CONFIG_BOOTCOUNT_RAM
2909 enable support for the bootcounter in RAM
2910 CONFIG_BOOTCOUNT_I2C
2911 enable support for the bootcounter on an i2c (like RTC) device.
2912 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2913 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2914 the bootcounter.
2915 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07002916
wdenka8c7c702003-12-06 19:49:23 +00002917- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002918 CONFIG_SHOW_BOOT_PROGRESS
2919
wdenk43d96162003-03-06 00:02:04 +00002920 Defining this option allows to add some board-
2921 specific code (calling a user-provided function
2922 "show_boot_progress(int)") that enables you to show
2923 the system's boot progress on some display (for
2924 example, some LED's) on your board. At the moment,
2925 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002926
Simon Glass94fd1312012-09-28 08:56:37 +00002927
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002928Legacy uImage format:
2929
wdenkc6097192002-11-03 00:24:07 +00002930 Arg Where When
2931 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002932 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002933 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002934 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002935 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002936 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002937 4 common/cmd_bootm.c Image data has correct checksum
2938 -4 common/cmd_bootm.c Image is for unsupported architecture
2939 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002940 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002941 6 common/cmd_bootm.c Image Type check OK
2942 -6 common/cmd_bootm.c gunzip uncompression error
2943 -7 common/cmd_bootm.c Unimplemented compression type
2944 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002945 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002946 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002947
2948 9 common/image.c Start initial ramdisk verification
2949 -10 common/image.c Ramdisk header has bad magic number
2950 -11 common/image.c Ramdisk header has bad checksum
2951 10 common/image.c Ramdisk header is OK
2952 -12 common/image.c Ramdisk data has bad checksum
2953 11 common/image.c Ramdisk data has correct checksum
2954 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002955 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002956 13 common/image.c Start multifile image verification
2957 14 common/image.c No initial ramdisk, no multifile, continue.
2958
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002959 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002960
Stefan Roesea47a12b2010-04-15 16:07:28 +02002961 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00002962 -31 post/post.c POST test failed, detected by post_output_backlog()
2963 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002964
Heiko Schocher566a4942007-06-22 19:11:54 +02002965 34 common/cmd_doc.c before loading a Image from a DOC device
2966 -35 common/cmd_doc.c Bad usage of "doc" command
2967 35 common/cmd_doc.c correct usage of "doc" command
2968 -36 common/cmd_doc.c No boot device
2969 36 common/cmd_doc.c correct boot device
2970 -37 common/cmd_doc.c Unknown Chip ID on boot device
2971 37 common/cmd_doc.c correct chip ID found, device available
2972 -38 common/cmd_doc.c Read Error on boot device
2973 38 common/cmd_doc.c reading Image header from DOC device OK
2974 -39 common/cmd_doc.c Image header has bad magic number
2975 39 common/cmd_doc.c Image header has correct magic number
2976 -40 common/cmd_doc.c Error reading Image from DOC device
2977 40 common/cmd_doc.c Image header has correct magic number
2978 41 common/cmd_ide.c before loading a Image from a IDE device
2979 -42 common/cmd_ide.c Bad usage of "ide" command
2980 42 common/cmd_ide.c correct usage of "ide" command
2981 -43 common/cmd_ide.c No boot device
2982 43 common/cmd_ide.c boot device found
2983 -44 common/cmd_ide.c Device not available
2984 44 common/cmd_ide.c Device available
2985 -45 common/cmd_ide.c wrong partition selected
2986 45 common/cmd_ide.c partition selected
2987 -46 common/cmd_ide.c Unknown partition table
2988 46 common/cmd_ide.c valid partition table found
2989 -47 common/cmd_ide.c Invalid partition type
2990 47 common/cmd_ide.c correct partition type
2991 -48 common/cmd_ide.c Error reading Image Header on boot device
2992 48 common/cmd_ide.c reading Image Header from IDE device OK
2993 -49 common/cmd_ide.c Image header has bad magic number
2994 49 common/cmd_ide.c Image header has correct magic number
2995 -50 common/cmd_ide.c Image header has bad checksum
2996 50 common/cmd_ide.c Image header has correct checksum
2997 -51 common/cmd_ide.c Error reading Image from IDE device
2998 51 common/cmd_ide.c reading Image from IDE device OK
2999 52 common/cmd_nand.c before loading a Image from a NAND device
3000 -53 common/cmd_nand.c Bad usage of "nand" command
3001 53 common/cmd_nand.c correct usage of "nand" command
3002 -54 common/cmd_nand.c No boot device
3003 54 common/cmd_nand.c boot device found
3004 -55 common/cmd_nand.c Unknown Chip ID on boot device
3005 55 common/cmd_nand.c correct chip ID found, device available
3006 -56 common/cmd_nand.c Error reading Image Header on boot device
3007 56 common/cmd_nand.c reading Image Header from NAND device OK
3008 -57 common/cmd_nand.c Image header has bad magic number
3009 57 common/cmd_nand.c Image header has correct magic number
3010 -58 common/cmd_nand.c Error reading Image from NAND device
3011 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003012
Heiko Schocher566a4942007-06-22 19:11:54 +02003013 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003014
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003015 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003016 -64 net/eth.c no Ethernet found.
3017 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003018
Heiko Schocher566a4942007-06-22 19:11:54 +02003019 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003020 80 common/cmd_net.c before calling net_loop()
3021 -81 common/cmd_net.c some error in net_loop() occurred
3022 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003023 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3024 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003025 83 common/cmd_net.c running "source" command
3026 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003027 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003028
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003029FIT uImage format:
3030
3031 Arg Where When
3032 100 common/cmd_bootm.c Kernel FIT Image has correct format
3033 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3034 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3035 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3036 102 common/cmd_bootm.c Kernel unit name specified
3037 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003038 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003039 104 common/cmd_bootm.c Got kernel subimage node offset
3040 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3041 105 common/cmd_bootm.c Kernel subimage hash verification OK
3042 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3043 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003044 -106 common/cmd_bootm.c Kernel subimage has wrong type
3045 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003046 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3047 108 common/cmd_bootm.c Got kernel subimage data/size
3048 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3049 -109 common/cmd_bootm.c Can't get kernel subimage type
3050 -110 common/cmd_bootm.c Can't get kernel subimage comp
3051 -111 common/cmd_bootm.c Can't get kernel subimage os
3052 -112 common/cmd_bootm.c Can't get kernel subimage load address
3053 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3054
3055 120 common/image.c Start initial ramdisk verification
3056 -120 common/image.c Ramdisk FIT image has incorrect format
3057 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003058 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003059 -122 common/image.c Can't get configuration for ramdisk subimage
3060 123 common/image.c Ramdisk unit name specified
3061 -124 common/image.c Can't get ramdisk subimage node offset
3062 125 common/image.c Got ramdisk subimage node offset
3063 -125 common/image.c Ramdisk subimage hash verification failed
3064 126 common/image.c Ramdisk subimage hash verification OK
3065 -126 common/image.c Ramdisk subimage for unsupported architecture
3066 127 common/image.c Architecture check OK
3067 -127 common/image.c Can't get ramdisk subimage data/size
3068 128 common/image.c Got ramdisk subimage data/size
3069 129 common/image.c Can't get ramdisk load address
3070 -129 common/image.c Got ramdisk load address
3071
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003072 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003073 131 common/cmd_doc.c FIT image format OK
3074
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003075 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003076 141 common/cmd_ide.c FIT image format OK
3077
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003078 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003079 151 common/cmd_nand.c FIT image format OK
3080
Heiko Schocher21d29f72014-05-28 11:33:33 +02003081- legacy image format:
3082 CONFIG_IMAGE_FORMAT_LEGACY
3083 enables the legacy image format support in U-Boot.
3084
3085 Default:
3086 enabled if CONFIG_FIT_SIGNATURE is not defined.
3087
3088 CONFIG_DISABLE_IMAGE_LEGACY
3089 disable the legacy image format
3090
3091 This define is introduced, as the legacy image format is
3092 enabled per default for backward compatibility.
3093
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003094- FIT image support:
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003095 CONFIG_FIT_DISABLE_SHA256
3096 Supporting SHA256 hashes has quite an impact on binary size.
3097 For constrained systems sha256 hash support can be disabled
3098 with this option.
3099
Simon Glass73223f02016-02-22 22:55:43 -07003100 TODO(sjg@chromium.org): Adjust this option to be positive,
3101 and move it to Kconfig
3102
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003103- Standalone program support:
3104 CONFIG_STANDALONE_LOAD_ADDR
3105
Wolfgang Denk6feff892011-10-09 21:06:34 +02003106 This option defines a board specific value for the
3107 address where standalone program gets loaded, thus
3108 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003109 settings.
3110
3111- Frame Buffer Address:
3112 CONFIG_FB_ADDR
3113
3114 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003115 address for frame buffer. This is typically the case
3116 when using a graphics controller has separate video
3117 memory. U-Boot will then place the frame buffer at
3118 the given address instead of dynamically reserving it
3119 in system RAM by calling lcd_setmem(), which grabs
3120 the memory for the frame buffer depending on the
3121 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003122
3123 Please see board_init_f function.
3124
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003125- Automatic software updates via TFTP server
3126 CONFIG_UPDATE_TFTP
3127 CONFIG_UPDATE_TFTP_CNT_MAX
3128 CONFIG_UPDATE_TFTP_MSEC_MAX
3129
3130 These options enable and control the auto-update feature;
3131 for a more detailed description refer to doc/README.update.
3132
3133- MTD Support (mtdparts command, UBI support)
3134 CONFIG_MTD_DEVICE
3135
3136 Adds the MTD device infrastructure from the Linux kernel.
3137 Needed for mtdparts command support.
3138
3139 CONFIG_MTD_PARTITIONS
3140
3141 Adds the MTD partitioning infrastructure from the Linux
3142 kernel. Needed for UBI support.
3143
Joe Hershberger70c219c2013-04-08 10:32:48 +00003144- UBI support
3145 CONFIG_CMD_UBI
3146
3147 Adds commands for interacting with MTD partitions formatted
3148 with the UBI flash translation layer
3149
3150 Requires also defining CONFIG_RBTREE
3151
Joe Hershberger147162d2013-04-08 10:32:49 +00003152 CONFIG_UBI_SILENCE_MSG
3153
3154 Make the verbose messages from UBI stop printing. This leaves
3155 warnings and errors enabled.
3156
Heiko Schocherff94bc42014-06-24 10:10:04 +02003157
3158 CONFIG_MTD_UBI_WL_THRESHOLD
3159 This parameter defines the maximum difference between the highest
3160 erase counter value and the lowest erase counter value of eraseblocks
3161 of UBI devices. When this threshold is exceeded, UBI starts performing
3162 wear leveling by means of moving data from eraseblock with low erase
3163 counter to eraseblocks with high erase counter.
3164
3165 The default value should be OK for SLC NAND flashes, NOR flashes and
3166 other flashes which have eraseblock life-cycle 100000 or more.
3167 However, in case of MLC NAND flashes which typically have eraseblock
3168 life-cycle less than 10000, the threshold should be lessened (e.g.,
3169 to 128 or 256, although it does not have to be power of 2).
3170
3171 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003172
Heiko Schocherff94bc42014-06-24 10:10:04 +02003173 CONFIG_MTD_UBI_BEB_LIMIT
3174 This option specifies the maximum bad physical eraseblocks UBI
3175 expects on the MTD device (per 1024 eraseblocks). If the
3176 underlying flash does not admit of bad eraseblocks (e.g. NOR
3177 flash), this value is ignored.
3178
3179 NAND datasheets often specify the minimum and maximum NVM
3180 (Number of Valid Blocks) for the flashes' endurance lifetime.
3181 The maximum expected bad eraseblocks per 1024 eraseblocks
3182 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3183 which gives 20 for most NANDs (MaxNVB is basically the total
3184 count of eraseblocks on the chip).
3185
3186 To put it differently, if this value is 20, UBI will try to
3187 reserve about 1.9% of physical eraseblocks for bad blocks
3188 handling. And that will be 1.9% of eraseblocks on the entire
3189 NAND chip, not just the MTD partition UBI attaches. This means
3190 that if you have, say, a NAND flash chip admits maximum 40 bad
3191 eraseblocks, and it is split on two MTD partitions of the same
3192 size, UBI will reserve 40 eraseblocks when attaching a
3193 partition.
3194
3195 default: 20
3196
3197 CONFIG_MTD_UBI_FASTMAP
3198 Fastmap is a mechanism which allows attaching an UBI device
3199 in nearly constant time. Instead of scanning the whole MTD device it
3200 only has to locate a checkpoint (called fastmap) on the device.
3201 The on-flash fastmap contains all information needed to attach
3202 the device. Using fastmap makes only sense on large devices where
3203 attaching by scanning takes long. UBI will not automatically install
3204 a fastmap on old images, but you can set the UBI parameter
3205 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3206 that fastmap-enabled images are still usable with UBI implementations
3207 without fastmap support. On typical flash devices the whole fastmap
3208 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3209
3210 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3211 Set this parameter to enable fastmap automatically on images
3212 without a fastmap.
3213 default: 0
3214
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003215 CONFIG_MTD_UBI_FM_DEBUG
3216 Enable UBI fastmap debug
3217 default: 0
3218
Joe Hershberger70c219c2013-04-08 10:32:48 +00003219- UBIFS support
3220 CONFIG_CMD_UBIFS
3221
3222 Adds commands for interacting with UBI volumes formatted as
3223 UBIFS. UBIFS is read-only in u-boot.
3224
3225 Requires UBI support as well as CONFIG_LZO
3226
Joe Hershberger147162d2013-04-08 10:32:49 +00003227 CONFIG_UBIFS_SILENCE_MSG
3228
3229 Make the verbose messages from UBIFS stop printing. This leaves
3230 warnings and errors enabled.
3231
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003232- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003233 CONFIG_SPL
3234 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003235
Tom Rini95579792012-02-14 07:29:40 +00003236 CONFIG_SPL_LDSCRIPT
3237 LDSCRIPT for linking the SPL binary.
3238
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003239 CONFIG_SPL_MAX_FOOTPRINT
3240 Maximum size in memory allocated to the SPL, BSS included.
3241 When defined, the linker checks that the actual memory
3242 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003243 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003244 must not be both defined at the same time.
3245
Tom Rini95579792012-02-14 07:29:40 +00003246 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003247 Maximum size of the SPL image (text, data, rodata, and
3248 linker lists sections), BSS excluded.
3249 When defined, the linker checks that the actual size does
3250 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003251
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003252 CONFIG_SPL_TEXT_BASE
3253 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003254
Scott Wood94a45bb2012-09-20 19:05:12 -05003255 CONFIG_SPL_RELOC_TEXT_BASE
3256 Address to relocate to. If unspecified, this is equal to
3257 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3258
Tom Rini95579792012-02-14 07:29:40 +00003259 CONFIG_SPL_BSS_START_ADDR
3260 Link address for the BSS within the SPL binary.
3261
3262 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003263 Maximum size in memory allocated to the SPL BSS.
3264 When defined, the linker checks that the actual memory used
3265 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003266 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003267 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003268
3269 CONFIG_SPL_STACK
3270 Adress of the start of the stack SPL will use
3271
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003272 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3273 When defined, SPL will panic() if the image it has
3274 loaded does not have a signature.
3275 Defining this is useful when code which loads images
3276 in SPL cannot guarantee that absolutely all read errors
3277 will be caught.
3278 An example is the LPC32XX MLC NAND driver, which will
3279 consider that a completely unreadable NAND block is bad,
3280 and thus should be skipped silently.
3281
Marek Vasute0727512016-04-29 00:44:55 +02003282 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3283 When defined, SPL will proceed to another boot method
3284 if the image it has loaded does not have a signature.
3285
Scott Wood94a45bb2012-09-20 19:05:12 -05003286 CONFIG_SPL_RELOC_STACK
3287 Adress of the start of the stack SPL will use after
3288 relocation. If unspecified, this is equal to
3289 CONFIG_SPL_STACK.
3290
Tom Rini95579792012-02-14 07:29:40 +00003291 CONFIG_SYS_SPL_MALLOC_START
3292 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003293 When this option is set the full malloc is used in SPL and
3294 it is set up by spl_init() and before that, the simple malloc()
3295 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003296
3297 CONFIG_SYS_SPL_MALLOC_SIZE
3298 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003299
Tom Rini47f7bca2012-08-13 12:03:19 -07003300 CONFIG_SPL_FRAMEWORK
3301 Enable the SPL framework under common/. This framework
3302 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3303 NAND loading of the Linux Kernel.
3304
Tom Rini9607faf2014-03-28 12:03:39 -04003305 CONFIG_SPL_OS_BOOT
3306 Enable booting directly to an OS from SPL.
3307 See also: doc/README.falcon
3308
Tom Rini861a86f2012-08-13 11:37:56 -07003309 CONFIG_SPL_DISPLAY_PRINT
3310 For ARM, enable an optional function to print more information
3311 about the running system.
3312
Scott Wood4b919722012-09-20 16:35:21 -05003313 CONFIG_SPL_INIT_MINIMAL
3314 Arch init code should be built for a very small image
3315
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003316 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3317 Partition on the MMC to load U-Boot from when the MMC is being
3318 used in raw mode
3319
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003320 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3321 Sector to load kernel uImage from when MMC is being
3322 used in raw mode (for Falcon mode)
3323
3324 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3325 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3326 Sector and number of sectors to load kernel argument
3327 parameters from when MMC is being used in raw mode
3328 (for falcon mode)
3329
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003330 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3331 Partition on the MMC to load U-Boot from when the MMC is being
3332 used in fs mode
3333
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003334 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3335 Filename to read to load U-Boot when reading from filesystem
3336
3337 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003338 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003339 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003340
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003341 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003342 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003343 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003344
Scott Wood06f60ae2012-12-06 13:33:17 +00003345 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3346 Set this for NAND SPL on PPC mpc83xx targets, so that
3347 start.S waits for the rest of the SPL to load before
3348 continuing (the hardware starts execution after just
3349 loading the first page rather than the full 4K).
3350
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303351 CONFIG_SPL_SKIP_RELOCATE
3352 Avoid SPL relocation
3353
Scott Wood6f2f01b2012-09-20 19:09:07 -05003354 CONFIG_SPL_NAND_BASE
3355 Include nand_base.c in the SPL. Requires
3356 CONFIG_SPL_NAND_DRIVERS.
3357
3358 CONFIG_SPL_NAND_DRIVERS
3359 SPL uses normal NAND drivers, not minimal drivers.
3360
3361 CONFIG_SPL_NAND_ECC
3362 Include standard software ECC in the SPL
3363
Tom Rini95579792012-02-14 07:29:40 +00003364 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003365 Support for NAND boot using simple NAND drivers that
3366 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003367
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02003368 CONFIG_SPL_UBI
3369 Support for a lightweight UBI (fastmap) scanner and
3370 loader
3371
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003372 CONFIG_SPL_NAND_RAW_ONLY
3373 Support to boot only raw u-boot.bin images. Use this only
3374 if you need to save space.
3375
Ying Zhang7c8eea52013-08-16 15:16:12 +08003376 CONFIG_SPL_COMMON_INIT_DDR
3377 Set for common ddr init with serial presence detect in
3378 SPL binary.
3379
Tom Rini95579792012-02-14 07:29:40 +00003380 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3381 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3382 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3383 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3384 CONFIG_SYS_NAND_ECCBYTES
3385 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003386 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003387
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303388 CONFIG_SPL_NAND_BOOT
3389 Add support NAND boot
3390
Tom Rini95579792012-02-14 07:29:40 +00003391 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003392 Location in NAND to read U-Boot from
3393
3394 CONFIG_SYS_NAND_U_BOOT_DST
3395 Location in memory to load U-Boot to
3396
3397 CONFIG_SYS_NAND_U_BOOT_SIZE
3398 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003399
3400 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003401 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003402
3403 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3404 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003405 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003406
3407 CONFIG_SPL_OMAP3_ID_NAND
3408 Support for an OMAP3-specific set of functions to return the
3409 ID and MFR of the first attached NAND chip, if present.
3410
Pavel Machekc57b9532012-08-30 22:42:11 +02003411 CONFIG_SPL_RAM_DEVICE
3412 Support for running image already present in ram, in SPL binary
3413
Scott Wood74752ba2012-12-06 13:33:16 +00003414 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003415 Image offset to which the SPL should be padded before appending
3416 the SPL payload. By default, this is defined as
3417 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3418 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3419 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003420
Scott Woodca2fca22012-09-21 16:27:32 -05003421 CONFIG_SPL_TARGET
3422 Final target image containing SPL and payload. Some SPLs
3423 use an arch-specific makefile fragment instead, for
3424 example if more than one image needs to be produced.
3425
Simon Glass87ebee32013-05-08 08:05:59 +00003426 CONFIG_FIT_SPL_PRINT
3427 Printing information about a FIT image adds quite a bit of
3428 code to SPL. So this is normally disabled in SPL. Use this
3429 option to re-enable it. This will affect the output of the
3430 bootm command when booting a FIT image.
3431
Ying Zhang3aa29de2013-08-16 15:16:15 +08003432- TPL framework
3433 CONFIG_TPL
3434 Enable building of TPL globally.
3435
3436 CONFIG_TPL_PAD_TO
3437 Image offset to which the TPL should be padded before appending
3438 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003439 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3440 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3441 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003442
wdenka8c7c702003-12-06 19:49:23 +00003443- Interrupt support (PPC):
3444
wdenkd4ca31c2004-01-02 14:00:00 +00003445 There are common interrupt_init() and timer_interrupt()
3446 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003447 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003448 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003449 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003450 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003451 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003452 specific handling. If board has watchdog / status_led
3453 / other_activity_monitor it works automatically from
3454 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003455
wdenkc6097192002-11-03 00:24:07 +00003456
Helmut Raiger9660e442011-10-20 04:19:47 +00003457Board initialization settings:
3458------------------------------
3459
3460During Initialization u-boot calls a number of board specific functions
3461to allow the preparation of board specific prerequisites, e.g. pin setup
3462before drivers are initialized. To enable these callbacks the
3463following configuration macros have to be defined. Currently this is
3464architecture specific, so please check arch/your_architecture/lib/board.c
3465typically in board_init_f() and board_init_r().
3466
3467- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3468- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3469- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3470- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003471
wdenkc6097192002-11-03 00:24:07 +00003472Configuration Settings:
3473-----------------------
3474
York Sun4d1fd7f2014-02-26 17:03:19 -08003475- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3476 Optionally it can be defined to support 64-bit memory commands.
3477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003478- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003479 undefine this when you're short of memory.
3480
Peter Tyser2fb26042009-01-27 18:03:12 -06003481- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3482 width of the commands listed in the 'help' command output.
3483
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003484- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003485 prompt for user input.
3486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003487- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003489- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003491- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003493- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003494 the application (usually a Linux kernel) when it is
3495 booted
3496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003497- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003498 List of legal baudrate settings for this board.
3499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003500- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003501 Begin and End addresses of the area used by the
3502 simple memory test.
3503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003504- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003505 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003506
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003507- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003508 Scratch address used by the alternate memory test
3509 You only need to set this if address zero isn't writeable
3510
York Sune8149522015-12-04 11:57:07 -08003511- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003512 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003513 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3514 is substracted from total RAM and won't be reported to OS.
3515 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003516 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003517 the RAM base is not zero, or RAM is divided into banks,
3518 this variable needs to be recalcuated to get the address.
3519
York Sunaabd7dd2015-12-07 11:05:29 -08003520- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003521 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003522 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003523 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003524 fixing up gd->ram_size the Linux kernel should gets passed
3525 the now "corrected" memory size and won't touch it either.
3526 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003527 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003528 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003529 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003530
3531 This option can be used as a workaround for the 440EPx/GRx
3532 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3533 be touched.
3534
3535 WARNING: Please make sure that this value is a multiple of
3536 the Linux page size (normally 4k). If this is not the case,
3537 then the end address of the Linux memory will be located at a
3538 non page size aligned address and this could cause major
3539 problems.
3540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003541- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003542 Enable temporary baudrate change while serial download
3543
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003544- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003545 Physical start address of SDRAM. _Must_ be 0 here.
3546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003547- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003548 Physical start address of Flash memory.
3549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003550- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003551 Physical start address of boot monitor code (set by
3552 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003553 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003554 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003557 Size of memory reserved for monitor code, used to
3558 determine _at_compile_time_ (!) if the environment is
3559 embedded within the U-Boot image, or in a separate
3560 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003562- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003563 Size of DRAM reserved for malloc() use.
3564
Simon Glassd59476b2014-07-10 22:23:28 -06003565- CONFIG_SYS_MALLOC_F_LEN
3566 Size of the malloc() pool for use before relocation. If
3567 this is defined, then a very simple malloc() implementation
3568 will become available before relocation. The address is just
3569 below the global data, and the stack is moved down to make
3570 space.
3571
3572 This feature allocates regions with increasing addresses
3573 within the region. calloc() is supported, but realloc()
3574 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003575 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003576 U-Boot relocates itself.
3577
Simon Glass38687ae2014-11-10 17:16:54 -07003578- CONFIG_SYS_MALLOC_SIMPLE
3579 Provides a simple and small malloc() and calloc() for those
3580 boards which do not use the full malloc in SPL (which is
3581 enabled with CONFIG_SYS_SPL_MALLOC_START).
3582
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003583- CONFIG_SYS_NONCACHED_MEMORY:
3584 Size of non-cached memory area. This area of memory will be
3585 typically located right below the malloc() area and mapped
3586 uncached in the MMU. This is useful for drivers that would
3587 otherwise require a lot of explicit cache maintenance. For
3588 some drivers it's also impossible to properly maintain the
3589 cache. For example if the regions that need to be flushed
3590 are not a multiple of the cache-line size, *and* padding
3591 cannot be allocated between the regions to align them (i.e.
3592 if the HW requires a contiguous array of regions, and the
3593 size of each region is not cache-aligned), then a flush of
3594 one region may result in overwriting data that hardware has
3595 written to another region in the same cache-line. This can
3596 happen for example in network drivers where descriptors for
3597 buffers are typically smaller than the CPU cache-line (e.g.
3598 16 bytes vs. 32 or 64 bytes).
3599
3600 Non-cached memory is only supported on 32-bit ARM at present.
3601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003602- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003603 Normally compressed uImages are limited to an
3604 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003605 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003606 to adjust this setting to your needs.
3607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003608- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003609 Maximum size of memory mapped by the startup code of
3610 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003611 the Linux kernel (bd_info, boot arguments, FDT blob if
3612 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003613 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003614 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003615 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003616 variable "bootm_mapsize" will override the value of
3617 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3618 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003619
John Rigbyfca43cc2010-10-13 13:57:35 -06003620- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3621 Enable initrd_high functionality. If defined then the
3622 initrd_high feature is enabled and the bootm ramdisk subcommand
3623 is enabled.
3624
3625- CONFIG_SYS_BOOT_GET_CMDLINE:
3626 Enables allocating and saving kernel cmdline in space between
3627 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3628
3629- CONFIG_SYS_BOOT_GET_KBD:
3630 Enables allocating and saving a kernel copy of the bd_info in
3631 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003633- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003634 Max number of Flash memory banks
3635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003636- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003637 Max number of sectors on a Flash chip
3638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003639- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003640 Timeout for Flash erase operations (in ms)
3641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003642- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003643 Timeout for Flash write operations (in ms)
3644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003645- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003646 Timeout for Flash set sector lock bit operation (in ms)
3647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003648- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003649 Timeout for Flash clear lock bits operation (in ms)
3650
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003651- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003652 If defined, hardware flash sectors protection is used
3653 instead of U-Boot software protection.
3654
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003655- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003656
3657 Enable TFTP transfers directly to flash memory;
3658 without this option such a download has to be
3659 performed in two steps: (1) download to RAM, and (2)
3660 copy from RAM to flash.
3661
3662 The two-step approach is usually more reliable, since
3663 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003664 the flash, but in some situations (when system RAM is
3665 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003666 downloaded image) this option may be very useful.
3667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003668- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003669 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003670 common flash structure for storing flash geometry.
3671
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003672- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003673 This option also enables the building of the cfi_flash driver
3674 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003675
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003676- CONFIG_FLASH_CFI_MTD
3677 This option enables the building of the cfi_mtd driver
3678 in the drivers directory. The driver exports CFI flash
3679 to the MTD layer.
3680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003681- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003682 Use buffered writes to flash.
3683
3684- CONFIG_FLASH_SPANSION_S29WS_N
3685 s29ws-n MirrorBit flash has non-standard addresses for buffered
3686 write commands.
3687
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003688- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003689 If this option is defined, the common CFI flash doesn't
3690 print it's warning upon not recognized FLASH banks. This
3691 is useful, if some of the configured banks are only
3692 optionally available.
3693
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003694- CONFIG_FLASH_SHOW_PROGRESS
3695 If defined (must be an integer), print out countdown
3696 digits and dots. Recommended value: 45 (9..1) for 80
3697 column displays, 15 (3..1) for 40 column displays.
3698
Stefan Roese352ef3f2013-04-04 15:53:14 +02003699- CONFIG_FLASH_VERIFY
3700 If defined, the content of the flash (destination) is compared
3701 against the source after the write operation. An error message
3702 will be printed when the contents are not identical.
3703 Please note that this option is useless in nearly all cases,
3704 since such flash programming errors usually are detected earlier
3705 while unprotecting/erasing/programming. Please only enable
3706 this option if you really know what you are doing.
3707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003708- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003709 Defines the number of Ethernet receive buffers. On some
3710 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003711 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3712 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003713 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003714 Defaults to 4 if not defined.
3715
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003716- CONFIG_ENV_MAX_ENTRIES
3717
Wolfgang Denk071bc922010-10-27 22:48:30 +02003718 Maximum number of entries in the hash table that is used
3719 internally to store the environment settings. The default
3720 setting is supposed to be generous and should work in most
3721 cases. This setting can be used to tune behaviour; see
3722 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003723
Joe Hershberger25980902012-12-11 22:16:31 -06003724- CONFIG_ENV_FLAGS_LIST_DEFAULT
3725- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003726 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003727 calling env set. Variables can be restricted to only decimal,
3728 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3729 the variables can also be restricted to IP address or MAC address.
3730
3731 The format of the list is:
3732 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003733 access_attribute = [a|r|o|c]
3734 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003735 entry = variable_name[:attributes]
3736 list = entry[,list]
3737
3738 The type attributes are:
3739 s - String (default)
3740 d - Decimal
3741 x - Hexadecimal
3742 b - Boolean ([1yYtT|0nNfF])
3743 i - IP address
3744 m - MAC address
3745
Joe Hershberger267541f2012-12-11 22:16:34 -06003746 The access attributes are:
3747 a - Any (default)
3748 r - Read-only
3749 o - Write-once
3750 c - Change-default
3751
Joe Hershberger25980902012-12-11 22:16:31 -06003752 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3753 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003754 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06003755
3756 - CONFIG_ENV_FLAGS_LIST_STATIC
3757 Define this to a list (string) to define validation that
3758 should be done if an entry is not found in the ".flags"
3759 environment variable. To override a setting in the static
3760 list, simply add an entry for the same variable name to the
3761 ".flags" variable.
3762
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05003763 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3764 regular expression. This allows multiple variables to define the same
3765 flags without explicitly listing them for each variable.
3766
Joe Hershberger267541f2012-12-11 22:16:34 -06003767- CONFIG_ENV_ACCESS_IGNORE_FORCE
3768 If defined, don't allow the -f switch to env set override variable
3769 access flags.
3770
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003771- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3772 This is set by OMAP boards for the max time that reset should
3773 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003774 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003775
Gabe Black0d296cc2014-10-15 04:38:30 -06003776- CONFIG_USE_STDINT
3777 If stdint.h is available with your toolchain you can define this
3778 option to enable it. You can provide option 'USE_STDINT=1' when
3779 building U-Boot to enable this.
3780
wdenkc6097192002-11-03 00:24:07 +00003781The following definitions that deal with the placement and management
3782of environment data (variable area); in general, we support the
3783following configurations:
3784
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003785- CONFIG_BUILD_ENVCRC:
3786
3787 Builds up envcrc with the target environment so that external utils
3788 may easily extract it and embed it in final U-Boot images.
3789
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003790- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003791
3792 Define this if the environment is in flash memory.
3793
3794 a) The environment occupies one whole flash sector, which is
3795 "embedded" in the text segment with the U-Boot code. This
3796 happens usually with "bottom boot sector" or "top boot
3797 sector" type flash chips, which have several smaller
3798 sectors at the start or the end. For instance, such a
3799 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3800 such a case you would place the environment in one of the
3801 4 kB sectors - with U-Boot code before and after it. With
3802 "top boot sector" type flash chips, you would put the
3803 environment in one of the last sectors, leaving a gap
3804 between U-Boot and the environment.
3805
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003806 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003807
3808 Offset of environment data (variable area) to the
3809 beginning of flash memory; for instance, with bottom boot
3810 type flash chips the second sector can be used: the offset
3811 for this sector is given here.
3812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003813 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003814
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003815 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003816
3817 This is just another way to specify the start address of
3818 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003819 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003820
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003821 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003822
3823 Size of the sector containing the environment.
3824
3825
3826 b) Sometimes flash chips have few, equal sized, BIG sectors.
3827 In such a case you don't want to spend a whole sector for
3828 the environment.
3829
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003830 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003831
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003832 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003833 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003834 of this flash sector for the environment. This saves
3835 memory for the RAM copy of the environment.
3836
3837 It may also save flash memory if you decide to use this
3838 when your environment is "embedded" within U-Boot code,
3839 since then the remainder of the flash sector could be used
3840 for U-Boot code. It should be pointed out that this is
3841 STRONGLY DISCOURAGED from a robustness point of view:
3842 updating the environment in flash makes it always
3843 necessary to erase the WHOLE sector. If something goes
3844 wrong before the contents has been restored from a copy in
3845 RAM, your target system will be dead.
3846
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003847 - CONFIG_ENV_ADDR_REDUND
3848 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk43d96162003-03-06 00:02:04 +00003850 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003851 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003852 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003853 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003854
3855BE CAREFUL! Any changes to the flash layout, and some changes to the
3856source code will make it necessary to adapt <board>/u-boot.lds*
3857accordingly!
3858
3859
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003860- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003861
3862 Define this if you have some non-volatile memory device
3863 (NVRAM, battery buffered SRAM) which you want to use for the
3864 environment.
3865
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003866 - CONFIG_ENV_ADDR:
3867 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003868
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003869 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003870 want to use for environment. It is assumed that this memory
3871 can just be read and written to, without any special
3872 provision.
3873
3874BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003875in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003876console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003877U-Boot will hang.
3878
3879Please note that even with NVRAM we still use a copy of the
3880environment in RAM: we could work on NVRAM directly, but we want to
3881keep settings there always unmodified except somebody uses "saveenv"
3882to save the current settings.
3883
3884
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003885- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003886
3887 Use this if you have an EEPROM or similar serial access
3888 device and a driver for it.
3889
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003890 - CONFIG_ENV_OFFSET:
3891 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003892
3893 These two #defines specify the offset and size of the
3894 environment area within the total memory of your EEPROM.
3895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003896 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003897 If defined, specified the chip address of the EEPROM device.
3898 The default address is zero.
3899
Christian Gmeiner189d2572015-02-11 15:19:31 +01003900 - CONFIG_SYS_I2C_EEPROM_BUS:
3901 If defined, specified the i2c bus of the EEPROM device.
3902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003903 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003904 If defined, the number of bits used to address bytes in a
3905 single page in the EEPROM device. A 64 byte page, for example
3906 would require six bits.
3907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003908 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003909 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003910 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003912 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003913 The length in bytes of the EEPROM memory array address. Note
3914 that this is NOT the chip address length!
3915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003917 EEPROM chips that implement "address overflow" are ones
3918 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3919 address and the extra bits end up in the "chip address" bit
3920 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3921 byte chips.
3922
3923 Note that we consider the length of the address field to
3924 still be one byte because the extra address bits are hidden
3925 in the chip address.
3926
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003927 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003928 The size in bytes of the EEPROM device.
3929
Heiko Schocher548738b2010-01-07 08:55:40 +01003930 - CONFIG_ENV_EEPROM_IS_ON_I2C
3931 define this, if you have I2C and SPI activated, and your
3932 EEPROM, which holds the environment, is on the I2C bus.
3933
3934 - CONFIG_I2C_ENV_EEPROM_BUS
3935 if you have an Environment on an EEPROM reached over
3936 I2C muxes, you can define here, how to reach this
3937 EEPROM. For example:
3938
Heiko Schocherea818db2013-01-29 08:53:15 +01003939 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003940
3941 EEPROM which holds the environment, is reached over
3942 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003943
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003944- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003945
wdenkd4ca31c2004-01-02 14:00:00 +00003946 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003947 want to use for the environment.
3948
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003949 - CONFIG_ENV_OFFSET:
3950 - CONFIG_ENV_ADDR:
3951 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003952
3953 These three #defines specify the offset and size of the
3954 environment area within the total memory of your DataFlash placed
3955 at the specified address.
3956
Wu, Joshbd83b592014-07-01 19:30:13 +08003957- CONFIG_ENV_IS_IN_SPI_FLASH:
3958
3959 Define this if you have a SPI Flash memory device which you
3960 want to use for the environment.
3961
3962 - CONFIG_ENV_OFFSET:
3963 - CONFIG_ENV_SIZE:
3964
3965 These two #defines specify the offset and size of the
3966 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3967 aligned to an erase sector boundary.
3968
3969 - CONFIG_ENV_SECT_SIZE:
3970
3971 Define the SPI flash's sector size.
3972
3973 - CONFIG_ENV_OFFSET_REDUND (optional):
3974
3975 This setting describes a second storage area of CONFIG_ENV_SIZE
3976 size used to hold a redundant copy of the environment data, so
3977 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06003978 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Joshbd83b592014-07-01 19:30:13 +08003979 aligned to an erase sector boundary.
3980
3981 - CONFIG_ENV_SPI_BUS (optional):
3982 - CONFIG_ENV_SPI_CS (optional):
3983
3984 Define the SPI bus and chip select. If not defined they will be 0.
3985
3986 - CONFIG_ENV_SPI_MAX_HZ (optional):
3987
3988 Define the SPI max work clock. If not defined then use 1MHz.
3989
3990 - CONFIG_ENV_SPI_MODE (optional):
3991
3992 Define the SPI work mode. If not defined then use SPI_MODE_3.
3993
Liu Gang0a85a9e2012-03-08 00:33:20 +00003994- CONFIG_ENV_IS_IN_REMOTE:
3995
3996 Define this if you have a remote memory space which you
3997 want to use for the local device's environment.
3998
3999 - CONFIG_ENV_ADDR:
4000 - CONFIG_ENV_SIZE:
4001
4002 These two #defines specify the address and size of the
4003 environment area within the remote memory space. The
4004 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004005 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004006
4007BE CAREFUL! For some special cases, the local device can not use
4008"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004009environment stored in a remote NOR flash by SRIO or PCIE link,
4010but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004011
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004012- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004013
4014 Define this if you have a NAND device which you want to use
4015 for the environment.
4016
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004017 - CONFIG_ENV_OFFSET:
4018 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004019
4020 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004021 area within the first NAND device. CONFIG_ENV_OFFSET must be
4022 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004023
Scott Woodfdd813d2010-09-17 14:38:37 -05004024 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004025
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004026 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004027 size used to hold a redundant copy of the environment data, so
4028 that there is a valid backup copy in case there is a power failure
Simon Glass9dd05fb2016-10-02 18:00:58 -06004029 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004030 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004031
Scott Woodfdd813d2010-09-17 14:38:37 -05004032 - CONFIG_ENV_RANGE (optional):
4033
4034 Specifies the length of the region in which the environment
4035 can be written. This should be a multiple of the NAND device's
4036 block size. Specifying a range with more erase blocks than
4037 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4038 the range to be avoided.
4039
4040 - CONFIG_ENV_OFFSET_OOB (optional):
4041
4042 Enables support for dynamically retrieving the offset of the
4043 environment from block zero's out-of-band data. The
4044 "nand env.oob" command can be used to record this offset.
4045 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4046 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004047
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004048- CONFIG_NAND_ENV_DST
4049
4050 Defines address in RAM to which the nand_spl code should copy the
4051 environment. If redundant environment is used, it will be copied to
4052 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4053
Joe Hershberger2b744332013-04-08 10:32:51 +00004054- CONFIG_ENV_IS_IN_UBI:
4055
4056 Define this if you have an UBI volume that you want to use for the
4057 environment. This has the benefit of wear-leveling the environment
4058 accesses, which is important on NAND.
4059
4060 - CONFIG_ENV_UBI_PART:
4061
4062 Define this to a string that is the mtd partition containing the UBI.
4063
4064 - CONFIG_ENV_UBI_VOLUME:
4065
4066 Define this to the name of the volume that you want to store the
4067 environment in.
4068
Joe Hershberger785881f2013-04-08 10:32:52 +00004069 - CONFIG_ENV_UBI_VOLUME_REDUND:
4070
4071 Define this to the name of another volume to store a second copy of
4072 the environment in. This will enable redundant environments in UBI.
4073 It is assumed that both volumes are in the same MTD partition.
4074
Joe Hershberger2b744332013-04-08 10:32:51 +00004075 - CONFIG_UBI_SILENCE_MSG
4076 - CONFIG_UBIFS_SILENCE_MSG
4077
4078 You will probably want to define these to avoid a really noisy system
4079 when storing the env in UBI.
4080
Wu, Joshd1db76f2014-06-24 17:31:03 +08004081- CONFIG_ENV_IS_IN_FAT:
4082 Define this if you want to use the FAT file system for the environment.
4083
4084 - FAT_ENV_INTERFACE:
4085
4086 Define this to a string that is the name of the block device.
4087
Nicolae Rosia41987782016-11-21 17:33:58 +02004088 - FAT_ENV_DEVICE_AND_PART:
Wu, Joshd1db76f2014-06-24 17:31:03 +08004089
4090 Define this to a string to specify the partition of the device. It can
4091 be as following:
4092
4093 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4094 - "D:P": device D partition P. Error occurs if device D has no
4095 partition table.
4096 - "D:0": device D.
4097 - "D" or "D:": device D partition 1 if device D has partition
4098 table, or the whole device D if has no partition
4099 table.
4100 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004101 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004102 partition table then means device D.
4103
4104 - FAT_ENV_FILE:
4105
4106 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004107 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004108
4109 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004110 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004111
Stephen Warren06e4ae52013-06-11 15:14:00 -06004112- CONFIG_ENV_IS_IN_MMC:
4113
4114 Define this if you have an MMC device which you want to use for the
4115 environment.
4116
4117 - CONFIG_SYS_MMC_ENV_DEV:
4118
4119 Specifies which MMC device the environment is stored in.
4120
4121 - CONFIG_SYS_MMC_ENV_PART (optional):
4122
4123 Specifies which MMC partition the environment is stored in. If not
4124 set, defaults to partition 0, the user area. Common values might be
4125 1 (first MMC boot partition), 2 (second MMC boot partition).
4126
4127 - CONFIG_ENV_OFFSET:
4128 - CONFIG_ENV_SIZE:
4129
4130 These two #defines specify the offset and size of the environment
4131 area within the specified MMC device.
4132
Stephen Warren5c088ee2013-06-11 15:14:02 -06004133 If offset is positive (the usual case), it is treated as relative to
4134 the start of the MMC partition. If offset is negative, it is treated
4135 as relative to the end of the MMC partition. This can be useful if
4136 your board may be fitted with different MMC devices, which have
4137 different sizes for the MMC partitions, and you always want the
4138 environment placed at the very end of the partition, to leave the
4139 maximum possible space before it, to store other data.
4140
Stephen Warren06e4ae52013-06-11 15:14:00 -06004141 These two values are in units of bytes, but must be aligned to an
4142 MMC sector boundary.
4143
4144 - CONFIG_ENV_OFFSET_REDUND (optional):
4145
4146 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4147 hold a redundant copy of the environment data. This provides a
4148 valid backup copy in case the other copy is corrupted, e.g. due
4149 to a power failure during a "saveenv" operation.
4150
Stephen Warren5c088ee2013-06-11 15:14:02 -06004151 This value may also be positive or negative; this is handled in the
4152 same way as CONFIG_ENV_OFFSET.
4153
Stephen Warren06e4ae52013-06-11 15:14:00 -06004154 This value is also in units of bytes, but must also be aligned to
4155 an MMC sector boundary.
4156
4157 - CONFIG_ENV_SIZE_REDUND (optional):
4158
4159 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4160 set. If this value is set, it must be set to the same value as
4161 CONFIG_ENV_SIZE.
4162
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004163- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004164
4165 Defines offset to the initial SPI buffer area in DPRAM. The
4166 area is used at an early stage (ROM part) if the environment
4167 is configured to reside in the SPI EEPROM: We need a 520 byte
4168 scratch DPRAM area. It is used between the two initialization
4169 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4170 to be a good choice since it makes it far enough from the
4171 start of the data area as well as from the stack pointer.
4172
Bruce Adlere881cb52007-11-02 13:15:42 -07004173Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004174has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004175created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004176until then to read environment variables.
4177
wdenk85ec0bc2003-03-31 16:34:49 +00004178The environment is protected by a CRC32 checksum. Before the monitor
4179is relocated into RAM, as a result of a bad CRC you will be working
4180with the compiled-in default environment - *silently*!!! [This is
4181necessary, because the first environment variable we need is the
4182"baudrate" setting for the console - if we have a bad CRC, we don't
4183have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004184
4185Note: once the monitor has been relocated, then it will complain if
4186the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004187use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004188
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004189- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004190 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004191
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004192 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004193 also needs to be defined.
4194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004195- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004196 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004197
Ron Madridf5675aa2009-02-18 14:30:44 -08004198- CONFIG_NS16550_MIN_FUNCTIONS:
4199 Define this if you desire to only have use of the NS16550_init
4200 and NS16550_putc functions for the serial driver located at
4201 drivers/serial/ns16550.c. This option is useful for saving
4202 space for already greatly restricted images, including but not
4203 limited to NAND_SPL configurations.
4204
Simon Glassb2b92f52012-11-30 13:01:18 +00004205- CONFIG_DISPLAY_BOARDINFO
4206 Display information about the board that U-Boot is running on
4207 when U-Boot starts up. The board function checkboard() is called
4208 to do this.
4209
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004210- CONFIG_DISPLAY_BOARDINFO_LATE
4211 Similar to the previous option, but display this information
4212 later, once stdio is running and output goes to the LCD, if
4213 present.
4214
Sascha Silbefeb85802013-08-11 16:40:43 +02004215- CONFIG_BOARD_SIZE_LIMIT:
4216 Maximum size of the U-Boot image. When defined, the
4217 build system checks that the actual size does not
4218 exceed it.
4219
wdenkc6097192002-11-03 00:24:07 +00004220Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004221---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004223- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004224 Cache Line Size of the CPU.
4225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004226- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004227 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004228
wdenk42d1f032003-10-15 23:53:47 +00004229 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4230 and RPXsuper) to be able to adjust the position of
4231 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004232
Timur Tabie46fedf2011-08-04 18:03:41 -05004233- CONFIG_SYS_CCSRBAR_DEFAULT:
4234 Default (power-on reset) physical address of CCSR on Freescale
4235 PowerPC SOCs.
4236
4237- CONFIG_SYS_CCSRBAR:
4238 Virtual address of CCSR. On a 32-bit build, this is typically
4239 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4240
4241 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4242 for cross-platform code that uses that macro instead.
4243
4244- CONFIG_SYS_CCSRBAR_PHYS:
4245 Physical address of CCSR. CCSR can be relocated to a new
4246 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004247 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004248 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4249 is typically relocated on 36-bit builds. It is recommended
4250 that this macro be defined via the _HIGH and _LOW macros:
4251
4252 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4253 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4254
4255- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004256 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4257 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004258 used in assembly code, so it must not contain typecasts or
4259 integer size suffixes (e.g. "ULL").
4260
4261- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4262 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4263 used in assembly code, so it must not contain typecasts or
4264 integer size suffixes (e.g. "ULL").
4265
4266- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4267 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4268 forced to a value that ensures that CCSR is not relocated.
4269
wdenk7f6c2cb2002-11-10 22:06:23 +00004270- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004271 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004272
4273 the default drive number (default value 0)
4274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004275 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004276
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004277 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004278 (default value 1)
4279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004280 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004281
wdenk43d96162003-03-06 00:02:04 +00004282 defines the offset of register from address. It
4283 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004284 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004286 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4287 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004288 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004290 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004291 fdc_hw_init() is called at the beginning of the FDC
4292 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004293 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004294 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004295
Macpaul Lin0abddf82011-04-11 20:45:32 +00004296- CONFIG_IDE_AHB:
4297 Most IDE controllers were designed to be connected with PCI
4298 interface. Only few of them were designed for AHB interface.
4299 When software is doing ATA command and data transfer to
4300 IDE devices through IDE-AHB controller, some additional
4301 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004302 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004304- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004305 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004306 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004308- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk7152b1d2003-09-05 23:19:14 +00004310 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004311 initial data and stack; please note that this must be
4312 writable memory that is working WITHOUT special
4313 initialization, i. e. you CANNOT use normal RAM which
4314 will become available only after programming the
4315 memory controller and running certain initialization
4316 sequences.
4317
4318 U-Boot uses the following memory types:
4319 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4320 - MPC824X: data cache
4321 - PPC4xx: data cache
4322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004323- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004324
4325 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004326 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4327 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004328 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004329 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glassacd51f92016-10-02 18:01:06 -06004330 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004331 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4332 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004333
4334 Note:
4335 On the MPC824X (or other systems that use the data
4336 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004337 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004338 point to an otherwise UNUSED address space between
4339 the top of RAM and the start of the PCI space.
4340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004341- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004342
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004343- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004345- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004347- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004349- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004351- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004353- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004354 SDRAM timing
4355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004356- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004357 periodic timer for refresh
4358
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004359- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004361- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4362 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4363 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4364 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004365 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4366
4367- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004368 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4369 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004370 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4371
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004372- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4373 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004374 Machine Mode Register and Memory Periodic Timer
4375 Prescaler definitions (SDRAM timing)
4376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004377- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004378 enable I2C microcode relocation patch (MPC8xx);
4379 define relocation offset in DPRAM [DSP2]
4380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004381- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004382 enable SMC microcode relocation patch (MPC8xx);
4383 define relocation offset in DPRAM [SMC1]
4384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004385- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004386 enable SPI microcode relocation patch (MPC8xx);
4387 define relocation offset in DPRAM [SCC4]
4388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004389- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004390 Offset of the bootmode word in DPRAM used by post
4391 (Power On Self Tests). This definition overrides
4392 #define'd default value in commproc.h resp.
4393 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004395- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4396 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4397 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4398 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4399 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4400 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4401 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4402 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004403 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004404
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004405- CONFIG_PCI_DISABLE_PCIE:
4406 Disable PCI-Express on systems where it is supported but not
4407 required.
4408
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004409- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004410 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004411 Don't do any setup work, presumably because someone or
4412 something has already done it, and we don't need to do it
4413 a second time. Useful for platforms that are pre-booted
4414 by coreboot or similar.
4415
Gabor Juhos842033e2013-05-30 07:06:12 +00004416- CONFIG_PCI_INDIRECT_BRIDGE:
4417 Enable support for indirect PCI bridges.
4418
Kumar Galaa09b9b62010-12-30 12:09:53 -06004419- CONFIG_SYS_SRIO:
4420 Chip has SRIO or not
4421
4422- CONFIG_SRIO1:
4423 Board has SRIO 1 port available
4424
4425- CONFIG_SRIO2:
4426 Board has SRIO 2 port available
4427
Liu Gangc8b28152013-05-07 16:30:46 +08004428- CONFIG_SRIO_PCIE_BOOT_MASTER
4429 Board can support master function for Boot from SRIO and PCIE
4430
Kumar Galaa09b9b62010-12-30 12:09:53 -06004431- CONFIG_SYS_SRIOn_MEM_VIRT:
4432 Virtual Address of SRIO port 'n' memory region
4433
4434- CONFIG_SYS_SRIOn_MEM_PHYS:
4435 Physical Address of SRIO port 'n' memory region
4436
4437- CONFIG_SYS_SRIOn_MEM_SIZE:
4438 Size of SRIO port 'n' memory region
4439
Fabio Estevam66bd1842013-04-11 09:35:34 +00004440- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4441 Defined to tell the NAND controller that the NAND chip is using
4442 a 16 bit bus.
4443 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004444 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004445 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004446 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004447
4448- CONFIG_SYS_NDFC_EBC0_CFG
4449 Sets the EBC0_CFG register for the NDFC. If not defined
4450 a default value will be used.
4451
Ben Warrenbb99ad62006-09-07 16:50:54 -04004452- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004453 Get DDR timing information from an I2C EEPROM. Common
4454 with pluggable memory modules such as SODIMMs
4455
Ben Warrenbb99ad62006-09-07 16:50:54 -04004456 SPD_EEPROM_ADDRESS
4457 I2C address of the SPD EEPROM
4458
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004459- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004460 If SPD EEPROM is on an I2C bus other than the first
4461 one, specify here. Note that the value must resolve
4462 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004463
York Sun1b3e3c42011-06-07 09:42:16 +08004464- CONFIG_SYS_DDR_RAW_TIMING
4465 Get DDR timing information from other than SPD. Common with
4466 soldered DDR chips onboard without SPD. DDR raw timing
4467 parameters are extracted from datasheet and hard-coded into
4468 header files or board specific files.
4469
York Sun6f5e1dc2011-09-16 13:21:35 -07004470- CONFIG_FSL_DDR_INTERACTIVE
4471 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4472
York Sune32d59a2015-01-06 13:18:55 -08004473- CONFIG_FSL_DDR_SYNC_REFRESH
4474 Enable sync of refresh for multiple controllers.
4475
York Sun4516ff82015-03-19 09:30:28 -07004476- CONFIG_FSL_DDR_BIST
4477 Enable built-in memory test for Freescale DDR controllers.
4478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004479- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004480 Only for 83xx systems. If specified, then DDR should
4481 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004482
wdenkc26e4542004-04-18 10:13:26 +00004483- CONFIG_ETHER_ON_FEC[12]
4484 Define to enable FEC[12] on a 8xx series processor.
4485
4486- CONFIG_FEC[12]_PHY
4487 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004488 to the given FEC; i. e.
4489 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004490 means that the PHY with address 4 is connected to FEC1
4491
4492 When set to -1, means to probe for first available.
4493
4494- CONFIG_FEC[12]_PHY_NORXERR
4495 The PHY does not have a RXERR line (RMII only).
4496 (so program the FEC to ignore it).
4497
4498- CONFIG_RMII
4499 Enable RMII mode for all FECs.
4500 Note that this is a global option, we can't
4501 have one FEC in standard MII mode and another in RMII mode.
4502
wdenk5cf91d62004-04-23 20:32:05 +00004503- CONFIG_CRC32_VERIFY
4504 Add a verify option to the crc32 command.
4505 The syntax is:
4506
4507 => crc32 -v <address> <count> <crc32>
4508
4509 Where address/count indicate a memory area
4510 and crc32 is the correct crc32 which the
4511 area should have.
4512
wdenk56523f12004-07-11 17:40:54 +00004513- CONFIG_LOOPW
4514 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004515 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004516
stroese7b466642004-12-16 18:46:55 +00004517- CONFIG_MX_CYCLIC
4518 Add the "mdc" and "mwc" memory commands. These are cyclic
4519 "md/mw" commands.
4520 Examples:
4521
wdenkefe2a4d2004-12-16 21:44:03 +00004522 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004523 This command will print 4 bytes (10,11,12,13) each 500 ms.
4524
wdenkefe2a4d2004-12-16 21:44:03 +00004525 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004526 This command will write 12345678 to address 100 all 10 ms.
4527
wdenkefe2a4d2004-12-16 21:44:03 +00004528 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004529 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004530
wdenk8aa1a2d2005-04-04 12:44:11 +00004531- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004532 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004533 low level initializations (like setting up the memory
4534 controller) are omitted and/or U-Boot does not
4535 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004536
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004537 Normally this variable MUST NOT be defined. The only
4538 exception is when U-Boot is loaded (to RAM) by some
4539 other boot loader or by a debugger which performs
4540 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004541
Simon Glassb5bd0982016-05-05 07:28:06 -06004542- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4543 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09004544 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06004545 instruction cache) is still performed.
4546
Aneesh V401bb302011-07-13 05:11:07 +00004547- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004548 Modifies the behaviour of start.S when compiling a loader
4549 that is executed before the actual U-Boot. E.g. when
4550 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004551
Ying Zhang3aa29de2013-08-16 15:16:15 +08004552- CONFIG_TPL_BUILD
4553 Modifies the behaviour of start.S when compiling a loader
4554 that is executed after the SPL and before the actual U-Boot.
4555 It is loaded by the SPL.
4556
Ying Zhang5df572f2013-05-20 14:07:23 +08004557- CONFIG_SYS_MPC85XX_NO_RESETVEC
4558 Only for 85xx systems. If this variable is specified, the section
4559 .resetvec is not kept and the section .bootpg is placed in the
4560 previous 4k of the .text section.
4561
Simon Glass4213fc22013-02-24 17:33:14 +00004562- CONFIG_ARCH_MAP_SYSMEM
4563 Generally U-Boot (and in particular the md command) uses
4564 effective address. It is therefore not necessary to regard
4565 U-Boot address as virtual addresses that need to be translated
4566 to physical addresses. However, sandbox requires this, since
4567 it maintains its own little RAM buffer which contains all
4568 addressable memory. This option causes some memory accesses
4569 to be mapped through map_sysmem() / unmap_sysmem().
4570
Simon Glass588a13f2013-02-14 04:18:54 +00004571- CONFIG_X86_RESET_VECTOR
4572 If defined, the x86 reset vector code is included. This is not
4573 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004574
Mark Jacksonfc337052013-03-04 01:27:20 +00004575- CONFIG_SYS_MPUCLK
4576 Defines the MPU clock speed (in MHz).
4577
4578 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004579
Heiko Schocher16678eb2013-11-04 14:05:00 +01004580- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4581 Enables the RTC32K OSC on AM33xx based plattforms
4582
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004583- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4584 Option to disable subpage write in NAND driver
4585 driver that uses this:
4586 drivers/mtd/nand/davinci_nand.c
4587
Timur Tabif2717b42011-11-22 09:21:25 -06004588Freescale QE/FMAN Firmware Support:
4589-----------------------------------
4590
4591The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4592loading of "firmware", which is encoded in the QE firmware binary format.
4593This firmware often needs to be loaded during U-Boot booting, so macros
4594are used to identify the storage device (NOR flash, SPI, etc) and the address
4595within that device.
4596
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004597- CONFIG_SYS_FMAN_FW_ADDR
4598 The address in the storage device where the FMAN microcode is located. The
4599 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4600 is also specified.
4601
4602- CONFIG_SYS_QE_FW_ADDR
4603 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004604 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4605 is also specified.
4606
4607- CONFIG_SYS_QE_FMAN_FW_LENGTH
4608 The maximum possible size of the firmware. The firmware binary format
4609 has a field that specifies the actual size of the firmware, but it
4610 might not be possible to read any part of the firmware unless some
4611 local storage is allocated to hold the entire firmware first.
4612
4613- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4614 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4615 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4616 virtual address in NOR flash.
4617
4618- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4619 Specifies that QE/FMAN firmware is located in NAND flash.
4620 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4621
4622- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4623 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4624 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4625
Liu Gang292dc6c2012-03-08 00:33:18 +00004626- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4627 Specifies that QE/FMAN firmware is located in the remote (master)
4628 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004629 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4630 window->master inbound window->master LAW->the ucode address in
4631 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004632
J. German Riverab940ca62014-06-23 15:15:55 -07004633Freescale Layerscape Management Complex Firmware Support:
4634---------------------------------------------------------
4635The Freescale Layerscape Management Complex (MC) supports the loading of
4636"firmware".
4637This firmware often needs to be loaded during U-Boot booting, so macros
4638are used to identify the storage device (NOR flash, SPI, etc) and the address
4639within that device.
4640
4641- CONFIG_FSL_MC_ENET
4642 Enable the MC driver for Layerscape SoCs.
4643
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304644Freescale Layerscape Debug Server Support:
4645-------------------------------------------
4646The Freescale Layerscape Debug Server Support supports the loading of
4647"Debug Server firmware" and triggering SP boot-rom.
4648This firmware often needs to be loaded during U-Boot booting.
4649
York Sunc0492142015-12-07 11:08:58 -08004650- CONFIG_SYS_MC_RSV_MEM_ALIGN
4651 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304652
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02004653Reproducible builds
4654-------------------
4655
4656In order to achieve reproducible builds, timestamps used in the U-Boot build
4657process have to be set to a fixed value.
4658
4659This is done using the SOURCE_DATE_EPOCH environment variable.
4660SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4661option for U-Boot or an environment variable in U-Boot.
4662
4663SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4664
wdenkc6097192002-11-03 00:24:07 +00004665Building the Software:
4666======================
4667
Wolfgang Denk218ca722008-03-26 10:40:12 +01004668Building U-Boot has been tested in several native build environments
4669and in many different cross environments. Of course we cannot support
4670all possibly existing versions of cross development tools in all
4671(potentially obsolete) versions. In case of tool chain problems we
4672recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4673which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004674
Wolfgang Denk218ca722008-03-26 10:40:12 +01004675If you are not using a native environment, it is assumed that you
4676have GNU cross compiling tools available in your path. In this case,
4677you must set the environment variable CROSS_COMPILE in your shell.
4678Note that no changes to the Makefile or any other source files are
4679necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004680
Wolfgang Denk218ca722008-03-26 10:40:12 +01004681 $ CROSS_COMPILE=ppc_4xx-
4682 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004683
Peter Tyser2f8d3962009-03-13 18:54:51 -05004684Note: If you wish to generate Windows versions of the utilities in
4685 the tools directory you can use the MinGW toolchain
4686 (http://www.mingw.org). Set your HOST tools to the MinGW
4687 toolchain and execute 'make tools'. For example:
4688
4689 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4690
4691 Binaries such as tools/mkimage.exe will be created which can
4692 be executed on computers running Windows.
4693
Wolfgang Denk218ca722008-03-26 10:40:12 +01004694U-Boot is intended to be simple to build. After installing the
4695sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004696is done by typing:
4697
Holger Freytherab584d62014-08-04 09:26:05 +02004698 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004699
Holger Freytherab584d62014-08-04 09:26:05 +02004700where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004701rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703Note: for some board special configuration names may exist; check if
4704 additional information is available from the board vendor; for
4705 instance, the TQM823L systems are available without (standard)
4706 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004707 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004708
Holger Freytherab584d62014-08-04 09:26:05 +02004709 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00004710 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004711
Holger Freytherab584d62014-08-04 09:26:05 +02004712 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00004713 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk2729af92004-05-03 20:45:30 +00004715 etc.
wdenkc6097192002-11-03 00:24:07 +00004716
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718Finally, type "make all", and you should get some working U-Boot
4719images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004720
wdenk2729af92004-05-03 20:45:30 +00004721- "u-boot.bin" is a raw binary image
4722- "u-boot" is an image in ELF binary format
4723- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004724
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004725By default the build is performed locally and the objects are saved
4726in the source directory. One of the two methods can be used to change
4727this behavior and build U-Boot to some external directory:
4728
47291. Add O= to the make command line invocations:
4730
4731 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004732 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004733 make O=/tmp/build all
4734
Timo Ketolaadbba992014-11-06 14:39:05 +020047352. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004736
Timo Ketolaadbba992014-11-06 14:39:05 +02004737 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004738 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02004739 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004740 make all
4741
Timo Ketolaadbba992014-11-06 14:39:05 +02004742Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004743variable.
4744
wdenkc6097192002-11-03 00:24:07 +00004745
wdenk2729af92004-05-03 20:45:30 +00004746Please be aware that the Makefiles assume you are using GNU make, so
4747for instance on NetBSD you might need to use "gmake" instead of
4748native "make".
wdenkc6097192002-11-03 00:24:07 +00004749
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk2729af92004-05-03 20:45:30 +00004751If the system board that you have is not listed, then you will need
4752to port U-Boot to your hardware platform. To do this, follow these
4753steps:
wdenkc6097192002-11-03 00:24:07 +00004754
Phil Sutter3c1496c2015-12-25 14:41:18 +010047551. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00004756 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01004757 the "Makefile" and a "<board>.c".
47582. Create a new configuration file "include/configs/<board>.h" for
4759 your board.
wdenk2729af92004-05-03 20:45:30 +000047603. If you're porting U-Boot to a new CPU, then also create a new
4761 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020047624. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000047635. Type "make", and you should get a working "u-boot.srec" file
4764 to be installed on your target system.
47656. Debug and solve any problems that might arise.
4766 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004767
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk2729af92004-05-03 20:45:30 +00004769Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4770==============================================================
wdenkc6097192002-11-03 00:24:07 +00004771
Wolfgang Denk218ca722008-03-26 10:40:12 +01004772If you have modified U-Boot sources (for instance added a new board
4773or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004774provide feedback to the other developers. The feedback normally takes
4775the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004776official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004777
Wolfgang Denk218ca722008-03-26 10:40:12 +01004778But before you submit such a patch, please verify that your modifi-
4779cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004780the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glass6de80f22016-07-27 20:33:08 -06004781just run the buildman script (tools/buildman/buildman), which will
4782configure and build U-Boot for ALL supported system. Be warned, this
4783will take a while. Please see the buildman README, or run 'buildman -H'
4784for documentation.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004785
4786
wdenk2729af92004-05-03 20:45:30 +00004787See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004788
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790Monitor Commands - Overview:
4791============================
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793go - start application at address 'addr'
4794run - run commands in an environment variable
4795bootm - boot application image from memory
4796bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004797bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004798tftpboot- boot image via network using TFTP protocol
4799 and env variables "ipaddr" and "serverip"
4800 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004801tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004802rarpboot- boot image via network using RARP/TFTP protocol
4803diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4804loads - load S-Record file over serial line
4805loadb - load binary file over serial line (kermit mode)
4806md - memory display
4807mm - memory modify (auto-incrementing)
4808nm - memory modify (constant address)
4809mw - memory write (fill)
4810cp - memory copy
4811cmp - memory compare
4812crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004813i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004814sspi - SPI utility commands
4815base - print or set address offset
4816printenv- print environment variables
4817setenv - set environment variables
4818saveenv - save environment variables to persistent storage
4819protect - enable or disable FLASH write protection
4820erase - erase FLASH memory
4821flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004822nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004823bdinfo - print Board Info structure
4824iminfo - print header information for application image
4825coninfo - print console devices and informations
4826ide - IDE sub-system
4827loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004828loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004829mtest - simple RAM test
4830icache - enable or disable instruction cache
4831dcache - enable or disable data cache
4832reset - Perform RESET of the CPU
4833echo - echo args to console
4834version - print monitor version
4835help - print online help
4836? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004837
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk2729af92004-05-03 20:45:30 +00004839Monitor Commands - Detailed Description:
4840========================================
wdenkc6097192002-11-03 00:24:07 +00004841
wdenk2729af92004-05-03 20:45:30 +00004842TODO.
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004845
4846
wdenk2729af92004-05-03 20:45:30 +00004847Environment Variables:
4848======================
wdenkc6097192002-11-03 00:24:07 +00004849
wdenk2729af92004-05-03 20:45:30 +00004850U-Boot supports user configuration using Environment Variables which
4851can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004852
wdenk2729af92004-05-03 20:45:30 +00004853Environment Variables are set using "setenv", printed using
4854"printenv", and saved to Flash using "saveenv". Using "setenv"
4855without a value can be used to delete a variable from the
4856environment. As long as you don't save the environment you are
4857working with an in-memory copy. In case the Flash area containing the
4858environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004859
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004860Some configuration options can be set using Environment Variables.
4861
4862List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004863
wdenk2729af92004-05-03 20:45:30 +00004864 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk2729af92004-05-03 20:45:30 +00004866 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk2729af92004-05-03 20:45:30 +00004868 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk2729af92004-05-03 20:45:30 +00004870 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004873
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004874 bootm_low - Memory range available for image processing in the bootm
4875 command can be restricted. This variable is given as
4876 a hexadecimal number and defines lowest address allowed
4877 for use by the bootm command. See also "bootm_size"
4878 environment variable. Address defined by "bootm_low" is
4879 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004880 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4881 bootm_mapsize.
4882
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004883 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004884 This variable is given as a hexadecimal number and it
4885 defines the size of the memory region starting at base
4886 address bootm_low that is accessible by the Linux kernel
4887 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4888 as the default value if it is defined, and bootm_size is
4889 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004890
4891 bootm_size - Memory range available for image processing in the bootm
4892 command can be restricted. This variable is given as
4893 a hexadecimal number and defines the size of the region
4894 allowed for use by the bootm command. See also "bootm_low"
4895 environment variable.
4896
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004897 updatefile - Location of the software update file on a TFTP server, used
4898 by the automatic software update feature. Please refer to
4899 documentation in doc/README.update for more details.
4900
wdenk2729af92004-05-03 20:45:30 +00004901 autoload - if set to "no" (any string beginning with 'n'),
4902 "bootp" will just load perform a lookup of the
4903 configuration from the BOOTP server, but not try to
4904 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk2729af92004-05-03 20:45:30 +00004906 autostart - if set to "yes", an image loaded using the "bootp",
4907 "rarpboot", "tftpboot" or "diskboot" commands will
4908 be automatically started (by internally calling
4909 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004910
wdenk2729af92004-05-03 20:45:30 +00004911 If set to "no", a standalone image passed to the
4912 "bootm" command will be copied to the load address
4913 (and eventually uncompressed), but NOT be started.
4914 This can be used to load and uncompress arbitrary
4915 data.
wdenkc6097192002-11-03 00:24:07 +00004916
David A. Longa28afca2011-07-09 16:40:19 -04004917 fdt_high - if set this restricts the maximum address that the
4918 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004919 For example, if you have a system with 1 GB memory
4920 at physical address 0x10000000, while Linux kernel
4921 only recognizes the first 704 MB as low memory, you
4922 may need to set fdt_high as 0x3C000000 to have the
4923 device tree blob be copied to the maximum address
4924 of the 704 MB low memory, so that Linux kernel can
4925 access it during the boot procedure.
4926
David A. Longa28afca2011-07-09 16:40:19 -04004927 If this is set to the special value 0xFFFFFFFF then
4928 the fdt will not be copied at all on boot. For this
4929 to work it must reside in writable memory, have
4930 sufficient padding on the end of it for u-boot to
4931 add the information it needs into it, and the memory
4932 must be accessible by the kernel.
4933
Simon Glasseea63e02011-10-24 19:15:34 +00004934 fdtcontroladdr- if set this is the address of the control flattened
4935 device tree used by U-Boot when CONFIG_OF_CONTROL is
4936 defined.
4937
wdenk17ea1172004-06-06 21:51:03 +00004938 i2cfast - (PPC405GP|PPC405EP only)
4939 if set to 'y' configures Linux I2C driver for fast
4940 mode (400kHZ). This environment variable is used in
4941 initialization code. So, for changes to be effective
4942 it must be saved and board must be reset.
4943
wdenk2729af92004-05-03 20:45:30 +00004944 initrd_high - restrict positioning of initrd images:
4945 If this variable is not set, initrd images will be
4946 copied to the highest possible address in RAM; this
4947 is usually what you want since it allows for
4948 maximum initrd size. If for some reason you want to
4949 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004950 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004951 variable to a value of "no" or "off" or "0".
4952 Alternatively, you can set it to a maximum upper
4953 address to use (U-Boot will still check that it
4954 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004955
wdenk2729af92004-05-03 20:45:30 +00004956 For instance, when you have a system with 16 MB
4957 RAM, and want to reserve 4 MB from use by Linux,
4958 you can do this by adding "mem=12M" to the value of
4959 the "bootargs" variable. However, now you must make
4960 sure that the initrd image is placed in the first
4961 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004962
wdenk2729af92004-05-03 20:45:30 +00004963 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk2729af92004-05-03 20:45:30 +00004965 If you set initrd_high to 0xFFFFFFFF, this is an
4966 indication to U-Boot that all addresses are legal
4967 for the Linux kernel, including addresses in flash
4968 memory. In this case U-Boot will NOT COPY the
4969 ramdisk at all. This may be useful to reduce the
4970 boot time on your system, but requires that this
4971 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975 loadaddr - Default load address for commands like "bootp",
4976 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk2729af92004-05-03 20:45:30 +00004978 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk2729af92004-05-03 20:45:30 +00004980 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004981
wdenk2729af92004-05-03 20:45:30 +00004982 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004987
Mike Frysingere2a53452011-10-02 10:01:27 +00004988 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004989
Mike Frysingere2a53452011-10-02 10:01:27 +00004990 ethact - controls which interface is currently active.
4991 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004992
Heiko Schocher48690d82010-07-20 17:45:02 +02004993 => setenv ethact FEC
4994 => ping 192.168.0.1 # traffic sent on FEC
4995 => setenv ethact SCC
4996 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004997
Matthias Fuchse1692572008-01-17 07:45:05 +01004998 ethrotate - When set to "no" U-Boot does not go through all
4999 available network interfaces.
5000 It just stays at the currently selected interface.
5001
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005002 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005003 either succeed or fail without retrying.
5004 When set to "once" the network operation will
5005 fail when all the available network interfaces
5006 are tried once without success.
5007 Useful on scripts which control the retry operation
5008 themselves.
wdenkc6097192002-11-03 00:24:07 +00005009
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005010 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005011
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005012 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005013 changing the console to be empty. If "yes" it will be
5014 made silent. If "no" it will not be made silent. If
5015 unset, then it will be made silent if the U-Boot console
5016 is silent.
5017
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005018 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005019 UDP source port.
5020
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005021 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005022 destination port instead of the Well Know Port 69.
5023
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005024 tftpblocksize - Block size to use for TFTP transfers; if not set,
5025 we use the TFTP server's default block size
5026
5027 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5028 seconds, minimum value is 1000 = 1 second). Defines
5029 when a packet is considered to be lost so it has to
5030 be retransmitted. The default is 5000 = 5 seconds.
5031 Lowering this value may make downloads succeed
5032 faster in networks with high packet loss rates or
5033 with unreliable TFTP servers.
5034
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005035 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5036 unit, minimum value = 0). Defines how many timeouts
5037 can happen during a single file transfer before that
5038 transfer is aborted. The default is 10, and 0 means
5039 'no timeouts allowed'. Increasing this value may help
5040 downloads succeed with high packet loss rates, or with
5041 unreliable TFTP servers or client hardware.
5042
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005043 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005044 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005045 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005046
Alexandre Messier50768f52016-02-01 17:08:57 -05005047 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5048 Unsigned value, in milliseconds. If not set, the period will
5049 be either the default (28000), or a value based on
5050 CONFIG_NET_RETRY_COUNT, if defined. This value has
5051 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5052
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005053The following image location variables contain the location of images
5054used in booting. The "Image" column gives the role of the image and is
5055not an environment variable name. The other columns are environment
5056variable names. "File Name" gives the name of the file on a TFTP
5057server, "RAM Address" gives the location in RAM the image will be
5058loaded to, and "Flash Location" gives the image's address in NOR
5059flash or offset in NAND flash.
5060
5061*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005062boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005063boards use these variables for other purposes.
5064
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005065Image File Name RAM Address Flash Location
5066----- --------- ----------- --------------
5067u-boot u-boot u-boot_addr_r u-boot_addr
5068Linux kernel bootfile kernel_addr_r kernel_addr
5069device tree blob fdtfile fdt_addr_r fdt_addr
5070ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005071
wdenk2729af92004-05-03 20:45:30 +00005072The following environment variables may be used and automatically
5073updated by the network boot commands ("bootp" and "rarpboot"),
5074depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005075
wdenk2729af92004-05-03 20:45:30 +00005076 bootfile - see above
5077 dnsip - IP address of your Domain Name Server
5078 dnsip2 - IP address of your secondary Domain Name Server
5079 gatewayip - IP address of the Gateway (Router) to use
5080 hostname - Target hostname
5081 ipaddr - see above
5082 netmask - Subnet Mask
5083 rootpath - Pathname of the root filesystem on the NFS server
5084 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005085
wdenka3d991b2004-04-15 21:48:45 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089 serial# - contains hardware identification information such
5090 as type string and/or serial number
5091 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093These variables can be set only once (usually during manufacturing of
5094the board). U-Boot refuses to delete or overwrite these variables
5095once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005096
5097
wdenk2729af92004-05-03 20:45:30 +00005098Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk2729af92004-05-03 20:45:30 +00005100 ver - Contains the U-Boot version string as printed
5101 with the "version" command. This variable is
5102 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005103
wdenkc6097192002-11-03 00:24:07 +00005104
wdenk2729af92004-05-03 20:45:30 +00005105Please note that changes to some configuration parameters may take
5106only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005107
stroesec1551ea2003-04-04 15:53:41 +00005108
Joe Hershberger170ab112012-12-11 22:16:24 -06005109Callback functions for environment variables:
5110---------------------------------------------
5111
5112For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005113when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005114be associated with arbitrary variables. On creation, overwrite, or
5115deletion, the callback will provide the opportunity for some side
5116effect to happen or for the change to be rejected.
5117
5118The callbacks are named and associated with a function using the
5119U_BOOT_ENV_CALLBACK macro in your board or driver code.
5120
5121These callbacks are associated with variables in one of two ways. The
5122static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5123in the board configuration to a string that defines a list of
5124associations. The list must be in the following format:
5125
5126 entry = variable_name[:callback_name]
5127 list = entry[,list]
5128
5129If the callback name is not specified, then the callback is deleted.
5130Spaces are also allowed anywhere in the list.
5131
5132Callbacks can also be associated by defining the ".callbacks" variable
5133with the same list format above. Any association in ".callbacks" will
5134override any association in the static list. You can define
5135CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005136".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005137
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005138If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5139regular expression. This allows multiple variables to be connected to
5140the same callback without explicitly listing them all out.
5141
Joe Hershberger170ab112012-12-11 22:16:24 -06005142
wdenk2729af92004-05-03 20:45:30 +00005143Command Line Parsing:
5144=====================
stroesec1551ea2003-04-04 15:53:41 +00005145
wdenk2729af92004-05-03 20:45:30 +00005146There are two different command line parsers available with U-Boot:
5147the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149Old, simple command line parser:
5150--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk2729af92004-05-03 20:45:30 +00005152- supports environment variables (through setenv / saveenv commands)
5153- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005154- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005155- special characters ('$', ';') can be escaped by prefixing with '\',
5156 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005157 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005158- You can also escape text by enclosing in single apostrophes, for example:
5159 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005160
wdenk2729af92004-05-03 20:45:30 +00005161Hush shell:
5162-----------
wdenkf07771c2003-05-28 08:06:31 +00005163
wdenk2729af92004-05-03 20:45:30 +00005164- similar to Bourne shell, with control structures like
5165 if...then...else...fi, for...do...done; while...do...done,
5166 until...do...done, ...
5167- supports environment ("global") variables (through setenv / saveenv
5168 commands) and local shell variables (through standard shell syntax
5169 "name=value"); only environment variables can be used with "run"
5170 command
wdenkf07771c2003-05-28 08:06:31 +00005171
wdenk2729af92004-05-03 20:45:30 +00005172General rules:
5173--------------
wdenkf07771c2003-05-28 08:06:31 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175(1) If a command line (or an environment variable executed by a "run"
5176 command) contains several commands separated by semicolon, and
5177 one of these commands fails, then the remaining commands will be
5178 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005179
wdenk2729af92004-05-03 20:45:30 +00005180(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005181 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005182 command will cause "run" to terminate, i. e. the remaining
5183 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185Note for Redundant Ethernet Interfaces:
5186=======================================
wdenkf07771c2003-05-28 08:06:31 +00005187
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005188Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005189such configurations and is capable of automatic selection of a
5190"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5193MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5194"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005195
wdenk2729af92004-05-03 20:45:30 +00005196If the network interface stores some valid MAC address (for instance
5197in SROM), this is used as default address if there is NO correspon-
5198ding setting in the environment; if the corresponding environment
5199variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005200
wdenk2729af92004-05-03 20:45:30 +00005201o If the SROM has a valid MAC address, and there is no address in the
5202 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk2729af92004-05-03 20:45:30 +00005204o If there is no valid address in the SROM, and a definition in the
5205 environment exists, then the value from the environment variable is
5206 used.
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk2729af92004-05-03 20:45:30 +00005208o If both the SROM and the environment contain a MAC address, and
5209 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk2729af92004-05-03 20:45:30 +00005211o If both the SROM and the environment contain a MAC address, and the
5212 addresses differ, the value from the environment is used and a
5213 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk2729af92004-05-03 20:45:30 +00005215o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005216 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5217 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005218
Ben Warrenecee9322010-04-26 11:11:46 -07005219If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005220will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005221may be skipped by setting the appropriate 'ethmacskip' environment variable.
5222The naming convention is as follows:
5223"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk2729af92004-05-03 20:45:30 +00005225Image Formats:
5226==============
wdenkc6097192002-11-03 00:24:07 +00005227
Marian Balakowicz3310c542008-03-12 12:13:13 +01005228U-Boot is capable of booting (and performing other auxiliary operations on)
5229images in two formats:
5230
5231New uImage format (FIT)
5232-----------------------
5233
5234Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5235to Flattened Device Tree). It allows the use of images with multiple
5236components (several kernels, ramdisks, etc.), with contents protected by
5237SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5238
5239
5240Old uImage format
5241-----------------
5242
5243Old image format is based on binary files which can be basically anything,
5244preceded by a special header; see the definitions in include/image.h for
5245details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk2729af92004-05-03 20:45:30 +00005247* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5248 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005249 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5250 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5251 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005252* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005253 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5254 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005255* Compression Type (uncompressed, gzip, bzip2)
5256* Load Address
5257* Entry Point
5258* Image Name
5259* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261The header is marked by a special Magic Number, and both the header
5262and the data portions of the image are secured against corruption by
5263CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005264
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk2729af92004-05-03 20:45:30 +00005266Linux Support:
5267==============
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk2729af92004-05-03 20:45:30 +00005269Although U-Boot should support any OS or standalone application
5270easily, the main focus has always been on Linux during the design of
5271U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk2729af92004-05-03 20:45:30 +00005273U-Boot includes many features that so far have been part of some
5274special "boot loader" code within the Linux kernel. Also, any
5275"initrd" images to be used are no longer part of one big Linux image;
5276instead, kernel and "initrd" are separate images. This implementation
5277serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk2729af92004-05-03 20:45:30 +00005279- the same features can be used for other OS or standalone
5280 applications (for instance: using compressed images to reduce the
5281 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk2729af92004-05-03 20:45:30 +00005283- it becomes much easier to port new Linux kernel versions because
5284 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk2729af92004-05-03 20:45:30 +00005286- the same Linux kernel image can now be used with different "initrd"
5287 images; of course this also means that different kernel images can
5288 be run with the same "initrd". This makes testing easier (you don't
5289 have to build a new "zImage.initrd" Linux image when you just
5290 change a file in your "initrd"). Also, a field-upgrade of the
5291 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005292
wdenkc6097192002-11-03 00:24:07 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294Linux HOWTO:
5295============
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk2729af92004-05-03 20:45:30 +00005297Porting Linux to U-Boot based systems:
5298---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk2729af92004-05-03 20:45:30 +00005300U-Boot cannot save you from doing all the necessary modifications to
5301configure the Linux device drivers for use with your target hardware
5302(no, we don't intend to provide a full virtual machine interface to
5303Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005304
Stefan Roesea47a12b2010-04-15 16:07:28 +02005305But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk2729af92004-05-03 20:45:30 +00005307Just make sure your machine specific header file (for instance
5308include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005309Information structure as we define in include/asm-<arch>/u-boot.h,
5310and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005311as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005312
Simon Glass2eb31b12014-06-11 23:29:46 -06005313Note that U-Boot now has a driver model, a unified model for drivers.
5314If you are adding a new driver, plumb it into driver model. If there
5315is no uclass available, you are encouraged to create one. See
5316doc/driver-model.
5317
wdenkc6097192002-11-03 00:24:07 +00005318
wdenk2729af92004-05-03 20:45:30 +00005319Configuring the Linux kernel:
5320-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk2729af92004-05-03 20:45:30 +00005322No specific requirements for U-Boot. Make sure you have some root
5323device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005324
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk2729af92004-05-03 20:45:30 +00005326Building a Linux Image:
5327-----------------------
wdenkc6097192002-11-03 00:24:07 +00005328
wdenk2729af92004-05-03 20:45:30 +00005329With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5330not used. If you use recent kernel source, a new build target
5331"uImage" will exist which automatically builds an image usable by
5332U-Boot. Most older kernels also have support for a "pImage" target,
5333which was introduced for our predecessor project PPCBoot and uses a
5334100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk2729af92004-05-03 20:45:30 +00005336Example:
wdenkc6097192002-11-03 00:24:07 +00005337
Holger Freytherab584d62014-08-04 09:26:05 +02005338 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005339 make oldconfig
5340 make dep
5341 make uImage
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk2729af92004-05-03 20:45:30 +00005343The "uImage" build target uses a special tool (in 'tools/mkimage') to
5344encapsulate a compressed Linux kernel image with header information,
5345CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk2729af92004-05-03 20:45:30 +00005347* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk2729af92004-05-03 20:45:30 +00005349* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351 ${CROSS_COMPILE}-objcopy -O binary \
5352 -R .note -R .comment \
5353 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005354
wdenk2729af92004-05-03 20:45:30 +00005355* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk2729af92004-05-03 20:45:30 +00005359* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005360
wdenk2729af92004-05-03 20:45:30 +00005361 mkimage -A ppc -O linux -T kernel -C gzip \
5362 -a 0 -e 0 -n "Linux Kernel Image" \
5363 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005364
wdenk24ee89b2002-11-03 17:56:27 +00005365
wdenk2729af92004-05-03 20:45:30 +00005366The "mkimage" tool can also be used to create ramdisk images for use
5367with U-Boot, either separated from the Linux kernel image, or
5368combined into one file. "mkimage" encapsulates the images with a 64
5369byte header containing information about target architecture,
5370operating system, image type, compression method, entry points, time
5371stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005372
wdenk2729af92004-05-03 20:45:30 +00005373"mkimage" can be called in two ways: to verify existing images and
5374print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376In the first form (with "-l" option) mkimage lists the information
5377contained in the header of an existing U-Boot image; this includes
5378checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005379
wdenk2729af92004-05-03 20:45:30 +00005380 tools/mkimage -l image
5381 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005382
wdenk2729af92004-05-03 20:45:30 +00005383The second form (with "-d" option) is used to build a U-Boot image
5384from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005385
wdenk2729af92004-05-03 20:45:30 +00005386 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5387 -n name -d data_file image
5388 -A ==> set architecture to 'arch'
5389 -O ==> set operating system to 'os'
5390 -T ==> set image type to 'type'
5391 -C ==> set compression type 'comp'
5392 -a ==> set load address to 'addr' (hex)
5393 -e ==> set entry point to 'ep' (hex)
5394 -n ==> set image name to 'name'
5395 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005396
wdenk69459792004-05-29 16:53:29 +00005397Right now, all Linux kernels for PowerPC systems use the same load
5398address (0x00000000), but the entry point address depends on the
5399kernel version:
wdenkc6097192002-11-03 00:24:07 +00005400
wdenk2729af92004-05-03 20:45:30 +00005401- 2.2.x kernels have the entry point at 0x0000000C,
5402- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005403
wdenk2729af92004-05-03 20:45:30 +00005404So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk2729af92004-05-03 20:45:30 +00005406 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5407 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005408 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005409 > examples/uImage.TQM850L
5410 Image Name: 2.4.4 kernel for TQM850L
5411 Created: Wed Jul 19 02:34:59 2000
5412 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5413 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5414 Load Address: 0x00000000
5415 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk2729af92004-05-03 20:45:30 +00005417To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005418
wdenk2729af92004-05-03 20:45:30 +00005419 -> tools/mkimage -l examples/uImage.TQM850L
5420 Image Name: 2.4.4 kernel for TQM850L
5421 Created: Wed Jul 19 02:34:59 2000
5422 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5423 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5424 Load Address: 0x00000000
5425 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005426
wdenk2729af92004-05-03 20:45:30 +00005427NOTE: for embedded systems where boot time is critical you can trade
5428speed for memory and install an UNCOMPRESSED image instead: this
5429needs more space in Flash, but boots much faster since it does not
5430need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005431
Stefan Roesea47a12b2010-04-15 16:07:28 +02005432 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005433 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5434 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005435 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005436 > examples/uImage.TQM850L-uncompressed
5437 Image Name: 2.4.4 kernel for TQM850L
5438 Created: Wed Jul 19 02:34:59 2000
5439 Image Type: PowerPC Linux Kernel Image (uncompressed)
5440 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5441 Load Address: 0x00000000
5442 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005443
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk2729af92004-05-03 20:45:30 +00005445Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5446when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005447
wdenk2729af92004-05-03 20:45:30 +00005448 -> tools/mkimage -n 'Simple Ramdisk Image' \
5449 > -A ppc -O linux -T ramdisk -C gzip \
5450 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5451 Image Name: Simple Ramdisk Image
5452 Created: Wed Jan 12 14:01:50 2000
5453 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5454 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5455 Load Address: 0x00000000
5456 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005457
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005458The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5459option performs the converse operation of the mkimage's second form (the "-d"
5460option). Given an image built by mkimage, the dumpimage extracts a "data file"
5461from the image:
5462
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005463 tools/dumpimage -i image -T type -p position data_file
5464 -i ==> extract from the 'image' a specific 'data_file'
5465 -T ==> set image type to 'type'
5466 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005467
wdenkdb01a2e2004-04-15 23:14:49 +00005468
wdenk2729af92004-05-03 20:45:30 +00005469Installing a Linux Image:
5470-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005471
wdenk2729af92004-05-03 20:45:30 +00005472To downloading a U-Boot image over the serial (console) interface,
5473you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005474
wdenk2729af92004-05-03 20:45:30 +00005475 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005476
wdenk2729af92004-05-03 20:45:30 +00005477The 'objcopy' does not understand the information in the U-Boot
5478image header, so the resulting S-Record file will be relative to
5479address 0x00000000. To load it to a given address, you need to
5480specify the target address as 'offset' parameter with the 'loads'
5481command.
wdenkc6097192002-11-03 00:24:07 +00005482
wdenk2729af92004-05-03 20:45:30 +00005483Example: install the image to address 0x40100000 (which on the
5484TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005485
wdenk2729af92004-05-03 20:45:30 +00005486 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005487
wdenk2729af92004-05-03 20:45:30 +00005488 .......... done
5489 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk2729af92004-05-03 20:45:30 +00005491 => loads 40100000
5492 ## Ready for S-Record download ...
5493 ~>examples/image.srec
5494 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5495 ...
5496 15989 15990 15991 15992
5497 [file transfer complete]
5498 [connected]
5499 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005500
5501
wdenk2729af92004-05-03 20:45:30 +00005502You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005503this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005504corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk2729af92004-05-03 20:45:30 +00005506 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005507
wdenk2729af92004-05-03 20:45:30 +00005508 ## Checking Image at 40100000 ...
5509 Image Name: 2.2.13 for initrd on TQM850L
5510 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5511 Data Size: 335725 Bytes = 327 kB = 0 MB
5512 Load Address: 00000000
5513 Entry Point: 0000000c
5514 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005515
5516
wdenk2729af92004-05-03 20:45:30 +00005517Boot Linux:
5518-----------
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520The "bootm" command is used to boot an application that is stored in
5521memory (RAM or Flash). In case of a Linux kernel image, the contents
5522of the "bootargs" environment variable is passed to the kernel as
5523parameters. You can check and modify this variable using the
5524"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005525
5526
wdenk2729af92004-05-03 20:45:30 +00005527 => printenv bootargs
5528 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk2729af92004-05-03 20:45:30 +00005530 => 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 +00005531
wdenk2729af92004-05-03 20:45:30 +00005532 => printenv bootargs
5533 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 +00005534
wdenk2729af92004-05-03 20:45:30 +00005535 => bootm 40020000
5536 ## Booting Linux kernel at 40020000 ...
5537 Image Name: 2.2.13 for NFS on TQM850L
5538 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5539 Data Size: 381681 Bytes = 372 kB = 0 MB
5540 Load Address: 00000000
5541 Entry Point: 0000000c
5542 Verifying Checksum ... OK
5543 Uncompressing Kernel Image ... OK
5544 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
5545 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5546 time_init: decrementer frequency = 187500000/60
5547 Calibrating delay loop... 49.77 BogoMIPS
5548 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5549 ...
wdenkc6097192002-11-03 00:24:07 +00005550
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005551If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005552the memory addresses of both the kernel and the initrd image (PPBCOOT
5553format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk2729af92004-05-03 20:45:30 +00005555 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk2729af92004-05-03 20:45:30 +00005557 ## Checking Image at 40100000 ...
5558 Image Name: 2.2.13 for initrd on TQM850L
5559 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5560 Data Size: 335725 Bytes = 327 kB = 0 MB
5561 Load Address: 00000000
5562 Entry Point: 0000000c
5563 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk2729af92004-05-03 20:45:30 +00005565 ## Checking Image at 40200000 ...
5566 Image Name: Simple Ramdisk Image
5567 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5568 Data Size: 566530 Bytes = 553 kB = 0 MB
5569 Load Address: 00000000
5570 Entry Point: 00000000
5571 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005572
wdenk2729af92004-05-03 20:45:30 +00005573 => bootm 40100000 40200000
5574 ## Booting Linux kernel at 40100000 ...
5575 Image Name: 2.2.13 for initrd on TQM850L
5576 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5577 Data Size: 335725 Bytes = 327 kB = 0 MB
5578 Load Address: 00000000
5579 Entry Point: 0000000c
5580 Verifying Checksum ... OK
5581 Uncompressing Kernel Image ... OK
5582 ## Loading RAMDisk Image at 40200000 ...
5583 Image Name: Simple Ramdisk Image
5584 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5585 Data Size: 566530 Bytes = 553 kB = 0 MB
5586 Load Address: 00000000
5587 Entry Point: 00000000
5588 Verifying Checksum ... OK
5589 Loading Ramdisk ... OK
5590 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
5591 Boot arguments: root=/dev/ram
5592 time_init: decrementer frequency = 187500000/60
5593 Calibrating delay loop... 49.77 BogoMIPS
5594 ...
5595 RAMDISK: Compressed image found at block 0
5596 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005597
wdenk2729af92004-05-03 20:45:30 +00005598 bash#
wdenkc6097192002-11-03 00:24:07 +00005599
Matthew McClintock02677682006-06-28 10:41:37 -05005600Boot Linux and pass a flat device tree:
5601-----------
5602
5603First, U-Boot must be compiled with the appropriate defines. See the section
5604titled "Linux Kernel Interface" above for a more in depth explanation. The
5605following is an example of how to start a kernel and pass an updated
5606flat device tree:
5607
5608=> print oftaddr
5609oftaddr=0x300000
5610=> print oft
5611oft=oftrees/mpc8540ads.dtb
5612=> tftp $oftaddr $oft
5613Speed: 1000, full duplex
5614Using TSEC0 device
5615TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5616Filename 'oftrees/mpc8540ads.dtb'.
5617Load address: 0x300000
5618Loading: #
5619done
5620Bytes transferred = 4106 (100a hex)
5621=> tftp $loadaddr $bootfile
5622Speed: 1000, full duplex
5623Using TSEC0 device
5624TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5625Filename 'uImage'.
5626Load address: 0x200000
5627Loading:############
5628done
5629Bytes transferred = 1029407 (fb51f hex)
5630=> print loadaddr
5631loadaddr=200000
5632=> print oftaddr
5633oftaddr=0x300000
5634=> bootm $loadaddr - $oftaddr
5635## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005636 Image Name: Linux-2.6.17-dirty
5637 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5638 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005639 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005640 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005641 Verifying Checksum ... OK
5642 Uncompressing Kernel Image ... OK
5643Booting using flat device tree at 0x300000
5644Using MPC85xx ADS machine description
5645Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5646[snip]
5647
5648
wdenk2729af92004-05-03 20:45:30 +00005649More About U-Boot Image Types:
5650------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005653
wdenk2729af92004-05-03 20:45:30 +00005654 "Standalone Programs" are directly runnable in the environment
5655 provided by U-Boot; it is expected that (if they behave
5656 well) you can continue to work in U-Boot after return from
5657 the Standalone Program.
5658 "OS Kernel Images" are usually images of some Embedded OS which
5659 will take over control completely. Usually these programs
5660 will install their own set of exception handlers, device
5661 drivers, set up the MMU, etc. - this means, that you cannot
5662 expect to re-enter U-Boot except by resetting the CPU.
5663 "RAMDisk Images" are more or less just data blocks, and their
5664 parameters (address, size) are passed to an OS kernel that is
5665 being started.
5666 "Multi-File Images" contain several images, typically an OS
5667 (Linux) kernel image and one or more data images like
5668 RAMDisks. This construct is useful for instance when you want
5669 to boot over the network using BOOTP etc., where the boot
5670 server provides just a single image file, but you want to get
5671 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005672
wdenk2729af92004-05-03 20:45:30 +00005673 "Multi-File Images" start with a list of image sizes, each
5674 image size (in bytes) specified by an "uint32_t" in network
5675 byte order. This list is terminated by an "(uint32_t)0".
5676 Immediately after the terminating 0 follow the images, one by
5677 one, all aligned on "uint32_t" boundaries (size rounded up to
5678 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005679
wdenk2729af92004-05-03 20:45:30 +00005680 "Firmware Images" are binary images containing firmware (like
5681 U-Boot or FPGA images) which usually will be programmed to
5682 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684 "Script files" are command sequences that will be executed by
5685 U-Boot's command interpreter; this feature is especially
5686 useful when you configure U-Boot to use a real shell (hush)
5687 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005688
Marek Vasut44f074c2012-03-14 21:52:45 +00005689Booting the Linux zImage:
5690-------------------------
5691
5692On some platforms, it's possible to boot Linux zImage. This is done
5693using the "bootz" command. The syntax of "bootz" command is the same
5694as the syntax of "bootm" command.
5695
Tom Rini8ac28562013-05-16 11:40:11 -04005696Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005697kernel with raw initrd images. The syntax is slightly different, the
5698address of the initrd must be augmented by it's size, in the following
5699format: "<initrd addres>:<initrd size>".
5700
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk2729af92004-05-03 20:45:30 +00005702Standalone HOWTO:
5703=================
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705One of the features of U-Boot is that you can dynamically load and
5706run "standalone" applications, which can use some resources of
5707U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk2729af92004-05-03 20:45:30 +00005709Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711"Hello World" Demo:
5712-------------------
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714'examples/hello_world.c' contains a small "Hello World" Demo
5715application; it is automatically compiled when you build U-Boot.
5716It's configured to run at address 0x00040004, so you can play with it
5717like that:
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk2729af92004-05-03 20:45:30 +00005719 => loads
5720 ## Ready for S-Record download ...
5721 ~>examples/hello_world.srec
5722 1 2 3 4 5 6 7 8 9 10 11 ...
5723 [file transfer complete]
5724 [connected]
5725 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk2729af92004-05-03 20:45:30 +00005727 => go 40004 Hello World! This is a test.
5728 ## Starting application at 0x00040004 ...
5729 Hello World
5730 argc = 7
5731 argv[0] = "40004"
5732 argv[1] = "Hello"
5733 argv[2] = "World!"
5734 argv[3] = "This"
5735 argv[4] = "is"
5736 argv[5] = "a"
5737 argv[6] = "test."
5738 argv[7] = "<NULL>"
5739 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk2729af92004-05-03 20:45:30 +00005741 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk2729af92004-05-03 20:45:30 +00005743Another example, which demonstrates how to register a CPM interrupt
5744handler with the U-Boot code, can be found in 'examples/timer.c'.
5745Here, a CPM timer is set up to generate an interrupt every second.
5746The interrupt service routine is trivial, just printing a '.'
5747character, but this is just a demo program. The application can be
5748controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk2729af92004-05-03 20:45:30 +00005750 ? - print current values og the CPM Timer registers
5751 b - enable interrupts and start timer
5752 e - stop timer and disable interrupts
5753 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk2729af92004-05-03 20:45:30 +00005755 => loads
5756 ## Ready for S-Record download ...
5757 ~>examples/timer.srec
5758 1 2 3 4 5 6 7 8 9 10 11 ...
5759 [file transfer complete]
5760 [connected]
5761 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk2729af92004-05-03 20:45:30 +00005763 => go 40004
5764 ## Starting application at 0x00040004 ...
5765 TIMERS=0xfff00980
5766 Using timer 1
5767 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk2729af92004-05-03 20:45:30 +00005769Hit 'b':
5770 [q, b, e, ?] Set interval 1000000 us
5771 Enabling timer
5772Hit '?':
5773 [q, b, e, ?] ........
5774 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5775Hit '?':
5776 [q, b, e, ?] .
5777 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5778Hit '?':
5779 [q, b, e, ?] .
5780 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5781Hit '?':
5782 [q, b, e, ?] .
5783 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5784Hit 'e':
5785 [q, b, e, ?] ...Stopping timer
5786Hit 'q':
5787 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005788
5789
wdenk2729af92004-05-03 20:45:30 +00005790Minicom warning:
5791================
wdenk85ec0bc2003-03-31 16:34:49 +00005792
wdenk2729af92004-05-03 20:45:30 +00005793Over time, many people have reported problems when trying to use the
5794"minicom" terminal emulation program for serial download. I (wd)
5795consider minicom to be broken, and recommend not to use it. Under
5796Unix, I recommend to use C-Kermit for general purpose use (and
5797especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005798use "cu" for S-Record download ("loads" command). See
5799http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5800for help with kermit.
5801
wdenk85ec0bc2003-03-31 16:34:49 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803Nevertheless, if you absolutely want to use it try adding this
5804configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806 Name Program Name U/D FullScr IO-Red. Multi
5807 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5808 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005809
5810
wdenk2729af92004-05-03 20:45:30 +00005811NetBSD Notes:
5812=============
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk2729af92004-05-03 20:45:30 +00005814Starting at version 0.9.2, U-Boot supports NetBSD both as host
5815(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk2729af92004-05-03 20:45:30 +00005817Building requires a cross environment; it is known to work on
5818NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5819need gmake since the Makefiles are not compatible with BSD make).
5820Note that the cross-powerpc package does not install include files;
5821attempting to build U-Boot will fail because <machine/ansi.h> is
5822missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005823
wdenk2729af92004-05-03 20:45:30 +00005824 # cd /usr/pkg/cross/powerpc-netbsd/include
5825 # mkdir powerpc
5826 # ln -s powerpc machine
5827 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5828 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk2729af92004-05-03 20:45:30 +00005830Native builds *don't* work due to incompatibilities between native
5831and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk2729af92004-05-03 20:45:30 +00005833Booting assumes that (the first part of) the image booted is a
5834stage-2 loader which in turn loads and then invokes the kernel
5835proper. Loader sources will eventually appear in the NetBSD source
5836tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005837meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005838
5839
wdenk2729af92004-05-03 20:45:30 +00005840Implementation Internals:
5841=========================
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk2729af92004-05-03 20:45:30 +00005843The following is not intended to be a complete description of every
5844implementation detail. However, it should help to understand the
5845inner workings of U-Boot and make it easier to port it to custom
5846hardware.
wdenkc6097192002-11-03 00:24:07 +00005847
5848
wdenk2729af92004-05-03 20:45:30 +00005849Initial Stack, Global Data:
5850---------------------------
wdenkc6097192002-11-03 00:24:07 +00005851
wdenk2729af92004-05-03 20:45:30 +00005852The implementation of U-Boot is complicated by the fact that U-Boot
5853starts running out of ROM (flash memory), usually without access to
5854system RAM (because the memory controller is not initialized yet).
5855This means that we don't have writable Data or BSS segments, and BSS
5856is not initialized as zero. To be able to get a C environment working
5857at all, we have to allocate at least a minimal stack. Implementation
5858options for this are defined and restricted by the CPU used: Some CPU
5859models provide on-chip memory (like the IMMR area on MPC8xx and
5860MPC826x processors), on others (parts of) the data cache can be
5861locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005862
Wolfgang Denk218ca722008-03-26 10:40:12 +01005863 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005864 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005865
wdenk2729af92004-05-03 20:45:30 +00005866 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5867 From: "Chris Hallinan" <clh@net1plus.com>
5868 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5869 ...
wdenk43d96162003-03-06 00:02:04 +00005870
wdenk2729af92004-05-03 20:45:30 +00005871 Correct me if I'm wrong, folks, but the way I understand it
5872 is this: Using DCACHE as initial RAM for Stack, etc, does not
5873 require any physical RAM backing up the cache. The cleverness
5874 is that the cache is being used as a temporary supply of
5875 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005876 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005877 can see how this works by studying the cache architecture and
5878 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005879
wdenk2729af92004-05-03 20:45:30 +00005880 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5881 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005882 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005883 option should work for you. Using CS 4 should be fine if your
5884 board designers haven't used it for something that would
5885 cause you grief during the initial boot! It is frequently not
5886 used.
wdenk43d96162003-03-06 00:02:04 +00005887
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005888 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005889 with your processor/board/system design. The default value
5890 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005891 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005892 than your SDRAM module. If you have a 64MB SDRAM module, set
5893 it above 400_0000. Just make sure your board has no resources
5894 that are supposed to respond to that address! That code in
5895 start.S has been around a while and should work as is when
5896 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005897
wdenk2729af92004-05-03 20:45:30 +00005898 -Chris Hallinan
5899 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005900
wdenk2729af92004-05-03 20:45:30 +00005901It is essential to remember this, since it has some impact on the C
5902code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk2729af92004-05-03 20:45:30 +00005904* Initialized global data (data segment) is read-only. Do not attempt
5905 to write it.
wdenkc6097192002-11-03 00:24:07 +00005906
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005907* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00005908 as zero data - BSS segment) at all - this is undefined, initiali-
5909 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk2729af92004-05-03 20:45:30 +00005911* Stack space is very limited. Avoid big data buffers or things like
5912 that.
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk2729af92004-05-03 20:45:30 +00005914Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005915normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00005916turned out that the implementation of U-Boot can be greatly
5917simplified by making a global data structure (gd_t) available to all
5918functions. We could pass a pointer to this data as argument to _all_
5919functions, but this would bloat the code. Instead we use a feature of
5920the GCC compiler (Global Register Variables) to share the data: we
5921place a pointer (gd) to the global data into a register which we
5922reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk2729af92004-05-03 20:45:30 +00005924When choosing a register for such a purpose we are restricted by the
5925relevant (E)ABI specifications for the current architecture, and by
5926GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005927
wdenk2729af92004-05-03 20:45:30 +00005928For PowerPC, the following registers have specific use:
5929 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005930 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005931 R3-R4: parameter passing and return values
5932 R5-R10: parameter passing
5933 R13: small data area pointer
5934 R30: GOT pointer
5935 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005936
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005937 (U-Boot also uses R12 as internal GOT pointer. r12
5938 is a volatile register so r12 needs to be reset when
5939 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005940
Wolfgang Denke7670f62008-02-14 22:43:22 +01005941 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005942
wdenk2729af92004-05-03 20:45:30 +00005943 Note: on PPC, we could use a static initializer (since the
5944 address of the global data structure is known at compile time),
5945 but it turned out that reserving a register results in somewhat
5946 smaller code - although the code savings are not that big (on
5947 average for all boards 752 bytes for the whole U-Boot image,
5948 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005949
Robin Getzc4db3352009-08-17 15:23:02 +00005950On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005951 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5952
Robin Getzc4db3352009-08-17 15:23:02 +00005953 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005954
wdenk2729af92004-05-03 20:45:30 +00005955On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005956
wdenk2729af92004-05-03 20:45:30 +00005957 R0: function argument word/integer result
5958 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005959 R9: platform specific
5960 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005961 R11: argument (frame) pointer
5962 R12: temporary workspace
5963 R13: stack pointer
5964 R14: link register
5965 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005966
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005967 ==> U-Boot will use R9 to hold a pointer to the global data
5968
5969 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005970
Thomas Chou0df01fd32010-05-21 11:08:03 +08005971On Nios II, the ABI is documented here:
5972 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5973
5974 ==> U-Boot will use gp to hold a pointer to the global data
5975
5976 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5977 to access small data sections, so gp is free.
5978
Macpaul Linafc1ce82011-10-19 20:41:11 +00005979On NDS32, the following registers are used:
5980
5981 R0-R1: argument/return
5982 R2-R5: argument
5983 R15: temporary register for assembler
5984 R16: trampoline register
5985 R28: frame pointer (FP)
5986 R29: global pointer (GP)
5987 R30: link register (LP)
5988 R31: stack pointer (SP)
5989 PC: program counter (PC)
5990
5991 ==> U-Boot will use R10 to hold a pointer to the global data
5992
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005993NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5994or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk2729af92004-05-03 20:45:30 +00005996Memory Management:
5997------------------
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk2729af92004-05-03 20:45:30 +00005999U-Boot runs in system state and uses physical addresses, i.e. the
6000MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006001
wdenk2729af92004-05-03 20:45:30 +00006002The available memory is mapped to fixed addresses using the memory
6003controller. In this process, a contiguous block is formed for each
6004memory type (Flash, SDRAM, SRAM), even when it consists of several
6005physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk2729af92004-05-03 20:45:30 +00006007U-Boot is installed in the first 128 kB of the first Flash bank (on
6008TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6009booting and sizing and initializing DRAM, the code relocates itself
6010to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006011memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006012configuration setting]. Below that, a structure with global Board
6013Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006014
wdenk2729af92004-05-03 20:45:30 +00006015Additionally, some exception handler code is copied to the low 8 kB
6016of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk2729af92004-05-03 20:45:30 +00006018So a typical memory configuration with 16 MB of DRAM could look like
6019this:
wdenkc6097192002-11-03 00:24:07 +00006020
wdenk2729af92004-05-03 20:45:30 +00006021 0x0000 0000 Exception Vector code
6022 :
6023 0x0000 1FFF
6024 0x0000 2000 Free for Application Use
6025 :
6026 :
wdenkc6097192002-11-03 00:24:07 +00006027
wdenk2729af92004-05-03 20:45:30 +00006028 :
6029 :
6030 0x00FB FF20 Monitor Stack (Growing downward)
6031 0x00FB FFAC Board Info Data and permanent copy of global data
6032 0x00FC 0000 Malloc Arena
6033 :
6034 0x00FD FFFF
6035 0x00FE 0000 RAM Copy of Monitor Code
6036 ... eventually: LCD or video framebuffer
6037 ... eventually: pRAM (Protected RAM - unchanged by reset)
6038 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006039
6040
wdenk2729af92004-05-03 20:45:30 +00006041System Initialization:
6042----------------------
wdenkc6097192002-11-03 00:24:07 +00006043
wdenk2729af92004-05-03 20:45:30 +00006044In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006045(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006046configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006047To be able to re-map memory U-Boot then jumps to its link address.
6048To be able to implement the initialization code in C, a (small!)
6049initial stack is set up in the internal Dual Ported RAM (in case CPUs
6050which provide such a feature like MPC8xx or MPC8260), or in a locked
6051part of the data cache. After that, U-Boot initializes the CPU core,
6052the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006053
wdenk2729af92004-05-03 20:45:30 +00006054Next, all (potentially) available memory banks are mapped using a
6055preliminary mapping. For example, we put them on 512 MB boundaries
6056(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6057on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6058programmed for SDRAM access. Using the temporary configuration, a
6059simple memory test is run that determines the size of the SDRAM
6060banks.
wdenkc6097192002-11-03 00:24:07 +00006061
wdenk2729af92004-05-03 20:45:30 +00006062When there is more than one SDRAM bank, and the banks are of
6063different size, the largest is mapped first. For equal size, the first
6064bank (CS2#) is mapped first. The first mapping is always for address
60650x00000000, with any additional banks following immediately to create
6066contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006067
wdenk2729af92004-05-03 20:45:30 +00006068Then, the monitor installs itself at the upper end of the SDRAM area
6069and allocates memory for use by malloc() and for the global Board
6070Info data; also, the exception vector code is copied to the low RAM
6071pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006072
wdenk2729af92004-05-03 20:45:30 +00006073Only after this relocation will you have a "normal" C environment;
6074until that you are restricted in several ways, mostly because you are
6075running from ROM, and because the code will have to be relocated to a
6076new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006077
6078
wdenk2729af92004-05-03 20:45:30 +00006079U-Boot Porting Guide:
6080----------------------
wdenkc6097192002-11-03 00:24:07 +00006081
wdenk2729af92004-05-03 20:45:30 +00006082[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6083list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006084
6085
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006086int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006087{
6088 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006089
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006090 signal(SIGALRM, no_more_time);
6091 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006092
wdenk2729af92004-05-03 20:45:30 +00006093 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006094 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006095 return 0;
6096 }
6097
wdenk2729af92004-05-03 20:45:30 +00006098 Download latest U-Boot source;
6099
Wolfgang Denk06682362008-12-30 22:56:11 +01006100 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006101
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006102 if (clueless)
6103 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006104
wdenk2729af92004-05-03 20:45:30 +00006105 while (learning) {
6106 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006107 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6108 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006109 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006110 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006111 }
wdenkc6097192002-11-03 00:24:07 +00006112
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006113 if (available_money > toLocalCurrency ($2500))
6114 Buy a BDI3000;
6115 else
wdenk2729af92004-05-03 20:45:30 +00006116 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006117
6118 if (a similar board exists) { /* hopefully... */
6119 cp -a board/<similar> board/<myboard>
6120 cp include/configs/<similar>.h include/configs/<myboard>.h
6121 } else {
6122 Create your own board support subdirectory;
6123 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006124 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006125 Edit new board/<myboard> files
6126 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006127
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006128 while (!accepted) {
6129 while (!running) {
6130 do {
6131 Add / modify source code;
6132 } until (compiles);
6133 Debug;
6134 if (clueless)
6135 email("Hi, I am having problems...");
6136 }
6137 Send patch file to the U-Boot email list;
6138 if (reasonable critiques)
6139 Incorporate improvements from email list code review;
6140 else
6141 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006142 }
wdenkc6097192002-11-03 00:24:07 +00006143
wdenk2729af92004-05-03 20:45:30 +00006144 return 0;
6145}
6146
6147void no_more_time (int sig)
6148{
6149 hire_a_guru();
6150}
wdenkc6097192002-11-03 00:24:07 +00006151
6152
wdenk2729af92004-05-03 20:45:30 +00006153Coding Standards:
6154-----------------
wdenkc6097192002-11-03 00:24:07 +00006155
wdenk2729af92004-05-03 20:45:30 +00006156All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006157coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006158"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006159
Detlev Zundel2c051652006-09-01 15:39:02 +02006160Source files originating from a different project (for example the
6161MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006162reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006163sources.
6164
6165Please note that U-Boot is implemented in C (and to some small parts in
6166Assembler); no C++ is used, so please do not use C++ style comments (//)
6167in your code.
wdenk2729af92004-05-03 20:45:30 +00006168
6169Please also stick to the following formatting rules:
6170- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006171- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006172- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006173- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006174- do not add trailing empty lines to source files
6175
6176Submissions which do not conform to the standards may be returned
6177with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006178
6179
wdenk2729af92004-05-03 20:45:30 +00006180Submitting Patches:
6181-------------------
wdenkc6097192002-11-03 00:24:07 +00006182
wdenk2729af92004-05-03 20:45:30 +00006183Since the number of patches for U-Boot is growing, we need to
6184establish some rules. Submissions which do not conform to these rules
6185may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006186
Magnus Lilja0d28f342008-08-06 19:32:33 +02006187Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006188
Wolfgang Denk06682362008-12-30 22:56:11 +01006189Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6190see http://lists.denx.de/mailman/listinfo/u-boot
6191
wdenk2729af92004-05-03 20:45:30 +00006192When you send a patch, please include the following information with
6193it:
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk2729af92004-05-03 20:45:30 +00006195* For bug fixes: a description of the bug and how your patch fixes
6196 this bug. Please try to include a way of demonstrating that the
6197 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006198
wdenk2729af92004-05-03 20:45:30 +00006199* For new features: a description of the feature and your
6200 implementation.
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk2729af92004-05-03 20:45:30 +00006202* A CHANGELOG entry as plaintext (separate from the patch)
6203
Robert P. J. Day7207b362015-12-19 07:16:10 -05006204* For major contributions, add a MAINTAINERS file with your
6205 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006206
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006207* When you add support for a new board, don't forget to add a
6208 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006209
6210* If your patch adds new configuration options, don't forget to
6211 document these in the README file.
6212
Wolfgang Denk218ca722008-03-26 10:40:12 +01006213* The patch itself. If you are using git (which is *strongly*
6214 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006215 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006216 the U-Boot mailing list, you will avoid most of the common problems
6217 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006218
Wolfgang Denk218ca722008-03-26 10:40:12 +01006219 If you cannot use git, use "diff -purN OLD NEW". If your version of
6220 diff does not support these options, then get the latest version of
6221 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006222
Wolfgang Denk218ca722008-03-26 10:40:12 +01006223 The current directory when running this command shall be the parent
6224 directory of the U-Boot source tree (i. e. please make sure that
6225 your patch includes sufficient directory information for the
6226 affected files).
6227
6228 We prefer patches as plain text. MIME attachments are discouraged,
6229 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006230
6231* If one logical set of modifications affects or creates several
6232 files, all these changes shall be submitted in a SINGLE patch file.
6233
6234* Changesets that contain different, unrelated modifications shall be
6235 submitted as SEPARATE patches, one patch per changeset.
6236
6237
6238Notes:
6239
Simon Glass6de80f22016-07-27 20:33:08 -06006240* Before sending the patch, run the buildman script on your patched
wdenk2729af92004-05-03 20:45:30 +00006241 source tree and make sure that no errors or warnings are reported
6242 for any of the boards.
6243
6244* Keep your modifications to the necessary minimum: A patch
6245 containing several unrelated changes or arbitrary reformats will be
6246 returned with a request to re-formatting / split it.
6247
6248* If you modify existing code, make sure that your new code does not
6249 add to the memory footprint of the code ;-) Small is beautiful!
6250 When adding new features, these should compile conditionally only
6251 (using #ifdef), and the resulting code with the new feature
6252 disabled must not need more memory than the old code without your
6253 modification.
wdenk90dc6702005-05-03 14:12:25 +00006254
Wolfgang Denk06682362008-12-30 22:56:11 +01006255* Remember that there is a size limit of 100 kB per message on the
6256 u-boot mailing list. Bigger patches will be moderated. If they are
6257 reasonable and not too big, they will be acknowledged. But patches
6258 bigger than the size limit should be avoided.