blob: 9c992c1ea3288ffdeb95a1322494955df6c82c33 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-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. Day076ed9b2015-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. Day974ed2f2012-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. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-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 Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-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.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800154/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500156/configs Board default configuration files
Peter Tysere4d1abc2010-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. Daya269c932013-09-15 18:34:15 -0400160/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-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. Day076ed9b2015-12-19 07:16:10 -0500164/lib Library routines generic to all architectures
165/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/net Networking code
167/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500168/scripts Various build scripts and Makefiles
169/test Various unit test files
Peter Tysere4d1abc2010-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-VILLARD03836942008-10-16 15:01:15 +0200187 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000188
Robert P. J. Day076ed9b2015-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 Freyther7ba4e572014-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 Freyther7ba4e572014-08-04 09:26:05 +0200205 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000206
Robert P. J. Day076ed9b2015-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 Glass53552c92014-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 Teki287314f2014-08-31 21:19:43 +0530219See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600220
221
Simon Glassd8711af2015-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. Day076ed9b2015-12-19 07:16:10 -0500226SPL and U-Boot proper (i.e. they both follow the same rules).
227
228Note: "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.
Simon Glassd8711af2015-03-03 08:03:00 -0700235
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500236Execution 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 Glassd8711af2015-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500321- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000322
Kim Phillips203fee32007-08-10 13:28:25 -0500323- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200324
325- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100326 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000327
Lei Wen20014762011-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-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 Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-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 Galaf4fb90f2011-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 Gala179b1b22011-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 Wood80806962012-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 Kushwahad324f472013-04-16 13:27:44 +0530399 CONFIG_A003399_NOR_WORKAROUND
400 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800401 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530402
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530403 CONFIG_A008044_WORKAROUND
404 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800405 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530406
Scott Wood80806962012-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 Jainc73b9032013-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 Jainf81e8b22013-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 Jainc73b9032013-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 Jainf81e8b22013-04-04 09:31:54 +0530424 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
425 This value denotes start offset of DSP CCSR space.
426
Priyanka Jaine9dcaa82013-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 Bansal8bcbc272014-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 Meng75574052016-02-05 19:30:11 -0800434 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530435
Tang Yuantiana7364af2014-04-17 15:33:46 +0800436 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800437 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800438 supported, core will start to execute uboot when wakes up.
439
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000440- Generic CPU options:
York Sun021d2022014-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 Schwierzeckd8a49ca2012-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 Sunf0626592013-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 Sun2896cb72014-03-27 17:54:47 -0700473 CONFIG_SYS_FSL_DDRC_GEN4
474 Freescale DDR4 controller.
475
York Sun461c9392013-09-30 14:20:51 -0700476 CONFIG_SYS_FSL_DDRC_ARM_GEN3
477 Freescale DDR3 controller for ARM-based SoCs.
478
York Sunf0626592013-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. Day8d56db92016-07-15 13:44:45 -0400485 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-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 Sun2896cb72014-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 Sunf0626592013-09-30 09:22:09 -0700500
Prabhakar Kushwaha62908c22014-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 Kushwaha950f2f72014-01-13 11:28:04 +0530507 CONFIG_SYS_FSL_PBL_PBI
508 It enables addition of RCW (Power on reset configuration) in built image.
509 Please refer doc/README.pblimage for more details
510
511 CONFIG_SYS_FSL_PBL_RCW
512 It adds PBI(pre-boot instructions) commands in u-boot build image.
513 PBI commands can be used to configure SoC before it starts the execution.
514 Please refer doc/README.pblimage for more details
515
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530516 CONFIG_SPL_FSL_PBL
517 It adds a target to create boot binary having SPL binary in PBI format
518 concatenated with u-boot binary.
519
York Sun29647ab2014-02-10 13:59:42 -0800520 CONFIG_SYS_FSL_DDR_BE
521 Defines the DDR controller register space as Big Endian
522
523 CONFIG_SYS_FSL_DDR_LE
524 Defines the DDR controller register space as Little Endian
525
York Sun3a0916d2014-02-10 13:59:43 -0800526 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
527 Physical address from the view of DDR controllers. It is the
528 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
529 it could be different for ARM SoCs.
530
York Sunc459ae62014-02-10 13:59:44 -0800531 CONFIG_SYS_FSL_DDR_INTLV_256B
532 DDR controller interleaving on 256-byte. This is a special
533 interleaving mode, handled by Dickens for Freescale layerscape
534 SoCs with ARM core.
535
York Sun79a779b2014-08-01 15:51:00 -0700536 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
537 Number of controllers used as main memory.
538
539 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
540 Number of controllers used for other than main memory.
541
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530542 CONFIG_SYS_FSL_HAS_DP_DDR
543 Defines the SoC has DP-DDR used for DPAA.
544
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530545 CONFIG_SYS_FSL_SEC_BE
546 Defines the SEC controller register space as Big Endian
547
548 CONFIG_SYS_FSL_SEC_LE
549 Defines the SEC controller register space as Little Endian
550
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200551- MIPS CPU options:
552 CONFIG_SYS_INIT_SP_OFFSET
553
554 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
555 pointer. This is needed for the temporary stack before
556 relocation.
557
558 CONFIG_SYS_MIPS_CACHE_MODE
559
560 Cache operation mode for the MIPS CPU.
561 See also arch/mips/include/asm/mipsregs.h.
562 Possible values are:
563 CONF_CM_CACHABLE_NO_WA
564 CONF_CM_CACHABLE_WA
565 CONF_CM_UNCACHED
566 CONF_CM_CACHABLE_NONCOHERENT
567 CONF_CM_CACHABLE_CE
568 CONF_CM_CACHABLE_COW
569 CONF_CM_CACHABLE_CUW
570 CONF_CM_CACHABLE_ACCELERATED
571
572 CONFIG_SYS_XWAY_EBU_BOOTCFG
573
574 Special option for Lantiq XWAY SoCs for booting from NOR flash.
575 See also arch/mips/cpu/mips32/start.S.
576
577 CONFIG_XWAY_SWAP_BYTES
578
579 Enable compilation of tools/xway-swap-bytes needed for Lantiq
580 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
581 be swapped if a flash programmer is used.
582
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000583- ARM options:
584 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
585
586 Select high exception vectors of the ARM core, e.g., do not
587 clear the V bit of the c1 register of CP15.
588
Aneesh Vb8e40802012-03-08 07:20:19 +0000589 CONFIG_SYS_THUMB_BUILD
590
591 Use this flag to build U-Boot using the Thumb instruction
592 set for ARM architectures. Thumb instruction set provides
593 better code density. For ARM architectures that support
594 Thumb2 this flag will result in Thumb2 code generated by
595 GCC.
596
Stephen Warrenc63c3502013-03-04 13:29:40 +0000597 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000598 CONFIG_ARM_ERRATA_742230
599 CONFIG_ARM_ERRATA_743622
600 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500601 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100602 CONFIG_ARM_ERRATA_773022
603 CONFIG_ARM_ERRATA_774769
604 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-02-26 12:28:27 +0000605
606 If set, the workarounds for these ARM errata are applied early
607 during U-Boot startup. Note that these options force the
608 workarounds to be applied; no CPU-type/version detection
609 exists, unlike the similar options in the Linux kernel. Do not
610 set these options unless they apply!
611
York Sun77a10972015-03-20 19:28:08 -0700612 COUNTER_FREQUENCY
613 Generic timer clock source frequency.
614
615 COUNTER_FREQUENCY_REAL
616 Generic timer clock source frequency if the real clock is
617 different from COUNTER_FREQUENCY, and can only be determined
618 at run time.
619
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500620 NOTE: The following can be machine specific errata. These
621 do have ability to provide rudimentary version and machine
622 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500623 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500624 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500625 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500626 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500627 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500628
Stephen Warren8d1fb312015-01-19 16:25:52 -0700629- Tegra SoC options:
630 CONFIG_TEGRA_SUPPORT_NON_SECURE
631
632 Support executing U-Boot in non-secure (NS) mode. Certain
633 impossible actions will be skipped if the CPU is in NS mode,
634 such as ARM architectural timer initialization.
635
wdenk9b7f3842003-10-09 20:09:04 +0000636- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000637 CONFIG_CLOCKS_IN_MHZ
638
639 U-Boot stores all clock information in Hz
640 internally. For binary compatibility with older Linux
641 kernels (which expect the clocks passed in the
642 bd_info data to be in MHz) the environment variable
643 "clocks_in_mhz" can be defined so that U-Boot
644 converts clock data to MHZ before passing it to the
645 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000646 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100647 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000648 default environment.
649
wdenk9b7f3842003-10-09 20:09:04 +0000650 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
651
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800652 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000653 expect it to be in bytes, others in MB.
654 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
655
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400656 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200657
658 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400659 passed using flattened device trees (based on open firmware
660 concepts).
661
662 CONFIG_OF_LIBFDT
663 * New libfdt-based support
664 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500665 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400666
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200667 OF_CPU - The proper name of the cpus node (only required for
668 MPC512X and MPC5xxx based boards).
669 OF_SOC - The proper name of the soc node (only required for
670 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200671 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600672 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200673
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200674 boards with QUICC Engines require OF_QE to set UCC MAC
675 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500676
Kumar Gala1e26aa52006-01-11 13:54:17 -0600677 CONFIG_OF_BOARD_SETUP
678
679 Board code has addition modification that it wants to make
680 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000681
Simon Glass6c0be912014-10-23 18:58:54 -0600682 CONFIG_OF_SYSTEM_SETUP
683
684 Other code has addition modification that it wants to make
685 to the flat device tree before handing it off to the kernel.
686 This causes ft_system_setup() to be called before booting
687 the kernel.
688
Heiko Schocherffb293a2009-09-23 07:56:08 +0200689 CONFIG_OF_IDE_FIXUP
690
691 U-Boot can detect if an IDE device is present or not.
692 If not, and this new config option is activated, U-Boot
693 removes the ATA node from the DTS before booting Linux,
694 so the Linux IDE driver does not probe the device and
695 crash. This is needed for buggy hardware (uc101) where
696 no pull down resistor is connected to the signal IDE5V_DD7.
697
Igor Grinberg06890672011-07-14 05:45:07 +0000698 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
699
700 This setting is mandatory for all boards that have only one
701 machine type and must be used to specify the machine type
702 number as it appears in the ARM machine registry
703 (see http://www.arm.linux.org.uk/developer/machines/).
704 Only boards that have multiple machine types supported
705 in a single configuration file and the machine type is
706 runtime discoverable, do not have to use this setting.
707
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100708- vxWorks boot parameters:
709
710 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700711 environments variables: bootdev, bootfile, ipaddr, netmask,
712 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100713 It loads the vxWorks image pointed bootfile.
714
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100715 Note: If a "bootargs" environment is defined, it will overwride
716 the defaults discussed just above.
717
Aneesh V960f5c02011-06-16 23:30:47 +0000718- Cache Configuration:
719 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
720 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
721 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
722
Aneesh V686a0752011-06-16 23:30:51 +0000723- Cache Configuration for ARM:
724 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
725 controller
726 CONFIG_SYS_PL310_BASE - Physical base address of PL310
727 controller register space
728
wdenkda04a8b2004-08-02 23:22:59 +0000729- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200730 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000731
732 Define this if you want support for Amba PrimeCell PL010 UARTs.
733
Andreas Engel0813b122008-09-08 14:30:53 +0200734 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000735
736 Define this if you want support for Amba PrimeCell PL011 UARTs.
737
738 CONFIG_PL011_CLOCK
739
740 If you have Amba PrimeCell PL011 UARTs, set this variable to
741 the clock speed of the UARTs.
742
743 CONFIG_PL01x_PORTS
744
745 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
746 define this to a list of base addresses for each (supported)
747 port. See e.g. include/configs/versatile.h
748
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400749 CONFIG_SERIAL_HW_FLOW_CONTROL
750
751 Define this variable to enable hw flow control in serial driver.
752 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000753
wdenkc6097192002-11-03 00:24:07 +0000754- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000755 Depending on board, define exactly one serial port
756 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
757 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
758 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000759
760 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
761 port routines must be defined elsewhere
762 (i.e. serial_init(), serial_getc(), ...)
763
wdenkc6097192002-11-03 00:24:07 +0000764- Console Baudrate:
765 CONFIG_BAUDRATE - in bps
766 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200767 CONFIG_SYS_BAUDRATE_TABLE, see below.
768 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000769
Heiko Schocher327480a2009-01-30 12:55:38 +0100770- Console Rx buffer length
771 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
772 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100773 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100774 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
775 must be defined, to setup the maximum idle timeout for
776 the SMC.
777
wdenkc6097192002-11-03 00:24:07 +0000778- Autoboot Command:
779 CONFIG_BOOTCOMMAND
780 Only needed when CONFIG_BOOTDELAY is enabled;
781 define a command string that is automatically executed
782 when no character is read on the console interface
783 within "Boot Delay" after reset.
784
785 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000786 This can be used to pass arguments to the bootm
787 command. The value of CONFIG_BOOTARGS goes into the
788 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000789
790 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000791 The value of these goes into the environment as
792 "ramboot" and "nfsboot" respectively, and can be used
793 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200794 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000795
Heiko Schocher040c5c32013-11-04 14:04:59 +0100796- Bootcount:
797 CONFIG_BOOTCOUNT_LIMIT
798 Implements a mechanism for detecting a repeating reboot
799 cycle, see:
800 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
801
802 CONFIG_BOOTCOUNT_ENV
803 If no softreset save registers are found on the hardware
804 "bootcount" is stored in the environment. To prevent a
805 saveenv on all reboots, the environment variable
806 "upgrade_available" is used. If "upgrade_available" is
807 0, "bootcount" is always 0, if "upgrade_available" is
808 1 "bootcount" is incremented in the environment.
809 So the Userspace Applikation must set the "upgrade_available"
810 and "bootcount" variable to 0, if a boot was successfully.
811
wdenkc6097192002-11-03 00:24:07 +0000812- Pre-Boot Commands:
813 CONFIG_PREBOOT
814
815 When this option is #defined, the existence of the
816 environment variable "preboot" will be checked
817 immediately before starting the CONFIG_BOOTDELAY
818 countdown and/or running the auto-boot command resp.
819 entering interactive mode.
820
821 This feature is especially useful when "preboot" is
822 automatically generated or modified. For an example
823 see the LWMON board specific code: here "preboot" is
824 modified when the user holds down a certain
825 combination of keys on the (special) keyboard when
826 booting the systems
827
828- Serial Download Echo Mode:
829 CONFIG_LOADS_ECHO
830 If defined to 1, all characters received during a
831 serial download (using the "loads" command) are
832 echoed back. This might be needed by some terminal
833 emulations (like "cu"), but may as well just take
834 time on others. This setting #define's the initial
835 value of the "loads_echo" environment variable.
836
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500837- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000838 CONFIG_KGDB_BAUDRATE
839 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200840 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000841
842- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500843 Monitor commands can be included or excluded
844 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000845 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500846 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000847
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500848 The default command configuration includes all commands
849 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000850
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100851 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500853 CONFIG_CMD_BDI bdinfo
854 CONFIG_CMD_BEDBUG * Include BedBug Debugger
855 CONFIG_CMD_BMP * BMP support
856 CONFIG_CMD_BSP * Board specific commands
857 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400858 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500859 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800860 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500861 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500862 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500863 CONFIG_CMD_DATE * support for RTC, date/time...
864 CONFIG_CMD_DHCP * DHCP support
865 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600866 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
867 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
868 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
869 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500870 CONFIG_CMD_DTT * Digital Therm and Thermostat
871 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500872 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500873 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300874 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500875 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600876 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600877 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500878 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500879 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000880 CONFIG_CMD_EXT2 * ext2 command support
881 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700882 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
883 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100884 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500885 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500886 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000887 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500888 CONFIG_CMD_FLASH flinfo, erase, protect
889 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200890 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000891 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500892 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000893 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000894 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_I2C * I2C serial bus support
896 CONFIG_CMD_IDE * IDE harddisk support
897 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000898 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200899 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500900 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600901 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500902 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000903 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_IRQ * irqinfo
905 CONFIG_CMD_ITEST Integer/string test of 2 values
906 CONFIG_CMD_JFFS2 * JFFS2 Support
907 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200908 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000909 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
910 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500911 CONFIG_CMD_LOADB loadb
912 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200913 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400914 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000915 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000917 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200918 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500919 CONFIG_CMD_MISC Misc functions like sleep etc
920 CONFIG_CMD_MMC * MMC memory mapped support
921 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100922 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500923 CONFIG_CMD_NAND * NAND support
924 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200925 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600926 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000927 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 CONFIG_CMD_PCI * pciinfo
929 CONFIG_CMD_PCMCIA * PCMCIA support
930 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
931 host
932 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000933 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500934 CONFIG_CMD_REGINFO * Register dump
935 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000936 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500937 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600938 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500939 CONFIG_CMD_SDRAM * print SDRAM configuration information
940 (requires CONFIG_CMD_I2C)
941 CONFIG_CMD_SETGETDCR Support for DCR Register access
942 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700943 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200944 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400945 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800946 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200947 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500948 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000949 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000950 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000951 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
952 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500953 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500954 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000955 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200956 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200957 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000958
959 EXAMPLE: If you want all functions except of network
960 support you can write:
961
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500962 #include "config_cmd_all.h"
963 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000964
Gerald Van Barend6abef42007-03-31 12:23:51 -0400965 Other Commands:
966 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000967
968 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500969 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000970 what you (and your U-Boot users) are doing. Data
971 cache cannot be enabled on systems like the 8xx or
972 8260 (where accesses to the IMMR region must be
973 uncached), and it cannot be disabled on all other
974 systems where we (mis-) use the data cache to hold an
975 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000976
977
978 XXX - this list needs to get updated!
979
Simon Glassaa34ef22016-03-13 19:07:28 -0600980- Removal of commands
981 If no commands are needed to boot, you can disable
982 CONFIG_CMDLINE to remove them. In this case, the command line
983 will not be available, and when U-Boot wants to execute the
984 boot command (on start-up) it will call board_run_command()
985 instead. This can reduce image size significantly for very
986 simple boot procedures.
987
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000988- Regular expression support:
989 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200990 If this variable is defined, U-Boot is linked against
991 the SLRE (Super Light Regular Expression) library,
992 which adds regex support to some commands, as for
993 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000994
Simon Glass3d686442011-10-15 05:48:20 +0000995- Device tree:
996 CONFIG_OF_CONTROL
997 If this variable is defined, U-Boot will use a device tree
998 to configure its devices, instead of relying on statically
999 compiled #defines in the board file. This option is
1000 experimental and only available on a few boards. The device
1001 tree is available in the global data as gd->fdt_blob.
1002
Simon Glass5cb34db2011-10-24 19:15:31 +00001003 U-Boot needs to get its device tree from somewhere. This can
1004 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001005
1006 CONFIG_OF_EMBED
1007 If this variable is defined, U-Boot will embed a device tree
1008 binary in its image. This device tree file should be in the
1009 board directory and called <soc>-<board>.dts. The binary file
1010 is then picked up in board_init_f() and made available through
1011 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001012
Simon Glass5cb34db2011-10-24 19:15:31 +00001013 CONFIG_OF_SEPARATE
1014 If this variable is defined, U-Boot will build a device tree
1015 binary. It will be called u-boot.dtb. Architecture-specific
1016 code will locate it at run-time. Generally this works by:
1017
1018 cat u-boot.bin u-boot.dtb >image.bin
1019
1020 and in fact, U-Boot does this for you, creating a file called
1021 u-boot-dtb.bin which is useful in the common case. You can
1022 still use the individual files if you need something more
1023 exotic.
1024
wdenkc6097192002-11-03 00:24:07 +00001025- Watchdog:
1026 CONFIG_WATCHDOG
1027 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001028 support for the SoC. There must be support in the SoC
1029 specific code for a watchdog. For the 8xx and 8260
1030 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1031 register. When supported for a specific SoC is
1032 available, then no further board specific code should
1033 be needed to use it.
1034
1035 CONFIG_HW_WATCHDOG
1036 When using a watchdog circuitry external to the used
1037 SoC, then define this variable and provide board
1038 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001039
Heiko Schocher735326c2015-01-21 08:38:22 +01001040 CONFIG_AT91_HW_WDT_TIMEOUT
1041 specify the timeout in seconds. default 2 seconds.
1042
stroeseb9c17c52003-04-04 15:53:41 +00001043- U-Boot Version:
1044 CONFIG_VERSION_VARIABLE
1045 If this variable is defined, an environment variable
1046 named "ver" is created by U-Boot showing the U-Boot
1047 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001048 Any change to this variable will be reverted at the
1049 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001050
wdenkc6097192002-11-03 00:24:07 +00001051- Real-Time Clock:
1052
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001053 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001054 has to be selected, too. Define exactly one of the
1055 following options:
1056
1057 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1058 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001059 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001060 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001061 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001062 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001063 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001064 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001065 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001066 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001067 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001068 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001069 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1070 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001071
wdenkb9bbd242003-06-30 16:24:52 +00001072 Note that if the RTC uses I2C, then the I2C interface
1073 must also be configured. See I2C Support, below.
1074
Peter Tyser9902e422008-12-17 16:36:21 -06001075- GPIO Support:
1076 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001077
Chris Packham9b383202010-12-19 10:12:13 +00001078 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1079 chip-ngpio pairs that tell the PCA953X driver the number of
1080 pins supported by a particular chip.
1081
Peter Tyser9902e422008-12-17 16:36:21 -06001082 Note that if the GPIO device uses I2C, then the I2C interface
1083 must also be configured. See I2C Support, below.
1084
Simon Glass4dc47ca2014-06-11 23:29:41 -06001085- I/O tracing:
1086 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1087 accesses and can checksum them or write a list of them out
1088 to memory. See the 'iotrace' command for details. This is
1089 useful for testing device drivers since it can confirm that
1090 the driver behaves the same way before and after a code
1091 change. Currently this is supported on sandbox and arm. To
1092 add support for your architecture, add '#include <iotrace.h>'
1093 to the bottom of arch/<arch>/include/asm/io.h and test.
1094
1095 Example output from the 'iotrace stats' command is below.
1096 Note that if the trace buffer is exhausted, the checksum will
1097 still continue to operate.
1098
1099 iotrace is enabled
1100 Start: 10000000 (buffer start address)
1101 Size: 00010000 (buffer size)
1102 Offset: 00000120 (current buffer offset)
1103 Output: 10000120 (start + offset)
1104 Count: 00000018 (number of trace records)
1105 CRC32: 9526fb66 (CRC32 of all trace records)
1106
wdenkc6097192002-11-03 00:24:07 +00001107- Timestamp Support:
1108
wdenk4a5c8a72003-03-06 00:02:04 +00001109 When CONFIG_TIMESTAMP is selected, the timestamp
1110 (date and time) of an image is printed by image
1111 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001112 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001113
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001114- Partition Labels (disklabels) Supported:
1115 Zero or more of the following:
1116 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1117 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1118 Intel architecture, USB sticks, etc.
1119 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1120 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1121 bootloader. Note 2TB partition limit; see
1122 disk/part_efi.c
1123 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001124
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001125 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001126 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001127 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001128
1129- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001130 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1131 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001132
wdenk369d43d2004-03-14 14:09:05 +00001133 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1134 be performed by calling the function
1135 ide_set_reset(int reset)
1136 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001137
1138- ATAPI Support:
1139 CONFIG_ATAPI
1140
1141 Set this to enable ATAPI support.
1142
wdenkf602aa02004-03-13 23:29:43 +00001143- LBA48 Support
1144 CONFIG_LBA48
1145
1146 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001147 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001148 Whithout these , LBA48 support uses 32bit variables and will 'only'
1149 support disks up to 2.1TB.
1150
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001151 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001152 When enabled, makes the IDE subsystem use 64bit sector addresses.
1153 Default is 32bit.
1154
wdenkc6097192002-11-03 00:24:07 +00001155- SCSI Support:
1156 At the moment only there is only support for the
1157 SYM53C8XX SCSI controller; define
1158 CONFIG_SCSI_SYM53C8XX to enable it.
1159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001160 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1161 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1162 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001163 maximum numbers of LUNs, SCSI ID's and target
1164 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001165 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001166
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001167 The environment variable 'scsidevs' is set to the number of
1168 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001169
wdenkc6097192002-11-03 00:24:07 +00001170- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001171 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001172 Support for Intel 8254x/8257x gigabit chips.
1173
1174 CONFIG_E1000_SPI
1175 Utility code for direct access to the SPI bus on Intel 8257x.
1176 This does not do anything useful unless you set at least one
1177 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1178
1179 CONFIG_E1000_SPI_GENERIC
1180 Allow generic access to the SPI bus on the Intel 8257x, for
1181 example with the "sspi" command.
1182
1183 CONFIG_CMD_E1000
1184 Management command for E1000 devices. When used on devices
1185 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001186
wdenkc6097192002-11-03 00:24:07 +00001187 CONFIG_EEPRO100
1188 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001189 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001190 write routine for first time initialisation.
1191
1192 CONFIG_TULIP
1193 Support for Digital 2114x chips.
1194 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1195 modem chip initialisation (KS8761/QS6611).
1196
1197 CONFIG_NATSEMI
1198 Support for National dp83815 chips.
1199
1200 CONFIG_NS8382X
1201 Support for National dp8382[01] gigabit chips.
1202
wdenkaa603362003-05-12 21:50:16 +00001203- NETWORK Support (other):
1204
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001205 CONFIG_DRIVER_AT91EMAC
1206 Support for AT91RM9200 EMAC.
1207
1208 CONFIG_RMII
1209 Define this to use reduced MII inteface
1210
1211 CONFIG_DRIVER_AT91EMAC_QUIET
1212 If this defined, the driver is quiet.
1213 The driver doen't show link status messages.
1214
Rob Herringc9830dc2011-12-15 11:15:49 +00001215 CONFIG_CALXEDA_XGMAC
1216 Support for the Calxeda XGMAC device
1217
Ashok93fb8722012-10-15 06:20:47 +00001218 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001219 Support for SMSC's LAN91C96 chips.
1220
wdenkaa603362003-05-12 21:50:16 +00001221 CONFIG_LAN91C96_USE_32_BIT
1222 Define this to enable 32 bit addressing
1223
Ashok93fb8722012-10-15 06:20:47 +00001224 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001225 Support for SMSC's LAN91C111 chip
1226
1227 CONFIG_SMC91111_BASE
1228 Define this to hold the physical address
1229 of the device (I/O space)
1230
1231 CONFIG_SMC_USE_32_BIT
1232 Define this if data bus is 32 bits
1233
1234 CONFIG_SMC_USE_IOFUNCS
1235 Define this to use i/o functions instead of macros
1236 (some hardware wont work with macros)
1237
Heiko Schocher7d037f72011-11-15 10:00:04 -05001238 CONFIG_DRIVER_TI_EMAC
1239 Support for davinci emac
1240
1241 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1242 Define this if you have more then 3 PHYs.
1243
Macpaul Lin199c6252010-12-21 16:59:46 +08001244 CONFIG_FTGMAC100
1245 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1246
1247 CONFIG_FTGMAC100_EGIGA
1248 Define this to use GE link update with gigabit PHY.
1249 Define this if FTGMAC100 is connected to gigabit PHY.
1250 If your system has 10/100 PHY only, it might not occur
1251 wrong behavior. Because PHY usually return timeout or
1252 useless data when polling gigabit status and gigabit
1253 control registers. This behavior won't affect the
1254 correctnessof 10/100 link speed update.
1255
Mike Rapoportf4761af2009-11-11 10:03:03 +02001256 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001257 Support for SMSC's LAN911x and LAN921x chips
1258
Mike Rapoportf4761af2009-11-11 10:03:03 +02001259 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001260 Define this to hold the physical address
1261 of the device (I/O space)
1262
Mike Rapoportf4761af2009-11-11 10:03:03 +02001263 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001264 Define this if data bus is 32 bits
1265
Mike Rapoportf4761af2009-11-11 10:03:03 +02001266 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001267 Define this if data bus is 16 bits. If your processor
1268 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001269 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001270
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001271 CONFIG_SH_ETHER
1272 Support for Renesas on-chip Ethernet controller
1273
1274 CONFIG_SH_ETHER_USE_PORT
1275 Define the number of ports to be used
1276
1277 CONFIG_SH_ETHER_PHY_ADDR
1278 Define the ETH PHY's address
1279
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001280 CONFIG_SH_ETHER_CACHE_WRITEBACK
1281 If this option is set, the driver enables cache flush.
1282
Heiko Schocher2b387762014-07-18 06:07:19 +02001283- PWM Support:
1284 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001285 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001286
Vadim Bendeburydac69642011-10-17 08:36:14 +00001287- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001288 CONFIG_TPM
1289 Support TPM devices.
1290
Christophe Ricard8759ff82015-10-06 22:54:41 +02001291 CONFIG_TPM_TIS_INFINEON
1292 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001293 per system is supported at this time.
1294
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001295 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1296 Define the burst count bytes upper limit
1297
Christophe Ricard88249232016-01-21 23:27:13 +01001298 CONFIG_TPM_ST33ZP24
1299 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1300
1301 CONFIG_TPM_ST33ZP24_I2C
1302 Support for STMicroelectronics ST33ZP24 I2C devices.
1303 Requires TPM_ST33ZP24 and I2C.
1304
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001305 CONFIG_TPM_ST33ZP24_SPI
1306 Support for STMicroelectronics ST33ZP24 SPI devices.
1307 Requires TPM_ST33ZP24 and SPI.
1308
Dirk Eibach20489092013-06-26 15:55:15 +02001309 CONFIG_TPM_ATMEL_TWI
1310 Support for Atmel TWI TPM device. Requires I2C support.
1311
Che-liang Chiouacea5702013-04-12 11:04:34 +00001312 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001313 Support for generic parallel port TPM devices. Only one device
1314 per system is supported at this time.
1315
1316 CONFIG_TPM_TIS_BASE_ADDRESS
1317 Base address where the generic TPM device is mapped
1318 to. Contemporary x86 systems usually map it at
1319 0xfed40000.
1320
Reinhard Pfau4fece432013-06-26 15:55:13 +02001321 CONFIG_CMD_TPM
1322 Add tpm monitor functions.
1323 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1324 provides monitor access to authorized functions.
1325
1326 CONFIG_TPM
1327 Define this to enable the TPM support library which provides
1328 functional interfaces to some TPM commands.
1329 Requires support for a TPM device.
1330
1331 CONFIG_TPM_AUTH_SESSIONS
1332 Define this to enable authorized functions in the TPM library.
1333 Requires CONFIG_TPM and CONFIG_SHA1.
1334
wdenkc6097192002-11-03 00:24:07 +00001335- USB Support:
1336 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001337 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001338 CONFIG_USB_UHCI to enable it.
1339 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001340 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001341 storage devices.
1342 Note:
1343 Supported are USB Keyboards and USB Floppy drives
1344 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001345 MPC5200 USB requires additional defines:
1346 CONFIG_USB_CLOCK
1347 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001348 CONFIG_PSC3_USB
1349 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001350 CONFIG_USB_CONFIG
1351 for differential drivers: 0x00001000
1352 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001353 for differential drivers on PSC3: 0x00000100
1354 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001355 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001356 May be defined to allow interrupt polling
1357 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001358
Simon Glass5978cdb2012-02-27 10:52:47 +00001359 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1360 txfilltuning field in the EHCI controller on reset.
1361
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001362 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1363 HW module registers.
1364
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001365- USB Device:
1366 Define the below if you wish to use the USB console.
1367 Once firmware is rebuilt from a serial console issue the
1368 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001369 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001370 it has found a new device. The environment variable usbtty
1371 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001372 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001373 Common Device Class Abstract Control Model serial device.
1374 If you select usbtty = gserial you should be able to enumerate
1375 a Linux host by
1376 # modprobe usbserial vendor=0xVendorID product=0xProductID
1377 else if using cdc_acm, simply setting the environment
1378 variable usbtty to be cdc_acm should suffice. The following
1379 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001380
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001381 CONFIG_USB_DEVICE
1382 Define this to build a UDC device
1383
1384 CONFIG_USB_TTY
1385 Define this to have a tty type of device available to
1386 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001387
Vipin KUMARbdb17702012-03-26 15:38:06 +05301388 CONFIG_USBD_HS
1389 Define this to enable the high speed support for usb
1390 device and usbtty. If this feature is enabled, a routine
1391 int is_usbd_high_speed(void)
1392 also needs to be defined by the driver to dynamically poll
1393 whether the enumeration has succeded at high speed or full
1394 speed.
1395
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001396 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001397 Define this if you want stdin, stdout &/or stderr to
1398 be set to usbtty.
1399
1400 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001401 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001402 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001403 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001404
Wolfgang Denke2601822006-06-14 18:14:56 +02001405 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001406 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001407 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001408 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1409 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1410 should pretend to be a Linux device to it's target host.
1411
1412 CONFIG_USBD_MANUFACTURER
1413 Define this string as the name of your company for
1414 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001415
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001416 CONFIG_USBD_PRODUCT_NAME
1417 Define this string as the name of your product
1418 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001419
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001420 CONFIG_USBD_VENDORID
1421 Define this as your assigned Vendor ID from the USB
1422 Implementors Forum. This *must* be a genuine Vendor ID
1423 to avoid polluting the USB namespace.
1424 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001425
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001426 CONFIG_USBD_PRODUCTID
1427 Define this as the unique Product ID
1428 for your device
1429 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001430
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001431- ULPI Layer Support:
1432 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1433 the generic ULPI layer. The generic layer accesses the ULPI PHY
1434 via the platform viewport, so you need both the genric layer and
1435 the viewport enabled. Currently only Chipidea/ARC based
1436 viewport is supported.
1437 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1438 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001439 If your ULPI phy needs a different reference clock than the
1440 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1441 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001442
wdenk7a428cc2003-06-15 22:40:42 +00001443- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001444 The MMC controller on the Intel PXA is supported. To
1445 enable this define CONFIG_MMC. The MMC can be
1446 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001447 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001448 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1449 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001450
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001451 CONFIG_SH_MMCIF
1452 Support for Renesas on-chip MMCIF controller
1453
1454 CONFIG_SH_MMCIF_ADDR
1455 Define the base address of MMCIF registers
1456
1457 CONFIG_SH_MMCIF_CLK
1458 Define the clock frequency for MMCIF
1459
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001460 CONFIG_SUPPORT_EMMC_BOOT
1461 Enable some additional features of the eMMC boot partitions.
1462
1463 CONFIG_SUPPORT_EMMC_RPMB
1464 Enable the commands for reading, writing and programming the
1465 key for the Replay Protection Memory Block partition in eMMC.
1466
Tom Rini58a8d322013-03-14 05:32:47 +00001467- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001468 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001469 This enables the USB portion of the DFU USB class
1470
1471 CONFIG_CMD_DFU
1472 This enables the command "dfu" which is used to have
1473 U-Boot create a DFU class device via USB. This command
1474 requires that the "dfu_alt_info" environment variable be
1475 set and define the alt settings to expose to the host.
1476
1477 CONFIG_DFU_MMC
1478 This enables support for exposing (e)MMC devices via DFU.
1479
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001480 CONFIG_DFU_NAND
1481 This enables support for exposing NAND devices via DFU.
1482
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301483 CONFIG_DFU_RAM
1484 This enables support for exposing RAM via DFU.
1485 Note: DFU spec refer to non-volatile memory usage, but
1486 allow usages beyond the scope of spec - here RAM usage,
1487 one that would help mostly the developer.
1488
Heiko Schochera2f831e2013-06-12 06:05:51 +02001489 CONFIG_SYS_DFU_DATA_BUF_SIZE
1490 Dfu transfer uses a buffer before writing data to the
1491 raw storage device. Make the size (in bytes) of this buffer
1492 configurable. The size of this buffer is also configurable
1493 through the "dfu_bufsiz" environment variable.
1494
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001495 CONFIG_SYS_DFU_MAX_FILE_SIZE
1496 When updating files rather than the raw storage device,
1497 we use a static buffer to copy the file into and then write
1498 the buffer once we've been given the whole file. Define
1499 this to the maximum filesize (in bytes) for the buffer.
1500 Default is 4 MiB if undefined.
1501
Heiko Schochere1ba1512014-03-18 08:09:56 +01001502 DFU_DEFAULT_POLL_TIMEOUT
1503 Poll timeout [ms], is the timeout a device can send to the
1504 host. The host must wait for this timeout before sending
1505 a subsequent DFU_GET_STATUS request to the device.
1506
1507 DFU_MANIFEST_POLL_TIMEOUT
1508 Poll timeout [ms], which the device sends to the host when
1509 entering dfuMANIFEST state. Host waits this timeout, before
1510 sending again an USB request to the device.
1511
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001512- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001513 CONFIG_USB_FUNCTION_FASTBOOT
1514 This enables the USB part of the fastboot gadget
1515
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001516 CONFIG_CMD_FASTBOOT
1517 This enables the command "fastboot" which enables the Android
1518 fastboot mode for the platform's USB device. Fastboot is a USB
1519 protocol for downloading images, flashing and device control
1520 used on Android devices.
1521 See doc/README.android-fastboot for more information.
1522
1523 CONFIG_ANDROID_BOOT_IMAGE
1524 This enables support for booting images which use the Android
1525 image format header.
1526
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001527 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001528 The fastboot protocol requires a large memory buffer for
1529 downloads. Define this to the starting RAM address to use for
1530 downloaded images.
1531
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001532 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001533 The fastboot protocol requires a large memory buffer for
1534 downloads. This buffer should be as large as possible for a
1535 platform. Define this to the size available RAM for fastboot.
1536
Steve Raebfb9ba42014-08-26 11:47:28 -07001537 CONFIG_FASTBOOT_FLASH
1538 The fastboot protocol includes a "flash" command for writing
1539 the downloaded image to a non-volatile storage device. Define
1540 this to enable the "fastboot flash" command.
1541
1542 CONFIG_FASTBOOT_FLASH_MMC_DEV
1543 The fastboot "flash" command requires additional information
1544 regarding the non-volatile storage device. Define this to
1545 the eMMC device that fastboot should use to store the image.
1546
Steve Rae7d059342014-12-12 15:51:54 -08001547 CONFIG_FASTBOOT_GPT_NAME
1548 The fastboot "flash" command supports writing the downloaded
1549 image to the Protective MBR and the Primary GUID Partition
1550 Table. (Additionally, this downloaded image is post-processed
1551 to generate and write the Backup GUID Partition Table.)
1552 This occurs when the specified "partition name" on the
1553 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001554 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001555
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001556 CONFIG_FASTBOOT_MBR_NAME
1557 The fastboot "flash" command supports writing the downloaded
1558 image to DOS MBR.
1559 This occurs when the "partition name" specified on the
1560 "fastboot flash" command line matches this value.
1561 If not defined the default value "mbr" is used.
1562
wdenkda04a8b2004-08-02 23:22:59 +00001563- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001564 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001565 Define these for a default partition on a NAND device
1566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001567 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1568 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001569 Define these for a default partition on a NOR device
1570
Donggeun Kim8f814002011-10-24 21:15:28 +00001571- FAT(File Allocation Table) filesystem write function support:
1572 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001573
1574 Define this to enable support for saving memory data as a
1575 file in FAT formatted partition.
1576
1577 This will also enable the command "fatwrite" enabling the
1578 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001579
Alexander von Gernler3ab5f462016-10-07 19:44:14 +02001580- CBFS (Coreboot Filesystem) support:
Gabe Black7f8574c2012-10-12 14:26:11 +00001581 CONFIG_CMD_CBFS
1582
1583 Define this to enable support for reading from a Coreboot
1584 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1585 and cbfsload.
1586
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301587- FAT(File Allocation Table) filesystem cluster size:
1588 CONFIG_FS_FAT_MAX_CLUSTSIZE
1589
1590 Define the max cluster size for fat operations else
1591 a default value of 65536 will be defined.
1592
wdenkc6097192002-11-03 00:24:07 +00001593- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001594 See Kconfig help for available keyboard drivers.
1595
1596 CONFIG_KEYBOARD
1597
1598 Define this to enable a custom keyboard support.
1599 This simply calls drv_keyboard_init() which must be
1600 defined in your board-specific files. This option is deprecated
1601 and is only used by novena. For new boards, use driver model
1602 instead.
wdenkc6097192002-11-03 00:24:07 +00001603
1604- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001605 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001606 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001607 SOCs that have a DIU should define this macro to enable DIU
1608 support, and should also define these other macros:
1609
1610 CONFIG_SYS_DIU_ADDR
1611 CONFIG_VIDEO
1612 CONFIG_CMD_BMP
1613 CONFIG_CFB_CONSOLE
1614 CONFIG_VIDEO_SW_CURSOR
1615 CONFIG_VGA_AS_SINGLE_DEVICE
1616 CONFIG_VIDEO_LOGO
1617 CONFIG_VIDEO_BMP_LOGO
1618
Timur Tabi32f709e2011-04-11 14:18:22 -05001619 The DIU driver will look for the 'video-mode' environment
1620 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001621 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001622 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001623
wdenkc6097192002-11-03 00:24:07 +00001624- LCD Support: CONFIG_LCD
1625
1626 Define this to enable LCD support (for output to LCD
1627 display); also select one of the supported displays
1628 by defining one of these:
1629
Stelian Popf6f86652008-05-09 21:57:18 +02001630 CONFIG_ATMEL_LCD:
1631
1632 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1633
wdenkc0d54ae2003-11-25 16:55:19 +00001634 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001635
wdenkc0d54ae2003-11-25 16:55:19 +00001636 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001637
wdenkc0d54ae2003-11-25 16:55:19 +00001638 CONFIG_NEC_NL6448BC20
1639
1640 NEC NL6448BC20-08. 6.5", 640x480.
1641 Active, color, single scan.
1642
1643 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001644
wdenkc0d54ae2003-11-25 16:55:19 +00001645 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001646 Active, color, single scan.
1647
1648 CONFIG_SHARP_16x9
1649
1650 Sharp 320x240. Active, color, single scan.
1651 It isn't 16x9, and I am not sure what it is.
1652
1653 CONFIG_SHARP_LQ64D341
1654
1655 Sharp LQ64D341 display, 640x480.
1656 Active, color, single scan.
1657
1658 CONFIG_HLD1045
1659
1660 HLD1045 display, 640x480.
1661 Active, color, single scan.
1662
1663 CONFIG_OPTREX_BW
1664
1665 Optrex CBL50840-2 NF-FW 99 22 M5
1666 or
1667 Hitachi LMG6912RPFC-00T
1668 or
1669 Hitachi SP14Q002
1670
1671 320x240. Black & white.
1672
1673 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001674 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001675
Simon Glass599a4df2012-10-17 13:24:54 +00001676 CONFIG_LCD_ALIGNMENT
1677
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001678 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001679 defined then the LCD will be aligned to this value instead.
1680 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1681 here, since it is cheaper to change data cache settings on
1682 a per-section basis.
1683
1684
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001685 CONFIG_LCD_ROTATION
1686
1687 Sometimes, for example if the display is mounted in portrait
1688 mode or even if it's mounted landscape but rotated by 180degree,
1689 we need to rotate our content of the display relative to the
1690 framebuffer, so that user can read the messages which are
1691 printed out.
1692 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1693 initialized with a given rotation from "vl_rot" out of
1694 "vidinfo_t" which is provided by the board specific code.
1695 The value for vl_rot is coded as following (matching to
1696 fbcon=rotate:<n> linux-kernel commandline):
1697 0 = no rotation respectively 0 degree
1698 1 = 90 degree rotation
1699 2 = 180 degree rotation
1700 3 = 270 degree rotation
1701
1702 If CONFIG_LCD_ROTATION is not defined, the console will be
1703 initialized with 0degree rotation.
1704
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001705 CONFIG_LCD_BMP_RLE8
1706
1707 Support drawing of RLE8-compressed bitmaps on the LCD.
1708
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001709 CONFIG_I2C_EDID
1710
1711 Enables an 'i2c edid' command which can read EDID
1712 information over I2C from an attached LCD display.
1713
wdenkeb20ad32003-09-05 23:19:14 +00001714- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001715
wdenk57b2d802003-06-27 21:31:46 +00001716 If this option is set, the environment is checked for
1717 a variable "splashimage". If found, the usual display
1718 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001719 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001720 specified in "splashimage" is loaded instead. The
1721 console is redirected to the "nulldev", too. This
1722 allows for a "silent" boot where a splash screen is
1723 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001724
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001725 CONFIG_SPLASHIMAGE_GUARD
1726
1727 If this option is set, then U-Boot will prevent the environment
1728 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001729 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001730 This option is useful for targets where, due to alignment
1731 restrictions, an improperly aligned BMP image will cause a data
1732 abort. If you think you will not have problems with unaligned
1733 accesses (for example because your toolchain prevents them)
1734 there is no need to set this option.
1735
Matthias Weisser53884182009-07-09 16:07:30 +02001736 CONFIG_SPLASH_SCREEN_ALIGN
1737
1738 If this option is set the splash image can be freely positioned
1739 on the screen. Environment variable "splashpos" specifies the
1740 position as "x,y". If a positive number is given it is used as
1741 number of pixel from left/top. If a negative number is given it
1742 is used as number of pixel from right/bottom. You can also
1743 specify 'm' for centering the image.
1744
1745 Example:
1746 setenv splashpos m,m
1747 => image at center of screen
1748
1749 setenv splashpos 30,20
1750 => image at x = 30 and y = 20
1751
1752 setenv splashpos -10,m
1753 => vertically centered image
1754 at x = dspWidth - bmpWidth - 9
1755
Stefan Roesed9d97742005-09-22 09:04:17 +02001756- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1757
1758 If this option is set, additionally to standard BMP
1759 images, gzipped BMP images can be displayed via the
1760 splashscreen support or the bmp command.
1761
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001762- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1763
1764 If this option is set, 8-bit RLE compressed BMP images
1765 can be displayed via the splashscreen support or the
1766 bmp command.
1767
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001768- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001769 CONFIG_CMD_ZIP
1770
1771 If this option is set, it would use zlib deflate method
1772 to compress the specified memory at its best effort.
1773
wdenk710e3502003-08-29 20:57:53 +00001774- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001775 CONFIG_GZIP
1776
1777 Enabled by default to support gzip compressed images.
1778
wdenk710e3502003-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
wdenk9c53f402003-10-15 23:53:47 +00001785 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001786 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001787 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001788
Luigi 'Comio' Mantellini35afc062008-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-VILLARD03836942008-10-16 15:01:15 +02001810 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001811
Kees Cook5b06e642013-08-16 07:59:12 -07001812 CONFIG_LZO
1813
1814 If this option is set, support for LZO compressed images
1815 is included.
1816
wdenk0e2bd9c2004-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 Ziswilerabd8dcb2008-07-09 08:17:15 +02001829 detection of gigabit PHY is included.
wdenk0e2bd9c2004-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 Ziswilerabd8dcb2008-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 Denk26da2992011-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 Ziswilerabd8dcb2008-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 Denk26da2992011-10-26 10:21:22 +00001856 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001857
Robin Getz470a6d42009-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 Denk26da2992011-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 Updegraff7280da72007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +02001885 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-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 Denkb65aaf92007-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 Reding8977cda2014-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
stroesee0aadfb2003-08-28 14:17:32 +00001926- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001927 You can fine tune the DHCP functionality by defining
1928 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001929
Jon Loeliger5336a762007-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 Hershberger8ca7fa02012-05-23 07:59:19 +00001942 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001943
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001944 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1945 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001946
Joe Hershberger8ca7fa02012-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
stroesee0aadfb2003-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 Loeliger5336a762007-07-09 22:08:34 -05001960 is defined.
stroesee0aadfb2003-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 Callan22bcd6e2007-07-28 10:56:13 -04001965 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001966 of the "hostname" environment variable is passed as
1967 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001968
Aras Vaichas72aa3f32008-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 Hershbergerb35a3a62012-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
wdenk145d2c12004-04-15 21:48:45 +00001991 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001992 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-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 Ziswilerabd8dcb2008-07-09 08:17:15 +02002005 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-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 Mashiach3dc6f652017-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 Mashiach3dc6f652017-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 Grinberg4997a9e2013-11-08 01:03:50 +02002044 Additional options:
2045
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002046 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-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 Mashiach3dc6f652017-01-19 10:51:05 +02002049 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002050 to include the gpio_led driver in the U-Boot binary.
2051
Igor Grinberg203bd9f2013-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 Schochere0e55bc2012-01-16 21:12:24 +00002065- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002066
Heiko Schochere0e55bc2012-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 Schocher479a4cf2013-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 Schochere0e55bc2012-01-16 21:12:24 +00002088
Heiko Schocherf2850742012-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 Denkec7fbf52013-10-04 17:43:24 +02002095 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-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 Glass026fefb2012-10-30 07:28:53 +00002101 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-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 Glass026fefb2012-10-30 07:28:53 +00002105
Dirk Eibach42b204f2013-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
trema49f40a2013-09-21 18:13:35 +02002111 - drivers/i2c/i2c_mxc.c
2112 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-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
trema49f40a2013-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\\)eb943872015-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 Mahler03f930c2015-01-04 18:56:50 -08002125 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002126 for speed, and 0 for slave.
2127
Nobuhiro Iwamatsue94ea2f2013-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 Iwamatsu12240102013-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 Mahler03f930c2015-01-04 18:56:50 -08002156 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002157
Heiko Schocherf53f2b82013-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 Schocher465819a2013-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 Ch5d5efd32013-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 Eibachb9577432014-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 Eibach9ac33852015-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 Eibachb9577432014-07-03 09:28:18 +02002205
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002206 additional defines:
2207
2208 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002209 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-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 Mahler03f930c2015-01-04 18:56:50 -08002222 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-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 Schocher479a4cf2013-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 Schochere0e55bc2012-01-16 21:12:24 +00002245 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-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 Schochere0e55bc2012-01-16 21:12:24 +00002248
2249 If you do not have i2c muxes on your board, omit this define.
2250
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002251- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-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. **
wdenkc6097192002-11-03 00:24:07 +00002261
Heiko Schocher479a4cf2013-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
wdenk21136db2003-07-16 21:53:01 +00002266 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002267 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-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
wdenk4a5c8a72003-03-06 00:02:04 +00002270 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002271
Ben Warren45657152006-09-07 16:50:54 -04002272 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002273
wdenk21136db2003-07-16 21:53:01 +00002274 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002275 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002277 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002278 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002279 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002280 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002281
Peter Tysere4d1abc2010-04-12 22:28:21 -05002282 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002283 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-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 Millbrandt12990a42009-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
wdenk21136db2003-07-16 21:53:01 +00002295 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002296
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002297 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-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
wdenkb9bbd242003-06-30 16:24:52 +00002303 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002304 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002305
wdenk544e9732004-02-06 23:19:44 +00002306 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002307
wdenkc6097192002-11-03 00:24:07 +00002308 I2C_PORT
2309
wdenk4a5c8a72003-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
wdenkb9bbd242003-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
wdenkb9bbd242003-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 Sun4a598092013-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
wdenkb9bbd242003-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 Sun4a598092013-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
wdenkb9bbd242003-06-30 16:24:52 +00002342 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002343 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002344 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002345
wdenkc6097192002-11-03 00:24:07 +00002346 I2C_SCL(bit)
2347
York Sun4a598092013-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
wdenkb9bbd242003-06-30 16:24:52 +00002351 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002352 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002353 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-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
wdenkb9bbd242003-06-30 16:24:52 +00002359 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002360 like:
2361
wdenkb9bbd242003-06-30 16:24:52 +00002362 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002363
Mike Frysingeree12d542010-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-VILLARD03836942008-10-16 15:01:15 +02002374 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002375
wdenk57b2d802003-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.
wdenkcc1e2562003-03-06 13:39:27 +00002384
Richard Retanubundf0149c2010-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
wdenk0e2bd9c2004-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 Warren45657152006-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 Denk092ae952011-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 Warren45657152006-09-07 16:50:54 -04002407 Note that bus numbering is zero-based.
2408
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002409 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002410
2411 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002412 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-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 Warren45657152006-09-07 16:50:54 -04002415
2416 e.g.
2417 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002418 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002419
2420 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2421
Wolfgang Denk092ae952011-10-26 10:21:21 +00002422 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002423 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-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-VILLARD03836942008-10-16 15:01:15 +02002427 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-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-VILLARD03836942008-10-16 15:01:15 +02002432 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-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-VILLARD03836942008-10-16 15:01:15 +02002437 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-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-VILLARD03836942008-10-16 15:01:15 +02002442 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-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 Dyer58c41f92008-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 Tabiab347542006-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 Shimoda65bd9b42011-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
wdenk4a5c8a72003-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 Warren7efe9272008-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 Denk092ae952011-10-26 10:21:21 +00002484 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002485 example, see include/configs/mpc8349emds.h.
2486
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002487 CONFIG_MXC_SPI
2488
2489 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002490 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002491
Heiko Schocherb77c8882014-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 Fuchsa4400872007-12-27 17:12:34 +01002496- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002497
Matthias Fuchsa4400872007-12-27 17:12:34 +01002498 Enables FPGA subsystem.
2499
2500 CONFIG_FPGA_<vendor>
2501
2502 Enables support for specific chip vendors.
2503 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002504
Matthias Fuchsa4400872007-12-27 17:12:34 +01002505 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002506
Matthias Fuchsa4400872007-12-27 17:12:34 +01002507 Enables support for FPGA family.
2508 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2509
2510 CONFIG_FPGA_COUNT
2511
2512 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002513
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302514 CONFIG_CMD_FPGA_LOADMK
2515
2516 Enable support for fpga loadmk command
2517
Michal Simek64c70982014-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-VILLARD03836942008-10-16 15:01:15 +02002527 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk57b2d802003-06-27 21:31:46 +00002529 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk4a5c8a72003-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-VILLARD03836942008-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-VILLARD03836942008-10-16 15:01:15 +02002546 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk4a5c8a72003-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-VILLARD03836942008-10-16 15:01:15 +02002553 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002554
Jeremiah Mahler03f930c2015-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
wdenk4a5c8a72003-03-06 00:02:04 +00002557 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002558 ms.
wdenkc6097192002-11-03 00:24:07 +00002559
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002560 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002561
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002562 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-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-VILLARD03836942008-10-16 15:01:15 +02002565 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002566
wdenk4a5c8a72003-03-06 00:02:04 +00002567 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002568 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002569
2570- Configuration Management:
Stefan Roese141ed202014-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 Glassdc27def2016-07-27 20:33:08 -06002577 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002578
wdenkc6097192002-11-03 00:24:07 +00002579 CONFIG_IDENT_STRING
2580
wdenk4a5c8a72003-03-06 00:02:04 +00002581 If defined, this string will be added to the U-Boot
2582 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002583
2584- Vendor Parameter Protection:
2585
wdenk4a5c8a72003-03-06 00:02:04 +00002586 U-Boot considers the values of the environment
2587 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002588 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002589 are set once by the board vendor / manufacturer, and
2590 protects these variables from casual modification by
2591 the user. Once set, these variables are read-only,
2592 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002593 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002594
2595 If CONFIG_ENV_OVERWRITE is #defined in your config
2596 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002597 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002598 these parameters.
2599
Joe Hershberger76f353e2015-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 Ziswilerabd8dcb2008-07-09 08:17:15 +02002602 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002603 which can be changed exactly ONCE by the user. [The
2604 serial# is unaffected by this, i. e. it remains
2605 read-only.]
2606
Joe Hershberger71497d02012-12-11 22:16:31 -06002607 The same can be accomplished in a more flexible way
2608 for any variable by configuring the type of access
2609 to allow for those variables in the ".flags" variable
2610 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2611
wdenkc6097192002-11-03 00:24:07 +00002612- Protected RAM:
2613 CONFIG_PRAM
2614
2615 Define this variable to enable the reservation of
2616 "protected RAM", i. e. RAM which is not overwritten
2617 by U-Boot. Define CONFIG_PRAM to hold the number of
2618 kB you want to reserve for pRAM. You can overwrite
2619 this default value by defining an environment
2620 variable "pram" to the number of kB you want to
2621 reserve. Note that the board info structure will
2622 still show the full amount of RAM. If pRAM is
2623 reserved, a new environment variable "mem" will
2624 automatically be defined to hold the amount of
2625 remaining RAM in a form that can be passed as boot
2626 argument to Linux, for instance like that:
2627
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002628 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002629 saveenv
2630
2631 This way you can tell Linux not to use this memory,
2632 either, which results in a memory region that will
2633 not be affected by reboots.
2634
2635 *WARNING* If your board configuration uses automatic
2636 detection of the RAM size, you must make sure that
2637 this memory test is non-destructive. So far, the
2638 following board configurations are known to be
2639 "pRAM-clean":
2640
Wolfgang Denk90326762012-10-24 02:36:15 +00002641 IVMS8, IVML24, SPD8xx, TQM8xxL,
2642 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002643 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002644
Gabe Blacka2f3a932012-12-02 04:55:18 +00002645- Access to physical memory region (> 4GB)
2646 Some basic support is provided for operations on memory not
2647 normally accessible to U-Boot - e.g. some architectures
2648 support access to more than 4GB of memory on 32-bit
2649 machines using physical address extension or similar.
2650 Define CONFIG_PHYSMEM to access this basic support, which
2651 currently only supports clearing the memory.
2652
wdenkc6097192002-11-03 00:24:07 +00002653- Error Recovery:
2654 CONFIG_PANIC_HANG
2655
2656 Define this variable to stop the system in case of a
2657 fatal error, so that you have to reset it manually.
2658 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002659 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002660 automatically as fast as possible, but it may be
2661 useful during development since you can try to debug
2662 the conditions that lead to the situation.
2663
2664 CONFIG_NET_RETRY_COUNT
2665
wdenk4a5c8a72003-03-06 00:02:04 +00002666 This variable defines the number of retries for
2667 network operations like ARP, RARP, TFTP, or BOOTP
2668 before giving up the operation. If not defined, a
2669 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002670
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002671 CONFIG_ARP_TIMEOUT
2672
2673 Timeout waiting for an ARP reply in milliseconds.
2674
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002675 CONFIG_NFS_TIMEOUT
2676
2677 Timeout in milliseconds used in NFS protocol.
2678 If you encounter "ERROR: Cannot umount" in nfs command,
2679 try longer timeout such as
2680 #define CONFIG_NFS_TIMEOUT 10000UL
2681
wdenkc6097192002-11-03 00:24:07 +00002682- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002683 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002684
2685 Enable auto completion of commands using TAB.
2686
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk57b2d802003-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
wdenk4a5c8a72003-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 Mahler03f930c2015-01-04 18:56:50 -08002714- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002715 CONFIG_CMDLINE_EDITING
2716
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002717 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002718 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002719
Marek Vasut734fb042016-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
wdenkc0aa5c52003-12-06 19:49:23 +00002728- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002729 CONFIG_EXTRA_ENV_SETTINGS
2730
wdenk4a5c8a72003-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
wdenkeb20ad32003-09-05 23:19:14 +00002733 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002734
wdenk4a5c8a72003-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
wdenk4a5c8a72003-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
wdenkeb20ad32003-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
wdenk4a5c8a72003-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 Denk85c25df2009-04-01 23:34:12 +02002751 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002752 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002753
Stephen Warren1465d5f2012-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 Rini4c8cc9b2012-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 Glass6b8d5fd2012-11-30 13:01:17 +00002774 CONFIG_DELAY_ENVIRONMENT
2775
2776 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002777 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-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
Chris Packham2216ddb2015-06-19 20:25:59 +12002783- Parallel Flash support:
2784 CONFIG_SYS_NO_FLASH
2785
Bin Meng75574052016-02-05 19:30:11 -08002786 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002787 flash. This option is used to disable support for parallel NOR
2788 flash. This option should be defined if the board does not have
2789 parallel flash.
2790
2791 If this option is not defined one of the generic flash drivers
2792 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2793 selected or the board must provide an implementation of the
2794 flash API (see include/flash.h).
2795
wdenkc0aa5c52003-12-06 19:49:23 +00002796- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002797 CONFIG_HAS_DATAFLASH
2798
wdenk57b2d802003-06-27 21:31:46 +00002799 Defining this option enables DataFlash features and
2800 allows to read/write in Dataflash via the standard
2801 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002802
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002803- Serial Flash support
2804 CONFIG_CMD_SF
2805
2806 Defining this option enables SPI flash commands
2807 'sf probe/read/write/erase/update'.
2808
2809 Usage requires an initial 'probe' to define the serial
2810 flash parameters, followed by read/write/erase/update
2811 commands.
2812
2813 The following defaults may be provided by the platform
2814 to handle the common case when only a single serial
2815 flash is present on the system.
2816
2817 CONFIG_SF_DEFAULT_BUS Bus identifier
2818 CONFIG_SF_DEFAULT_CS Chip-select
2819 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2820 CONFIG_SF_DEFAULT_SPEED in Hz
2821
Simon Glass4b5545e2012-10-08 13:16:02 +00002822 CONFIG_CMD_SF_TEST
2823
2824 Define this option to include a destructive SPI flash
2825 test ('sf test').
2826
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302827 CONFIG_SF_DUAL_FLASH Dual flash memories
2828
2829 Define this option to use dual flash support where two flash
2830 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002831 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302832
wdenkef893942004-02-23 16:11:30 +00002833- SystemACE Support:
2834 CONFIG_SYSTEMACE
2835
2836 Adding this option adds support for Xilinx SystemACE
2837 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002838 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002839 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002840
2841 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002842 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002843
2844 When SystemACE support is added, the "ace" device type
2845 becomes available to the fat commands, i.e. fatls.
2846
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002847- TFTP Fixed UDP Port:
2848 CONFIG_TFTP_PORT
2849
Wolfgang Denk227b5192005-09-24 23:25:46 +02002850 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002851 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002852 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002853 number generator is used.
2854
Wolfgang Denk227b5192005-09-24 23:25:46 +02002855 Also, the environment variable tftpdstp is used to supply
2856 the TFTP UDP destination port value. If tftpdstp isn't
2857 defined, the normal port 69 is used.
2858
2859 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002860 blindly start the TFTP transfer using the pre-configured
2861 target IP address and UDP port. This has the effect of
2862 "punching through" the (Windows XP) firewall, allowing
2863 the remainder of the TFTP transfer to proceed normally.
2864 A better solution is to properly configure the firewall,
2865 but sometimes that is not allowed.
2866
Simon Glass058bb8d2012-12-05 14:46:38 +00002867- Hashing support:
2868 CONFIG_CMD_HASH
2869
2870 This enables a generic 'hash' command which can produce
2871 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2872
2873 CONFIG_HASH_VERIFY
2874
2875 Enable the hash verify command (hash -v). This adds to code
2876 size a little.
2877
gaurav ranaef201592015-02-20 12:51:46 +05302878 CONFIG_SHA1 - This option enables support of hashing using SHA1
2879 algorithm. The hash is calculated in software.
2880 CONFIG_SHA256 - This option enables support of hashing using
2881 SHA256 algorithm. The hash is calculated in software.
2882 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2883 for SHA1/SHA256 hashing.
2884 This affects the 'hash' command and also the
2885 hash_lookup_algo() function.
2886 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2887 hardware-acceleration for SHA1/SHA256 progressive hashing.
2888 Data can be streamed in a block at a time and the hashing
2889 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00002890
2891 Note: There is also a sha1sum command, which should perhaps
2892 be deprecated in favour of 'hash sha1'.
2893
Robert Winkler765ccf42013-07-24 17:57:06 -07002894- Freescale i.MX specific commands:
2895 CONFIG_CMD_HDMIDETECT
2896 This enables 'hdmidet' command which returns true if an
2897 HDMI monitor is detected. This command is i.MX 6 specific.
2898
2899 CONFIG_CMD_BMODE
2900 This enables the 'bmode' (bootmode) command for forcing
2901 a boot from specific media.
2902
2903 This is useful for forcing the ROM's usb downloader to
2904 activate upon a watchdog reset which is nice when iterating
2905 on U-Boot. Using the reset button or running bmode normal
2906 will set it back to normal. This command currently
2907 supports i.MX53 and i.MX6.
2908
Heiko Schocher443ca402014-01-25 07:27:13 +01002909- bootcount support:
2910 CONFIG_BOOTCOUNT_LIMIT
2911
2912 This enables the bootcounter support, see:
2913 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2914
2915 CONFIG_AT91SAM9XE
2916 enable special bootcounter support on at91sam9xe based boards.
2917 CONFIG_BLACKFIN
2918 enable special bootcounter support on blackfin based boards.
2919 CONFIG_SOC_DA8XX
2920 enable special bootcounter support on da850 based boards.
2921 CONFIG_BOOTCOUNT_RAM
2922 enable support for the bootcounter in RAM
2923 CONFIG_BOOTCOUNT_I2C
2924 enable support for the bootcounter on an i2c (like RTC) device.
2925 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2926 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2927 the bootcounter.
2928 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002929
wdenkc0aa5c52003-12-06 19:49:23 +00002930- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002931 CONFIG_SHOW_BOOT_PROGRESS
2932
wdenk4a5c8a72003-03-06 00:02:04 +00002933 Defining this option allows to add some board-
2934 specific code (calling a user-provided function
2935 "show_boot_progress(int)") that enables you to show
2936 the system's boot progress on some display (for
2937 example, some LED's) on your board. At the moment,
2938 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002939
Simon Glass0fa36a42012-09-28 08:56:37 +00002940
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002941Legacy uImage format:
2942
wdenkc6097192002-11-03 00:24:07 +00002943 Arg Where When
2944 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002945 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002946 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002947 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002948 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002949 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002950 4 common/cmd_bootm.c Image data has correct checksum
2951 -4 common/cmd_bootm.c Image is for unsupported architecture
2952 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002953 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002954 6 common/cmd_bootm.c Image Type check OK
2955 -6 common/cmd_bootm.c gunzip uncompression error
2956 -7 common/cmd_bootm.c Unimplemented compression type
2957 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002958 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002959 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002960
2961 9 common/image.c Start initial ramdisk verification
2962 -10 common/image.c Ramdisk header has bad magic number
2963 -11 common/image.c Ramdisk header has bad checksum
2964 10 common/image.c Ramdisk header is OK
2965 -12 common/image.c Ramdisk data has bad checksum
2966 11 common/image.c Ramdisk data has correct checksum
2967 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002968 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002969 13 common/image.c Start multifile image verification
2970 14 common/image.c No initial ramdisk, no multifile, continue.
2971
Wolfgang Denk092ae952011-10-26 10:21:21 +00002972 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002973
Stefan Roese88fbf932010-04-15 16:07:28 +02002974 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002975 -31 post/post.c POST test failed, detected by post_output_backlog()
2976 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002977
Heiko Schocher633e03a2007-06-22 19:11:54 +02002978 34 common/cmd_doc.c before loading a Image from a DOC device
2979 -35 common/cmd_doc.c Bad usage of "doc" command
2980 35 common/cmd_doc.c correct usage of "doc" command
2981 -36 common/cmd_doc.c No boot device
2982 36 common/cmd_doc.c correct boot device
2983 -37 common/cmd_doc.c Unknown Chip ID on boot device
2984 37 common/cmd_doc.c correct chip ID found, device available
2985 -38 common/cmd_doc.c Read Error on boot device
2986 38 common/cmd_doc.c reading Image header from DOC device OK
2987 -39 common/cmd_doc.c Image header has bad magic number
2988 39 common/cmd_doc.c Image header has correct magic number
2989 -40 common/cmd_doc.c Error reading Image from DOC device
2990 40 common/cmd_doc.c Image header has correct magic number
2991 41 common/cmd_ide.c before loading a Image from a IDE device
2992 -42 common/cmd_ide.c Bad usage of "ide" command
2993 42 common/cmd_ide.c correct usage of "ide" command
2994 -43 common/cmd_ide.c No boot device
2995 43 common/cmd_ide.c boot device found
2996 -44 common/cmd_ide.c Device not available
2997 44 common/cmd_ide.c Device available
2998 -45 common/cmd_ide.c wrong partition selected
2999 45 common/cmd_ide.c partition selected
3000 -46 common/cmd_ide.c Unknown partition table
3001 46 common/cmd_ide.c valid partition table found
3002 -47 common/cmd_ide.c Invalid partition type
3003 47 common/cmd_ide.c correct partition type
3004 -48 common/cmd_ide.c Error reading Image Header on boot device
3005 48 common/cmd_ide.c reading Image Header from IDE device OK
3006 -49 common/cmd_ide.c Image header has bad magic number
3007 49 common/cmd_ide.c Image header has correct magic number
3008 -50 common/cmd_ide.c Image header has bad checksum
3009 50 common/cmd_ide.c Image header has correct checksum
3010 -51 common/cmd_ide.c Error reading Image from IDE device
3011 51 common/cmd_ide.c reading Image from IDE device OK
3012 52 common/cmd_nand.c before loading a Image from a NAND device
3013 -53 common/cmd_nand.c Bad usage of "nand" command
3014 53 common/cmd_nand.c correct usage of "nand" command
3015 -54 common/cmd_nand.c No boot device
3016 54 common/cmd_nand.c boot device found
3017 -55 common/cmd_nand.c Unknown Chip ID on boot device
3018 55 common/cmd_nand.c correct chip ID found, device available
3019 -56 common/cmd_nand.c Error reading Image Header on boot device
3020 56 common/cmd_nand.c reading Image Header from NAND device OK
3021 -57 common/cmd_nand.c Image header has bad magic number
3022 57 common/cmd_nand.c Image header has correct magic number
3023 -58 common/cmd_nand.c Error reading Image from NAND device
3024 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003025
Heiko Schocher633e03a2007-06-22 19:11:54 +02003026 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003027
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003028 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003029 -64 net/eth.c no Ethernet found.
3030 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003031
Heiko Schocher633e03a2007-06-22 19:11:54 +02003032 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003033 80 common/cmd_net.c before calling net_loop()
3034 -81 common/cmd_net.c some error in net_loop() occurred
3035 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003036 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3037 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003038 83 common/cmd_net.c running "source" command
3039 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003040 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003041
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003042FIT uImage format:
3043
3044 Arg Where When
3045 100 common/cmd_bootm.c Kernel FIT Image has correct format
3046 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3047 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3048 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3049 102 common/cmd_bootm.c Kernel unit name specified
3050 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003051 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003052 104 common/cmd_bootm.c Got kernel subimage node offset
3053 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3054 105 common/cmd_bootm.c Kernel subimage hash verification OK
3055 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3056 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003057 -106 common/cmd_bootm.c Kernel subimage has wrong type
3058 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003059 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3060 108 common/cmd_bootm.c Got kernel subimage data/size
3061 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3062 -109 common/cmd_bootm.c Can't get kernel subimage type
3063 -110 common/cmd_bootm.c Can't get kernel subimage comp
3064 -111 common/cmd_bootm.c Can't get kernel subimage os
3065 -112 common/cmd_bootm.c Can't get kernel subimage load address
3066 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3067
3068 120 common/image.c Start initial ramdisk verification
3069 -120 common/image.c Ramdisk FIT image has incorrect format
3070 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003071 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003072 -122 common/image.c Can't get configuration for ramdisk subimage
3073 123 common/image.c Ramdisk unit name specified
3074 -124 common/image.c Can't get ramdisk subimage node offset
3075 125 common/image.c Got ramdisk subimage node offset
3076 -125 common/image.c Ramdisk subimage hash verification failed
3077 126 common/image.c Ramdisk subimage hash verification OK
3078 -126 common/image.c Ramdisk subimage for unsupported architecture
3079 127 common/image.c Architecture check OK
3080 -127 common/image.c Can't get ramdisk subimage data/size
3081 128 common/image.c Got ramdisk subimage data/size
3082 129 common/image.c Can't get ramdisk load address
3083 -129 common/image.c Got ramdisk load address
3084
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003085 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003086 131 common/cmd_doc.c FIT image format OK
3087
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003088 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003089 141 common/cmd_ide.c FIT image format OK
3090
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003091 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003092 151 common/cmd_nand.c FIT image format OK
3093
Heiko Schocher515eb122014-05-28 11:33:33 +02003094- legacy image format:
3095 CONFIG_IMAGE_FORMAT_LEGACY
3096 enables the legacy image format support in U-Boot.
3097
3098 Default:
3099 enabled if CONFIG_FIT_SIGNATURE is not defined.
3100
3101 CONFIG_DISABLE_IMAGE_LEGACY
3102 disable the legacy image format
3103
3104 This define is introduced, as the legacy image format is
3105 enabled per default for backward compatibility.
3106
Gabe Blackd572e162012-10-25 16:31:10 +00003107- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003108 CONFIG_FIT_DISABLE_SHA256
3109 Supporting SHA256 hashes has quite an impact on binary size.
3110 For constrained systems sha256 hash support can be disabled
3111 with this option.
3112
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003113 TODO(sjg@chromium.org): Adjust this option to be positive,
3114 and move it to Kconfig
3115
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003116- Standalone program support:
3117 CONFIG_STANDALONE_LOAD_ADDR
3118
Wolfgang Denk23f78482011-10-09 21:06:34 +02003119 This option defines a board specific value for the
3120 address where standalone program gets loaded, thus
3121 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003122 settings.
3123
3124- Frame Buffer Address:
3125 CONFIG_FB_ADDR
3126
3127 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003128 address for frame buffer. This is typically the case
3129 when using a graphics controller has separate video
3130 memory. U-Boot will then place the frame buffer at
3131 the given address instead of dynamically reserving it
3132 in system RAM by calling lcd_setmem(), which grabs
3133 the memory for the frame buffer depending on the
3134 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003135
3136 Please see board_init_f function.
3137
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003138- Automatic software updates via TFTP server
3139 CONFIG_UPDATE_TFTP
3140 CONFIG_UPDATE_TFTP_CNT_MAX
3141 CONFIG_UPDATE_TFTP_MSEC_MAX
3142
3143 These options enable and control the auto-update feature;
3144 for a more detailed description refer to doc/README.update.
3145
3146- MTD Support (mtdparts command, UBI support)
3147 CONFIG_MTD_DEVICE
3148
3149 Adds the MTD device infrastructure from the Linux kernel.
3150 Needed for mtdparts command support.
3151
3152 CONFIG_MTD_PARTITIONS
3153
3154 Adds the MTD partitioning infrastructure from the Linux
3155 kernel. Needed for UBI support.
3156
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003157- UBI support
3158 CONFIG_CMD_UBI
3159
3160 Adds commands for interacting with MTD partitions formatted
3161 with the UBI flash translation layer
3162
3163 Requires also defining CONFIG_RBTREE
3164
Joe Hershberger47550fc2013-04-08 10:32:49 +00003165 CONFIG_UBI_SILENCE_MSG
3166
3167 Make the verbose messages from UBI stop printing. This leaves
3168 warnings and errors enabled.
3169
Heiko Schocherf5895d12014-06-24 10:10:04 +02003170
3171 CONFIG_MTD_UBI_WL_THRESHOLD
3172 This parameter defines the maximum difference between the highest
3173 erase counter value and the lowest erase counter value of eraseblocks
3174 of UBI devices. When this threshold is exceeded, UBI starts performing
3175 wear leveling by means of moving data from eraseblock with low erase
3176 counter to eraseblocks with high erase counter.
3177
3178 The default value should be OK for SLC NAND flashes, NOR flashes and
3179 other flashes which have eraseblock life-cycle 100000 or more.
3180 However, in case of MLC NAND flashes which typically have eraseblock
3181 life-cycle less than 10000, the threshold should be lessened (e.g.,
3182 to 128 or 256, although it does not have to be power of 2).
3183
3184 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003185
Heiko Schocherf5895d12014-06-24 10:10:04 +02003186 CONFIG_MTD_UBI_BEB_LIMIT
3187 This option specifies the maximum bad physical eraseblocks UBI
3188 expects on the MTD device (per 1024 eraseblocks). If the
3189 underlying flash does not admit of bad eraseblocks (e.g. NOR
3190 flash), this value is ignored.
3191
3192 NAND datasheets often specify the minimum and maximum NVM
3193 (Number of Valid Blocks) for the flashes' endurance lifetime.
3194 The maximum expected bad eraseblocks per 1024 eraseblocks
3195 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3196 which gives 20 for most NANDs (MaxNVB is basically the total
3197 count of eraseblocks on the chip).
3198
3199 To put it differently, if this value is 20, UBI will try to
3200 reserve about 1.9% of physical eraseblocks for bad blocks
3201 handling. And that will be 1.9% of eraseblocks on the entire
3202 NAND chip, not just the MTD partition UBI attaches. This means
3203 that if you have, say, a NAND flash chip admits maximum 40 bad
3204 eraseblocks, and it is split on two MTD partitions of the same
3205 size, UBI will reserve 40 eraseblocks when attaching a
3206 partition.
3207
3208 default: 20
3209
3210 CONFIG_MTD_UBI_FASTMAP
3211 Fastmap is a mechanism which allows attaching an UBI device
3212 in nearly constant time. Instead of scanning the whole MTD device it
3213 only has to locate a checkpoint (called fastmap) on the device.
3214 The on-flash fastmap contains all information needed to attach
3215 the device. Using fastmap makes only sense on large devices where
3216 attaching by scanning takes long. UBI will not automatically install
3217 a fastmap on old images, but you can set the UBI parameter
3218 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3219 that fastmap-enabled images are still usable with UBI implementations
3220 without fastmap support. On typical flash devices the whole fastmap
3221 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3222
3223 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3224 Set this parameter to enable fastmap automatically on images
3225 without a fastmap.
3226 default: 0
3227
Heiko Schocher94b66de2015-10-22 06:19:21 +02003228 CONFIG_MTD_UBI_FM_DEBUG
3229 Enable UBI fastmap debug
3230 default: 0
3231
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003232- UBIFS support
3233 CONFIG_CMD_UBIFS
3234
3235 Adds commands for interacting with UBI volumes formatted as
3236 UBIFS. UBIFS is read-only in u-boot.
3237
3238 Requires UBI support as well as CONFIG_LZO
3239
Joe Hershberger47550fc2013-04-08 10:32:49 +00003240 CONFIG_UBIFS_SILENCE_MSG
3241
3242 Make the verbose messages from UBIFS stop printing. This leaves
3243 warnings and errors enabled.
3244
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003245- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003246 CONFIG_SPL
3247 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003248
Tom Rini36853852012-02-14 07:29:40 +00003249 CONFIG_SPL_LDSCRIPT
3250 LDSCRIPT for linking the SPL binary.
3251
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003252 CONFIG_SPL_MAX_FOOTPRINT
3253 Maximum size in memory allocated to the SPL, BSS included.
3254 When defined, the linker checks that the actual memory
3255 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003256 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003257 must not be both defined at the same time.
3258
Tom Rini36853852012-02-14 07:29:40 +00003259 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003260 Maximum size of the SPL image (text, data, rodata, and
3261 linker lists sections), BSS excluded.
3262 When defined, the linker checks that the actual size does
3263 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003264
Wolfgang Denk825223d2011-09-11 21:24:09 +02003265 CONFIG_SPL_TEXT_BASE
3266 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003267
Scott Woodc4f0d002012-09-20 19:05:12 -05003268 CONFIG_SPL_RELOC_TEXT_BASE
3269 Address to relocate to. If unspecified, this is equal to
3270 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3271
Tom Rini36853852012-02-14 07:29:40 +00003272 CONFIG_SPL_BSS_START_ADDR
3273 Link address for the BSS within the SPL binary.
3274
3275 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003276 Maximum size in memory allocated to the SPL BSS.
3277 When defined, the linker checks that the actual memory used
3278 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003279 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003280 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003281
3282 CONFIG_SPL_STACK
3283 Adress of the start of the stack SPL will use
3284
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003285 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3286 When defined, SPL will panic() if the image it has
3287 loaded does not have a signature.
3288 Defining this is useful when code which loads images
3289 in SPL cannot guarantee that absolutely all read errors
3290 will be caught.
3291 An example is the LPC32XX MLC NAND driver, which will
3292 consider that a completely unreadable NAND block is bad,
3293 and thus should be skipped silently.
3294
Marek Vasutbf541b22016-04-29 00:44:55 +02003295 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3296 When defined, SPL will proceed to another boot method
3297 if the image it has loaded does not have a signature.
3298
Scott Woodc4f0d002012-09-20 19:05:12 -05003299 CONFIG_SPL_RELOC_STACK
3300 Adress of the start of the stack SPL will use after
3301 relocation. If unspecified, this is equal to
3302 CONFIG_SPL_STACK.
3303
Tom Rini36853852012-02-14 07:29:40 +00003304 CONFIG_SYS_SPL_MALLOC_START
3305 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003306 When this option is set the full malloc is used in SPL and
3307 it is set up by spl_init() and before that, the simple malloc()
3308 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003309
3310 CONFIG_SYS_SPL_MALLOC_SIZE
3311 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003312
Tom Rini28591df2012-08-13 12:03:19 -07003313 CONFIG_SPL_FRAMEWORK
3314 Enable the SPL framework under common/. This framework
3315 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3316 NAND loading of the Linux Kernel.
3317
Tom Rinic2b76002014-03-28 12:03:39 -04003318 CONFIG_SPL_OS_BOOT
3319 Enable booting directly to an OS from SPL.
3320 See also: doc/README.falcon
3321
Tom Rinife3b0c72012-08-13 11:37:56 -07003322 CONFIG_SPL_DISPLAY_PRINT
3323 For ARM, enable an optional function to print more information
3324 about the running system.
3325
Scott Wood7c810902012-09-20 16:35:21 -05003326 CONFIG_SPL_INIT_MINIMAL
3327 Arch init code should be built for a very small image
3328
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003329 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3330 Partition on the MMC to load U-Boot from when the MMC is being
3331 used in raw mode
3332
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003333 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3334 Sector to load kernel uImage from when MMC is being
3335 used in raw mode (for Falcon mode)
3336
3337 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3338 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3339 Sector and number of sectors to load kernel argument
3340 parameters from when MMC is being used in raw mode
3341 (for falcon mode)
3342
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003343 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3344 Partition on the MMC to load U-Boot from when the MMC is being
3345 used in fs mode
3346
Guillaume GARDET5065b712014-10-15 17:53:13 +02003347 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3348 Filename to read to load U-Boot when reading from filesystem
3349
3350 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003351 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003352 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003353
Guillaume GARDET5065b712014-10-15 17:53:13 +02003354 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003355 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003356 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003357
Scott Wood2b36fbb2012-12-06 13:33:17 +00003358 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3359 Set this for NAND SPL on PPC mpc83xx targets, so that
3360 start.S waits for the rest of the SPL to load before
3361 continuing (the hardware starts execution after just
3362 loading the first page rather than the full 4K).
3363
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303364 CONFIG_SPL_SKIP_RELOCATE
3365 Avoid SPL relocation
3366
Scott Woodc352a0c2012-09-20 19:09:07 -05003367 CONFIG_SPL_NAND_BASE
3368 Include nand_base.c in the SPL. Requires
3369 CONFIG_SPL_NAND_DRIVERS.
3370
3371 CONFIG_SPL_NAND_DRIVERS
3372 SPL uses normal NAND drivers, not minimal drivers.
3373
3374 CONFIG_SPL_NAND_ECC
3375 Include standard software ECC in the SPL
3376
Tom Rini36853852012-02-14 07:29:40 +00003377 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003378 Support for NAND boot using simple NAND drivers that
3379 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003380
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003381 CONFIG_SPL_UBI
3382 Support for a lightweight UBI (fastmap) scanner and
3383 loader
3384
Heiko Schochercf000272014-10-31 08:31:00 +01003385 CONFIG_SPL_NAND_RAW_ONLY
3386 Support to boot only raw u-boot.bin images. Use this only
3387 if you need to save space.
3388
Ying Zhangdfb2b152013-08-16 15:16:12 +08003389 CONFIG_SPL_COMMON_INIT_DDR
3390 Set for common ddr init with serial presence detect in
3391 SPL binary.
3392
Tom Rini36853852012-02-14 07:29:40 +00003393 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3394 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3395 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3396 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3397 CONFIG_SYS_NAND_ECCBYTES
3398 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003399 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003400
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303401 CONFIG_SPL_NAND_BOOT
3402 Add support NAND boot
3403
Tom Rini36853852012-02-14 07:29:40 +00003404 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003405 Location in NAND to read U-Boot from
3406
3407 CONFIG_SYS_NAND_U_BOOT_DST
3408 Location in memory to load U-Boot to
3409
3410 CONFIG_SYS_NAND_U_BOOT_SIZE
3411 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003412
3413 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003414 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003415
3416 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3417 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003418 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003419
3420 CONFIG_SPL_OMAP3_ID_NAND
3421 Support for an OMAP3-specific set of functions to return the
3422 ID and MFR of the first attached NAND chip, if present.
3423
Pavel Machekde997252012-08-30 22:42:11 +02003424 CONFIG_SPL_RAM_DEVICE
3425 Support for running image already present in ram, in SPL binary
3426
Scott Woodeb7bd972012-12-06 13:33:16 +00003427 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003428 Image offset to which the SPL should be padded before appending
3429 the SPL payload. By default, this is defined as
3430 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3431 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3432 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003433
Scott Woodf147eb72012-09-21 16:27:32 -05003434 CONFIG_SPL_TARGET
3435 Final target image containing SPL and payload. Some SPLs
3436 use an arch-specific makefile fragment instead, for
3437 example if more than one image needs to be produced.
3438
Simon Glass82d94532013-05-08 08:05:59 +00003439 CONFIG_FIT_SPL_PRINT
3440 Printing information about a FIT image adds quite a bit of
3441 code to SPL. So this is normally disabled in SPL. Use this
3442 option to re-enable it. This will affect the output of the
3443 bootm command when booting a FIT image.
3444
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003445- TPL framework
3446 CONFIG_TPL
3447 Enable building of TPL globally.
3448
3449 CONFIG_TPL_PAD_TO
3450 Image offset to which the TPL should be padded before appending
3451 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003452 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3453 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3454 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003455
wdenkc0aa5c52003-12-06 19:49:23 +00003456- Interrupt support (PPC):
3457
wdenk1ebf41e2004-01-02 14:00:00 +00003458 There are common interrupt_init() and timer_interrupt()
3459 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003460 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003461 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003462 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003463 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003464 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003465 specific handling. If board has watchdog / status_led
3466 / other_activity_monitor it works automatically from
3467 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003468
wdenkc6097192002-11-03 00:24:07 +00003469
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003470Board initialization settings:
3471------------------------------
3472
3473During Initialization u-boot calls a number of board specific functions
3474to allow the preparation of board specific prerequisites, e.g. pin setup
3475before drivers are initialized. To enable these callbacks the
3476following configuration macros have to be defined. Currently this is
3477architecture specific, so please check arch/your_architecture/lib/board.c
3478typically in board_init_f() and board_init_r().
3479
3480- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3481- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3482- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3483- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003484
wdenkc6097192002-11-03 00:24:07 +00003485Configuration Settings:
3486-----------------------
3487
York Sun6c480012014-02-26 17:03:19 -08003488- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3489 Optionally it can be defined to support 64-bit memory commands.
3490
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003491- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003492 undefine this when you're short of memory.
3493
Peter Tyserdfb72b82009-01-27 18:03:12 -06003494- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3495 width of the commands listed in the 'help' command output.
3496
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003497- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003498 prompt for user input.
3499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003500- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003502- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003504- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003506- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003507 the application (usually a Linux kernel) when it is
3508 booted
3509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003510- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003511 List of legal baudrate settings for this board.
3512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003513- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003514 Begin and End addresses of the area used by the
3515 simple memory test.
3516
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003517- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003518 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003519
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003520- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003521 Scratch address used by the alternate memory test
3522 You only need to set this if address zero isn't writeable
3523
York Sun5d286cd2015-12-04 11:57:07 -08003524- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003525 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003526 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3527 is substracted from total RAM and won't be reported to OS.
3528 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003529 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003530 the RAM base is not zero, or RAM is divided into banks,
3531 this variable needs to be recalcuated to get the address.
3532
York Sun50739372015-12-07 11:05:29 -08003533- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003534 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003535 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003536 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003537 fixing up gd->ram_size the Linux kernel should gets passed
3538 the now "corrected" memory size and won't touch it either.
3539 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003540 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003541 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003542 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003543
3544 This option can be used as a workaround for the 440EPx/GRx
3545 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3546 be touched.
3547
3548 WARNING: Please make sure that this value is a multiple of
3549 the Linux page size (normally 4k). If this is not the case,
3550 then the end address of the Linux memory will be located at a
3551 non page size aligned address and this could cause major
3552 problems.
3553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003554- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003555 Enable temporary baudrate change while serial download
3556
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003557- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003558 Physical start address of SDRAM. _Must_ be 0 here.
3559
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003560- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003561 Physical start address of Flash memory.
3562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003564 Physical start address of boot monitor code (set by
3565 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003566 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003567 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003570 Size of memory reserved for monitor code, used to
3571 determine _at_compile_time_ (!) if the environment is
3572 embedded within the U-Boot image, or in a separate
3573 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003574
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003575- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003576 Size of DRAM reserved for malloc() use.
3577
Simon Glass863e4042014-07-10 22:23:28 -06003578- CONFIG_SYS_MALLOC_F_LEN
3579 Size of the malloc() pool for use before relocation. If
3580 this is defined, then a very simple malloc() implementation
3581 will become available before relocation. The address is just
3582 below the global data, and the stack is moved down to make
3583 space.
3584
3585 This feature allocates regions with increasing addresses
3586 within the region. calloc() is supported, but realloc()
3587 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003588 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003589 U-Boot relocates itself.
3590
Simon Glass9fa901b2014-11-10 17:16:54 -07003591- CONFIG_SYS_MALLOC_SIMPLE
3592 Provides a simple and small malloc() and calloc() for those
3593 boards which do not use the full malloc in SPL (which is
3594 enabled with CONFIG_SYS_SPL_MALLOC_START).
3595
Thierry Redingc97d9742014-12-09 22:25:22 -07003596- CONFIG_SYS_NONCACHED_MEMORY:
3597 Size of non-cached memory area. This area of memory will be
3598 typically located right below the malloc() area and mapped
3599 uncached in the MMU. This is useful for drivers that would
3600 otherwise require a lot of explicit cache maintenance. For
3601 some drivers it's also impossible to properly maintain the
3602 cache. For example if the regions that need to be flushed
3603 are not a multiple of the cache-line size, *and* padding
3604 cannot be allocated between the regions to align them (i.e.
3605 if the HW requires a contiguous array of regions, and the
3606 size of each region is not cache-aligned), then a flush of
3607 one region may result in overwriting data that hardware has
3608 written to another region in the same cache-line. This can
3609 happen for example in network drivers where descriptors for
3610 buffers are typically smaller than the CPU cache-line (e.g.
3611 16 bytes vs. 32 or 64 bytes).
3612
3613 Non-cached memory is only supported on 32-bit ARM at present.
3614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003615- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003616 Normally compressed uImages are limited to an
3617 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003618 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003619 to adjust this setting to your needs.
3620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003621- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003622 Maximum size of memory mapped by the startup code of
3623 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003624 the Linux kernel (bd_info, boot arguments, FDT blob if
3625 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003626 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003627 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003628 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003629 variable "bootm_mapsize" will override the value of
3630 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3631 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003632
John Rigbyeea8e692010-10-13 13:57:35 -06003633- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3634 Enable initrd_high functionality. If defined then the
3635 initrd_high feature is enabled and the bootm ramdisk subcommand
3636 is enabled.
3637
3638- CONFIG_SYS_BOOT_GET_CMDLINE:
3639 Enables allocating and saving kernel cmdline in space between
3640 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3641
3642- CONFIG_SYS_BOOT_GET_KBD:
3643 Enables allocating and saving a kernel copy of the bd_info in
3644 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003646- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003647 Max number of Flash memory banks
3648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003649- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003650 Max number of sectors on a Flash chip
3651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003653 Timeout for Flash erase operations (in ms)
3654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003655- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003656 Timeout for Flash write operations (in ms)
3657
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003658- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003659 Timeout for Flash set sector lock bit operation (in ms)
3660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003661- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003662 Timeout for Flash clear lock bits operation (in ms)
3663
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003664- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003665 If defined, hardware flash sectors protection is used
3666 instead of U-Boot software protection.
3667
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003668- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003669
3670 Enable TFTP transfers directly to flash memory;
3671 without this option such a download has to be
3672 performed in two steps: (1) download to RAM, and (2)
3673 copy from RAM to flash.
3674
3675 The two-step approach is usually more reliable, since
3676 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003677 the flash, but in some situations (when system RAM is
3678 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003679 downloaded image) this option may be very useful.
3680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003682 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003683 common flash structure for storing flash geometry.
3684
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003685- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003686 This option also enables the building of the cfi_flash driver
3687 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003688
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003689- CONFIG_FLASH_CFI_MTD
3690 This option enables the building of the cfi_mtd driver
3691 in the drivers directory. The driver exports CFI flash
3692 to the MTD layer.
3693
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003694- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003695 Use buffered writes to flash.
3696
3697- CONFIG_FLASH_SPANSION_S29WS_N
3698 s29ws-n MirrorBit flash has non-standard addresses for buffered
3699 write commands.
3700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003701- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003702 If this option is defined, the common CFI flash doesn't
3703 print it's warning upon not recognized FLASH banks. This
3704 is useful, if some of the configured banks are only
3705 optionally available.
3706
Jerry Van Barenaae73572008-03-08 13:48:01 -05003707- CONFIG_FLASH_SHOW_PROGRESS
3708 If defined (must be an integer), print out countdown
3709 digits and dots. Recommended value: 45 (9..1) for 80
3710 column displays, 15 (3..1) for 40 column displays.
3711
Stefan Roesed20cba52013-04-04 15:53:14 +02003712- CONFIG_FLASH_VERIFY
3713 If defined, the content of the flash (destination) is compared
3714 against the source after the write operation. An error message
3715 will be printed when the contents are not identical.
3716 Please note that this option is useless in nearly all cases,
3717 since such flash programming errors usually are detected earlier
3718 while unprotecting/erasing/programming. Please only enable
3719 this option if you really know what you are doing.
3720
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003721- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003722 Defines the number of Ethernet receive buffers. On some
3723 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003724 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3725 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003726 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003727 Defaults to 4 if not defined.
3728
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003729- CONFIG_ENV_MAX_ENTRIES
3730
Wolfgang Denk1136f692010-10-27 22:48:30 +02003731 Maximum number of entries in the hash table that is used
3732 internally to store the environment settings. The default
3733 setting is supposed to be generous and should work in most
3734 cases. This setting can be used to tune behaviour; see
3735 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003736
Joe Hershberger71497d02012-12-11 22:16:31 -06003737- CONFIG_ENV_FLAGS_LIST_DEFAULT
3738- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003739 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003740 calling env set. Variables can be restricted to only decimal,
3741 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3742 the variables can also be restricted to IP address or MAC address.
3743
3744 The format of the list is:
3745 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003746 access_attribute = [a|r|o|c]
3747 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003748 entry = variable_name[:attributes]
3749 list = entry[,list]
3750
3751 The type attributes are:
3752 s - String (default)
3753 d - Decimal
3754 x - Hexadecimal
3755 b - Boolean ([1yYtT|0nNfF])
3756 i - IP address
3757 m - MAC address
3758
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003759 The access attributes are:
3760 a - Any (default)
3761 r - Read-only
3762 o - Write-once
3763 c - Change-default
3764
Joe Hershberger71497d02012-12-11 22:16:31 -06003765 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3766 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003767 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003768
3769 - CONFIG_ENV_FLAGS_LIST_STATIC
3770 Define this to a list (string) to define validation that
3771 should be done if an entry is not found in the ".flags"
3772 environment variable. To override a setting in the static
3773 list, simply add an entry for the same variable name to the
3774 ".flags" variable.
3775
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003776 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3777 regular expression. This allows multiple variables to define the same
3778 flags without explicitly listing them for each variable.
3779
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003780- CONFIG_ENV_ACCESS_IGNORE_FORCE
3781 If defined, don't allow the -f switch to env set override variable
3782 access flags.
3783
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003784- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3785 This is set by OMAP boards for the max time that reset should
3786 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003787 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003788
Gabe Black3687fe42014-10-15 04:38:30 -06003789- CONFIG_USE_STDINT
3790 If stdint.h is available with your toolchain you can define this
3791 option to enable it. You can provide option 'USE_STDINT=1' when
3792 building U-Boot to enable this.
3793
wdenkc6097192002-11-03 00:24:07 +00003794The following definitions that deal with the placement and management
3795of environment data (variable area); in general, we support the
3796following configurations:
3797
Mike Frysinger63b8f122011-07-08 10:44:25 +00003798- CONFIG_BUILD_ENVCRC:
3799
3800 Builds up envcrc with the target environment so that external utils
3801 may easily extract it and embed it in final U-Boot images.
3802
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003803- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003804
3805 Define this if the environment is in flash memory.
3806
3807 a) The environment occupies one whole flash sector, which is
3808 "embedded" in the text segment with the U-Boot code. This
3809 happens usually with "bottom boot sector" or "top boot
3810 sector" type flash chips, which have several smaller
3811 sectors at the start or the end. For instance, such a
3812 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3813 such a case you would place the environment in one of the
3814 4 kB sectors - with U-Boot code before and after it. With
3815 "top boot sector" type flash chips, you would put the
3816 environment in one of the last sectors, leaving a gap
3817 between U-Boot and the environment.
3818
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003819 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003820
3821 Offset of environment data (variable area) to the
3822 beginning of flash memory; for instance, with bottom boot
3823 type flash chips the second sector can be used: the offset
3824 for this sector is given here.
3825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003826 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003827
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003828 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003829
3830 This is just another way to specify the start address of
3831 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003832 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003833
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003834 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003835
3836 Size of the sector containing the environment.
3837
3838
3839 b) Sometimes flash chips have few, equal sized, BIG sectors.
3840 In such a case you don't want to spend a whole sector for
3841 the environment.
3842
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003843 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003844
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003845 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003846 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003847 of this flash sector for the environment. This saves
3848 memory for the RAM copy of the environment.
3849
3850 It may also save flash memory if you decide to use this
3851 when your environment is "embedded" within U-Boot code,
3852 since then the remainder of the flash sector could be used
3853 for U-Boot code. It should be pointed out that this is
3854 STRONGLY DISCOURAGED from a robustness point of view:
3855 updating the environment in flash makes it always
3856 necessary to erase the WHOLE sector. If something goes
3857 wrong before the contents has been restored from a copy in
3858 RAM, your target system will be dead.
3859
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003860 - CONFIG_ENV_ADDR_REDUND
3861 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003862
wdenk4a5c8a72003-03-06 00:02:04 +00003863 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003864 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003865 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003866 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003867
3868BE CAREFUL! Any changes to the flash layout, and some changes to the
3869source code will make it necessary to adapt <board>/u-boot.lds*
3870accordingly!
3871
3872
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003873- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003874
3875 Define this if you have some non-volatile memory device
3876 (NVRAM, battery buffered SRAM) which you want to use for the
3877 environment.
3878
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003879 - CONFIG_ENV_ADDR:
3880 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003881
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003882 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003883 want to use for environment. It is assumed that this memory
3884 can just be read and written to, without any special
3885 provision.
3886
3887BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003888in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003889console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003890U-Boot will hang.
3891
3892Please note that even with NVRAM we still use a copy of the
3893environment in RAM: we could work on NVRAM directly, but we want to
3894keep settings there always unmodified except somebody uses "saveenv"
3895to save the current settings.
3896
3897
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003898- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003899
3900 Use this if you have an EEPROM or similar serial access
3901 device and a driver for it.
3902
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003903 - CONFIG_ENV_OFFSET:
3904 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003905
3906 These two #defines specify the offset and size of the
3907 environment area within the total memory of your EEPROM.
3908
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003909 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003910 If defined, specified the chip address of the EEPROM device.
3911 The default address is zero.
3912
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003913 - CONFIG_SYS_I2C_EEPROM_BUS:
3914 If defined, specified the i2c bus of the EEPROM device.
3915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003916 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003917 If defined, the number of bits used to address bytes in a
3918 single page in the EEPROM device. A 64 byte page, for example
3919 would require six bits.
3920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003922 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003923 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003926 The length in bytes of the EEPROM memory array address. Note
3927 that this is NOT the chip address length!
3928
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003930 EEPROM chips that implement "address overflow" are ones
3931 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3932 address and the extra bits end up in the "chip address" bit
3933 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3934 byte chips.
3935
3936 Note that we consider the length of the address field to
3937 still be one byte because the extra address bits are hidden
3938 in the chip address.
3939
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003940 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003941 The size in bytes of the EEPROM device.
3942
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003943 - CONFIG_ENV_EEPROM_IS_ON_I2C
3944 define this, if you have I2C and SPI activated, and your
3945 EEPROM, which holds the environment, is on the I2C bus.
3946
3947 - CONFIG_I2C_ENV_EEPROM_BUS
3948 if you have an Environment on an EEPROM reached over
3949 I2C muxes, you can define here, how to reach this
3950 EEPROM. For example:
3951
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003952 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003953
3954 EEPROM which holds the environment, is reached over
3955 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003956
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003957- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003958
wdenk1ebf41e2004-01-02 14:00:00 +00003959 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003960 want to use for the environment.
3961
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003962 - CONFIG_ENV_OFFSET:
3963 - CONFIG_ENV_ADDR:
3964 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003965
3966 These three #defines specify the offset and size of the
3967 environment area within the total memory of your DataFlash placed
3968 at the specified address.
3969
Wu, Josh76db7bf2014-07-01 19:30:13 +08003970- CONFIG_ENV_IS_IN_SPI_FLASH:
3971
3972 Define this if you have a SPI Flash memory device which you
3973 want to use for the environment.
3974
3975 - CONFIG_ENV_OFFSET:
3976 - CONFIG_ENV_SIZE:
3977
3978 These two #defines specify the offset and size of the
3979 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3980 aligned to an erase sector boundary.
3981
3982 - CONFIG_ENV_SECT_SIZE:
3983
3984 Define the SPI flash's sector size.
3985
3986 - CONFIG_ENV_OFFSET_REDUND (optional):
3987
3988 This setting describes a second storage area of CONFIG_ENV_SIZE
3989 size used to hold a redundant copy of the environment data, so
3990 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003991 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003992 aligned to an erase sector boundary.
3993
3994 - CONFIG_ENV_SPI_BUS (optional):
3995 - CONFIG_ENV_SPI_CS (optional):
3996
3997 Define the SPI bus and chip select. If not defined they will be 0.
3998
3999 - CONFIG_ENV_SPI_MAX_HZ (optional):
4000
4001 Define the SPI max work clock. If not defined then use 1MHz.
4002
4003 - CONFIG_ENV_SPI_MODE (optional):
4004
4005 Define the SPI work mode. If not defined then use SPI_MODE_3.
4006
Liu Gang85bcd732012-03-08 00:33:20 +00004007- CONFIG_ENV_IS_IN_REMOTE:
4008
4009 Define this if you have a remote memory space which you
4010 want to use for the local device's environment.
4011
4012 - CONFIG_ENV_ADDR:
4013 - CONFIG_ENV_SIZE:
4014
4015 These two #defines specify the address and size of the
4016 environment area within the remote memory space. The
4017 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004018 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004019
4020BE CAREFUL! For some special cases, the local device can not use
4021"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004022environment stored in a remote NOR flash by SRIO or PCIE link,
4023but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004024
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004025- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004026
4027 Define this if you have a NAND device which you want to use
4028 for the environment.
4029
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004030 - CONFIG_ENV_OFFSET:
4031 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004032
4033 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004034 area within the first NAND device. CONFIG_ENV_OFFSET must be
4035 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004036
Scott Wood08239322010-09-17 14:38:37 -05004037 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004038
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004039 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004040 size used to hold a redundant copy of the environment data, so
4041 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004042 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004043 aligned to an erase block boundary.
4044
4045 - CONFIG_ENV_RANGE (optional):
4046
4047 Specifies the length of the region in which the environment
4048 can be written. This should be a multiple of the NAND device's
4049 block size. Specifying a range with more erase blocks than
4050 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4051 the range to be avoided.
4052
4053 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004054
Scott Wood08239322010-09-17 14:38:37 -05004055 Enables support for dynamically retrieving the offset of the
4056 environment from block zero's out-of-band data. The
4057 "nand env.oob" command can be used to record this offset.
4058 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4059 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004060
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004061- CONFIG_NAND_ENV_DST
4062
4063 Defines address in RAM to which the nand_spl code should copy the
4064 environment. If redundant environment is used, it will be copied to
4065 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4066
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004067- CONFIG_ENV_IS_IN_UBI:
4068
4069 Define this if you have an UBI volume that you want to use for the
4070 environment. This has the benefit of wear-leveling the environment
4071 accesses, which is important on NAND.
4072
4073 - CONFIG_ENV_UBI_PART:
4074
4075 Define this to a string that is the mtd partition containing the UBI.
4076
4077 - CONFIG_ENV_UBI_VOLUME:
4078
4079 Define this to the name of the volume that you want to store the
4080 environment in.
4081
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004082 - CONFIG_ENV_UBI_VOLUME_REDUND:
4083
4084 Define this to the name of another volume to store a second copy of
4085 the environment in. This will enable redundant environments in UBI.
4086 It is assumed that both volumes are in the same MTD partition.
4087
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004088 - CONFIG_UBI_SILENCE_MSG
4089 - CONFIG_UBIFS_SILENCE_MSG
4090
4091 You will probably want to define these to avoid a really noisy system
4092 when storing the env in UBI.
4093
Wu, Josha7d0c872014-06-24 17:31:03 +08004094- CONFIG_ENV_IS_IN_FAT:
4095 Define this if you want to use the FAT file system for the environment.
4096
4097 - FAT_ENV_INTERFACE:
4098
4099 Define this to a string that is the name of the block device.
4100
Nicolae Rosia86811f22016-11-21 17:33:58 +02004101 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08004102
4103 Define this to a string to specify the partition of the device. It can
4104 be as following:
4105
4106 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4107 - "D:P": device D partition P. Error occurs if device D has no
4108 partition table.
4109 - "D:0": device D.
4110 - "D" or "D:": device D partition 1 if device D has partition
4111 table, or the whole device D if has no partition
4112 table.
4113 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004114 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004115 partition table then means device D.
4116
4117 - FAT_ENV_FILE:
4118
4119 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004120 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004121
4122 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004123 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004124
Stephen Warreneedcacd2013-06-11 15:14:00 -06004125- CONFIG_ENV_IS_IN_MMC:
4126
4127 Define this if you have an MMC device which you want to use for the
4128 environment.
4129
4130 - CONFIG_SYS_MMC_ENV_DEV:
4131
4132 Specifies which MMC device the environment is stored in.
4133
4134 - CONFIG_SYS_MMC_ENV_PART (optional):
4135
4136 Specifies which MMC partition the environment is stored in. If not
4137 set, defaults to partition 0, the user area. Common values might be
4138 1 (first MMC boot partition), 2 (second MMC boot partition).
4139
4140 - CONFIG_ENV_OFFSET:
4141 - CONFIG_ENV_SIZE:
4142
4143 These two #defines specify the offset and size of the environment
4144 area within the specified MMC device.
4145
Stephen Warren24dc2032013-06-11 15:14:02 -06004146 If offset is positive (the usual case), it is treated as relative to
4147 the start of the MMC partition. If offset is negative, it is treated
4148 as relative to the end of the MMC partition. This can be useful if
4149 your board may be fitted with different MMC devices, which have
4150 different sizes for the MMC partitions, and you always want the
4151 environment placed at the very end of the partition, to leave the
4152 maximum possible space before it, to store other data.
4153
Stephen Warreneedcacd2013-06-11 15:14:00 -06004154 These two values are in units of bytes, but must be aligned to an
4155 MMC sector boundary.
4156
4157 - CONFIG_ENV_OFFSET_REDUND (optional):
4158
4159 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4160 hold a redundant copy of the environment data. This provides a
4161 valid backup copy in case the other copy is corrupted, e.g. due
4162 to a power failure during a "saveenv" operation.
4163
Stephen Warren24dc2032013-06-11 15:14:02 -06004164 This value may also be positive or negative; this is handled in the
4165 same way as CONFIG_ENV_OFFSET.
4166
Stephen Warreneedcacd2013-06-11 15:14:00 -06004167 This value is also in units of bytes, but must also be aligned to
4168 an MMC sector boundary.
4169
4170 - CONFIG_ENV_SIZE_REDUND (optional):
4171
4172 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4173 set. If this value is set, it must be set to the same value as
4174 CONFIG_ENV_SIZE.
4175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004176- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004177
4178 Defines offset to the initial SPI buffer area in DPRAM. The
4179 area is used at an early stage (ROM part) if the environment
4180 is configured to reside in the SPI EEPROM: We need a 520 byte
4181 scratch DPRAM area. It is used between the two initialization
4182 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4183 to be a good choice since it makes it far enough from the
4184 start of the data area as well as from the stack pointer.
4185
Bruce Adleredecc942007-11-02 13:15:42 -07004186Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004187has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004188created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004189until then to read environment variables.
4190
wdenk8dba0502003-03-31 16:34:49 +00004191The environment is protected by a CRC32 checksum. Before the monitor
4192is relocated into RAM, as a result of a bad CRC you will be working
4193with the compiled-in default environment - *silently*!!! [This is
4194necessary, because the first environment variable we need is the
4195"baudrate" setting for the console - if we have a bad CRC, we don't
4196have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004197
4198Note: once the monitor has been relocated, then it will complain if
4199the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004200use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004202- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004203 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004204
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004205 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004206 also needs to be defined.
4207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004208- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004209 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004210
Ron Madriddfa028a2009-02-18 14:30:44 -08004211- CONFIG_NS16550_MIN_FUNCTIONS:
4212 Define this if you desire to only have use of the NS16550_init
4213 and NS16550_putc functions for the serial driver located at
4214 drivers/serial/ns16550.c. This option is useful for saving
4215 space for already greatly restricted images, including but not
4216 limited to NAND_SPL configurations.
4217
Simon Glass28a9e332012-11-30 13:01:18 +00004218- CONFIG_DISPLAY_BOARDINFO
4219 Display information about the board that U-Boot is running on
4220 when U-Boot starts up. The board function checkboard() is called
4221 to do this.
4222
Simon Glasse8822012012-11-30 13:01:19 +00004223- CONFIG_DISPLAY_BOARDINFO_LATE
4224 Similar to the previous option, but display this information
4225 later, once stdio is running and output goes to the LCD, if
4226 present.
4227
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004228- CONFIG_BOARD_SIZE_LIMIT:
4229 Maximum size of the U-Boot image. When defined, the
4230 build system checks that the actual size does not
4231 exceed it.
4232
wdenkc6097192002-11-03 00:24:07 +00004233Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004234---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004236- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004237 Cache Line Size of the CPU.
4238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004239- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004240 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004241
wdenk9c53f402003-10-15 23:53:47 +00004242 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4243 and RPXsuper) to be able to adjust the position of
4244 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004245
Timur Tabid8f341c2011-08-04 18:03:41 -05004246- CONFIG_SYS_CCSRBAR_DEFAULT:
4247 Default (power-on reset) physical address of CCSR on Freescale
4248 PowerPC SOCs.
4249
4250- CONFIG_SYS_CCSRBAR:
4251 Virtual address of CCSR. On a 32-bit build, this is typically
4252 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4253
4254 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4255 for cross-platform code that uses that macro instead.
4256
4257- CONFIG_SYS_CCSRBAR_PHYS:
4258 Physical address of CCSR. CCSR can be relocated to a new
4259 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004260 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004261 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4262 is typically relocated on 36-bit builds. It is recommended
4263 that this macro be defined via the _HIGH and _LOW macros:
4264
4265 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4266 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4267
4268- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004269 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4270 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004271 used in assembly code, so it must not contain typecasts or
4272 integer size suffixes (e.g. "ULL").
4273
4274- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4275 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4276 used in assembly code, so it must not contain typecasts or
4277 integer size suffixes (e.g. "ULL").
4278
4279- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4280 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4281 forced to a value that ensures that CCSR is not relocated.
4282
wdenk1272e232002-11-10 22:06:23 +00004283- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004284 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004285
4286 the default drive number (default value 0)
4287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004288 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004289
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004290 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004291 (default value 1)
4292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004293 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004294
wdenk4a5c8a72003-03-06 00:02:04 +00004295 defines the offset of register from address. It
4296 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004297 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004299 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4300 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004301 default value.
wdenk1272e232002-11-10 22:06:23 +00004302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004303 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004304 fdc_hw_init() is called at the beginning of the FDC
4305 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004306 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004307 initializations.
wdenk1272e232002-11-10 22:06:23 +00004308
Macpaul Lind1e49942011-04-11 20:45:32 +00004309- CONFIG_IDE_AHB:
4310 Most IDE controllers were designed to be connected with PCI
4311 interface. Only few of them were designed for AHB interface.
4312 When software is doing ATA command and data transfer to
4313 IDE devices through IDE-AHB controller, some additional
4314 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004315 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004316
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004317- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004318 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004319 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004320
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004321- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004322
wdenkeb20ad32003-09-05 23:19:14 +00004323 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004324 initial data and stack; please note that this must be
4325 writable memory that is working WITHOUT special
4326 initialization, i. e. you CANNOT use normal RAM which
4327 will become available only after programming the
4328 memory controller and running certain initialization
4329 sequences.
4330
4331 U-Boot uses the following memory types:
4332 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4333 - MPC824X: data cache
4334 - PPC4xx: data cache
4335
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004336- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004337
4338 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004339 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4340 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004341 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004342 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004343 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004344 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4345 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004346
4347 Note:
4348 On the MPC824X (or other systems that use the data
4349 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004350 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004351 point to an otherwise UNUSED address space between
4352 the top of RAM and the start of the PCI space.
4353
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004354- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004356- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004358- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004359
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004360- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004361
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004362- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004363
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004364- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004365
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004366- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004367 SDRAM timing
4368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004369- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004370 periodic timer for refresh
4371
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004372- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004373
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004374- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4375 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4376 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4377 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004378 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4379
4380- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004381 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4382 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004383 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4384
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004385- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4386 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004387 Machine Mode Register and Memory Periodic Timer
4388 Prescaler definitions (SDRAM timing)
4389
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004390- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004391 enable I2C microcode relocation patch (MPC8xx);
4392 define relocation offset in DPRAM [DSP2]
4393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004394- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004395 enable SMC microcode relocation patch (MPC8xx);
4396 define relocation offset in DPRAM [SMC1]
4397
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004398- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004399 enable SPI microcode relocation patch (MPC8xx);
4400 define relocation offset in DPRAM [SCC4]
4401
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004402- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004403 Offset of the bootmode word in DPRAM used by post
4404 (Power On Self Tests). This definition overrides
4405 #define'd default value in commproc.h resp.
4406 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004408- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4409 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4410 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4411 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4412 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4413 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4414 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4415 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004416 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004417
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004418- CONFIG_PCI_DISABLE_PCIE:
4419 Disable PCI-Express on systems where it is supported but not
4420 required.
4421
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004422- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004423 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004424 Don't do any setup work, presumably because someone or
4425 something has already done it, and we don't need to do it
4426 a second time. Useful for platforms that are pre-booted
4427 by coreboot or similar.
4428
Gabor Juhosb4458732013-05-30 07:06:12 +00004429- CONFIG_PCI_INDIRECT_BRIDGE:
4430 Enable support for indirect PCI bridges.
4431
Kumar Gala8975d7a2010-12-30 12:09:53 -06004432- CONFIG_SYS_SRIO:
4433 Chip has SRIO or not
4434
4435- CONFIG_SRIO1:
4436 Board has SRIO 1 port available
4437
4438- CONFIG_SRIO2:
4439 Board has SRIO 2 port available
4440
Liu Gang27afb9c2013-05-07 16:30:46 +08004441- CONFIG_SRIO_PCIE_BOOT_MASTER
4442 Board can support master function for Boot from SRIO and PCIE
4443
Kumar Gala8975d7a2010-12-30 12:09:53 -06004444- CONFIG_SYS_SRIOn_MEM_VIRT:
4445 Virtual Address of SRIO port 'n' memory region
4446
4447- CONFIG_SYS_SRIOn_MEM_PHYS:
4448 Physical Address of SRIO port 'n' memory region
4449
4450- CONFIG_SYS_SRIOn_MEM_SIZE:
4451 Size of SRIO port 'n' memory region
4452
Fabio Estevamf17e8782013-04-11 09:35:34 +00004453- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4454 Defined to tell the NAND controller that the NAND chip is using
4455 a 16 bit bus.
4456 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004457 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004458 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004459 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004460
4461- CONFIG_SYS_NDFC_EBC0_CFG
4462 Sets the EBC0_CFG register for the NDFC. If not defined
4463 a default value will be used.
4464
Ben Warren45657152006-09-07 16:50:54 -04004465- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004466 Get DDR timing information from an I2C EEPROM. Common
4467 with pluggable memory modules such as SODIMMs
4468
Ben Warren45657152006-09-07 16:50:54 -04004469 SPD_EEPROM_ADDRESS
4470 I2C address of the SPD EEPROM
4471
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004472- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004473 If SPD EEPROM is on an I2C bus other than the first
4474 one, specify here. Note that the value must resolve
4475 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004476
York Sune73cc042011-06-07 09:42:16 +08004477- CONFIG_SYS_DDR_RAW_TIMING
4478 Get DDR timing information from other than SPD. Common with
4479 soldered DDR chips onboard without SPD. DDR raw timing
4480 parameters are extracted from datasheet and hard-coded into
4481 header files or board specific files.
4482
York Sunbd495cf2011-09-16 13:21:35 -07004483- CONFIG_FSL_DDR_INTERACTIVE
4484 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4485
York Sun8ced0502015-01-06 13:18:55 -08004486- CONFIG_FSL_DDR_SYNC_REFRESH
4487 Enable sync of refresh for multiple controllers.
4488
York Sunb6a35f82015-03-19 09:30:28 -07004489- CONFIG_FSL_DDR_BIST
4490 Enable built-in memory test for Freescale DDR controllers.
4491
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004492- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004493 Only for 83xx systems. If specified, then DDR should
4494 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004495
wdenk6203e402004-04-18 10:13:26 +00004496- CONFIG_ETHER_ON_FEC[12]
4497 Define to enable FEC[12] on a 8xx series processor.
4498
4499- CONFIG_FEC[12]_PHY
4500 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004501 to the given FEC; i. e.
4502 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004503 means that the PHY with address 4 is connected to FEC1
4504
4505 When set to -1, means to probe for first available.
4506
4507- CONFIG_FEC[12]_PHY_NORXERR
4508 The PHY does not have a RXERR line (RMII only).
4509 (so program the FEC to ignore it).
4510
4511- CONFIG_RMII
4512 Enable RMII mode for all FECs.
4513 Note that this is a global option, we can't
4514 have one FEC in standard MII mode and another in RMII mode.
4515
wdenk20c98a62004-04-23 20:32:05 +00004516- CONFIG_CRC32_VERIFY
4517 Add a verify option to the crc32 command.
4518 The syntax is:
4519
4520 => crc32 -v <address> <count> <crc32>
4521
4522 Where address/count indicate a memory area
4523 and crc32 is the correct crc32 which the
4524 area should have.
4525
wdenk64519362004-07-11 17:40:54 +00004526- CONFIG_LOOPW
4527 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004528 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004529
stroesecc3af832004-12-16 18:46:55 +00004530- CONFIG_MX_CYCLIC
4531 Add the "mdc" and "mwc" memory commands. These are cyclic
4532 "md/mw" commands.
4533 Examples:
4534
wdenk07d7e6b2004-12-16 21:44:03 +00004535 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004536 This command will print 4 bytes (10,11,12,13) each 500 ms.
4537
wdenk07d7e6b2004-12-16 21:44:03 +00004538 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004539 This command will write 12345678 to address 100 all 10 ms.
4540
wdenk07d7e6b2004-12-16 21:44:03 +00004541 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004542 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004543
wdenk3d3d99f2005-04-04 12:44:11 +00004544- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004545 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004546 low level initializations (like setting up the memory
4547 controller) are omitted and/or U-Boot does not
4548 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004549
Wolfgang Denk302141d2010-11-27 23:30:56 +01004550 Normally this variable MUST NOT be defined. The only
4551 exception is when U-Boot is loaded (to RAM) by some
4552 other boot loader or by a debugger which performs
4553 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004554
Simon Glass90844072016-05-05 07:28:06 -06004555- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4556 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004557 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004558 instruction cache) is still performed.
4559
Aneesh V552a3192011-07-13 05:11:07 +00004560- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004561 Modifies the behaviour of start.S when compiling a loader
4562 that is executed before the actual U-Boot. E.g. when
4563 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004564
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004565- CONFIG_TPL_BUILD
4566 Modifies the behaviour of start.S when compiling a loader
4567 that is executed after the SPL and before the actual U-Boot.
4568 It is loaded by the SPL.
4569
Ying Zhang0d4f5442013-05-20 14:07:23 +08004570- CONFIG_SYS_MPC85XX_NO_RESETVEC
4571 Only for 85xx systems. If this variable is specified, the section
4572 .resetvec is not kept and the section .bootpg is placed in the
4573 previous 4k of the .text section.
4574
Simon Glass17dabf02013-02-24 17:33:14 +00004575- CONFIG_ARCH_MAP_SYSMEM
4576 Generally U-Boot (and in particular the md command) uses
4577 effective address. It is therefore not necessary to regard
4578 U-Boot address as virtual addresses that need to be translated
4579 to physical addresses. However, sandbox requires this, since
4580 it maintains its own little RAM buffer which contains all
4581 addressable memory. This option causes some memory accesses
4582 to be mapped through map_sysmem() / unmap_sysmem().
4583
Simon Glassbfb59802013-02-14 04:18:54 +00004584- CONFIG_X86_RESET_VECTOR
4585 If defined, the x86 reset vector code is included. This is not
4586 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004587
Mark Jackson52b003c2013-03-04 01:27:20 +00004588- CONFIG_SYS_MPUCLK
4589 Defines the MPU clock speed (in MHz).
4590
4591 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004592
Heiko Schocher2233e462013-11-04 14:05:00 +01004593- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4594 Enables the RTC32K OSC on AM33xx based plattforms
4595
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004596- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4597 Option to disable subpage write in NAND driver
4598 driver that uses this:
4599 drivers/mtd/nand/davinci_nand.c
4600
Timur Tabi275f4bb2011-11-22 09:21:25 -06004601Freescale QE/FMAN Firmware Support:
4602-----------------------------------
4603
4604The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4605loading of "firmware", which is encoded in the QE firmware binary format.
4606This firmware often needs to be loaded during U-Boot booting, so macros
4607are used to identify the storage device (NOR flash, SPI, etc) and the address
4608within that device.
4609
Zhao Qiang83a90842014-03-21 16:21:44 +08004610- CONFIG_SYS_FMAN_FW_ADDR
4611 The address in the storage device where the FMAN microcode is located. The
4612 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4613 is also specified.
4614
4615- CONFIG_SYS_QE_FW_ADDR
4616 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004617 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4618 is also specified.
4619
4620- CONFIG_SYS_QE_FMAN_FW_LENGTH
4621 The maximum possible size of the firmware. The firmware binary format
4622 has a field that specifies the actual size of the firmware, but it
4623 might not be possible to read any part of the firmware unless some
4624 local storage is allocated to hold the entire firmware first.
4625
4626- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4627 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4628 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4629 virtual address in NOR flash.
4630
4631- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4632 Specifies that QE/FMAN firmware is located in NAND flash.
4633 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4634
4635- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4636 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4637 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4638
Liu Gang1e084582012-03-08 00:33:18 +00004639- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4640 Specifies that QE/FMAN firmware is located in the remote (master)
4641 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004642 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4643 window->master inbound window->master LAW->the ucode address in
4644 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004645
J. German Rivera8ff14b72014-06-23 15:15:55 -07004646Freescale Layerscape Management Complex Firmware Support:
4647---------------------------------------------------------
4648The Freescale Layerscape Management Complex (MC) supports the loading of
4649"firmware".
4650This firmware often needs to be loaded during U-Boot booting, so macros
4651are used to identify the storage device (NOR flash, SPI, etc) and the address
4652within that device.
4653
4654- CONFIG_FSL_MC_ENET
4655 Enable the MC driver for Layerscape SoCs.
4656
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304657Freescale Layerscape Debug Server Support:
4658-------------------------------------------
4659The Freescale Layerscape Debug Server Support supports the loading of
4660"Debug Server firmware" and triggering SP boot-rom.
4661This firmware often needs to be loaded during U-Boot booting.
4662
York Sun928b6812015-12-07 11:08:58 -08004663- CONFIG_SYS_MC_RSV_MEM_ALIGN
4664 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304665
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004666Reproducible builds
4667-------------------
4668
4669In order to achieve reproducible builds, timestamps used in the U-Boot build
4670process have to be set to a fixed value.
4671
4672This is done using the SOURCE_DATE_EPOCH environment variable.
4673SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4674option for U-Boot or an environment variable in U-Boot.
4675
4676SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4677
wdenkc6097192002-11-03 00:24:07 +00004678Building the Software:
4679======================
4680
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004681Building U-Boot has been tested in several native build environments
4682and in many different cross environments. Of course we cannot support
4683all possibly existing versions of cross development tools in all
4684(potentially obsolete) versions. In case of tool chain problems we
4685recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4686which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004687
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004688If you are not using a native environment, it is assumed that you
4689have GNU cross compiling tools available in your path. In this case,
4690you must set the environment variable CROSS_COMPILE in your shell.
4691Note that no changes to the Makefile or any other source files are
4692necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004693
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004694 $ CROSS_COMPILE=ppc_4xx-
4695 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004696
Peter Tyserb06976d2009-03-13 18:54:51 -05004697Note: If you wish to generate Windows versions of the utilities in
4698 the tools directory you can use the MinGW toolchain
4699 (http://www.mingw.org). Set your HOST tools to the MinGW
4700 toolchain and execute 'make tools'. For example:
4701
4702 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4703
4704 Binaries such as tools/mkimage.exe will be created which can
4705 be executed on computers running Windows.
4706
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004707U-Boot is intended to be simple to build. After installing the
4708sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004709is done by typing:
4710
Holger Freyther7ba4e572014-08-04 09:26:05 +02004711 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004712
Holger Freyther7ba4e572014-08-04 09:26:05 +02004713where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004714rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004715
wdenk6c59edc2004-05-03 20:45:30 +00004716Note: for some board special configuration names may exist; check if
4717 additional information is available from the board vendor; for
4718 instance, the TQM823L systems are available without (standard)
4719 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004720 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004721
Holger Freyther7ba4e572014-08-04 09:26:05 +02004722 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004723 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004724
Holger Freyther7ba4e572014-08-04 09:26:05 +02004725 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004726 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728 etc.
wdenkc6097192002-11-03 00:24:07 +00004729
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk6c59edc2004-05-03 20:45:30 +00004731Finally, type "make all", and you should get some working U-Boot
4732images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004733
wdenk6c59edc2004-05-03 20:45:30 +00004734- "u-boot.bin" is a raw binary image
4735- "u-boot" is an image in ELF binary format
4736- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004737
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004738By default the build is performed locally and the objects are saved
4739in the source directory. One of the two methods can be used to change
4740this behavior and build U-Boot to some external directory:
4741
47421. Add O= to the make command line invocations:
4743
4744 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004745 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004746 make O=/tmp/build all
4747
Timo Ketolac8c67602014-11-06 14:39:05 +020047482. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004749
Timo Ketolac8c67602014-11-06 14:39:05 +02004750 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004751 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004752 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004753 make all
4754
Timo Ketolac8c67602014-11-06 14:39:05 +02004755Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004756variable.
4757
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk6c59edc2004-05-03 20:45:30 +00004759Please be aware that the Makefiles assume you are using GNU make, so
4760for instance on NetBSD you might need to use "gmake" instead of
4761native "make".
wdenkc6097192002-11-03 00:24:07 +00004762
wdenkc6097192002-11-03 00:24:07 +00004763
wdenk6c59edc2004-05-03 20:45:30 +00004764If the system board that you have is not listed, then you will need
4765to port U-Boot to your hardware platform. To do this, follow these
4766steps:
wdenkc6097192002-11-03 00:24:07 +00004767
Phil Sutterc77b4882015-12-25 14:41:18 +010047681. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004769 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004770 the "Makefile" and a "<board>.c".
47712. Create a new configuration file "include/configs/<board>.h" for
4772 your board.
wdenk6c59edc2004-05-03 20:45:30 +000047733. If you're porting U-Boot to a new CPU, then also create a new
4774 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020047754. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000047765. Type "make", and you should get a working "u-boot.srec" file
4777 to be installed on your target system.
47786. Debug and solve any problems that might arise.
4779 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004780
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4783==============================================================
wdenkc6097192002-11-03 00:24:07 +00004784
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004785If you have modified U-Boot sources (for instance added a new board
4786or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004787provide feedback to the other developers. The feedback normally takes
4788the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004789official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004790
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004791But before you submit such a patch, please verify that your modifi-
4792cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004793the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004794just run the buildman script (tools/buildman/buildman), which will
4795configure and build U-Boot for ALL supported system. Be warned, this
4796will take a while. Please see the buildman README, or run 'buildman -H'
4797for documentation.
wdenkc6097192002-11-03 00:24:07 +00004798
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004799
wdenk6c59edc2004-05-03 20:45:30 +00004800See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004801
wdenkc6097192002-11-03 00:24:07 +00004802
wdenk6c59edc2004-05-03 20:45:30 +00004803Monitor Commands - Overview:
4804============================
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk6c59edc2004-05-03 20:45:30 +00004806go - start application at address 'addr'
4807run - run commands in an environment variable
4808bootm - boot application image from memory
4809bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004810bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004811tftpboot- boot image via network using TFTP protocol
4812 and env variables "ipaddr" and "serverip"
4813 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004814tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004815rarpboot- boot image via network using RARP/TFTP protocol
4816diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4817loads - load S-Record file over serial line
4818loadb - load binary file over serial line (kermit mode)
4819md - memory display
4820mm - memory modify (auto-incrementing)
4821nm - memory modify (constant address)
4822mw - memory write (fill)
4823cp - memory copy
4824cmp - memory compare
4825crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004826i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004827sspi - SPI utility commands
4828base - print or set address offset
4829printenv- print environment variables
4830setenv - set environment variables
4831saveenv - save environment variables to persistent storage
4832protect - enable or disable FLASH write protection
4833erase - erase FLASH memory
4834flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004835nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004836bdinfo - print Board Info structure
4837iminfo - print header information for application image
4838coninfo - print console devices and informations
4839ide - IDE sub-system
4840loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004841loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004842mtest - simple RAM test
4843icache - enable or disable instruction cache
4844dcache - enable or disable data cache
4845reset - Perform RESET of the CPU
4846echo - echo args to console
4847version - print monitor version
4848help - print online help
4849? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004850
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk6c59edc2004-05-03 20:45:30 +00004852Monitor Commands - Detailed Description:
4853========================================
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk6c59edc2004-05-03 20:45:30 +00004855TODO.
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk6c59edc2004-05-03 20:45:30 +00004857For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004858
4859
wdenk6c59edc2004-05-03 20:45:30 +00004860Environment Variables:
4861======================
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk6c59edc2004-05-03 20:45:30 +00004863U-Boot supports user configuration using Environment Variables which
4864can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866Environment Variables are set using "setenv", printed using
4867"printenv", and saved to Flash using "saveenv". Using "setenv"
4868without a value can be used to delete a variable from the
4869environment. As long as you don't save the environment you are
4870working with an in-memory copy. In case the Flash area containing the
4871environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004872
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004873Some configuration options can be set using Environment Variables.
4874
4875List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004886
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004887 bootm_low - Memory range available for image processing in the bootm
4888 command can be restricted. This variable is given as
4889 a hexadecimal number and defines lowest address allowed
4890 for use by the bootm command. See also "bootm_size"
4891 environment variable. Address defined by "bootm_low" is
4892 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004893 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4894 bootm_mapsize.
4895
Wolfgang Denk092ae952011-10-26 10:21:21 +00004896 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004897 This variable is given as a hexadecimal number and it
4898 defines the size of the memory region starting at base
4899 address bootm_low that is accessible by the Linux kernel
4900 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4901 as the default value if it is defined, and bootm_size is
4902 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004903
4904 bootm_size - Memory range available for image processing in the bootm
4905 command can be restricted. This variable is given as
4906 a hexadecimal number and defines the size of the region
4907 allowed for use by the bootm command. See also "bootm_low"
4908 environment variable.
4909
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004910 updatefile - Location of the software update file on a TFTP server, used
4911 by the automatic software update feature. Please refer to
4912 documentation in doc/README.update for more details.
4913
wdenk6c59edc2004-05-03 20:45:30 +00004914 autoload - if set to "no" (any string beginning with 'n'),
4915 "bootp" will just load perform a lookup of the
4916 configuration from the BOOTP server, but not try to
4917 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk6c59edc2004-05-03 20:45:30 +00004919 autostart - if set to "yes", an image loaded using the "bootp",
4920 "rarpboot", "tftpboot" or "diskboot" commands will
4921 be automatically started (by internally calling
4922 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk6c59edc2004-05-03 20:45:30 +00004924 If set to "no", a standalone image passed to the
4925 "bootm" command will be copied to the load address
4926 (and eventually uncompressed), but NOT be started.
4927 This can be used to load and uncompress arbitrary
4928 data.
wdenkc6097192002-11-03 00:24:07 +00004929
David A. Longd558a4e2011-07-09 16:40:19 -04004930 fdt_high - if set this restricts the maximum address that the
4931 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004932 For example, if you have a system with 1 GB memory
4933 at physical address 0x10000000, while Linux kernel
4934 only recognizes the first 704 MB as low memory, you
4935 may need to set fdt_high as 0x3C000000 to have the
4936 device tree blob be copied to the maximum address
4937 of the 704 MB low memory, so that Linux kernel can
4938 access it during the boot procedure.
4939
David A. Longd558a4e2011-07-09 16:40:19 -04004940 If this is set to the special value 0xFFFFFFFF then
4941 the fdt will not be copied at all on boot. For this
4942 to work it must reside in writable memory, have
4943 sufficient padding on the end of it for u-boot to
4944 add the information it needs into it, and the memory
4945 must be accessible by the kernel.
4946
Simon Glassdc6fa642011-10-24 19:15:34 +00004947 fdtcontroladdr- if set this is the address of the control flattened
4948 device tree used by U-Boot when CONFIG_OF_CONTROL is
4949 defined.
4950
wdenk0e2bd9c2004-06-06 21:51:03 +00004951 i2cfast - (PPC405GP|PPC405EP only)
4952 if set to 'y' configures Linux I2C driver for fast
4953 mode (400kHZ). This environment variable is used in
4954 initialization code. So, for changes to be effective
4955 it must be saved and board must be reset.
4956
wdenk6c59edc2004-05-03 20:45:30 +00004957 initrd_high - restrict positioning of initrd images:
4958 If this variable is not set, initrd images will be
4959 copied to the highest possible address in RAM; this
4960 is usually what you want since it allows for
4961 maximum initrd size. If for some reason you want to
4962 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004963 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004964 variable to a value of "no" or "off" or "0".
4965 Alternatively, you can set it to a maximum upper
4966 address to use (U-Boot will still check that it
4967 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969 For instance, when you have a system with 16 MB
4970 RAM, and want to reserve 4 MB from use by Linux,
4971 you can do this by adding "mem=12M" to the value of
4972 the "bootargs" variable. However, now you must make
4973 sure that the initrd image is placed in the first
4974 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978 If you set initrd_high to 0xFFFFFFFF, this is an
4979 indication to U-Boot that all addresses are legal
4980 for the Linux kernel, including addresses in flash
4981 memory. In this case U-Boot will NOT COPY the
4982 ramdisk at all. This may be useful to reduce the
4983 boot time on your system, but requires that this
4984 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004985
wdenk6c59edc2004-05-03 20:45:30 +00004986 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk6c59edc2004-05-03 20:45:30 +00004988 loadaddr - Default load address for commands like "bootp",
4989 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004990
wdenk6c59edc2004-05-03 20:45:30 +00004991 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk6c59edc2004-05-03 20:45:30 +00004993 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk6c59edc2004-05-03 20:45:30 +00004999 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005000
Mike Frysingera23230c2011-10-02 10:01:27 +00005001 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005002
Mike Frysingera23230c2011-10-02 10:01:27 +00005003 ethact - controls which interface is currently active.
5004 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005005
Heiko Schocherc5e84052010-07-20 17:45:02 +02005006 => setenv ethact FEC
5007 => ping 192.168.0.1 # traffic sent on FEC
5008 => setenv ethact SCC
5009 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005010
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005011 ethrotate - When set to "no" U-Boot does not go through all
5012 available network interfaces.
5013 It just stays at the currently selected interface.
5014
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005015 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005016 either succeed or fail without retrying.
5017 When set to "once" the network operation will
5018 fail when all the available network interfaces
5019 are tried once without success.
5020 Useful on scripts which control the retry operation
5021 themselves.
wdenkc6097192002-11-03 00:24:07 +00005022
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005023 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005024
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005025 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005026 changing the console to be empty. If "yes" it will be
5027 made silent. If "no" it will not be made silent. If
5028 unset, then it will be made silent if the U-Boot console
5029 is silent.
5030
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005031 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005032 UDP source port.
5033
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005034 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005035 destination port instead of the Well Know Port 69.
5036
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005037 tftpblocksize - Block size to use for TFTP transfers; if not set,
5038 we use the TFTP server's default block size
5039
5040 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5041 seconds, minimum value is 1000 = 1 second). Defines
5042 when a packet is considered to be lost so it has to
5043 be retransmitted. The default is 5000 = 5 seconds.
5044 Lowering this value may make downloads succeed
5045 faster in networks with high packet loss rates or
5046 with unreliable TFTP servers.
5047
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005048 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5049 unit, minimum value = 0). Defines how many timeouts
5050 can happen during a single file transfer before that
5051 transfer is aborted. The default is 10, and 0 means
5052 'no timeouts allowed'. Increasing this value may help
5053 downloads succeed with high packet loss rates, or with
5054 unreliable TFTP servers or client hardware.
5055
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005056 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005057 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005058 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005059
Alexandre Messier15971322016-02-01 17:08:57 -05005060 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5061 Unsigned value, in milliseconds. If not set, the period will
5062 be either the default (28000), or a value based on
5063 CONFIG_NET_RETRY_COUNT, if defined. This value has
5064 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5065
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005066The following image location variables contain the location of images
5067used in booting. The "Image" column gives the role of the image and is
5068not an environment variable name. The other columns are environment
5069variable names. "File Name" gives the name of the file on a TFTP
5070server, "RAM Address" gives the location in RAM the image will be
5071loaded to, and "Flash Location" gives the image's address in NOR
5072flash or offset in NAND flash.
5073
5074*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005075boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005076boards use these variables for other purposes.
5077
Wolfgang Denk092ae952011-10-26 10:21:21 +00005078Image File Name RAM Address Flash Location
5079----- --------- ----------- --------------
5080u-boot u-boot u-boot_addr_r u-boot_addr
5081Linux kernel bootfile kernel_addr_r kernel_addr
5082device tree blob fdtfile fdt_addr_r fdt_addr
5083ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005084
wdenk6c59edc2004-05-03 20:45:30 +00005085The following environment variables may be used and automatically
5086updated by the network boot commands ("bootp" and "rarpboot"),
5087depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005088
wdenk6c59edc2004-05-03 20:45:30 +00005089 bootfile - see above
5090 dnsip - IP address of your Domain Name Server
5091 dnsip2 - IP address of your secondary Domain Name Server
5092 gatewayip - IP address of the Gateway (Router) to use
5093 hostname - Target hostname
5094 ipaddr - see above
5095 netmask - Subnet Mask
5096 rootpath - Pathname of the root filesystem on the NFS server
5097 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005098
wdenk145d2c12004-04-15 21:48:45 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102 serial# - contains hardware identification information such
5103 as type string and/or serial number
5104 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106These variables can be set only once (usually during manufacturing of
5107the board). U-Boot refuses to delete or overwrite these variables
5108once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005109
5110
wdenk6c59edc2004-05-03 20:45:30 +00005111Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk6c59edc2004-05-03 20:45:30 +00005113 ver - Contains the U-Boot version string as printed
5114 with the "version" command. This variable is
5115 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005116
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118Please note that changes to some configuration parameters may take
5119only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005120
stroeseb9c17c52003-04-04 15:53:41 +00005121
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005122Callback functions for environment variables:
5123---------------------------------------------
5124
5125For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005126when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005127be associated with arbitrary variables. On creation, overwrite, or
5128deletion, the callback will provide the opportunity for some side
5129effect to happen or for the change to be rejected.
5130
5131The callbacks are named and associated with a function using the
5132U_BOOT_ENV_CALLBACK macro in your board or driver code.
5133
5134These callbacks are associated with variables in one of two ways. The
5135static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5136in the board configuration to a string that defines a list of
5137associations. The list must be in the following format:
5138
5139 entry = variable_name[:callback_name]
5140 list = entry[,list]
5141
5142If the callback name is not specified, then the callback is deleted.
5143Spaces are also allowed anywhere in the list.
5144
5145Callbacks can also be associated by defining the ".callbacks" variable
5146with the same list format above. Any association in ".callbacks" will
5147override any association in the static list. You can define
5148CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005149".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005150
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005151If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5152regular expression. This allows multiple variables to be connected to
5153the same callback without explicitly listing them all out.
5154
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005155
wdenk6c59edc2004-05-03 20:45:30 +00005156Command Line Parsing:
5157=====================
stroeseb9c17c52003-04-04 15:53:41 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159There are two different command line parsers available with U-Boot:
5160the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162Old, simple command line parser:
5163--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165- supports environment variables (through setenv / saveenv commands)
5166- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005167- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005168- special characters ('$', ';') can be escaped by prefixing with '\',
5169 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005170 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005171- You can also escape text by enclosing in single apostrophes, for example:
5172 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174Hush shell:
5175-----------
wdenkf4688a22003-05-28 08:06:31 +00005176
wdenk6c59edc2004-05-03 20:45:30 +00005177- similar to Bourne shell, with control structures like
5178 if...then...else...fi, for...do...done; while...do...done,
5179 until...do...done, ...
5180- supports environment ("global") variables (through setenv / saveenv
5181 commands) and local shell variables (through standard shell syntax
5182 "name=value"); only environment variables can be used with "run"
5183 command
wdenkf4688a22003-05-28 08:06:31 +00005184
wdenk6c59edc2004-05-03 20:45:30 +00005185General rules:
5186--------------
wdenkf4688a22003-05-28 08:06:31 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188(1) If a command line (or an environment variable executed by a "run"
5189 command) contains several commands separated by semicolon, and
5190 one of these commands fails, then the remaining commands will be
5191 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005192
wdenk6c59edc2004-05-03 20:45:30 +00005193(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005194 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005195 command will cause "run" to terminate, i. e. the remaining
5196 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005197
wdenk6c59edc2004-05-03 20:45:30 +00005198Note for Redundant Ethernet Interfaces:
5199=======================================
wdenkf4688a22003-05-28 08:06:31 +00005200
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005201Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005202such configurations and is capable of automatic selection of a
5203"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5206MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5207"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209If the network interface stores some valid MAC address (for instance
5210in SROM), this is used as default address if there is NO correspon-
5211ding setting in the environment; if the corresponding environment
5212variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005213
wdenk6c59edc2004-05-03 20:45:30 +00005214o If the SROM has a valid MAC address, and there is no address in the
5215 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk6c59edc2004-05-03 20:45:30 +00005217o If there is no valid address in the SROM, and a definition in the
5218 environment exists, then the value from the environment variable is
5219 used.
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221o If both the SROM and the environment contain a MAC address, and
5222 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk6c59edc2004-05-03 20:45:30 +00005224o If both the SROM and the environment contain a MAC address, and the
5225 addresses differ, the value from the environment is used and a
5226 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk6c59edc2004-05-03 20:45:30 +00005228o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005229 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5230 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005231
Ben Warren6db991a2010-04-26 11:11:46 -07005232If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005233will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005234may be skipped by setting the appropriate 'ethmacskip' environment variable.
5235The naming convention is as follows:
5236"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238Image Formats:
5239==============
wdenkc6097192002-11-03 00:24:07 +00005240
Marian Balakowicz18710b82008-03-12 12:13:13 +01005241U-Boot is capable of booting (and performing other auxiliary operations on)
5242images in two formats:
5243
5244New uImage format (FIT)
5245-----------------------
5246
5247Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5248to Flattened Device Tree). It allows the use of images with multiple
5249components (several kernels, ramdisks, etc.), with contents protected by
5250SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5251
5252
5253Old uImage format
5254-----------------
5255
5256Old image format is based on binary files which can be basically anything,
5257preceded by a special header; see the definitions in include/image.h for
5258details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk6c59edc2004-05-03 20:45:30 +00005260* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5261 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005262 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5263 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5264 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005265* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005266 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5267 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005268* Compression Type (uncompressed, gzip, bzip2)
5269* Load Address
5270* Entry Point
5271* Image Name
5272* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274The header is marked by a special Magic Number, and both the header
5275and the data portions of the image are secured against corruption by
5276CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005277
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279Linux Support:
5280==============
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282Although U-Boot should support any OS or standalone application
5283easily, the main focus has always been on Linux during the design of
5284U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk6c59edc2004-05-03 20:45:30 +00005286U-Boot includes many features that so far have been part of some
5287special "boot loader" code within the Linux kernel. Also, any
5288"initrd" images to be used are no longer part of one big Linux image;
5289instead, kernel and "initrd" are separate images. This implementation
5290serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292- the same features can be used for other OS or standalone
5293 applications (for instance: using compressed images to reduce the
5294 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk6c59edc2004-05-03 20:45:30 +00005296- it becomes much easier to port new Linux kernel versions because
5297 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk6c59edc2004-05-03 20:45:30 +00005299- the same Linux kernel image can now be used with different "initrd"
5300 images; of course this also means that different kernel images can
5301 be run with the same "initrd". This makes testing easier (you don't
5302 have to build a new "zImage.initrd" Linux image when you just
5303 change a file in your "initrd"). Also, a field-upgrade of the
5304 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005305
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307Linux HOWTO:
5308============
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310Porting Linux to U-Boot based systems:
5311---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313U-Boot cannot save you from doing all the necessary modifications to
5314configure the Linux device drivers for use with your target hardware
5315(no, we don't intend to provide a full virtual machine interface to
5316Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005317
Stefan Roese88fbf932010-04-15 16:07:28 +02005318But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320Just make sure your machine specific header file (for instance
5321include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005322Information structure as we define in include/asm-<arch>/u-boot.h,
5323and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005324as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005325
Simon Glassd097e592014-06-11 23:29:46 -06005326Note that U-Boot now has a driver model, a unified model for drivers.
5327If you are adding a new driver, plumb it into driver model. If there
5328is no uclass available, you are encouraged to create one. See
5329doc/driver-model.
5330
wdenkc6097192002-11-03 00:24:07 +00005331
wdenk6c59edc2004-05-03 20:45:30 +00005332Configuring the Linux kernel:
5333-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk6c59edc2004-05-03 20:45:30 +00005335No specific requirements for U-Boot. Make sure you have some root
5336device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005337
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk6c59edc2004-05-03 20:45:30 +00005339Building a Linux Image:
5340-----------------------
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk6c59edc2004-05-03 20:45:30 +00005342With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5343not used. If you use recent kernel source, a new build target
5344"uImage" will exist which automatically builds an image usable by
5345U-Boot. Most older kernels also have support for a "pImage" target,
5346which was introduced for our predecessor project PPCBoot and uses a
5347100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349Example:
wdenkc6097192002-11-03 00:24:07 +00005350
Holger Freyther7ba4e572014-08-04 09:26:05 +02005351 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005352 make oldconfig
5353 make dep
5354 make uImage
wdenkc6097192002-11-03 00:24:07 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356The "uImage" build target uses a special tool (in 'tools/mkimage') to
5357encapsulate a compressed Linux kernel image with header information,
5358CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk6c59edc2004-05-03 20:45:30 +00005360* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk6c59edc2004-05-03 20:45:30 +00005364 ${CROSS_COMPILE}-objcopy -O binary \
5365 -R .note -R .comment \
5366 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005367
wdenk6c59edc2004-05-03 20:45:30 +00005368* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005373
wdenk6c59edc2004-05-03 20:45:30 +00005374 mkimage -A ppc -O linux -T kernel -C gzip \
5375 -a 0 -e 0 -n "Linux Kernel Image" \
5376 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005377
wdenkc6097192002-11-03 00:24:07 +00005378
wdenk6c59edc2004-05-03 20:45:30 +00005379The "mkimage" tool can also be used to create ramdisk images for use
5380with U-Boot, either separated from the Linux kernel image, or
5381combined into one file. "mkimage" encapsulates the images with a 64
5382byte header containing information about target architecture,
5383operating system, image type, compression method, entry points, time
5384stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386"mkimage" can be called in two ways: to verify existing images and
5387print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389In the first form (with "-l" option) mkimage lists the information
5390contained in the header of an existing U-Boot image; this includes
5391checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005392
wdenk6c59edc2004-05-03 20:45:30 +00005393 tools/mkimage -l image
5394 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005395
wdenk6c59edc2004-05-03 20:45:30 +00005396The second form (with "-d" option) is used to build a U-Boot image
5397from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005398
wdenk6c59edc2004-05-03 20:45:30 +00005399 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5400 -n name -d data_file image
5401 -A ==> set architecture to 'arch'
5402 -O ==> set operating system to 'os'
5403 -T ==> set image type to 'type'
5404 -C ==> set compression type 'comp'
5405 -a ==> set load address to 'addr' (hex)
5406 -e ==> set entry point to 'ep' (hex)
5407 -n ==> set image name to 'name'
5408 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005409
wdenkcd914452004-05-29 16:53:29 +00005410Right now, all Linux kernels for PowerPC systems use the same load
5411address (0x00000000), but the entry point address depends on the
5412kernel version:
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk6c59edc2004-05-03 20:45:30 +00005414- 2.2.x kernels have the entry point at 0x0000000C,
5415- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005418
wdenk6c59edc2004-05-03 20:45:30 +00005419 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5420 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005421 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005422 > examples/uImage.TQM850L
5423 Image Name: 2.4.4 kernel for TQM850L
5424 Created: Wed Jul 19 02:34:59 2000
5425 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5426 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5427 Load Address: 0x00000000
5428 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432 -> tools/mkimage -l examples/uImage.TQM850L
5433 Image Name: 2.4.4 kernel for TQM850L
5434 Created: Wed Jul 19 02:34:59 2000
5435 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5436 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5437 Load Address: 0x00000000
5438 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005439
wdenk6c59edc2004-05-03 20:45:30 +00005440NOTE: for embedded systems where boot time is critical you can trade
5441speed for memory and install an UNCOMPRESSED image instead: this
5442needs more space in Flash, but boots much faster since it does not
5443need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005444
Stefan Roese88fbf932010-04-15 16:07:28 +02005445 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005446 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5447 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005448 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005449 > examples/uImage.TQM850L-uncompressed
5450 Image Name: 2.4.4 kernel for TQM850L
5451 Created: Wed Jul 19 02:34:59 2000
5452 Image Type: PowerPC Linux Kernel Image (uncompressed)
5453 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5454 Load Address: 0x00000000
5455 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005456
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5459when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461 -> tools/mkimage -n 'Simple Ramdisk Image' \
5462 > -A ppc -O linux -T ramdisk -C gzip \
5463 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5464 Image Name: Simple Ramdisk Image
5465 Created: Wed Jan 12 14:01:50 2000
5466 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5467 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5468 Load Address: 0x00000000
5469 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005470
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005471The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5472option performs the converse operation of the mkimage's second form (the "-d"
5473option). Given an image built by mkimage, the dumpimage extracts a "data file"
5474from the image:
5475
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005476 tools/dumpimage -i image -T type -p position data_file
5477 -i ==> extract from the 'image' a specific 'data_file'
5478 -T ==> set image type to 'type'
5479 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005480
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482Installing a Linux Image:
5483-------------------------
wdenkc6097192002-11-03 00:24:07 +00005484
wdenk6c59edc2004-05-03 20:45:30 +00005485To downloading a U-Boot image over the serial (console) interface,
5486you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005487
wdenk6c59edc2004-05-03 20:45:30 +00005488 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005489
wdenk6c59edc2004-05-03 20:45:30 +00005490The 'objcopy' does not understand the information in the U-Boot
5491image header, so the resulting S-Record file will be relative to
5492address 0x00000000. To load it to a given address, you need to
5493specify the target address as 'offset' parameter with the 'loads'
5494command.
wdenkc6097192002-11-03 00:24:07 +00005495
wdenk6c59edc2004-05-03 20:45:30 +00005496Example: install the image to address 0x40100000 (which on the
5497TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005498
wdenk6c59edc2004-05-03 20:45:30 +00005499 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005500
wdenk6c59edc2004-05-03 20:45:30 +00005501 .......... done
5502 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504 => loads 40100000
5505 ## Ready for S-Record download ...
5506 ~>examples/image.srec
5507 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5508 ...
5509 15989 15990 15991 15992
5510 [file transfer complete]
5511 [connected]
5512 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005513
wdenkc6097192002-11-03 00:24:07 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005516this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005517corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005518
wdenk6c59edc2004-05-03 20:45:30 +00005519 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk6c59edc2004-05-03 20:45:30 +00005521 ## Checking Image at 40100000 ...
5522 Image Name: 2.2.13 for initrd on TQM850L
5523 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5524 Data Size: 335725 Bytes = 327 kB = 0 MB
5525 Load Address: 00000000
5526 Entry Point: 0000000c
5527 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005528
5529
wdenk6c59edc2004-05-03 20:45:30 +00005530Boot Linux:
5531-----------
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533The "bootm" command is used to boot an application that is stored in
5534memory (RAM or Flash). In case of a Linux kernel image, the contents
5535of the "bootargs" environment variable is passed to the kernel as
5536parameters. You can check and modify this variable using the
5537"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005538
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk6c59edc2004-05-03 20:45:30 +00005540 => printenv bootargs
5541 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543 => 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 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545 => printenv bootargs
5546 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 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548 => bootm 40020000
5549 ## Booting Linux kernel at 40020000 ...
5550 Image Name: 2.2.13 for NFS on TQM850L
5551 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5552 Data Size: 381681 Bytes = 372 kB = 0 MB
5553 Load Address: 00000000
5554 Entry Point: 0000000c
5555 Verifying Checksum ... OK
5556 Uncompressing Kernel Image ... OK
5557 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
5558 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5559 time_init: decrementer frequency = 187500000/60
5560 Calibrating delay loop... 49.77 BogoMIPS
5561 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5562 ...
wdenkc6097192002-11-03 00:24:07 +00005563
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005564If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005565the memory addresses of both the kernel and the initrd image (PPBCOOT
5566format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk6c59edc2004-05-03 20:45:30 +00005568 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570 ## Checking Image at 40100000 ...
5571 Image Name: 2.2.13 for initrd on TQM850L
5572 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5573 Data Size: 335725 Bytes = 327 kB = 0 MB
5574 Load Address: 00000000
5575 Entry Point: 0000000c
5576 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk6c59edc2004-05-03 20:45:30 +00005578 ## Checking Image at 40200000 ...
5579 Image Name: Simple Ramdisk Image
5580 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5581 Data Size: 566530 Bytes = 553 kB = 0 MB
5582 Load Address: 00000000
5583 Entry Point: 00000000
5584 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586 => bootm 40100000 40200000
5587 ## Booting Linux kernel at 40100000 ...
5588 Image Name: 2.2.13 for initrd on TQM850L
5589 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5590 Data Size: 335725 Bytes = 327 kB = 0 MB
5591 Load Address: 00000000
5592 Entry Point: 0000000c
5593 Verifying Checksum ... OK
5594 Uncompressing Kernel Image ... OK
5595 ## Loading RAMDisk Image at 40200000 ...
5596 Image Name: Simple Ramdisk Image
5597 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5598 Data Size: 566530 Bytes = 553 kB = 0 MB
5599 Load Address: 00000000
5600 Entry Point: 00000000
5601 Verifying Checksum ... OK
5602 Loading Ramdisk ... OK
5603 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
5604 Boot arguments: root=/dev/ram
5605 time_init: decrementer frequency = 187500000/60
5606 Calibrating delay loop... 49.77 BogoMIPS
5607 ...
5608 RAMDISK: Compressed image found at block 0
5609 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611 bash#
wdenkc6097192002-11-03 00:24:07 +00005612
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005613Boot Linux and pass a flat device tree:
5614-----------
5615
5616First, U-Boot must be compiled with the appropriate defines. See the section
5617titled "Linux Kernel Interface" above for a more in depth explanation. The
5618following is an example of how to start a kernel and pass an updated
5619flat device tree:
5620
5621=> print oftaddr
5622oftaddr=0x300000
5623=> print oft
5624oft=oftrees/mpc8540ads.dtb
5625=> tftp $oftaddr $oft
5626Speed: 1000, full duplex
5627Using TSEC0 device
5628TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5629Filename 'oftrees/mpc8540ads.dtb'.
5630Load address: 0x300000
5631Loading: #
5632done
5633Bytes transferred = 4106 (100a hex)
5634=> tftp $loadaddr $bootfile
5635Speed: 1000, full duplex
5636Using TSEC0 device
5637TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5638Filename 'uImage'.
5639Load address: 0x200000
5640Loading:############
5641done
5642Bytes transferred = 1029407 (fb51f hex)
5643=> print loadaddr
5644loadaddr=200000
5645=> print oftaddr
5646oftaddr=0x300000
5647=> bootm $loadaddr - $oftaddr
5648## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005649 Image Name: Linux-2.6.17-dirty
5650 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5651 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005652 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005653 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005654 Verifying Checksum ... OK
5655 Uncompressing Kernel Image ... OK
5656Booting using flat device tree at 0x300000
5657Using MPC85xx ADS machine description
5658Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5659[snip]
5660
5661
wdenk6c59edc2004-05-03 20:45:30 +00005662More About U-Boot Image Types:
5663------------------------------
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667 "Standalone Programs" are directly runnable in the environment
5668 provided by U-Boot; it is expected that (if they behave
5669 well) you can continue to work in U-Boot after return from
5670 the Standalone Program.
5671 "OS Kernel Images" are usually images of some Embedded OS which
5672 will take over control completely. Usually these programs
5673 will install their own set of exception handlers, device
5674 drivers, set up the MMU, etc. - this means, that you cannot
5675 expect to re-enter U-Boot except by resetting the CPU.
5676 "RAMDisk Images" are more or less just data blocks, and their
5677 parameters (address, size) are passed to an OS kernel that is
5678 being started.
5679 "Multi-File Images" contain several images, typically an OS
5680 (Linux) kernel image and one or more data images like
5681 RAMDisks. This construct is useful for instance when you want
5682 to boot over the network using BOOTP etc., where the boot
5683 server provides just a single image file, but you want to get
5684 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk6c59edc2004-05-03 20:45:30 +00005686 "Multi-File Images" start with a list of image sizes, each
5687 image size (in bytes) specified by an "uint32_t" in network
5688 byte order. This list is terminated by an "(uint32_t)0".
5689 Immediately after the terminating 0 follow the images, one by
5690 one, all aligned on "uint32_t" boundaries (size rounded up to
5691 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk6c59edc2004-05-03 20:45:30 +00005693 "Firmware Images" are binary images containing firmware (like
5694 U-Boot or FPGA images) which usually will be programmed to
5695 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697 "Script files" are command sequences that will be executed by
5698 U-Boot's command interpreter; this feature is especially
5699 useful when you configure U-Boot to use a real shell (hush)
5700 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005701
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005702Booting the Linux zImage:
5703-------------------------
5704
5705On some platforms, it's possible to boot Linux zImage. This is done
5706using the "bootz" command. The syntax of "bootz" command is the same
5707as the syntax of "bootm" command.
5708
Tom Rini45f46d12013-05-16 11:40:11 -04005709Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005710kernel with raw initrd images. The syntax is slightly different, the
5711address of the initrd must be augmented by it's size, in the following
5712format: "<initrd addres>:<initrd size>".
5713
stroeseb9c17c52003-04-04 15:53:41 +00005714
wdenk6c59edc2004-05-03 20:45:30 +00005715Standalone HOWTO:
5716=================
stroeseb9c17c52003-04-04 15:53:41 +00005717
wdenk6c59edc2004-05-03 20:45:30 +00005718One of the features of U-Boot is that you can dynamically load and
5719run "standalone" applications, which can use some resources of
5720U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005721
wdenk6c59edc2004-05-03 20:45:30 +00005722Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724"Hello World" Demo:
5725-------------------
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727'examples/hello_world.c' contains a small "Hello World" Demo
5728application; it is automatically compiled when you build U-Boot.
5729It's configured to run at address 0x00040004, so you can play with it
5730like that:
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732 => loads
5733 ## Ready for S-Record download ...
5734 ~>examples/hello_world.srec
5735 1 2 3 4 5 6 7 8 9 10 11 ...
5736 [file transfer complete]
5737 [connected]
5738 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk6c59edc2004-05-03 20:45:30 +00005740 => go 40004 Hello World! This is a test.
5741 ## Starting application at 0x00040004 ...
5742 Hello World
5743 argc = 7
5744 argv[0] = "40004"
5745 argv[1] = "Hello"
5746 argv[2] = "World!"
5747 argv[3] = "This"
5748 argv[4] = "is"
5749 argv[5] = "a"
5750 argv[6] = "test."
5751 argv[7] = "<NULL>"
5752 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005753
wdenk6c59edc2004-05-03 20:45:30 +00005754 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756Another example, which demonstrates how to register a CPM interrupt
5757handler with the U-Boot code, can be found in 'examples/timer.c'.
5758Here, a CPM timer is set up to generate an interrupt every second.
5759The interrupt service routine is trivial, just printing a '.'
5760character, but this is just a demo program. The application can be
5761controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763 ? - print current values og the CPM Timer registers
5764 b - enable interrupts and start timer
5765 e - stop timer and disable interrupts
5766 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk6c59edc2004-05-03 20:45:30 +00005768 => loads
5769 ## Ready for S-Record download ...
5770 ~>examples/timer.srec
5771 1 2 3 4 5 6 7 8 9 10 11 ...
5772 [file transfer complete]
5773 [connected]
5774 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk6c59edc2004-05-03 20:45:30 +00005776 => go 40004
5777 ## Starting application at 0x00040004 ...
5778 TIMERS=0xfff00980
5779 Using timer 1
5780 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk6c59edc2004-05-03 20:45:30 +00005782Hit 'b':
5783 [q, b, e, ?] Set interval 1000000 us
5784 Enabling timer
5785Hit '?':
5786 [q, b, e, ?] ........
5787 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5788Hit '?':
5789 [q, b, e, ?] .
5790 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5791Hit '?':
5792 [q, b, e, ?] .
5793 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5794Hit '?':
5795 [q, b, e, ?] .
5796 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5797Hit 'e':
5798 [q, b, e, ?] ...Stopping timer
5799Hit 'q':
5800 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005801
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk6c59edc2004-05-03 20:45:30 +00005803Minicom warning:
5804================
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806Over time, many people have reported problems when trying to use the
5807"minicom" terminal emulation program for serial download. I (wd)
5808consider minicom to be broken, and recommend not to use it. Under
5809Unix, I recommend to use C-Kermit for general purpose use (and
5810especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005811use "cu" for S-Record download ("loads" command). See
5812http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5813for help with kermit.
5814
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816Nevertheless, if you absolutely want to use it try adding this
5817configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005818
wdenk6c59edc2004-05-03 20:45:30 +00005819 Name Program Name U/D FullScr IO-Red. Multi
5820 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5821 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005822
wdenk8dba0502003-03-31 16:34:49 +00005823
wdenk6c59edc2004-05-03 20:45:30 +00005824NetBSD Notes:
5825=============
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827Starting at version 0.9.2, U-Boot supports NetBSD both as host
5828(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005829
wdenk6c59edc2004-05-03 20:45:30 +00005830Building requires a cross environment; it is known to work on
5831NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5832need gmake since the Makefiles are not compatible with BSD make).
5833Note that the cross-powerpc package does not install include files;
5834attempting to build U-Boot will fail because <machine/ansi.h> is
5835missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005836
wdenk6c59edc2004-05-03 20:45:30 +00005837 # cd /usr/pkg/cross/powerpc-netbsd/include
5838 # mkdir powerpc
5839 # ln -s powerpc machine
5840 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5841 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005842
wdenk6c59edc2004-05-03 20:45:30 +00005843Native builds *don't* work due to incompatibilities between native
5844and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk6c59edc2004-05-03 20:45:30 +00005846Booting assumes that (the first part of) the image booted is a
5847stage-2 loader which in turn loads and then invokes the kernel
5848proper. Loader sources will eventually appear in the NetBSD source
5849tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005850meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005851
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853Implementation Internals:
5854=========================
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk6c59edc2004-05-03 20:45:30 +00005856The following is not intended to be a complete description of every
5857implementation detail. However, it should help to understand the
5858inner workings of U-Boot and make it easier to port it to custom
5859hardware.
wdenkc6097192002-11-03 00:24:07 +00005860
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk6c59edc2004-05-03 20:45:30 +00005862Initial Stack, Global Data:
5863---------------------------
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk6c59edc2004-05-03 20:45:30 +00005865The implementation of U-Boot is complicated by the fact that U-Boot
5866starts running out of ROM (flash memory), usually without access to
5867system RAM (because the memory controller is not initialized yet).
5868This means that we don't have writable Data or BSS segments, and BSS
5869is not initialized as zero. To be able to get a C environment working
5870at all, we have to allocate at least a minimal stack. Implementation
5871options for this are defined and restricted by the CPU used: Some CPU
5872models provide on-chip memory (like the IMMR area on MPC8xx and
5873MPC826x processors), on others (parts of) the data cache can be
5874locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005875
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005876 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005877 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk6c59edc2004-05-03 20:45:30 +00005879 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5880 From: "Chris Hallinan" <clh@net1plus.com>
5881 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5882 ...
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884 Correct me if I'm wrong, folks, but the way I understand it
5885 is this: Using DCACHE as initial RAM for Stack, etc, does not
5886 require any physical RAM backing up the cache. The cleverness
5887 is that the cache is being used as a temporary supply of
5888 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005889 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005890 can see how this works by studying the cache architecture and
5891 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk6c59edc2004-05-03 20:45:30 +00005893 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5894 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005895 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005896 option should work for you. Using CS 4 should be fine if your
5897 board designers haven't used it for something that would
5898 cause you grief during the initial boot! It is frequently not
5899 used.
wdenkc6097192002-11-03 00:24:07 +00005900
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005901 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005902 with your processor/board/system design. The default value
5903 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005904 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005905 than your SDRAM module. If you have a 64MB SDRAM module, set
5906 it above 400_0000. Just make sure your board has no resources
5907 that are supposed to respond to that address! That code in
5908 start.S has been around a while and should work as is when
5909 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911 -Chris Hallinan
5912 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914It is essential to remember this, since it has some impact on the C
5915code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005916
wdenk6c59edc2004-05-03 20:45:30 +00005917* Initialized global data (data segment) is read-only. Do not attempt
5918 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005919
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005920* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005921 as zero data - BSS segment) at all - this is undefined, initiali-
5922 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924* Stack space is very limited. Avoid big data buffers or things like
5925 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005926
wdenk6c59edc2004-05-03 20:45:30 +00005927Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005928normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005929turned out that the implementation of U-Boot can be greatly
5930simplified by making a global data structure (gd_t) available to all
5931functions. We could pass a pointer to this data as argument to _all_
5932functions, but this would bloat the code. Instead we use a feature of
5933the GCC compiler (Global Register Variables) to share the data: we
5934place a pointer (gd) to the global data into a register which we
5935reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937When choosing a register for such a purpose we are restricted by the
5938relevant (E)ABI specifications for the current architecture, and by
5939GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941For PowerPC, the following registers have specific use:
5942 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005943 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005944 R3-R4: parameter passing and return values
5945 R5-R10: parameter passing
5946 R13: small data area pointer
5947 R30: GOT pointer
5948 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005949
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005950 (U-Boot also uses R12 as internal GOT pointer. r12
5951 is a volatile register so r12 needs to be reset when
5952 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005953
Wolfgang Denk69c09642008-02-14 22:43:22 +01005954 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005955
wdenk6c59edc2004-05-03 20:45:30 +00005956 Note: on PPC, we could use a static initializer (since the
5957 address of the global data structure is known at compile time),
5958 but it turned out that reserving a register results in somewhat
5959 smaller code - although the code savings are not that big (on
5960 average for all boards 752 bytes for the whole U-Boot image,
5961 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005962
Robin Getz2773d5f2009-08-17 15:23:02 +00005963On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005964 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5965
Robin Getz2773d5f2009-08-17 15:23:02 +00005966 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005967
wdenk6c59edc2004-05-03 20:45:30 +00005968On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970 R0: function argument word/integer result
5971 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005972 R9: platform specific
5973 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005974 R11: argument (frame) pointer
5975 R12: temporary workspace
5976 R13: stack pointer
5977 R14: link register
5978 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005979
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005980 ==> U-Boot will use R9 to hold a pointer to the global data
5981
5982 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005983
Thomas Chou8fa38582010-05-21 11:08:03 +08005984On Nios II, the ABI is documented here:
5985 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5986
5987 ==> U-Boot will use gp to hold a pointer to the global data
5988
5989 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5990 to access small data sections, so gp is free.
5991
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005992On NDS32, the following registers are used:
5993
5994 R0-R1: argument/return
5995 R2-R5: argument
5996 R15: temporary register for assembler
5997 R16: trampoline register
5998 R28: frame pointer (FP)
5999 R29: global pointer (GP)
6000 R30: link register (LP)
6001 R31: stack pointer (SP)
6002 PC: program counter (PC)
6003
6004 ==> U-Boot will use R10 to hold a pointer to the global data
6005
Wolfgang Denk6405a152006-03-31 18:32:53 +02006006NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6007or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk6c59edc2004-05-03 20:45:30 +00006009Memory Management:
6010------------------
wdenkc6097192002-11-03 00:24:07 +00006011
wdenk6c59edc2004-05-03 20:45:30 +00006012U-Boot runs in system state and uses physical addresses, i.e. the
6013MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006014
wdenk6c59edc2004-05-03 20:45:30 +00006015The available memory is mapped to fixed addresses using the memory
6016controller. In this process, a contiguous block is formed for each
6017memory type (Flash, SDRAM, SRAM), even when it consists of several
6018physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020U-Boot is installed in the first 128 kB of the first Flash bank (on
6021TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6022booting and sizing and initializing DRAM, the code relocates itself
6023to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006024memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006025configuration setting]. Below that, a structure with global Board
6026Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006027
wdenk6c59edc2004-05-03 20:45:30 +00006028Additionally, some exception handler code is copied to the low 8 kB
6029of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006030
wdenk6c59edc2004-05-03 20:45:30 +00006031So a typical memory configuration with 16 MB of DRAM could look like
6032this:
wdenkc6097192002-11-03 00:24:07 +00006033
wdenk6c59edc2004-05-03 20:45:30 +00006034 0x0000 0000 Exception Vector code
6035 :
6036 0x0000 1FFF
6037 0x0000 2000 Free for Application Use
6038 :
6039 :
wdenkc6097192002-11-03 00:24:07 +00006040
wdenk6c59edc2004-05-03 20:45:30 +00006041 :
6042 :
6043 0x00FB FF20 Monitor Stack (Growing downward)
6044 0x00FB FFAC Board Info Data and permanent copy of global data
6045 0x00FC 0000 Malloc Arena
6046 :
6047 0x00FD FFFF
6048 0x00FE 0000 RAM Copy of Monitor Code
6049 ... eventually: LCD or video framebuffer
6050 ... eventually: pRAM (Protected RAM - unchanged by reset)
6051 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006052
wdenkc6097192002-11-03 00:24:07 +00006053
wdenk6c59edc2004-05-03 20:45:30 +00006054System Initialization:
6055----------------------
wdenkc6097192002-11-03 00:24:07 +00006056
wdenk6c59edc2004-05-03 20:45:30 +00006057In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006058(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006059configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006060To be able to re-map memory U-Boot then jumps to its link address.
6061To be able to implement the initialization code in C, a (small!)
6062initial stack is set up in the internal Dual Ported RAM (in case CPUs
6063which provide such a feature like MPC8xx or MPC8260), or in a locked
6064part of the data cache. After that, U-Boot initializes the CPU core,
6065the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006066
wdenk6c59edc2004-05-03 20:45:30 +00006067Next, all (potentially) available memory banks are mapped using a
6068preliminary mapping. For example, we put them on 512 MB boundaries
6069(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6070on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6071programmed for SDRAM access. Using the temporary configuration, a
6072simple memory test is run that determines the size of the SDRAM
6073banks.
wdenkc6097192002-11-03 00:24:07 +00006074
wdenk6c59edc2004-05-03 20:45:30 +00006075When there is more than one SDRAM bank, and the banks are of
6076different size, the largest is mapped first. For equal size, the first
6077bank (CS2#) is mapped first. The first mapping is always for address
60780x00000000, with any additional banks following immediately to create
6079contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006080
wdenk6c59edc2004-05-03 20:45:30 +00006081Then, the monitor installs itself at the upper end of the SDRAM area
6082and allocates memory for use by malloc() and for the global Board
6083Info data; also, the exception vector code is copied to the low RAM
6084pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086Only after this relocation will you have a "normal" C environment;
6087until that you are restricted in several ways, mostly because you are
6088running from ROM, and because the code will have to be relocated to a
6089new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006090
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092U-Boot Porting Guide:
6093----------------------
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk6c59edc2004-05-03 20:45:30 +00006095[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6096list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006097
wdenkc6097192002-11-03 00:24:07 +00006098
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006099int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006100{
6101 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006102
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006103 signal(SIGALRM, no_more_time);
6104 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk6c59edc2004-05-03 20:45:30 +00006106 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006107 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006108 return 0;
6109 }
wdenkc6097192002-11-03 00:24:07 +00006110
wdenk6c59edc2004-05-03 20:45:30 +00006111 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006112
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006113 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006114
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006115 if (clueless)
6116 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006117
wdenk6c59edc2004-05-03 20:45:30 +00006118 while (learning) {
6119 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006120 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6121 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006122 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006123 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006124 }
wdenkc6097192002-11-03 00:24:07 +00006125
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006126 if (available_money > toLocalCurrency ($2500))
6127 Buy a BDI3000;
6128 else
wdenk6c59edc2004-05-03 20:45:30 +00006129 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006130
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006131 if (a similar board exists) { /* hopefully... */
6132 cp -a board/<similar> board/<myboard>
6133 cp include/configs/<similar>.h include/configs/<myboard>.h
6134 } else {
6135 Create your own board support subdirectory;
6136 Create your own board include/configs/<myboard>.h file;
6137 }
6138 Edit new board/<myboard> files
6139 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006140
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006141 while (!accepted) {
6142 while (!running) {
6143 do {
6144 Add / modify source code;
6145 } until (compiles);
6146 Debug;
6147 if (clueless)
6148 email("Hi, I am having problems...");
6149 }
6150 Send patch file to the U-Boot email list;
6151 if (reasonable critiques)
6152 Incorporate improvements from email list code review;
6153 else
6154 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006155 }
wdenkc6097192002-11-03 00:24:07 +00006156
wdenk6c59edc2004-05-03 20:45:30 +00006157 return 0;
6158}
wdenkc6097192002-11-03 00:24:07 +00006159
wdenk6c59edc2004-05-03 20:45:30 +00006160void no_more_time (int sig)
6161{
6162 hire_a_guru();
6163}
wdenkc6097192002-11-03 00:24:07 +00006164
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk6c59edc2004-05-03 20:45:30 +00006166Coding Standards:
6167-----------------
wdenkc6097192002-11-03 00:24:07 +00006168
wdenk6c59edc2004-05-03 20:45:30 +00006169All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006170coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006171"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006172
6173Source files originating from a different project (for example the
6174MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006175reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006176sources.
wdenkc6097192002-11-03 00:24:07 +00006177
Detlev Zundelaa63d482006-09-01 15:39:02 +02006178Please note that U-Boot is implemented in C (and to some small parts in
6179Assembler); no C++ is used, so please do not use C++ style comments (//)
6180in your code.
wdenkad276f22004-01-04 16:28:35 +00006181
wdenk6c59edc2004-05-03 20:45:30 +00006182Please also stick to the following formatting rules:
6183- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006184- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006185- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006186- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006187- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006188
wdenk6c59edc2004-05-03 20:45:30 +00006189Submissions which do not conform to the standards may be returned
6190with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006191
wdenkc6097192002-11-03 00:24:07 +00006192
wdenk6c59edc2004-05-03 20:45:30 +00006193Submitting Patches:
6194-------------------
wdenkc6097192002-11-03 00:24:07 +00006195
wdenk6c59edc2004-05-03 20:45:30 +00006196Since the number of patches for U-Boot is growing, we need to
6197establish some rules. Submissions which do not conform to these rules
6198may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006199
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006200Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006201
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006202Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6203see http://lists.denx.de/mailman/listinfo/u-boot
6204
wdenk6c59edc2004-05-03 20:45:30 +00006205When you send a patch, please include the following information with
6206it:
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208* For bug fixes: a description of the bug and how your patch fixes
6209 this bug. Please try to include a way of demonstrating that the
6210 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006211
wdenk6c59edc2004-05-03 20:45:30 +00006212* For new features: a description of the feature and your
6213 implementation.
wdenkc6097192002-11-03 00:24:07 +00006214
wdenk6c59edc2004-05-03 20:45:30 +00006215* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006216
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006217* For major contributions, add a MAINTAINERS file with your
6218 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006219
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006220* When you add support for a new board, don't forget to add a
6221 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006222
wdenk6c59edc2004-05-03 20:45:30 +00006223* If your patch adds new configuration options, don't forget to
6224 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006225
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006226* The patch itself. If you are using git (which is *strongly*
6227 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006228 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006229 the U-Boot mailing list, you will avoid most of the common problems
6230 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006231
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006232 If you cannot use git, use "diff -purN OLD NEW". If your version of
6233 diff does not support these options, then get the latest version of
6234 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006235
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006236 The current directory when running this command shall be the parent
6237 directory of the U-Boot source tree (i. e. please make sure that
6238 your patch includes sufficient directory information for the
6239 affected files).
6240
6241 We prefer patches as plain text. MIME attachments are discouraged,
6242 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006243
wdenk6c59edc2004-05-03 20:45:30 +00006244* If one logical set of modifications affects or creates several
6245 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006246
wdenk6c59edc2004-05-03 20:45:30 +00006247* Changesets that contain different, unrelated modifications shall be
6248 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006249
wdenkc6097192002-11-03 00:24:07 +00006250
wdenk6c59edc2004-05-03 20:45:30 +00006251Notes:
wdenkc6097192002-11-03 00:24:07 +00006252
Simon Glassdc27def2016-07-27 20:33:08 -06006253* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006254 source tree and make sure that no errors or warnings are reported
6255 for any of the boards.
6256
6257* Keep your modifications to the necessary minimum: A patch
6258 containing several unrelated changes or arbitrary reformats will be
6259 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk6c59edc2004-05-03 20:45:30 +00006261* If you modify existing code, make sure that your new code does not
6262 add to the memory footprint of the code ;-) Small is beautiful!
6263 When adding new features, these should compile conditionally only
6264 (using #ifdef), and the resulting code with the new feature
6265 disabled must not need more memory than the old code without your
6266 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006267
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006268* Remember that there is a size limit of 100 kB per message on the
6269 u-boot mailing list. Bigger patches will be moderated. If they are
6270 reasonable and not too big, they will be acknowledged. But patches
6271 bigger than the size limit should be avoided.